org.texi 433 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879
  1. \input texinfo
  2. @c %**start of header
  3. @setfilename ../../info/org
  4. @settitle The Org Manual
  5. @set VERSION 6.22trans
  6. @set DATE February 2009
  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, 2009 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.3 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 to 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. * Variable and Faces Index:: Index for variables and faces discussed
  85. @detailmenu
  86. --- The Detailed Node Listing ---
  87. Introduction
  88. * Summary:: Brief summary of what Org does
  89. * Installation:: How to install a downloaded version of Org
  90. * Activation:: How to activate Org for certain buffers
  91. * Feedback:: Bug reports, ideas, patches etc.
  92. * Conventions:: Type-setting conventions in the manual
  93. Document Structure
  94. * Outlines:: Org is based on Outline mode
  95. * Headlines:: How to typeset Org tree headlines
  96. * Visibility cycling:: Show and hide, much simplified
  97. * Motion:: Jumping to other headlines
  98. * Structure editing:: Changing sequence and level of headlines
  99. * Archiving:: Move done task trees to a different place
  100. * Sparse trees:: Matches embedded in context
  101. * Plain lists:: Additional structure within an entry
  102. * Drawers:: Tucking stuff away
  103. * Footnotes:: How footnotes are defined in Org's syntax
  104. * Orgstruct mode:: Structure editing outside Org
  105. Archiving
  106. * ARCHIVE tag:: Marking a tree as inactive
  107. * Moving subtrees:: Moving a tree to an archive file
  108. Tables
  109. * Built-in table editor:: Simple tables
  110. * Narrow columns:: Stop wasting space in tables
  111. * Column groups:: Grouping to trigger vertical lines
  112. * Orgtbl mode:: The table editor as minor mode
  113. * The spreadsheet:: The table editor has spreadsheet capabilities
  114. * Org Plot:: Plotting from org tables
  115. The spreadsheet
  116. * References:: How to refer to another field or range
  117. * Formula syntax for Calc:: Using Calc to compute stuff
  118. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  119. * Field formulas:: Formulas valid for a single field
  120. * Column formulas:: Formulas valid for an entire column
  121. * Editing and debugging formulas:: Fixing formulas
  122. * Updating the table:: Recomputing all dependent fields
  123. * Advanced features:: Field names, parameters and automatic recalc
  124. Hyperlinks
  125. * Link format:: How links in Org are formatted
  126. * Internal links:: Links to other places in the current file
  127. * External links:: URL-like links to the world
  128. * Handling links:: Creating, inserting and following
  129. * Using links outside Org:: Linking from my C source code?
  130. * Link abbreviations:: Shortcuts for writing complex links
  131. * Search options:: Linking to a specific location
  132. * Custom searches:: When the default search is not enough
  133. Internal links
  134. * Radio targets:: Make targets trigger links in plain text
  135. TODO Items
  136. * TODO basics:: Marking and displaying TODO entries
  137. * TODO extensions:: Workflow and assignments
  138. * Progress logging:: Dates and notes for progress
  139. * Priorities:: Some things are more important than others
  140. * Breaking down tasks:: Splitting a task into manageable pieces
  141. * Checkboxes:: Tick-off lists
  142. Extended use of TODO keywords
  143. * Workflow states:: From TODO to DONE in steps
  144. * TODO types:: I do this, Fred does the rest
  145. * Multiple sets in one file:: Mixing it all, and still finding your way
  146. * Fast access to TODO states:: Single letter selection of a state
  147. * Per-file keywords:: Different files, different requirements
  148. * Faces for TODO keywords:: Highlighting states
  149. * TODO dependencies:: When one task needs to wait for others
  150. Progress logging
  151. * Closing items:: When was this entry marked DONE?
  152. * Tracking TODO state changes:: When did the status change?
  153. Tags
  154. * Tag inheritance:: Tags use the tree structure of the outline
  155. * Setting tags:: How to assign tags to a headline
  156. * Tag searches:: Searching for combinations of tags
  157. Properties and Columns
  158. * Property syntax:: How properties are spelled out
  159. * Special properties:: Access to other Org mode features
  160. * Property searches:: Matching property values
  161. * Property inheritance:: Passing values down the tree
  162. * Column view:: Tabular viewing and editing
  163. * Property API:: Properties for Lisp programmers
  164. Column view
  165. * Defining columns:: The COLUMNS format property
  166. * Using column view:: How to create and use column view
  167. * Capturing column view:: A dynamic block for column view
  168. Defining columns
  169. * Scope of column definitions:: Where defined, where valid?
  170. * Column attributes:: Appearance and content of a column
  171. Dates and Times
  172. * Timestamps:: Assigning a time to a tree entry
  173. * Creating timestamps:: Commands which insert timestamps
  174. * Deadlines and scheduling:: Planning your work
  175. * Clocking work time:: Tracking how long you spend on a task
  176. * Effort estimates:: Planning work effort in advance
  177. * Relative timer:: Notes with a running timer
  178. Creating timestamps
  179. * The date/time prompt:: How Org mode helps you entering date and time
  180. * Custom time format:: Making dates look different
  181. Deadlines and scheduling
  182. * Inserting deadline/schedule:: Planning items
  183. * Repeated tasks:: Items that show up again and again
  184. Capture
  185. * Remember:: Capture new tasks/ideas with little interruption
  186. * Attachments:: Add files to tasks.
  187. Remember
  188. * Setting up Remember:: Some code for .emacs to get things going
  189. * Remember templates:: Define the outline of different note types
  190. * Storing notes:: Directly get the note to where it belongs
  191. * Refiling notes:: Moving a note or task to a project
  192. Agenda Views
  193. * Agenda files:: Files being searched for agenda information
  194. * Agenda dispatcher:: Keyboard access to agenda views
  195. * Built-in agenda views:: What is available out of the box?
  196. * Presentation and sorting:: How agenda items are prepared for display
  197. * Agenda commands:: Remote editing of Org trees
  198. * Custom agenda views:: Defining special searches and views
  199. * Agenda column view:: Using column view for collected entries
  200. The built-in agenda views
  201. * Weekly/daily agenda:: The calendar page with current tasks
  202. * Global TODO list:: All unfinished action items
  203. * Matching tags and properties:: Structured information with fine-tuned search
  204. * Timeline:: Time-sorted view for single file
  205. * Keyword search:: Finding entries by keyword
  206. * Stuck projects:: Find projects you need to review
  207. Presentation and sorting
  208. * Categories:: Not all tasks are equal
  209. * Time-of-day specifications:: How the agenda knows the time
  210. * Sorting of agenda items:: The order of things
  211. Custom agenda views
  212. * Storing searches:: Type once, use often
  213. * Block agenda:: All the stuff you need in a single buffer
  214. * Setting Options:: Changing the rules
  215. * Exporting Agenda Views:: Writing agendas to files
  216. * Using the agenda elsewhere:: Using agenda information in other programs
  217. Embedded LaTeX
  218. * Math symbols:: TeX macros for symbols and Greek letters
  219. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  220. * LaTeX fragments:: Complex formulas made easy
  221. * Processing LaTeX fragments:: Previewing LaTeX processing
  222. * CDLaTeX mode:: Speed up entering of formulas
  223. Exporting
  224. * Markup rules:: Which structures are recognized?
  225. * Selective export:: Using tags to select and exclude trees
  226. * Export options:: Per-file export settings
  227. * The export dispatcher:: How to access exporter commands
  228. * ASCII export:: Exporting to plain ASCII
  229. * HTML export:: Exporting to HTML
  230. * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
  231. * XOXO export:: Exporting to XOXO
  232. * iCalendar export:: Exporting in iCalendar format
  233. Markup rules
  234. * Document title:: How the document title is determined
  235. * Headings and sections:: The main structure of the exported document
  236. * Table of contents:: If, where, how to create a table of contents
  237. * Initial text:: Text before the first headline
  238. * Lists:: Plain lists are exported
  239. * Paragraphs:: What determines beginning and ending
  240. * Literal examples:: Source code and other examples
  241. * Include files:: Include the contents of a file during export
  242. * Tables exported:: Tables are exported richly
  243. * Inlined images:: How to inline images during export
  244. * Footnote markup::
  245. * Emphasis and monospace:: To bold or not to bold
  246. * TeX macros and LaTeX fragments:: Create special, rich export.
  247. * Horizontal rules:: A line across the page
  248. * Comment lines:: Some lines will not be exported
  249. HTML export
  250. * HTML Export commands:: How to invoke HTML export
  251. * Quoting HTML tags:: Using direct HTML in Org mode
  252. * Links:: Transformation of links for HTML
  253. * Images in HTML export:: How to insert figures into HTML output
  254. * Text areas in HTML export:: An alternative way to show an example
  255. * CSS support:: Changing the appearance of the output
  256. * Javascript support:: Info and Folding in a web browser
  257. LaTeX and PDF export
  258. * LaTeX/PDF export commands:: Which key invokes which commands
  259. * Quoting LaTeX code:: Incorporating literal LaTeX code
  260. * Sectioning structure:: Changing sectioning in LaTeX output
  261. * Tables in LaTeX export:: Options for exporting tables to LaTeX
  262. * Images in LaTeX export:: How to insert figures into LaTeX output
  263. Publishing
  264. * Configuration:: Defining projects
  265. * Sample configuration:: Example projects
  266. * Triggering publication:: Publication commands
  267. Configuration
  268. * Project alist:: The central configuration variable
  269. * Sources and destinations:: From here to there
  270. * Selecting files:: What files are part of the project?
  271. * Publishing action:: Setting the function doing the publishing
  272. * Publishing options:: Tweaking HTML export
  273. * Publishing links:: Which links keep working after publishing?
  274. * Project page index:: Publishing a list of project files
  275. Sample configuration
  276. * Simple example:: One-component publishing
  277. * Complex example:: A multi-component publishing example
  278. Miscellaneous
  279. * Completion:: M-TAB knows what you need
  280. * Customization:: Adapting Org to your taste
  281. * In-buffer settings:: Overview of the #+KEYWORDS
  282. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  283. * Clean view:: Getting rid of leading stars in the outline
  284. * TTY keys:: Using Org on a tty
  285. * Interaction:: Other Emacs packages
  286. * Bugs:: Things which do not work perfectly
  287. Interaction with other packages
  288. * Cooperation:: Packages Org cooperates with
  289. * Conflicts:: Packages that lead to conflicts
  290. Extensions
  291. * Extensions in the contrib directory:: These come with the Org distro
  292. * Other extensions:: These you have to find on the web.
  293. Hacking
  294. * Adding hyperlink types:: New custom link types
  295. * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
  296. * Dynamic blocks:: Automatically filled blocks
  297. * Special agenda views:: Customized views
  298. * Using the property API:: Writing programs that use entry properties
  299. * Using the mapping API:: Mapping over all or selected entries
  300. Tables and lists in arbitrary syntax
  301. * Radio tables:: Sending and receiving
  302. * A LaTeX example:: Step by step, almost a tutorial
  303. * Translator functions:: Copy and modify
  304. * Radio lists:: Doing the same for lists
  305. @end detailmenu
  306. @end menu
  307. @node Introduction, Document Structure, Top, Top
  308. @chapter Introduction
  309. @cindex introduction
  310. @menu
  311. * Summary:: Brief summary of what Org does
  312. * Installation:: How to install a downloaded version of Org
  313. * Activation:: How to activate Org for certain buffers
  314. * Feedback:: Bug reports, ideas, patches etc.
  315. * Conventions:: Type-setting conventions in the manual
  316. @end menu
  317. @node Summary, Installation, Introduction, Introduction
  318. @section Summary
  319. @cindex summary
  320. Org is a mode for keeping notes, maintaining TODO lists, and doing
  321. project planning with a fast and effective plain-text system.
  322. Org develops organizational tasks around NOTES files that contain
  323. lists or information about projects as plain text. Org is
  324. implemented on top of Outline mode, which makes it possible to keep the
  325. content of large files well structured. Visibility cycling and
  326. structure editing help to work with the tree. Tables are easily created
  327. with a built-in table editor. Org supports TODO items, deadlines,
  328. time stamps, and scheduling. It dynamically compiles entries into an
  329. agenda that utilizes and smoothly integrates much of the Emacs calendar
  330. and diary. Plain text URL-like links connect to websites, emails,
  331. Usenet messages, BBDB entries, and any files related to the projects.
  332. For printing and sharing of notes, an Org file can be exported as a
  333. structured ASCII file, as HTML, or (TODO and agenda items only) as an
  334. iCalendar file. It can also serve as a publishing tool for a set of
  335. linked web pages.
  336. An important design aspect that distinguishes Org from for example
  337. Planner/Muse is that it encourages to store every piece of information
  338. only once. In Planner, you have project pages, day pages and possibly
  339. other files, duplicating some information such as tasks. In Org,
  340. you only have notes files. In your notes you mark entries as tasks,
  341. label them with tags and timestamps. All necessary lists like a
  342. schedule for the day, the agenda for a meeting, tasks lists selected by
  343. tags etc are created dynamically when you need them.
  344. Org keeps simple things simple. When first fired up, it should
  345. feel like a straightforward, easy to use outliner. Complexity is not
  346. imposed, but a large amount of functionality is available when you need
  347. it. Org is a toolbox and can be used in different ways, for
  348. example as:
  349. @example
  350. @r{@bullet{} outline extension with visibility cycling and structure editing}
  351. @r{@bullet{} ASCII system and table editor for taking structured notes}
  352. @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
  353. @r{@bullet{} TODO list editor}
  354. @r{@bullet{} full agenda and planner with deadlines and work scheduling}
  355. @r{@bullet{} environment to implement David Allen's GTD system}
  356. @r{@bullet{} a basic database application}
  357. @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
  358. @r{@bullet{} publishing tool to create a set of interlinked webpages}
  359. @end example
  360. Org's automatic, context sensitive table editor with spreadsheet
  361. capabilities can be integrated into any major mode by activating the
  362. minor Orgtbl mode. Using a translation step, it can be used to maintain
  363. tables in arbitrary file types, for example in La@TeX{}. The structure
  364. editing and list creation capabilities can be used outside Org with
  365. the minor Orgstruct mode.
  366. @cindex FAQ
  367. There is a website for Org which provides links to the newest
  368. version of Org, as well as additional information, frequently asked
  369. questions (FAQ), links to tutorials etc. This page is located at
  370. @uref{http://orgmode.org}.
  371. @page
  372. @node Installation, Activation, Summary, Introduction
  373. @section Installation
  374. @cindex installation
  375. @cindex XEmacs
  376. @b{Important:} @i{If Org is part of the Emacs distribution or an
  377. XEmacs package, please skip this section and go directly to
  378. @ref{Activation}.}
  379. If you have downloaded Org from the Web, either as a distribution @file{.zip}
  380. or @file{.tar} file, or as a GIT archive, you must take the following steps
  381. to install it: Go into the unpacked Org distribution directory and edit the
  382. top section of the file @file{Makefile}. You must set the name of the Emacs
  383. binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
  384. directories where local Lisp and Info files are kept. If you don't have
  385. access to the system-wide directories, you can simply run Org directly from
  386. the distribution directory by adding the @file{lisp} subdirectory to the
  387. Emacs load path. To do this, add the following line to @file{.emacs}:
  388. @example
  389. (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
  390. @end example
  391. @noindent
  392. If you plan to use code from the @file{contrib} subdirectory, do a similar
  393. step for this directory:
  394. @example
  395. (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
  396. @end example
  397. @b{XEmacs users now need to install the file @file{noutline.el} from
  398. the @file{xemacs} sub-directory of the Org distribution. Use the
  399. command:}
  400. @example
  401. @b{make install-noutline}
  402. @end example
  403. @noindent Now byte-compile the Lisp files with the shell command:
  404. @example
  405. make
  406. @end example
  407. @noindent If you are running Org from the distribution directory, this is
  408. all. If you want to install into the system directories, use
  409. @example
  410. make install
  411. make install-info
  412. @end example
  413. @noindent Then add to @file{.emacs}:
  414. @lisp
  415. ;; This line only if Org is not part of the X/Emacs distribution.
  416. (require 'org-install)
  417. @end lisp
  418. Do not forget to activate Org as described in the following section.
  419. @node Activation, Feedback, Installation, Introduction
  420. @section Activation
  421. @cindex activation
  422. @cindex autoload
  423. @cindex global key bindings
  424. @cindex key bindings, global
  425. @iftex
  426. @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
  427. PDF documentation as viewed by some PDF viewers to your .emacs file, the
  428. single quote character comes out incorrectly and the code will not work.
  429. You need to fix the single quotes by hand, or copy from Info
  430. documentation.}
  431. @end iftex
  432. Add the following lines to your @file{.emacs} file. The last three lines
  433. define @emph{global} keys for the commands @command{org-store-link},
  434. @command{org-agenda}, and @command{org-iswitchb} - please choose suitable
  435. keys yourself.
  436. @lisp
  437. ;; The following lines are always needed. Choose your own keys.
  438. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
  439. (global-set-key "\C-cl" 'org-store-link)
  440. (global-set-key "\C-ca" 'org-agenda)
  441. (global-set-key "\C-cb" 'org-iswitchb)
  442. @end lisp
  443. Furthermore, you must activate @code{font-lock-mode} in Org
  444. buffers, because significant functionality depends on font-locking being
  445. active. You can do this with either one of the following two lines
  446. (XEmacs user must use the second option):
  447. @lisp
  448. (global-font-lock-mode 1) ; for all buffers
  449. (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
  450. @end lisp
  451. @cindex Org mode, turning on
  452. With this setup, all files with extension @samp{.org} will be put
  453. into Org mode. As an alternative, make the first line of a file look
  454. like this:
  455. @example
  456. MY PROJECTS -*- mode: org; -*-
  457. @end example
  458. @vindex org-insert-mode-line-in-empty-file
  459. @noindent which will select Org mode for this buffer no matter what
  460. the file's name is. See also the variable
  461. @code{org-insert-mode-line-in-empty-file}.
  462. Many commands in Org work on the region if the region is active. To make use
  463. of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in
  464. XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to
  465. do this yourself with
  466. @lisp
  467. (transient-mark-mode 1)
  468. @end lisp
  469. @node Feedback, Conventions, Activation, Introduction
  470. @section Feedback
  471. @cindex feedback
  472. @cindex bug reports
  473. @cindex maintainer
  474. @cindex author
  475. If you find problems with Org, or if you have questions, remarks, or ideas
  476. about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
  477. If you are not a member of the mailing list, your mail will be reviewed by a
  478. moderator and then passed through to the list.
  479. For bug reports, please provide as much information as possible,
  480. including the version information of Emacs (@kbd{C-h v emacs-version
  481. @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
  482. the Org related setup in @file{.emacs}. If an error occurs, a
  483. backtrace can be very useful (see below on how to create one). Often a
  484. small example file helps, along with clear information about:
  485. @enumerate
  486. @item What exactly did you do?
  487. @item What did you expect to happen?
  488. @item What happened instead?
  489. @end enumerate
  490. @noindent Thank you for helping to improve this mode.
  491. @subsubheading How to create a useful backtrace
  492. @cindex backtrace of an error
  493. If working with Org produces an error with a message you don't
  494. understand, you may have hit a bug. The best way to report this is by
  495. providing, in addition to what was mentioned above, a @emph{Backtrace}.
  496. This is information from the built-in debugger about where and how the
  497. error occurred. Here is how to produce a useful backtrace:
  498. @enumerate
  499. @item
  500. Start a fresh Emacs or XEmacs, and make sure that it will load the
  501. original Lisp code in @file{org.el} instead of the compiled version in
  502. @file{org.elc}. The backtrace contains much more information if it is
  503. produced with uncompiled code. To do this, either rename @file{org.elc}
  504. to something else before starting Emacs, or ask Emacs explicitly to load
  505. @file{org.el} by using the command line
  506. @example
  507. emacs -l /path/to/org.el
  508. @end example
  509. @item
  510. Go to the @code{Options} menu and select @code{Enter Debugger on Error}
  511. (XEmacs has this option in the @code{Troubleshooting} sub-menu).
  512. @item
  513. Do whatever you have to do to hit the error. Don't forget to
  514. document the steps you take.
  515. @item
  516. When you hit the error, a @file{*Backtrace*} buffer will appear on the
  517. screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
  518. attach it to your bug report.
  519. @end enumerate
  520. @node Conventions, , Feedback, Introduction
  521. @section Typesetting conventions used in this manual
  522. Org uses three types of keywords: TODO keywords, tags, and property
  523. names. In this manual we use the following conventions:
  524. @table @code
  525. @item TODO
  526. @itemx WAITING
  527. TODO keywords are written with all capitals, even if they are
  528. user-defined.
  529. @item boss
  530. @itemx ARCHIVE
  531. User-defined tags are written in lowercase; built-in tags with special
  532. meaning are written with all capitals.
  533. @item Release
  534. @itemx PRIORITY
  535. User-defined properties are capitalized; built-in properties with
  536. special meaning are written with all capitals.
  537. @end table
  538. @node Document Structure, Tables, Introduction, Top
  539. @chapter Document Structure
  540. @cindex document structure
  541. @cindex structure of document
  542. Org is based on outline mode and provides flexible commands to
  543. edit the structure of the document.
  544. @menu
  545. * Outlines:: Org is based on Outline mode
  546. * Headlines:: How to typeset Org tree headlines
  547. * Visibility cycling:: Show and hide, much simplified
  548. * Motion:: Jumping to other headlines
  549. * Structure editing:: Changing sequence and level of headlines
  550. * Archiving:: Move done task trees to a different place
  551. * Sparse trees:: Matches embedded in context
  552. * Plain lists:: Additional structure within an entry
  553. * Drawers:: Tucking stuff away
  554. * Footnotes:: How footnotes are defined in Org's syntax
  555. * Orgstruct mode:: Structure editing outside Org
  556. @end menu
  557. @node Outlines, Headlines, Document Structure, Document Structure
  558. @section Outlines
  559. @cindex outlines
  560. @cindex Outline mode
  561. Org is implemented on top of Outline mode. Outlines allow a
  562. document to be organized in a hierarchical structure, which (at least
  563. for me) is the best representation of notes and thoughts. An overview
  564. of this structure is achieved by folding (hiding) large parts of the
  565. document to show only the general document structure and the parts
  566. currently being worked on. Org greatly simplifies the use of
  567. outlines by compressing the entire show/hide functionality into a single
  568. command @command{org-cycle}, which is bound to the @key{TAB} key.
  569. @node Headlines, Visibility cycling, Outlines, Document Structure
  570. @section Headlines
  571. @cindex headlines
  572. @cindex outline tree
  573. @vindex org-special-ctrl-a/e
  574. Headlines define the structure of an outline tree. The headlines in
  575. Org start with one or more stars, on the left margin@footnote{See
  576. the variable @code{org-special-ctrl-a/e} to configure special behavior
  577. of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
  578. @example
  579. * Top level headline
  580. ** Second level
  581. *** 3rd level
  582. some text
  583. *** 3rd level
  584. more text
  585. * Another top level headline
  586. @end example
  587. @noindent Some people find the many stars too noisy and would prefer an
  588. outline that has whitespace followed by a single star as headline
  589. starters. @ref{Clean view} describes a setup to realize this.
  590. @vindex org-cycle-separator-lines
  591. An empty line after the end of a subtree is considered part of it and
  592. will be hidden when the subtree is folded. However, if you leave at
  593. least two empty lines, one empty line will remain visible after folding
  594. the subtree, in order to structure the collapsed view. See the
  595. variable @code{org-cycle-separator-lines} to modify this behavior.
  596. @node Visibility cycling, Motion, Headlines, Document Structure
  597. @section Visibility cycling
  598. @cindex cycling, visibility
  599. @cindex visibility cycling
  600. @cindex trees, visibility
  601. @cindex show hidden text
  602. @cindex hide text
  603. Outlines make it possible to hide parts of the text in the buffer.
  604. Org uses just two commands, bound to @key{TAB} and
  605. @kbd{S-@key{TAB}} to change the visibility in the buffer.
  606. @cindex subtree visibility states
  607. @cindex subtree cycling
  608. @cindex folded, subtree visibility state
  609. @cindex children, subtree visibility state
  610. @cindex subtree, subtree visibility state
  611. @table @kbd
  612. @kindex @key{TAB}
  613. @item @key{TAB}
  614. @emph{Subtree cycling}: Rotate current subtree among the states
  615. @example
  616. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  617. '-----------------------------------'
  618. @end example
  619. @vindex org-cycle-emulate-tab
  620. @vindex org-cycle-global-at-bob
  621. The cursor must be on a headline for this to work@footnote{see, however,
  622. the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
  623. beginning of the buffer and the first line is not a headline, then
  624. @key{TAB} actually runs global cycling (see below)@footnote{see the
  625. option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
  626. argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
  627. @cindex global visibility states
  628. @cindex global cycling
  629. @cindex overview, global visibility state
  630. @cindex contents, global visibility state
  631. @cindex show all, global visibility state
  632. @kindex S-@key{TAB}
  633. @item S-@key{TAB}
  634. @itemx C-u @key{TAB}
  635. @emph{Global cycling}: Rotate the entire buffer among the states
  636. @example
  637. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  638. '--------------------------------------'
  639. @end example
  640. When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
  641. CONTENTS view up to headlines of level N will be shown. Note that inside
  642. tables, @kbd{S-@key{TAB}} jumps to the previous field.
  643. @cindex show all, command
  644. @kindex C-u C-u C-u @key{TAB}
  645. @item C-u C-u C-u @key{TAB}
  646. Show all, including drawers.
  647. @kindex C-c C-r
  648. @item C-c C-r
  649. Reveal context around point, showing the current entry, the following heading
  650. and the hierarchy above. Useful for working near a location that has been
  651. exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
  652. (@pxref{Agenda commands}). With a prefix argument show, on each
  653. level, all sibling headings.
  654. @kindex C-c C-x b
  655. @item C-c C-x b
  656. Show the current subtree in an indirect buffer@footnote{The indirect
  657. buffer
  658. @ifinfo
  659. (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
  660. @end ifinfo
  661. @ifnotinfo
  662. (see the Emacs manual for more information about indirect buffers)
  663. @end ifnotinfo
  664. will contain the entire buffer, but will be narrowed to the current
  665. tree. Editing the indirect buffer will also change the original buffer,
  666. but without affecting visibility in that buffer.}. With a numeric
  667. prefix argument N, go up to level N and then take that tree. If N is
  668. negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
  669. the previously used indirect buffer.
  670. @end table
  671. @vindex org-startup-folded
  672. When Emacs first visits an Org file, the global state is set to
  673. OVERVIEW, i.e. only the top level headlines are visible. This can be
  674. configured through the variable @code{org-startup-folded}, or on a
  675. per-file basis by adding one of the following lines anywhere in the
  676. buffer:
  677. @example
  678. #+STARTUP: overview
  679. #+STARTUP: content
  680. #+STARTUP: showall
  681. @end example
  682. @noindent
  683. Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
  684. and Columns}) will get their visibility adapted accordingly. Allowed values
  685. for this property are @code{folded}, @code{children}, @code{content}, and
  686. @code{all}.
  687. @table @kbd
  688. @kindex C-u C-u @key{TAB}
  689. @item C-u C-u @key{TAB}
  690. Switch back to the startup visibility of the buffer, i.e. whatever is
  691. requested by startup options and @samp{VISIBILITY} properties in individual
  692. entries.
  693. @end table
  694. @node Motion, Structure editing, Visibility cycling, Document Structure
  695. @section Motion
  696. @cindex motion, between headlines
  697. @cindex jumping, to headlines
  698. @cindex headline navigation
  699. The following commands jump to other headlines in the buffer.
  700. @table @kbd
  701. @kindex C-c C-n
  702. @item C-c C-n
  703. Next heading.
  704. @kindex C-c C-p
  705. @item C-c C-p
  706. Previous heading.
  707. @kindex C-c C-f
  708. @item C-c C-f
  709. Next heading same level.
  710. @kindex C-c C-b
  711. @item C-c C-b
  712. Previous heading same level.
  713. @kindex C-c C-u
  714. @item C-c C-u
  715. Backward to higher level heading.
  716. @kindex C-c C-j
  717. @item C-c C-j
  718. Jump to a different place without changing the current outline
  719. visibility. Shows the document structure in a temporary buffer, where
  720. you can use the following keys to find your destination:
  721. @vindex org-goto-auto-isearch
  722. @example
  723. @key{TAB} @r{Cycle visibility.}
  724. @key{down} / @key{up} @r{Next/previous visible headline.}
  725. @key{RET} @r{Select this location.}
  726. @kbd{/} @r{Do a Sparse-tree search}
  727. @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
  728. n / p @r{Next/previous visible headline.}
  729. f / b @r{Next/previous headline same level.}
  730. u @r{One level up.}
  731. 0-9 @r{Digit argument.}
  732. q @r{Quit}
  733. @end example
  734. @vindex org-goto-interface
  735. See also the variable@code{org-goto-interface}.
  736. @end table
  737. @node Structure editing, Archiving, Motion, Document Structure
  738. @section Structure editing
  739. @cindex structure editing
  740. @cindex headline, promotion and demotion
  741. @cindex promotion, of subtrees
  742. @cindex demotion, of subtrees
  743. @cindex subtree, cut and paste
  744. @cindex pasting, of subtrees
  745. @cindex cutting, of subtrees
  746. @cindex copying, of subtrees
  747. @cindex subtrees, cut and paste
  748. @table @kbd
  749. @kindex M-@key{RET}
  750. @item M-@key{RET}
  751. @vindex org-M-RET-may-split-line
  752. Insert new heading with same level as current. If the cursor is in a
  753. plain list item, a new item is created (@pxref{Plain lists}). To force
  754. creation of a new headline, use a prefix argument, or first press @key{RET}
  755. to get to the beginning of the next line. When this command is used in
  756. the middle of a line, the line is split and the rest of the line becomes
  757. the new headline@footnote{If you do not want the line to be split,
  758. customize the variable @code{org-M-RET-may-split-line}.}. If the
  759. command is used at the beginning of a headline, the new headline is
  760. created before the current line. If at the beginning of any other line,
  761. the content of that line is made the new heading. If the command is
  762. used at the end of a folded subtree (i.e. behind the ellipses at the end
  763. of a headline), then a headline like the current one will be inserted
  764. after the end of the subtree.
  765. @kindex C-@key{RET}
  766. @item C-@key{RET}
  767. Just like @kbd{M-@key{RET}}, except when adding a new heading below the
  768. current heading, the new heading is placed after the body instead of before
  769. it. This command works from anywhere in the entry.
  770. @kindex M-S-@key{RET}
  771. @item M-S-@key{RET}
  772. Insert new TODO entry with same level as current heading.
  773. @kindex C-S-@key{RET}
  774. @item C-S-@key{RET}
  775. Insert new TODO entry with same level as current heading. Like
  776. @kbd{C-@key{RET}}, the new headline will be inserted after the current
  777. subtree.
  778. @kindex M-@key{left}
  779. @item M-@key{left}
  780. Promote current heading by one level.
  781. @kindex M-@key{right}
  782. @item M-@key{right}
  783. Demote current heading by one level.
  784. @kindex M-S-@key{left}
  785. @item M-S-@key{left}
  786. Promote the current subtree by one level.
  787. @kindex M-S-@key{right}
  788. @item M-S-@key{right}
  789. Demote the current subtree by one level.
  790. @kindex M-S-@key{up}
  791. @item M-S-@key{up}
  792. Move subtree up (swap with previous subtree of same
  793. level).
  794. @kindex M-S-@key{down}
  795. @item M-S-@key{down}
  796. Move subtree down (swap with next subtree of same level).
  797. @kindex C-c C-x C-w
  798. @item C-c C-x C-w
  799. Kill subtree, i.e. remove it from buffer but save in kill ring.
  800. With a numeric prefix argument N, kill N sequential subtrees.
  801. @kindex C-c C-x M-w
  802. @item C-c C-x M-w
  803. Copy subtree to kill ring. With a numeric prefix argument N, copy the N
  804. sequential subtrees.
  805. @kindex C-c C-x C-y
  806. @item C-c C-x C-y
  807. Yank subtree from kill ring. This does modify the level of the subtree to
  808. make sure the tree fits in nicely at the yank position. The yank level can
  809. also be specified with a numeric prefix argument, or by yanking after a
  810. headline marker like @samp{****}.
  811. @kindex C-y
  812. @item C-y
  813. @vindex org-yank-adjusted-subtrees
  814. @vindex org-yank-folded-subtrees
  815. Depending on the variables @code{org-yank-adjusted-subtrees} and
  816. @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
  817. paste subtrees folded and in a clever way, using the same command as @kbd{C-c
  818. C-x C-y}. With the default settings, no level adjustment will take place,
  819. but the yanked tree will be folded unless doing so would swallow text
  820. previously visible. Any prefix argument to this command will force a normal
  821. @code{yank} to be executed, with the prefix passed along. A good way to
  822. force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
  823. yank, it will yank previous kill items plainly, without adjustment and
  824. folding.
  825. @kindex C-c C-w
  826. @item C-c C-w
  827. Refile entry or region to a different location. @xref{Refiling notes}.
  828. @kindex C-c ^
  829. @item C-c ^
  830. Sort same-level entries. When there is an active region, all entries in the
  831. region will be sorted. Otherwise the children of the current headline are
  832. sorted. The command prompts for the sorting method, which can be
  833. alphabetically, numerically, by time (using the first time stamp in each
  834. entry), by priority, or by TODO keyword (in the sequence the keywords have
  835. been defined in the setup). Reverse sorting is possible as well. You can
  836. also supply your own function to extract the sorting key. With a @kbd{C-u}
  837. prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes,
  838. duplicate entries will also be removed.
  839. @kindex C-x n s
  840. @item C-x n s
  841. Narrow buffer to current subtree.
  842. @kindex C-x n w
  843. @item C-x n w
  844. Widen buffer to remove a narrowing.
  845. @kindex C-c *
  846. @item C-c *
  847. Turn a normal line or plain list item into a headline (so that it becomes a
  848. subheading at its location). Also turn a headline into a normal line by
  849. removing the stars. If there is an active region, turn all lines in the
  850. region into headlines. If the first line in the region was an item, turn
  851. only the item lines into headlines. Finally, if the first line is a
  852. headline, remove the stars from all headlines in the region.
  853. @end table
  854. @cindex region, active
  855. @cindex active region
  856. @cindex Transient mark mode
  857. When there is an active region (Transient mark mode), promotion and
  858. demotion work on all headlines in the region. To select a region of
  859. headlines, it is best to place both point and mark at the beginning of a
  860. line, mark at the beginning of the first headline, and point at the line
  861. just after the last headline to change. Note that when the cursor is
  862. inside a table (@pxref{Tables}), the Meta-Cursor keys have different
  863. functionality.
  864. @node Archiving, Sparse trees, Structure editing, Document Structure
  865. @section Archiving
  866. @cindex archiving
  867. When a project represented by a (sub)tree is finished, you may want
  868. to move the tree out of the way and to stop it from contributing to the
  869. agenda. Org mode knows two ways of archiving. You can mark a tree with
  870. the ARCHIVE tag, or you can move an entire (sub)tree to a different
  871. location.
  872. @menu
  873. * ARCHIVE tag:: Marking a tree as inactive
  874. * Moving subtrees:: Moving a tree to an archive file
  875. @end menu
  876. @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
  877. @subsection The ARCHIVE tag
  878. @cindex internal archiving
  879. A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
  880. its location in the outline tree, but behaves in the following way:
  881. @itemize @minus
  882. @item
  883. @vindex org-cycle-open-archived-trees
  884. It does not open when you attempt to do so with a visibility cycling
  885. command (@pxref{Visibility cycling}). You can force cycling archived
  886. subtrees with @kbd{C-@key{TAB}}, or by setting the option
  887. @code{org-cycle-open-archived-trees}. Also normal outline commands like
  888. @code{show-all} will open archived subtrees.
  889. @item
  890. @vindex org-sparse-tree-open-archived-trees
  891. During sparse tree construction (@pxref{Sparse trees}), matches in
  892. archived subtrees are not exposed, unless you configure the option
  893. @code{org-sparse-tree-open-archived-trees}.
  894. @item
  895. @vindex org-agenda-skip-archived-trees
  896. During agenda view construction (@pxref{Agenda Views}), the content of
  897. archived trees is ignored unless you configure the option
  898. @code{org-agenda-skip-archived-trees}, in which case these trees will always
  899. be included. In the agenda you can press the @kbd{v} key to get archives
  900. temporarily included.
  901. @item
  902. @vindex org-export-with-archived-trees
  903. Archived trees are not exported (@pxref{Exporting}), only the headline
  904. is. Configure the details using the variable
  905. @code{org-export-with-archived-trees}.
  906. @end itemize
  907. The following commands help managing the ARCHIVE tag:
  908. @table @kbd
  909. @kindex C-c C-x a
  910. @item C-c C-x a
  911. Toggle the ARCHIVE tag for the current headline. When the tag is set,
  912. the headline changes to a shadowed face, and the subtree below it is
  913. hidden.
  914. @kindex C-u C-c C-x a
  915. @item C-u C-c C-x a
  916. Check if any direct children of the current headline should be archived.
  917. To do this, each subtree is checked for open TODO entries. If none are
  918. found, the command offers to set the ARCHIVE tag for the child. If the
  919. cursor is @emph{not} on a headline when this command is invoked, the
  920. level 1 trees will be checked.
  921. @kindex C-@kbd{TAB}
  922. @item C-@kbd{TAB}
  923. Cycle a tree even if it is tagged with ARCHIVE.
  924. @end table
  925. @node Moving subtrees, , ARCHIVE tag, Archiving
  926. @subsection Moving subtrees
  927. @cindex external archiving
  928. Once an entire project is finished, you may want to move it to a different
  929. location. Org can move it to an @emph{Archive Sibling} in the same tree, to a
  930. different tree in the current file, or to a different file, the archive file.
  931. @table @kbd
  932. @kindex C-c C-x A
  933. @item C-c C-x A
  934. Move the current entry to the @emph{Archive Sibling}. This is a sibling of
  935. the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
  936. (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
  937. way retains a lot of its original context, including inherited tags and
  938. approximate position in the outline.
  939. @kindex C-c $
  940. @kindex C-c C-x C-s
  941. @itemx C-c $
  942. @item C-c C-x C-s
  943. @vindex org-archive-location
  944. Archive the subtree starting at the cursor position to the location
  945. given by @code{org-archive-location}. Context information that could be
  946. lost like the file name, the category, inherited tags, and the TODO
  947. state will be store as properties in the entry.
  948. @kindex C-u C-c C-x C-s
  949. @item C-u C-c C-x C-s
  950. Check if any direct children of the current headline could be moved to
  951. the archive. To do this, each subtree is checked for open TODO entries.
  952. If none are found, the command offers to move it to the archive
  953. location. If the cursor is @emph{not} on a headline when this command
  954. is invoked, the level 1 trees will be checked.
  955. @end table
  956. @cindex archive locations
  957. The default archive location is a file in the same directory as the
  958. current file, with the name derived by appending @file{_archive} to the
  959. current file name. For information and examples on how to change this,
  960. see the documentation string of the variable
  961. @code{org-archive-location}. There is also an in-buffer option for
  962. setting this variable, for example@footnote{For backward compatibility,
  963. the following also works: If there are several such lines in a file,
  964. each specifies the archive location for the text below it. The first
  965. such line also applies to any text before its definition. However,
  966. using this method is @emph{strongly} deprecated as it is incompatible
  967. with the outline structure of the document. The correct method for
  968. setting multiple archive locations in a buffer is using properties.}:
  969. @example
  970. #+ARCHIVE: %s_done::
  971. @end example
  972. @noindent
  973. If you would like to have a special ARCHIVE location for a single entry
  974. or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
  975. location as the value (@pxref{Properties and Columns}).
  976. @vindex org-archive-save-context-info
  977. When a subtree is moved, it receives a number of special properties that
  978. record context information like the file from where the entry came, it's
  979. outline path the archiving time etc. Configure the variable
  980. @code{org-archive-save-context-info} to adjust the amount of information
  981. added.
  982. @node Sparse trees, Plain lists, Archiving, Document Structure
  983. @section Sparse trees
  984. @cindex sparse trees
  985. @cindex trees, sparse
  986. @cindex folding, sparse trees
  987. @cindex occur, command
  988. @vindex org-show-hierarchy-above
  989. @vindex org-show-following-heading
  990. @vindex org-show-siblings
  991. @vindex org-show-entry-below
  992. An important feature of Org mode is the ability to construct @emph{sparse
  993. trees} for selected information in an outline tree, so that the entire
  994. document is folded as much as possible, but the selected information is made
  995. visible along with the headline structure above it@footnote{See also the
  996. variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
  997. @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
  998. control on how much context is shown around each match.}. Just try it out
  999. and you will see immediately how it works.
  1000. Org mode contains several commands creating such trees, all these
  1001. commands can be accessed through a dispatcher:
  1002. @table @kbd
  1003. @kindex C-c /
  1004. @item C-c /
  1005. This prompts for an extra key to select a sparse-tree creating command.
  1006. @kindex C-c / r
  1007. @item C-c / r
  1008. @vindex org-remove-highlights-with-change
  1009. Occur. Prompts for a regexp and shows a sparse tree with all matches. If
  1010. the match is in a headline, the headline is made visible. If the match is in
  1011. the body of an entry, headline and body are made visible. In order to
  1012. provide minimal context, also the full hierarchy of headlines above the match
  1013. is shown, as well as the headline following the match. Each match is also
  1014. highlighted; the highlights disappear when the buffer is changed by an
  1015. editing command@footnote{depending on the option
  1016. @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
  1017. When called with a @kbd{C-u} prefix argument, previous highlights are kept,
  1018. so several calls to this command can be stacked.
  1019. @end table
  1020. @noindent
  1021. @vindex org-agenda-custom-commands
  1022. For frequently used sparse trees of specific search strings, you can
  1023. use the variable @code{org-agenda-custom-commands} to define fast
  1024. keyboard access to specific sparse trees. These commands will then be
  1025. accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
  1026. For example:
  1027. @lisp
  1028. (setq org-agenda-custom-commands
  1029. '(("f" occur-tree "FIXME")))
  1030. @end lisp
  1031. @noindent will define the key @kbd{C-c a f} as a shortcut for creating
  1032. a sparse tree matching the string @samp{FIXME}.
  1033. The other sparse tree commands select headings based on TODO keywords,
  1034. tags, or properties and will be discussed later in this manual.
  1035. @kindex C-c C-e v
  1036. @cindex printing sparse trees
  1037. @cindex visible text, printing
  1038. To print a sparse tree, you can use the Emacs command
  1039. @code{ps-print-buffer-with-faces} which does not print invisible parts
  1040. of the document @footnote{This does not work under XEmacs, because
  1041. XEmacs uses selective display for outlining, not text properties.}.
  1042. Or you can use the command @kbd{C-c C-e v} to export only the visible
  1043. part of the document and print the resulting file.
  1044. @node Plain lists, Drawers, Sparse trees, Document Structure
  1045. @section Plain lists
  1046. @cindex plain lists
  1047. @cindex lists, plain
  1048. @cindex lists, ordered
  1049. @cindex ordered lists
  1050. Within an entry of the outline tree, hand-formatted lists can provide
  1051. additional structure. They also provide a way to create lists of
  1052. checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
  1053. and the HTML exporter (@pxref{Exporting}) parses and formats them.
  1054. Org knows ordered lists, unordered lists, and description lists.
  1055. @itemize @bullet
  1056. @item
  1057. @emph{Unordered} list items start with @samp{-}, @samp{+}, or
  1058. @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
  1059. they will be seen as top-level headlines. Also, when you are hiding leading
  1060. stars to get a clean outline view, plain list items starting with a star are
  1061. visually indistinguishable from true headlines. In short: even though
  1062. @samp{*} is supported, it may be better to not use it for plain list items.}
  1063. as bullets.
  1064. @item
  1065. @emph{Ordered} list items start with a numeral followed by either a period or
  1066. a right parenthesis, such as @samp{1.} or @samp{1)}.
  1067. @item
  1068. @emph{Description} list items are like unordered list items, but contain the
  1069. separator @samp{ :: } to separate the description @emph{term} from the
  1070. description.
  1071. @end itemize
  1072. @vindex org-empty-line-terminates-plain-lists
  1073. Items belonging to the same list must have the same indentation on the first
  1074. line. In particular, if an ordered list reaches number @samp{10.}, then the
  1075. 2--digit numbers must be written left-aligned with the other numbers in the
  1076. list. Indentation also determines the end of a list item. It ends before
  1077. the next line that is indented like the bullet/number, or less. Empty lines
  1078. are part of the previous item, so you can have several paragraphs in one
  1079. item. If you would like an empty line to terminate all currently open plain
  1080. lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
  1081. Here is an example:
  1082. @example
  1083. @group
  1084. ** Lord of the Rings
  1085. My favorite scenes are (in this order)
  1086. 1. The attack of the Rohirrim
  1087. 2. Eowyn's fight with the witch king
  1088. + this was already my favorite scene in the book
  1089. + I really like Miranda Otto.
  1090. 3. Peter Jackson being shot by Legolas
  1091. - on DVD only
  1092. He makes a really funny face when it happens.
  1093. But in the end, no individual scenes matter but the film as a whole.
  1094. Important actors in this film are:
  1095. - @b{Elijah Wood} :: He plays Frodo
  1096. - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
  1097. him very well from his role as Mikey Walsh in the Goonies.
  1098. @end group
  1099. @end example
  1100. Org supports these lists by tuning filling and wrapping commands to
  1101. deal with them correctly@footnote{Org only changes the filling
  1102. settings for Emacs. For XEmacs, you should use Kyle E. Jones'
  1103. @file{filladapt.el}. To turn this on, put into @file{.emacs}:
  1104. @code{(require 'filladapt)}}, and by exporting them properly
  1105. (@pxref{Exporting}).
  1106. The following commands act on items when the cursor is in the first line
  1107. of an item (the line with the bullet or number).
  1108. @table @kbd
  1109. @kindex @key{TAB}
  1110. @item @key{TAB}
  1111. @vindex org-cycle-include-plain-lists
  1112. Items can be folded just like headline levels if you set the variable
  1113. @code{org-cycle-include-plain-lists}. The level of an item is then
  1114. given by the indentation of the bullet/number. Items are always
  1115. subordinate to real headlines, however; the hierarchies remain
  1116. completely separated.
  1117. If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
  1118. fixes the indentation of the current line in a heuristic way.
  1119. @kindex M-@key{RET}
  1120. @item M-@key{RET}
  1121. @vindex org-M-RET-may-split-line
  1122. Insert new item at current level. With a prefix argument, force a new
  1123. heading (@pxref{Structure editing}). If this command is used in the middle
  1124. of a line, the line is @emph{split} and the rest of the line becomes the new
  1125. item@footnote{If you do not want the line to be split, customize the variable
  1126. @code{org-M-RET-may-split-line}.}. If this command is executed in the
  1127. @emph{whitespace before a bullet or number}, the new item is created
  1128. @emph{before} the current item. If the command is executed in the white
  1129. space before the text that is part of an item but does not contain the
  1130. bullet, a bullet is added to the current line.
  1131. @kindex M-S-@key{RET}
  1132. @item M-S-@key{RET}
  1133. Insert a new item with a checkbox (@pxref{Checkboxes}).
  1134. @kindex S-@key{up}
  1135. @kindex S-@key{down}
  1136. @item S-@key{up}
  1137. @itemx S-@key{down}
  1138. @cindex shift-selection-mode
  1139. @vindex org-support-shift-select
  1140. Jump to the previous/next item in the current list, but only if
  1141. @code{org-support-shift-select} is off. If not, you can still use paragraph
  1142. jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
  1143. similar effect.
  1144. @kindex M-S-@key{up}
  1145. @kindex M-S-@key{down}
  1146. @item M-S-@key{up}
  1147. @itemx M-S-@key{down}
  1148. Move the item including subitems up/down (swap with previous/next item
  1149. of same indentation). If the list is ordered, renumbering is
  1150. automatic.
  1151. @kindex M-S-@key{left}
  1152. @kindex M-S-@key{right}
  1153. @item M-S-@key{left}
  1154. @itemx M-S-@key{right}
  1155. Decrease/increase the indentation of the item, including subitems.
  1156. Initially, the item tree is selected based on current indentation.
  1157. When these commands are executed several times in direct succession,
  1158. the initially selected region is used, even if the new indentation
  1159. would imply a different hierarchy. To use the new hierarchy, break
  1160. the command chain with a cursor motion or so.
  1161. @kindex C-c C-c
  1162. @item C-c C-c
  1163. If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
  1164. state of the checkbox. If not, this command makes sure that all the
  1165. items on this list level use the same bullet. Furthermore, if this is
  1166. an ordered list, make sure the numbering is OK.
  1167. @kindex C-c -
  1168. @item C-c -
  1169. Cycle the entire list level through the different itemize/enumerate bullets
  1170. (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
  1171. argument N, select the Nth bullet from this list. If there is an active
  1172. region when calling this, all lines will be converted to list items. If the
  1173. first line already was a list item, any item markers will be removed from the
  1174. list. Finally, even without an active region, a normal line will be
  1175. converted into a list item.
  1176. @kindex S-@key{left}
  1177. @kindex S-@key{right}
  1178. @item S-@key{left}/@key{right}
  1179. @vindex org-support-shift-select
  1180. This command also cycles bullet styles when the cursor in on the bullet or
  1181. anywhere in an item line, details depending on
  1182. @code{org-support-shift-select}.
  1183. @end table
  1184. @node Drawers, Footnotes, Plain lists, Document Structure
  1185. @section Drawers
  1186. @cindex drawers
  1187. @cindex visibility cycling, drawers
  1188. @vindex org-drawers
  1189. Sometimes you want to keep information associated with an entry, but you
  1190. normally don't want to see it. For this, Org mode has @emph{drawers}.
  1191. Drawers need to be configured with the variable
  1192. @code{org-drawers}@footnote{You can define drawers on a per-file basis
  1193. with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
  1194. look like this:
  1195. @example
  1196. ** This is a headline
  1197. Still outside the drawer
  1198. :DRAWERNAME:
  1199. This is inside the drawer.
  1200. :END:
  1201. After the drawer.
  1202. @end example
  1203. Visibility cycling (@pxref{Visibility cycling}) on the headline will
  1204. hide and show the entry, but keep the drawer collapsed to a single line.
  1205. In order to look inside the drawer, you need to move the cursor to the
  1206. drawer line and press @key{TAB} there. Org mode uses a drawer for
  1207. storing properties (@pxref{Properties and Columns}), and another one for
  1208. storing clock times (@pxref{Clocking work time}).
  1209. @node Footnotes, Orgstruct mode, Drawers, Document Structure
  1210. @section Footnotes
  1211. @cindex footnotes
  1212. Org-mode supports the creation of footnotes. In contrast to the
  1213. @file{footnote.el} package, Org-mode's footnotes are designed for work on a
  1214. larger document, not only for one-off documents like emails. The basic
  1215. syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
  1216. defined in a paragraph that is started by a footnote marker in square
  1217. brackets in column 0, no indentation allowed. If you need a paragraph break
  1218. inside a footnote, use the LaTeX idiom @samp{\par}. The footnote reference
  1219. is simply the marker in square brackets, inside text. For example:
  1220. @example
  1221. The Org homepage[fn:1] now looks a lot better than it used to.
  1222. ...
  1223. [fn:1] The link is: http://orgmode.org
  1224. @end example
  1225. Org-mode extends the number-based syntax to @emph{named} footnotes and
  1226. optional inline definition. Using plain numbers as markers (as
  1227. @file{footnote.el} does) is supported for backward compatibility, but not
  1228. encouraged because of possible conflicts with LaTeX snippets @pxref{Embedded
  1229. LaTeX}. Here are the valid references:
  1230. @table @code
  1231. @item [1]
  1232. A plain numeric footnote marker.
  1233. @item [fn:name]
  1234. A named footnote reference, where @code{name} is a unique label word, or, for
  1235. simplicity of automatic creation, a number.
  1236. @item [fn:: This is the inline definition of this footnote]
  1237. A LaTeX-like anonymous footnote where the definition is given directly at the
  1238. reference point.
  1239. @item [fn:name: a definition]
  1240. An inline definition of a footnote, which also specifies a name for the note.
  1241. Since Org allows multiple references to the same note, you can then use use
  1242. @code{[fn:name]} to create additional references.
  1243. @end table
  1244. @vindex org-footnote-auto-label
  1245. Footnote labels can be created automatically, or you create names yourself.
  1246. This is handled by the variable @code{org-footnote-auto-label} and its
  1247. corresponding @code{#+STARTUP} keywords, see the docstring of that variable
  1248. for details.
  1249. @noindent The following command handles footnotes:
  1250. @table @kbd
  1251. @kindex C-c C-x f
  1252. @item C-c C-x f
  1253. The footnote action command.
  1254. When the cursor is on a footnote reference, jump to the definition. When it
  1255. is at a definition, jump to the (first) reference.
  1256. @vindex org-footnote-define-inline
  1257. @vindex org-footnote-section
  1258. Otherwise, create a new footnote. Depending on the variable
  1259. @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
  1260. setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
  1261. definition will be placed right into the text as part of the reference, or
  1262. separately into the location determined by the variable
  1263. @code{org-footnote-section}.
  1264. When this command is called with a prefix argument, a menu of additional
  1265. options is offered:
  1266. @example
  1267. s @r{Sort the footnote definitions by reference sequence. During editing,}
  1268. @r{Org makes no effort to sort footnote definitions into a particular}
  1269. @r{sequence. If you want them sorted, use this command, which will}
  1270. @r{also move entries according to @code{org-footnote-section}.}
  1271. n @r{Normalize the footnotes by collecting all definitions (including}
  1272. @r{inline definitions) into a special section, and then numbering them}
  1273. @r{in sequence. The references will then also be numbers. This is}
  1274. @r{meant to be the final step before finishing a document (e.g. sending}
  1275. @r{off an email). The exporters do this automatically, and so could}
  1276. @r{something like @code{message-send-hook}.}
  1277. d @r{Delete the footnote at point, and all definitions of and references}
  1278. @r{to it.}
  1279. @end example
  1280. @kindex C-c C-c
  1281. @item C-c C-c
  1282. If the cursor is on a footnote reference, jump to the definition. If it is a
  1283. the definition, jump back to the reference. When called at a footnote
  1284. location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
  1285. @kindex C-c C-o
  1286. @kindex mouse-1
  1287. @kindex mouse-2
  1288. @item C-c C-c @r{or} mouse-1/2
  1289. Footnote labels are also links to the corresponding definition/reference, and
  1290. you can use the usual commands to follow these links.
  1291. @end table
  1292. @node Orgstruct mode, , Footnotes, Document Structure
  1293. @section The Orgstruct minor mode
  1294. @cindex Orgstruct mode
  1295. @cindex minor mode for structure editing
  1296. If you like the intuitive way the Org mode structure editing and list
  1297. formatting works, you might want to use these commands in other modes
  1298. like Text mode or Mail mode as well. The minor mode Orgstruct mode
  1299. makes this possible. You can always toggle the mode with @kbd{M-x
  1300. orgstruct-mode}. To turn it on by default, for example in Mail mode,
  1301. use
  1302. @lisp
  1303. (add-hook 'mail-mode-hook 'turn-on-orgstruct)
  1304. @end lisp
  1305. When this mode is active and the cursor is on a line that looks to
  1306. Org like a headline of the first line of a list item, most
  1307. structure editing commands will work, even if the same keys normally
  1308. have different functionality in the major mode you are using. If the
  1309. cursor is not in one of those special lines, Orgstruct mode lurks
  1310. silently in the shadow.
  1311. @node Tables, Hyperlinks, Document Structure, Top
  1312. @chapter Tables
  1313. @cindex tables
  1314. @cindex editing tables
  1315. Org comes with a fast and intuitive table editor. Spreadsheet-like
  1316. calculations are supported in connection with the Emacs @file{calc}
  1317. package
  1318. @ifinfo
  1319. (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
  1320. @end ifinfo
  1321. @ifnotinfo
  1322. (see the Emacs Calculator manual for more information about the Emacs
  1323. calculator).
  1324. @end ifnotinfo
  1325. @menu
  1326. * Built-in table editor:: Simple tables
  1327. * Narrow columns:: Stop wasting space in tables
  1328. * Column groups:: Grouping to trigger vertical lines
  1329. * Orgtbl mode:: The table editor as minor mode
  1330. * The spreadsheet:: The table editor has spreadsheet capabilities
  1331. * Org Plot:: Plotting from org tables
  1332. @end menu
  1333. @node Built-in table editor, Narrow columns, Tables, Tables
  1334. @section The built-in table editor
  1335. @cindex table editor, built-in
  1336. Org makes it easy to format tables in plain ASCII. Any line with
  1337. @samp{|} as the first non-whitespace character is considered part of a
  1338. table. @samp{|} is also the column separator. A table might look like
  1339. this:
  1340. @example
  1341. | Name | Phone | Age |
  1342. |-------+-------+-----|
  1343. | Peter | 1234 | 17 |
  1344. | Anna | 4321 | 25 |
  1345. @end example
  1346. A table is re-aligned automatically each time you press @key{TAB} or
  1347. @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
  1348. the next field (@key{RET} to the next row) and creates new table rows
  1349. at the end of the table or before horizontal lines. The indentation
  1350. of the table is set by the first line. Any line starting with
  1351. @samp{|-} is considered as a horizontal separator line and will be
  1352. expanded on the next re-align to span the whole table width. So, to
  1353. create the above table, you would only type
  1354. @example
  1355. |Name|Phone|Age|
  1356. |-
  1357. @end example
  1358. @noindent and then press @key{TAB} to align the table and start filling in
  1359. fields. Even faster would be to type @code{|Name|Phone|Age} followed by
  1360. @kbd{C-c @key{RET}}.
  1361. @vindex org-enable-table-editor
  1362. @vindex org-table-auto-blank-field
  1363. When typing text into a field, Org treats @key{DEL},
  1364. @key{Backspace}, and all character keys in a special way, so that
  1365. inserting and deleting avoids shifting other fields. Also, when
  1366. typing @emph{immediately after the cursor was moved into a new field
  1367. with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
  1368. field is automatically made blank. If this behavior is too
  1369. unpredictable for you, configure the variables
  1370. @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
  1371. @table @kbd
  1372. @tsubheading{Creation and conversion}
  1373. @kindex C-c |
  1374. @item C-c |
  1375. Convert the active region to table. If every line contains at least one
  1376. TAB character, the function assumes that the material is tab separated.
  1377. If every line contains a comma, comma-separated values (CSV) are assumed.
  1378. If not, lines are split at whitespace into fields. You can use a prefix
  1379. argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
  1380. C-u} forces TAB, and a numeric argument N indicates that at least N
  1381. consecutive spaces, or alternatively a TAB will be the separator.
  1382. @*
  1383. If there is no active region, this command creates an empty Org
  1384. table. But it's easier just to start typing, like
  1385. @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
  1386. @tsubheading{Re-aligning and field motion}
  1387. @kindex C-c C-c
  1388. @item C-c C-c
  1389. Re-align the table without moving the cursor.
  1390. @c
  1391. @kindex @key{TAB}
  1392. @item @key{TAB}
  1393. Re-align the table, move to the next field. Creates a new row if
  1394. necessary.
  1395. @c
  1396. @kindex S-@key{TAB}
  1397. @item S-@key{TAB}
  1398. Re-align, move to previous field.
  1399. @c
  1400. @kindex @key{RET}
  1401. @item @key{RET}
  1402. Re-align the table and move down to next row. Creates a new row if
  1403. necessary. At the beginning or end of a line, @key{RET} still does
  1404. NEWLINE, so it can be used to split a table.
  1405. @tsubheading{Column and row editing}
  1406. @kindex M-@key{left}
  1407. @kindex M-@key{right}
  1408. @item M-@key{left}
  1409. @itemx M-@key{right}
  1410. Move the current column left/right.
  1411. @c
  1412. @kindex M-S-@key{left}
  1413. @item M-S-@key{left}
  1414. Kill the current column.
  1415. @c
  1416. @kindex M-S-@key{right}
  1417. @item M-S-@key{right}
  1418. Insert a new column to the left of the cursor position.
  1419. @c
  1420. @kindex M-@key{up}
  1421. @kindex M-@key{down}
  1422. @item M-@key{up}
  1423. @itemx M-@key{down}
  1424. Move the current row up/down.
  1425. @c
  1426. @kindex M-S-@key{up}
  1427. @item M-S-@key{up}
  1428. Kill the current row or horizontal line.
  1429. @c
  1430. @kindex M-S-@key{down}
  1431. @item M-S-@key{down}
  1432. Insert a new row above the current row. With a prefix argument, the line is
  1433. created below the current one.
  1434. @c
  1435. @kindex C-c -
  1436. @item C-c -
  1437. Insert a horizontal line below current row. With a prefix argument, the line
  1438. is created above the current line.
  1439. @c
  1440. @kindex C-c @key{RET}
  1441. @item C-c @key{RET}
  1442. Insert a horizontal line below current row, and move the cursor into the row
  1443. below that line.
  1444. @c
  1445. @kindex C-c ^
  1446. @item C-c ^
  1447. Sort the table lines in the region. The position of point indicates the
  1448. column to be used for sorting, and the range of lines is the range
  1449. between the nearest horizontal separator lines, or the entire table. If
  1450. point is before the first column, you will be prompted for the sorting
  1451. column. If there is an active region, the mark specifies the first line
  1452. and the sorting column, while point should be in the last line to be
  1453. included into the sorting. The command prompts for the sorting type
  1454. (alphabetically, numerically, or by time). When called with a prefix
  1455. argument, alphabetic sorting will be case-sensitive.
  1456. @tsubheading{Regions}
  1457. @kindex C-c C-x M-w
  1458. @item C-c C-x M-w
  1459. Copy a rectangular region from a table to a special clipboard. Point
  1460. and mark determine edge fields of the rectangle. The process ignores
  1461. horizontal separator lines.
  1462. @c
  1463. @kindex C-c C-x C-w
  1464. @item C-c C-x C-w
  1465. Copy a rectangular region from a table to a special clipboard, and
  1466. blank all fields in the rectangle. So this is the ``cut'' operation.
  1467. @c
  1468. @kindex C-c C-x C-y
  1469. @item C-c C-x C-y
  1470. Paste a rectangular region into a table.
  1471. The upper left corner ends up in the current field. All involved fields
  1472. will be overwritten. If the rectangle does not fit into the present table,
  1473. the table is enlarged as needed. The process ignores horizontal separator
  1474. lines.
  1475. @c
  1476. @kindex M-@key{RET}
  1477. @itemx M-@kbd{RET}
  1478. Wrap several fields in a column like a paragraph. If there is an active
  1479. region, and both point and mark are in the same column, the text in the
  1480. column is wrapped to minimum width for the given number of lines. A numeric
  1481. prefix argument may be used to change the number of desired lines. If there
  1482. is no region, the current field is split at the cursor position and the text
  1483. fragment to the right of the cursor is prepended to the field one line
  1484. down. If there is no region, but you specify a prefix argument, the current
  1485. field is made blank, and the content is appended to the field above.
  1486. @tsubheading{Calculations}
  1487. @cindex formula, in tables
  1488. @cindex calculations, in tables
  1489. @cindex region, active
  1490. @cindex active region
  1491. @cindex Transient mark mode
  1492. @kindex C-c +
  1493. @item C-c +
  1494. Sum the numbers in the current column, or in the rectangle defined by
  1495. the active region. The result is shown in the echo area and can
  1496. be inserted with @kbd{C-y}.
  1497. @c
  1498. @kindex S-@key{RET}
  1499. @item S-@key{RET}
  1500. @vindex org-table-copy-increment
  1501. When current field is empty, copy from first non-empty field above. When not
  1502. empty, copy current field down to next row and move cursor along with it.
  1503. Depending on the variable @code{org-table-copy-increment}, integer field
  1504. values will be incremented during copy. Integers that are too large will not
  1505. be incremented. Also, a @code{0} prefix argument temporarily disables the
  1506. increment. This key is also used by CUA mode (@pxref{Cooperation}).
  1507. @tsubheading{Miscellaneous}
  1508. @kindex C-c `
  1509. @item C-c `
  1510. Edit the current field in a separate window. This is useful for fields
  1511. that are not fully visible (@pxref{Narrow columns}). When called with a
  1512. @kbd{C-u} prefix, just make the full field visible, so that it can be
  1513. edited in place.
  1514. @c
  1515. @item M-x org-table-import
  1516. Import a file as a table. The table should be TAB- or whitespace
  1517. separated. Useful, for example, to import a spreadsheet table or data
  1518. from a database, because these programs generally can write
  1519. TAB-separated text files. This command works by inserting the file into
  1520. the buffer and then converting the region to a table. Any prefix
  1521. argument is passed on to the converter, which uses it to determine the
  1522. separator.
  1523. @item C-c |
  1524. Tables can also be imported by pasting tabular text into the Org
  1525. buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
  1526. @kbd{C-c |} command (see above under @i{Creation and conversion}).
  1527. @c
  1528. @item M-x org-table-export
  1529. @vindex org-table-export-default-format
  1530. Export the table, by default as a TAB-separated file. Useful for data
  1531. exchange with, for example, spreadsheet or database programs. The format
  1532. used to export the file can be configured in the variable
  1533. @code{org-table-export-default-format}. You may also use properties
  1534. @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
  1535. name and the format for table export in a subtree. Org supports quite
  1536. general formats for exported tables. The exporter format is the same as the
  1537. format used by Orgtbl radio tables, see @ref{Translator functions} for a
  1538. detailed description.
  1539. @end table
  1540. If you don't like the automatic table editor because it gets in your
  1541. way on lines which you would like to start with @samp{|}, you can turn
  1542. it off with
  1543. @lisp
  1544. (setq org-enable-table-editor nil)
  1545. @end lisp
  1546. @noindent Then the only table command that still works is
  1547. @kbd{C-c C-c} to do a manual re-align.
  1548. @node Narrow columns, Column groups, Built-in table editor, Tables
  1549. @section Narrow columns
  1550. @cindex narrow columns in tables
  1551. The width of columns is automatically determined by the table editor.
  1552. Sometimes a single field or a few fields need to carry more text,
  1553. leading to inconveniently wide columns. To limit@footnote{This feature
  1554. does not work on XEmacs.} the width of a column, one field anywhere in
  1555. the column may contain just the string @samp{<N>} where @samp{N} is an
  1556. integer specifying the width of the column in characters. The next
  1557. re-align will then set the width of this column to no more than this
  1558. value.
  1559. @example
  1560. @group
  1561. |---+------------------------------| |---+--------|
  1562. | | | | | <6> |
  1563. | 1 | one | | 1 | one |
  1564. | 2 | two | ----\ | 2 | two |
  1565. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  1566. | 4 | four | | 4 | four |
  1567. |---+------------------------------| |---+--------|
  1568. @end group
  1569. @end example
  1570. @noindent
  1571. Fields that are wider become clipped and end in the string @samp{=>}.
  1572. Note that the full text is still in the buffer, it is only invisible.
  1573. To see the full text, hold the mouse over the field - a tool-tip window
  1574. will show the full content. To edit such a field, use the command
  1575. @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
  1576. open a new window with the full field. Edit it and finish with @kbd{C-c
  1577. C-c}.
  1578. @vindex org-startup-align-all-tables
  1579. When visiting a file containing a table with narrowed columns, the
  1580. necessary character hiding has not yet happened, and the table needs to
  1581. be aligned before it looks nice. Setting the option
  1582. @code{org-startup-align-all-tables} will realign all tables in a file
  1583. upon visiting, but also slow down startup. You can also set this option
  1584. on a per-file basis with:
  1585. @example
  1586. #+STARTUP: align
  1587. #+STARTUP: noalign
  1588. @end example
  1589. @node Column groups, Orgtbl mode, Narrow columns, Tables
  1590. @section Column groups
  1591. @cindex grouping columns in tables
  1592. When Org exports tables, it does so by default without vertical
  1593. lines because that is visually more satisfying in general. Occasionally
  1594. however, vertical lines can be useful to structure a table into groups
  1595. of columns, much like horizontal lines can do for groups of rows. In
  1596. order to specify column groups, you can use a special row where the
  1597. first field contains only @samp{/}. The further fields can either
  1598. contain @samp{<} to indicate that this column should start a group,
  1599. @samp{>} to indicate the end of a column, or @samp{<>} to make a column
  1600. a group of its own. Boundaries between column groups will upon export be
  1601. marked with vertical lines. Here is an example:
  1602. @example
  1603. | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1604. |---+----+-----+-----+-----+---------+------------|
  1605. | / | <> | < | | > | < | > |
  1606. | # | 1 | 1 | 1 | 1 | 1 | 1 |
  1607. | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
  1608. | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
  1609. |---+----+-----+-----+-----+---------+------------|
  1610. #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
  1611. @end example
  1612. It is also sufficient to just insert the column group starters after
  1613. every vertical line you'd like to have:
  1614. @example
  1615. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1616. |----+-----+-----+-----+---------+------------|
  1617. | / | < | | | < | |
  1618. @end example
  1619. @node Orgtbl mode, The spreadsheet, Column groups, Tables
  1620. @section The Orgtbl minor mode
  1621. @cindex Orgtbl mode
  1622. @cindex minor mode for tables
  1623. If you like the intuitive way the Org table editor works, you
  1624. might also want to use it in other modes like Text mode or Mail mode.
  1625. The minor mode Orgtbl mode makes this possible. You can always toggle
  1626. the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
  1627. example in mail mode, use
  1628. @lisp
  1629. (add-hook 'mail-mode-hook 'turn-on-orgtbl)
  1630. @end lisp
  1631. Furthermore, with some special setup, it is possible to maintain tables
  1632. in arbitrary syntax with Orgtbl mode. For example, it is possible to
  1633. construct La@TeX{} tables with the underlying ease and power of
  1634. Orgtbl mode, including spreadsheet capabilities. For details, see
  1635. @ref{Tables in arbitrary syntax}.
  1636. @node The spreadsheet, Org Plot, Orgtbl mode, Tables
  1637. @section The spreadsheet
  1638. @cindex calculations, in tables
  1639. @cindex spreadsheet capabilities
  1640. @cindex @file{calc} package
  1641. The table editor makes use of the Emacs @file{calc} package to implement
  1642. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  1643. derive fields from other fields. While fully featured, Org's
  1644. implementation is not identical to other spreadsheets. For example,
  1645. Org knows the concept of a @emph{column formula} that will be
  1646. applied to all non-header fields in a column without having to copy the
  1647. formula to each relevant field.
  1648. @menu
  1649. * References:: How to refer to another field or range
  1650. * Formula syntax for Calc:: Using Calc to compute stuff
  1651. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  1652. * Field formulas:: Formulas valid for a single field
  1653. * Column formulas:: Formulas valid for an entire column
  1654. * Editing and debugging formulas:: Fixing formulas
  1655. * Updating the table:: Recomputing all dependent fields
  1656. * Advanced features:: Field names, parameters and automatic recalc
  1657. @end menu
  1658. @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
  1659. @subsection References
  1660. @cindex references
  1661. To compute fields in the table from other fields, formulas must
  1662. reference other fields or ranges. In Org, fields can be referenced
  1663. by name, by absolute coordinates, and by relative coordinates. To find
  1664. out what the coordinates of a field are, press @kbd{C-c ?} in that
  1665. field, or press @kbd{C-c @}} to toggle the display of a grid.
  1666. @subsubheading Field references
  1667. @cindex field references
  1668. @cindex references, to fields
  1669. Formulas can reference the value of another field in two ways. Like in
  1670. any other spreadsheet, you may reference fields with a letter/number
  1671. combination like @code{B3}, meaning the 2nd field in the 3rd row.
  1672. @c Such references are always fixed to that field, they don't change
  1673. @c when you copy and paste a formula to a different field. So
  1674. @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
  1675. @noindent
  1676. Org also uses another, more general operator that looks like this:
  1677. @example
  1678. @@row$column
  1679. @end example
  1680. @noindent
  1681. Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
  1682. or relative to the current column like @samp{+1} or @samp{-2}.
  1683. The row specification only counts data lines and ignores horizontal
  1684. separator lines (hlines). You can use absolute row numbers
  1685. @samp{1}...@samp{N}, and row numbers relative to the current row like
  1686. @samp{+3} or @samp{-1}. Or specify the row relative to one of the
  1687. hlines: @samp{I} refers to the first hline@footnote{Note that only
  1688. hlines are counted that @emph{separate} table lines. If the table
  1689. starts with a hline above the header, it does not count.}, @samp{II} to
  1690. the second etc. @samp{-I} refers to the first such line above the
  1691. current line, @samp{+I} to the first such line below the current line.
  1692. You can also write @samp{III+2} which is the second data line after the
  1693. third hline in the table. Relative row numbers like @samp{-3} will not
  1694. cross hlines if the current line is too close to the hline. Instead,
  1695. the value directly at the hline is used.
  1696. @samp{0} refers to the current row and column. Also, if you omit
  1697. either the column or the row part of the reference, the current
  1698. row/column is implied.
  1699. Org's references with @emph{unsigned} numbers are fixed references
  1700. in the sense that if you use the same reference in the formula for two
  1701. different fields, the same field will be referenced each time.
  1702. Org's references with @emph{signed} numbers are floating
  1703. references because the same reference operator can reference different
  1704. fields depending on the field being calculated by the formula.
  1705. As a special case references like @samp{$LR5} and @samp{$LR12} can be used to
  1706. refer in a stable way to the 5th and 12th field in the last row of the
  1707. table.
  1708. Here are a few examples:
  1709. @example
  1710. @@2$3 @r{2nd row, 3rd column}
  1711. C2 @r{same as previous}
  1712. $5 @r{column 5 in the current row}
  1713. E& @r{same as previous}
  1714. @@2 @r{current column, row 2}
  1715. @@-1$-3 @r{the field one row up, three columns to the left}
  1716. @@-I$2 @r{field just under hline above current row, column 2}
  1717. @end example
  1718. @subsubheading Range references
  1719. @cindex range references
  1720. @cindex references, to ranges
  1721. You may reference a rectangular range of fields by specifying two field
  1722. references connected by two dots @samp{..}. If both fields are in the
  1723. current row, you may simply use @samp{$2..$7}, but if at least one field
  1724. is in a different row, you need to use the general @code{@@row$column}
  1725. format at least for the first field (i.e the reference must start with
  1726. @samp{@@} in order to be interpreted correctly). Examples:
  1727. @example
  1728. $1..$3 @r{First three fields in the current row.}
  1729. $P..$Q @r{Range, using column names (see under Advanced)}
  1730. @@2$1..@@4$3 @r{6 fields between these two fields.}
  1731. A2..C4 @r{Same as above.}
  1732. @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
  1733. @end example
  1734. @noindent Range references return a vector of values that can be fed
  1735. into Calc vector functions. Empty fields in ranges are normally
  1736. suppressed, so that the vector contains only the non-empty fields (but
  1737. see the @samp{E} mode switch below). If there are no non-empty fields,
  1738. @samp{[0]} is returned to avoid syntax errors in formulas.
  1739. @subsubheading Named references
  1740. @cindex named references
  1741. @cindex references, named
  1742. @cindex name, of column or field
  1743. @cindex constants, in calculations
  1744. @vindex org-table-formula-constants
  1745. @samp{$name} is interpreted as the name of a column, parameter or
  1746. constant. Constants are defined globally through the variable
  1747. @code{org-table-formula-constants}, and locally (for the file) through a
  1748. line like
  1749. @example
  1750. #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
  1751. @end example
  1752. @noindent
  1753. @vindex constants-unit-system
  1754. Also properties (@pxref{Properties and Columns}) can be used as
  1755. constants in table formulas: For a property @samp{:Xyz:} use the name
  1756. @samp{$PROP_Xyz}, and the property will be searched in the current
  1757. outline entry and in the hierarchy above it. If you have the
  1758. @file{constants.el} package, it will also be used to resolve constants,
  1759. including natural constants like @samp{$h} for Planck's constant, and
  1760. units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
  1761. supply the values of constants in two different unit systems, @code{SI}
  1762. and @code{cgs}. Which one is used depends on the value of the variable
  1763. @code{constants-unit-system}. You can use the @code{#+STARTUP} options
  1764. @code{constSI} and @code{constcgs} to set this value for the current
  1765. buffer.}. Column names and parameters can be specified in special table
  1766. lines. These are described below, see @ref{Advanced features}. All
  1767. names must start with a letter, and further consist of letters and
  1768. numbers.
  1769. @subsubheading Remote references
  1770. @cindex remote references
  1771. @cindex references, remote
  1772. @cindex references, to a different table
  1773. @cindex name, of column or field
  1774. @cindex constants, in calculations
  1775. You may also reference constants, fields and ranges from a different table,
  1776. either in the current file or even in a different file. The syntax is
  1777. @example
  1778. remote(NAME-OR-ID,REF)
  1779. @end example
  1780. @noindent
  1781. where NAME can be the name of a table in the current file as set by a
  1782. @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
  1783. entry, even in a different file, and the reference then refers to the first
  1784. table in that entry. REF is an absolute field or range reference as
  1785. described above, valid in the referenced table.
  1786. @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
  1787. @subsection Formula syntax for Calc
  1788. @cindex formula syntax, Calc
  1789. @cindex syntax, of formulas
  1790. A formula can be any algebraic expression understood by the Emacs
  1791. @file{Calc} package. @b{Note that @file{calc} has the
  1792. non-standard convention that @samp{/} has lower precedence than
  1793. @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
  1794. evaluation by @code{calc-eval} (@pxref{Calling Calc from
  1795. Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
  1796. Emacs Calc Manual}),
  1797. @c FIXME: The link to the Calc manual in HTML does not work.
  1798. variable substitution takes place according to the rules described above.
  1799. @cindex vectors, in table calculations
  1800. The range vectors can be directly fed into the Calc vector functions
  1801. like @samp{vmean} and @samp{vsum}.
  1802. @cindex format specifier
  1803. @cindex mode, for @file{calc}
  1804. @vindex org-calc-default-modes
  1805. A formula can contain an optional mode string after a semicolon. This
  1806. string consists of flags to influence Calc and other modes during
  1807. execution. By default, Org uses the standard Calc modes (precision
  1808. 12, angular units degrees, fraction and symbolic modes off). The display
  1809. format, however, has been changed to @code{(float 5)} to keep tables
  1810. compact. The default settings can be configured using the variable
  1811. @code{org-calc-default-modes}.
  1812. @example
  1813. p20 @r{switch the internal precision to 20 digits}
  1814. n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
  1815. D R @r{angle modes: degrees, radians}
  1816. F S @r{fraction and symbolic modes}
  1817. N @r{interpret all fields as numbers, use 0 for non-numbers}
  1818. T @r{force text interpretation}
  1819. E @r{keep empty fields in ranges}
  1820. @end example
  1821. @noindent
  1822. In addition, you may provide a @code{printf} format specifier to
  1823. reformat the final result. A few examples:
  1824. @example
  1825. $1+$2 @r{Sum of first and second field}
  1826. $1+$2;%.2f @r{Same, format result to two decimals}
  1827. exp($2)+exp($1) @r{Math functions can be used}
  1828. $0;%.1f @r{Reformat current cell to 1 decimal}
  1829. ($3-32)*5/9 @r{Degrees F -> C conversion}
  1830. $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
  1831. tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
  1832. sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
  1833. vmean($2..$7) @r{Compute column range mean, using vector function}
  1834. vmean($2..$7);EN @r{Same, but treat empty fields as 0}
  1835. taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
  1836. @end example
  1837. Calc also contains a complete set of logical operations. For example
  1838. @example
  1839. if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
  1840. @end example
  1841. @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
  1842. @subsection Emacs Lisp forms as formulas
  1843. @cindex Lisp forms, as table formulas
  1844. It is also possible to write a formula in Emacs Lisp; this can be useful
  1845. for string manipulation and control structures, if Calc's
  1846. functionality is not enough. If a formula starts with a single quote
  1847. followed by an opening parenthesis, then it is evaluated as a lisp form.
  1848. The evaluation should return either a string or a number. Just as with
  1849. @file{calc} formulas, you can specify modes and a printf format after a
  1850. semicolon. With Emacs Lisp forms, you need to be conscious about the way
  1851. field references are interpolated into the form. By default, a
  1852. reference will be interpolated as a Lisp string (in double quotes)
  1853. containing the field. If you provide the @samp{N} mode switch, all
  1854. referenced elements will be numbers (non-number fields will be zero) and
  1855. interpolated as Lisp numbers, without quotes. If you provide the
  1856. @samp{L} flag, all fields will be interpolated literally, without quotes.
  1857. I.e., if you want a reference to be interpreted as a string by the Lisp
  1858. form, enclose the reference operator itself in double quotes, like
  1859. @code{"$3"}. Ranges are inserted as space-separated fields, so you can
  1860. embed them in list or vector syntax. A few examples, note how the
  1861. @samp{N} mode is used when we do computations in lisp.
  1862. @example
  1863. @r{Swap the first two characters of the content of column 1}
  1864. '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
  1865. @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
  1866. '(+ $1 $2);N
  1867. @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
  1868. '(apply '+ '($1..$4));N
  1869. @end example
  1870. @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
  1871. @subsection Field formulas
  1872. @cindex field formula
  1873. @cindex formula, for individual table field
  1874. To assign a formula to a particular field, type it directly into the
  1875. field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
  1876. press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
  1877. the field, the formula will be stored as the formula for this field,
  1878. evaluated, and the current field replaced with the result.
  1879. Formulas are stored in a special line starting with @samp{#+TBLFM:}
  1880. directly below the table. If you typed the equation in the 4th field of
  1881. the 3rd data line in the table, the formula will look like
  1882. @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
  1883. with the appropriate commands, @i{absolute references} (but not relative
  1884. ones) in stored formulas are modified in order to still reference the
  1885. same field. Of cause this is not true if you edit the table structure
  1886. with normal editing commands - then you must fix the equations yourself.
  1887. The left hand side of a formula may also be a named field (@pxref{Advanced
  1888. features}), or a last-row reference like @samp{$LR3}.
  1889. Instead of typing an equation into the field, you may also use the
  1890. following command
  1891. @table @kbd
  1892. @kindex C-u C-c =
  1893. @item C-u C-c =
  1894. Install a new formula for the current field. The command prompts for a
  1895. formula, with default taken from the @samp{#+TBLFM:} line, applies
  1896. it to the current field and stores it.
  1897. @end table
  1898. @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
  1899. @subsection Column formulas
  1900. @cindex column formula
  1901. @cindex formula, for table column
  1902. Often in a table, the same formula should be used for all fields in a
  1903. particular column. Instead of having to copy the formula to all fields
  1904. in that column, Org allows to assign a single formula to an entire
  1905. column. If the table contains horizontal separator hlines, everything
  1906. before the first such line is considered part of the table @emph{header}
  1907. and will not be modified by column formulas.
  1908. To assign a formula to a column, type it directly into any field in the
  1909. column, preceded by an equal sign, like @samp{=$1+$2}. When you press
  1910. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
  1911. the formula will be stored as the formula for the current column, evaluated
  1912. and the current field replaced with the result. If the field contains only
  1913. @samp{=}, the previously stored formula for this column is used. For each
  1914. column, Org will only remember the most recently used formula. In the
  1915. @samp{TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left
  1916. hand side of a column formula can currently not be the name of column, it
  1917. must be the numeric column reference.
  1918. Instead of typing an equation into the field, you may also use the
  1919. following command:
  1920. @table @kbd
  1921. @kindex C-c =
  1922. @item C-c =
  1923. Install a new formula for the current column and replace current field with
  1924. the result of the formula. The command prompts for a formula, with default
  1925. taken from the @samp{#+TBLFM} line, applies it to the current field and
  1926. stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
  1927. will apply it to that many consecutive fields in the current column.
  1928. @end table
  1929. @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
  1930. @subsection Editing and debugging formulas
  1931. @cindex formula editing
  1932. @cindex editing, of table formulas
  1933. @vindex org-table-use-standard-references
  1934. You can edit individual formulas in the minibuffer or directly in the
  1935. field. Org can also prepare a special buffer with all active
  1936. formulas of a table. When offering a formula for editing, Org
  1937. converts references to the standard format (like @code{B3} or @code{D&})
  1938. if possible. If you prefer to only work with the internal format (like
  1939. @code{@@3$2} or @code{$4}), configure the variable
  1940. @code{org-table-use-standard-references}.
  1941. @table @kbd
  1942. @kindex C-c =
  1943. @kindex C-u C-c =
  1944. @item C-c =
  1945. @itemx C-u C-c =
  1946. Edit the formula associated with the current column/field in the
  1947. minibuffer. See @ref{Column formulas} and @ref{Field formulas}.
  1948. @kindex C-u C-u C-c =
  1949. @item C-u C-u C-c =
  1950. Re-insert the active formula (either a
  1951. field formula, or a column formula) into the current field, so that you
  1952. can edit it directly in the field. The advantage over editing in the
  1953. minibuffer is that you can use the command @kbd{C-c ?}.
  1954. @kindex C-c ?
  1955. @item C-c ?
  1956. While editing a formula in a table field, highlight the field(s)
  1957. referenced by the reference at the cursor position in the formula.
  1958. @kindex C-c @}
  1959. @item C-c @}
  1960. Toggle the display of row and column numbers for a table, using
  1961. overlays. These are updated each time the table is aligned, you can
  1962. force it with @kbd{C-c C-c}.
  1963. @kindex C-c @{
  1964. @item C-c @{
  1965. Toggle the formula debugger on and off. See below.
  1966. @kindex C-c '
  1967. @item C-c '
  1968. Edit all formulas for the current table in a special buffer, where the
  1969. formulas will be displayed one per line. If the current field has an
  1970. active formula, the cursor in the formula editor will mark it.
  1971. While inside the special buffer, Org will automatically highlight
  1972. any field or range reference at the cursor position. You may edit,
  1973. remove and add formulas, and use the following commands:
  1974. @table @kbd
  1975. @kindex C-c C-c
  1976. @kindex C-x C-s
  1977. @item C-c C-c
  1978. @itemx C-x C-s
  1979. Exit the formula editor and store the modified formulas. With @kbd{C-u}
  1980. prefix, also apply the new formulas to the entire table.
  1981. @kindex C-c C-q
  1982. @item C-c C-q
  1983. Exit the formula editor without installing changes.
  1984. @kindex C-c C-r
  1985. @item C-c C-r
  1986. Toggle all references in the formula editor between standard (like
  1987. @code{B3}) and internal (like @code{@@3$2}).
  1988. @kindex @key{TAB}
  1989. @item @key{TAB}
  1990. Pretty-print or indent lisp formula at point. When in a line containing
  1991. a lisp formula, format the formula according to Emacs Lisp rules.
  1992. Another @key{TAB} collapses the formula back again. In the open
  1993. formula, @key{TAB} re-indents just like in Emacs lisp mode.
  1994. @kindex M-@key{TAB}
  1995. @item M-@key{TAB}
  1996. Complete Lisp symbols, just like in Emacs lisp mode.
  1997. @kindex S-@key{up}
  1998. @kindex S-@key{down}
  1999. @kindex S-@key{left}
  2000. @kindex S-@key{right}
  2001. @item S-@key{up}/@key{down}/@key{left}/@key{right}
  2002. Shift the reference at point. For example, if the reference is
  2003. @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
  2004. This also works for relative references, and for hline references.
  2005. @kindex M-S-@key{up}
  2006. @kindex M-S-@key{down}
  2007. @item M-S-@key{up}/@key{down}
  2008. Move the test line for column formulas in the Org buffer up and
  2009. down.
  2010. @kindex M-@key{up}
  2011. @kindex M-@key{down}
  2012. @item M-@key{up}/@key{down}
  2013. Scroll the window displaying the table.
  2014. @kindex C-c @}
  2015. @item C-c @}
  2016. Turn the coordinate grid in the table on and off.
  2017. @end table
  2018. @end table
  2019. Making a table field blank does not remove the formula associated with
  2020. the field, because that is stored in a different line (the @samp{TBLFM}
  2021. line) - during the next recalculation the field will be filled again.
  2022. To remove a formula from a field, you have to give an empty reply when
  2023. prompted for the formula, or to edit the @samp{#+TBLFM} line.
  2024. @kindex C-c C-c
  2025. You may edit the @samp{#+TBLFM} directly and re-apply the changed
  2026. equations with @kbd{C-c C-c} in that line, or with the normal
  2027. recalculation commands in the table.
  2028. @subsubheading Debugging formulas
  2029. @cindex formula debugging
  2030. @cindex debugging, of table formulas
  2031. When the evaluation of a formula leads to an error, the field content
  2032. becomes the string @samp{#ERROR}. If you would like see what is going
  2033. on during variable substitution and calculation in order to find a bug,
  2034. turn on formula debugging in the @code{Tbl} menu and repeat the
  2035. calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
  2036. field. Detailed information will be displayed.
  2037. @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
  2038. @subsection Updating the table
  2039. @cindex recomputing table fields
  2040. @cindex updating, table
  2041. Recalculation of a table is normally not automatic, but needs to be
  2042. triggered by a command. See @ref{Advanced features} for a way to make
  2043. recalculation at least semi-automatically.
  2044. In order to recalculate a line of a table or the entire table, use the
  2045. following commands:
  2046. @table @kbd
  2047. @kindex C-c *
  2048. @item C-c *
  2049. Recalculate the current row by first applying the stored column formulas
  2050. from left to right, and all field formulas in the current row.
  2051. @c
  2052. @kindex C-u C-c *
  2053. @item C-u C-c *
  2054. @kindex C-u C-c C-c
  2055. @itemx C-u C-c C-c
  2056. Recompute the entire table, line by line. Any lines before the first
  2057. hline are left alone, assuming that these are part of the table header.
  2058. @c
  2059. @kindex C-u C-u C-c *
  2060. @kindex C-u C-u C-c C-c
  2061. @item C-u C-u C-c *
  2062. @itemx C-u C-u C-c C-c
  2063. Iterate the table by recomputing it until no further changes occur.
  2064. This may be necessary if some computed fields use the value of other
  2065. fields that are computed @i{later} in the calculation sequence.
  2066. @end table
  2067. @node Advanced features, , Updating the table, The spreadsheet
  2068. @subsection Advanced features
  2069. If you want the recalculation of fields to happen automatically, or if
  2070. you want to be able to assign @i{names} to fields and columns, you need
  2071. to reserve the first column of the table for special marking characters.
  2072. @table @kbd
  2073. @kindex C-#
  2074. @item C-#
  2075. Rotate the calculation mark in first column through the states @samp{},
  2076. @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
  2077. change all marks in the region.
  2078. @end table
  2079. Here is an example of a table that collects exam results of students and
  2080. makes use of these features:
  2081. @example
  2082. @group
  2083. |---+---------+--------+--------+--------+-------+------|
  2084. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  2085. |---+---------+--------+--------+--------+-------+------|
  2086. | ! | | P1 | P2 | P3 | Tot | |
  2087. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  2088. | ^ | | m1 | m2 | m3 | mt | |
  2089. |---+---------+--------+--------+--------+-------+------|
  2090. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  2091. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  2092. |---+---------+--------+--------+--------+-------+------|
  2093. | | Average | | | | 29.7 | |
  2094. | ^ | | | | | at | |
  2095. | $ | max=50 | | | | | |
  2096. |---+---------+--------+--------+--------+-------+------|
  2097. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
  2098. @end group
  2099. @end example
  2100. @noindent @b{Important}: Please note that for these special tables,
  2101. recalculating the table with @kbd{C-u C-c *} will only affect rows that
  2102. are marked @samp{#} or @samp{*}, and fields that have a formula assigned
  2103. to the field itself. The column formulas are not applied in rows with
  2104. empty first field.
  2105. @cindex marking characters, tables
  2106. The marking characters have the following meaning:
  2107. @table @samp
  2108. @item !
  2109. The fields in this line define names for the columns, so that you may
  2110. refer to a column as @samp{$Tot} instead of @samp{$6}.
  2111. @item ^
  2112. This row defines names for the fields @emph{above} the row. With such
  2113. a definition, any formula in the table may use @samp{$m1} to refer to
  2114. the value @samp{10}. Also, if you assign a formula to a names field, it
  2115. will be stored as @samp{$name=...}.
  2116. @item _
  2117. Similar to @samp{^}, but defines names for the fields in the row
  2118. @emph{below}.
  2119. @item $
  2120. Fields in this row can define @emph{parameters} for formulas. For
  2121. example, if a field in a @samp{$} row contains @samp{max=50}, then
  2122. formulas in this table can refer to the value 50 using @samp{$max}.
  2123. Parameters work exactly like constants, only that they can be defined on
  2124. a per-table basis.
  2125. @item #
  2126. Fields in this row are automatically recalculated when pressing
  2127. @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
  2128. is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
  2129. lines will be left alone by this command.
  2130. @item *
  2131. Selects this line for global recalculation with @kbd{C-u C-c *}, but
  2132. not for automatic recalculation. Use this when automatic
  2133. recalculation slows down editing too much.
  2134. @item
  2135. Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
  2136. All lines that should be recalculated should be marked with @samp{#}
  2137. or @samp{*}.
  2138. @item /
  2139. Do not export this line. Useful for lines that contain the narrowing
  2140. @samp{<N>} markers.
  2141. @end table
  2142. Finally, just to whet your appetite on what can be done with the
  2143. fantastic @file{calc} package, here is a table that computes the Taylor
  2144. series of degree @code{n} at location @code{x} for a couple of
  2145. functions.
  2146. @example
  2147. @group
  2148. |---+-------------+---+-----+--------------------------------------|
  2149. | | Func | n | x | Result |
  2150. |---+-------------+---+-----+--------------------------------------|
  2151. | # | exp(x) | 1 | x | 1 + x |
  2152. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  2153. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  2154. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  2155. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  2156. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  2157. |---+-------------+---+-----+--------------------------------------|
  2158. #+TBLFM: $5=taylor($2,$4,$3);n3
  2159. @end group
  2160. @end example
  2161. @page
  2162. @node Org Plot, , The spreadsheet, Tables
  2163. @section Org Plot
  2164. @cindex graph, in tables
  2165. @cindex plot tables using gnuplot
  2166. Org Plot can produce 2D and 3D graphs of information stored in org tables
  2167. using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
  2168. @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
  2169. this in action ensure that you have both Gnuplot and Gnuplot-mode installed
  2170. on your system, then call @code{org-plot/gnuplot} on the following table.
  2171. @example
  2172. @group
  2173. #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
  2174. | Sede | Max cites | H-index |
  2175. |-----------+-----------+---------|
  2176. | Chile | 257.72 | 21.39 |
  2177. | Leeds | 165.77 | 19.68 |
  2178. | Sao Paolo | 71.00 | 11.50 |
  2179. | Stockholm | 134.19 | 14.33 |
  2180. | Morelia | 257.56 | 17.67 |
  2181. @end group
  2182. @end example
  2183. Notice that Org Plot is smart enough to apply the tables headers as labels.
  2184. Further control over the labels, type, content, and appearance of plots can
  2185. be exercised through the @code{#+Plot:} lines preceding a table. See below
  2186. for a complete list of Org plot options. For more information and examples
  2187. see the org-plot tutorial at
  2188. @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
  2189. @subsubheading Plot Options
  2190. @table @code
  2191. @item set
  2192. Specify any @file{gnuplot} option to be set when graphing.
  2193. @item title
  2194. Specify the title of the plot.
  2195. @item ind
  2196. Specify which column of the table to use as the @code{x} axis.
  2197. @item deps
  2198. Specify the columns to graph as a lisp style list, surrounded by parenthesis
  2199. and separated by spaces for example @code{dep:(3 4)} to graph the third and
  2200. fourth columns (defaults to graphing all other columns aside from the ind
  2201. column).
  2202. @item type
  2203. Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
  2204. @item with
  2205. Specify a @code{with} option to be inserted for every col being plotted
  2206. (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
  2207. Defaults to 'lines'.
  2208. @item file
  2209. If you want to plot to a file specify the @code{"path/to/desired/output-file"}.
  2210. @item labels
  2211. List of labels to be used for the deps (defaults to column headers if they
  2212. exist).
  2213. @item line
  2214. Specify an entire line to be inserted in the gnuplot script.
  2215. @item map
  2216. When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
  2217. flat mapping rather than a @code{3d} slope.
  2218. @item timefmt
  2219. Specify format of org-mode timestamps as they will be parsed by gnuplot.
  2220. Defaults to '%Y-%m-%d-%H:%M:%S'.
  2221. @item script
  2222. If you want total control you can specify a script file (place the file name
  2223. between double quotes) which will be used to plot. Before plotting, every
  2224. instance of @code{$datafile} in the specified script will be replaced with
  2225. the path to the generated data file. Note even if you set this option you
  2226. may still want to specify the plot type, as that can impact the content of
  2227. the data file.
  2228. @end table
  2229. @node Hyperlinks, TODO Items, Tables, Top
  2230. @chapter Hyperlinks
  2231. @cindex hyperlinks
  2232. Like HTML, Org provides links inside a file, external links to
  2233. other files, Usenet articles, emails, and much more.
  2234. @menu
  2235. * Link format:: How links in Org are formatted
  2236. * Internal links:: Links to other places in the current file
  2237. * External links:: URL-like links to the world
  2238. * Handling links:: Creating, inserting and following
  2239. * Using links outside Org:: Linking from my C source code?
  2240. * Link abbreviations:: Shortcuts for writing complex links
  2241. * Search options:: Linking to a specific location
  2242. * Custom searches:: When the default search is not enough
  2243. @end menu
  2244. @node Link format, Internal links, Hyperlinks, Hyperlinks
  2245. @section Link format
  2246. @cindex link format
  2247. @cindex format, of links
  2248. Org will recognize plain URL-like links and activate them as
  2249. clickable links. The general link format, however, looks like this:
  2250. @example
  2251. [[link][description]] @r{or alternatively} [[link]]
  2252. @end example
  2253. Once a link in the buffer is complete (all brackets present), Org
  2254. will change the display so that @samp{description} is displayed instead
  2255. of @samp{[[link][description]]} and @samp{link} is displayed instead of
  2256. @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
  2257. which by default is an underlined face. You can directly edit the
  2258. visible part of a link. Note that this can be either the @samp{link}
  2259. part (if there is no description) or the @samp{description} part. To
  2260. edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
  2261. cursor on the link.
  2262. If you place the cursor at the beginning or just behind the end of the
  2263. displayed text and press @key{BACKSPACE}, you will remove the
  2264. (invisible) bracket at that location. This makes the link incomplete
  2265. and the internals are again displayed as plain text. Inserting the
  2266. missing bracket hides the link internals again. To show the
  2267. internal structure of all links, use the menu entry
  2268. @code{Org->Hyperlinks->Literal links}.
  2269. @node Internal links, External links, Link format, Hyperlinks
  2270. @section Internal links
  2271. @cindex internal links
  2272. @cindex links, internal
  2273. @cindex targets, for links
  2274. If the link does not look like a URL, it is considered to be internal in
  2275. the current file. Links such as @samp{[[My Target]]} or @samp{[[My
  2276. Target][Find my target]]} lead to a text search in the current file.
  2277. The link can be followed with @kbd{C-c C-o} when the cursor is on the
  2278. link, or with a mouse click (@pxref{Handling links}). The preferred
  2279. match for such a link is a dedicated target: the same string in double
  2280. angular brackets. Targets may be located anywhere; sometimes it is
  2281. convenient to put them into a comment line. For example
  2282. @example
  2283. # <<My Target>>
  2284. @end example
  2285. @noindent In HTML export (@pxref{HTML export}), such targets will become
  2286. named anchors for direct access through @samp{http} links@footnote{Note that
  2287. text before the first headline is usually not exported, so the first such
  2288. target should be after the first headline, or in the line directly before the
  2289. first headline.}.
  2290. If no dedicated target exists, Org will search for the words in the
  2291. link. In the above example the search would be for @samp{my target}.
  2292. Links starting with a star like @samp{*My Target} restrict the search to
  2293. headlines. When searching, Org mode will first try an exact match, but
  2294. then move on to more and more lenient searches. For example, the link
  2295. @samp{[[*My Targets]]} will find any of the following:
  2296. @example
  2297. ** My targets
  2298. ** TODO my targets are bright
  2299. ** my 20 targets are
  2300. @end example
  2301. To insert a link targeting a headline, in-buffer completion can be used.
  2302. Just type a star followed by a few optional letters into the buffer and
  2303. press @kbd{M-@key{TAB}}. All headlines in the current buffer will be
  2304. offered as completions. @xref{Handling links}, for more commands
  2305. creating links.
  2306. Following a link pushes a mark onto Org's own mark ring. You can
  2307. return to the previous position with @kbd{C-c &}. Using this command
  2308. several times in direct succession goes back to positions recorded
  2309. earlier.
  2310. @menu
  2311. * Radio targets:: Make targets trigger links in plain text
  2312. @end menu
  2313. @node Radio targets, , Internal links, Internal links
  2314. @subsection Radio targets
  2315. @cindex radio targets
  2316. @cindex targets, radio
  2317. @cindex links, radio targets
  2318. Org can automatically turn any occurrences of certain target names
  2319. in normal text into a link. So without explicitly creating a link, the
  2320. text connects to the target radioing its position. Radio targets are
  2321. enclosed by triple angular brackets. For example, a target @samp{<<<My
  2322. Target>>>} causes each occurrence of @samp{my target} in normal text to
  2323. become activated as a link. The Org file is scanned automatically
  2324. for radio targets only when the file is first loaded into Emacs. To
  2325. update the target list during editing, press @kbd{C-c C-c} with the
  2326. cursor on or at a target.
  2327. @node External links, Handling links, Internal links, Hyperlinks
  2328. @section External links
  2329. @cindex links, external
  2330. @cindex external links
  2331. @cindex links, external
  2332. @cindex Gnus links
  2333. @cindex BBDB links
  2334. @cindex IRC links
  2335. @cindex URL links
  2336. @cindex file links
  2337. @cindex VM links
  2338. @cindex RMAIL links
  2339. @cindex WANDERLUST links
  2340. @cindex MH-E links
  2341. @cindex USENET links
  2342. @cindex SHELL links
  2343. @cindex Info links
  2344. @cindex elisp links
  2345. Org supports links to files, websites, Usenet and email messages,
  2346. BBDB database entries and links to both IRC conversations and their
  2347. logs. External links are URL-like locators. They start with a short
  2348. identifying string followed by a colon. There can be no space after
  2349. the colon. The following list shows examples for each link type.
  2350. @example
  2351. http://www.astro.uva.nl/~dominik @r{on the web}
  2352. file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
  2353. /home/dominik/images/jupiter.jpg @r{same as above}
  2354. file:papers/last.pdf @r{file, relative path}
  2355. ./papers/last.pdf @r{same as above}
  2356. file:projects.org @r{another org file}
  2357. file:projects.org::some words @r{text search in org file}
  2358. file:projects.org::*task title @r{heading search in org file}
  2359. id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
  2360. news:comp.emacs @r{Usenet link}
  2361. mailto:adent@@galaxy.net @r{Mail link}
  2362. vm:folder @r{VM folder link}
  2363. vm:folder#id @r{VM message link}
  2364. vm://myself@@some.where.org/folder#id @r{VM on remote machine}
  2365. wl:folder @r{WANDERLUST folder link}
  2366. wl:folder#id @r{WANDERLUST message link}
  2367. mhe:folder @r{MH-E folder link}
  2368. mhe:folder#id @r{MH-E message link}
  2369. rmail:folder @r{RMAIL folder link}
  2370. rmail:folder#id @r{RMAIL message link}
  2371. gnus:group @r{Gnus group link}
  2372. gnus:group#id @r{Gnus article link}
  2373. bbdb:R.*Stallman @r{BBDB link (with regexp)}
  2374. irc:/irc.com/#emacs/bob @r{IRC link}
  2375. shell:ls *.org @r{A shell command}
  2376. elisp:org-agenda @r{Interactive elisp command}
  2377. elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
  2378. @end example
  2379. A link should be enclosed in double brackets and may contain a
  2380. descriptive text to be displayed instead of the URL (@pxref{Link
  2381. format}), for example:
  2382. @example
  2383. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  2384. @end example
  2385. @noindent
  2386. If the description is a file name or URL that points to an image, HTML
  2387. export (@pxref{HTML export}) will inline the image as a clickable
  2388. button. If there is no description at all and the link points to an
  2389. image,
  2390. that image will be inlined into the exported HTML file.
  2391. @cindex angular brackets, around links
  2392. @cindex plain text external links
  2393. Org also finds external links in the normal text and activates them
  2394. as links. If spaces must be part of the link (for example in
  2395. @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
  2396. about the end of the link, enclose them in angular brackets.
  2397. @node Handling links, Using links outside Org, External links, Hyperlinks
  2398. @section Handling links
  2399. @cindex links, handling
  2400. Org provides methods to create a link in the correct syntax, to
  2401. insert it into an Org file, and to follow the link.
  2402. @table @kbd
  2403. @kindex C-c l
  2404. @cindex storing links
  2405. @item C-c l
  2406. Store a link to the current location. This is a @emph{global} command (you
  2407. must create the key binding yourself) which can be used in any buffer to
  2408. create a link. The link will be stored for later insertion into an Org
  2409. buffer (see below).
  2410. @vindex org-link-to-org-use-id
  2411. For Org files, if there is a @samp{<<target>>} at the cursor, the link points
  2412. to the target. Otherwise it points to the current headline, either by text
  2413. (unsafe), or, if @file{org-id.el} is loaded and @code{org-link-to-org-use-id}
  2414. is set, by ID property.
  2415. @vindex org-irc-link-to-logs
  2416. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the link will
  2417. indicate the current article/entry. For W3 and W3M buffers, the link goes to
  2418. the current URL. For IRC links, if you set the variable
  2419. @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a
  2420. @samp{file:/} style link to the relevant point in the logs for the current
  2421. conversation. Otherwise an @samp{irc:/} style link to the user/channel/server
  2422. under the point will be stored.
  2423. For any other files, the link will point to the file, with a search string
  2424. (@pxref{Search options}) pointing to the contents of the current line. If
  2425. there is an active region, the selected words will form the basis of the
  2426. search string. If the automatically created link is not working correctly or
  2427. accurately enough, you can write custom functions to select the search string
  2428. and to do the search for particular file types - see @ref{Custom searches}.
  2429. The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}.
  2430. @c
  2431. @kindex C-c C-l
  2432. @cindex link completion
  2433. @cindex completion, of links
  2434. @cindex inserting links
  2435. @item C-c C-l
  2436. @vindex org-keep-stored-link-after-insertion
  2437. Insert a link. This prompts for a link to be inserted into the buffer. You
  2438. can just type a link, using text for an internal link, or one of the link
  2439. type prefixes mentioned in the examples above. All links stored during the
  2440. current session are part of the history for this prompt, so you can access
  2441. them with @key{up} and @key{down} (or @kbd{M-p/n}). Completion, on the other
  2442. hand, will help you to insert valid link prefixes like @samp{http:} or
  2443. @samp{ftp:}, including the prefixes defined through link abbreviations
  2444. (@pxref{Link abbreviations}). The link will be inserted into the
  2445. buffer@footnote{After insertion of a stored link, the link will be removed
  2446. from the list of stored links. To keep it in the list later use, use a
  2447. triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
  2448. @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
  2449. If some text was selected when this command is called, the selected text
  2450. becomes the default description.@* Note that you don't have to use this
  2451. command to insert a link. Links in Org are plain text, and you can type
  2452. or paste them straight into the buffer. By using this command, the links are
  2453. automatically enclosed in double brackets, and you will be asked for the
  2454. optional descriptive text.
  2455. @c
  2456. @c If the link is a @samp{file:} link and
  2457. @c the linked file is located in the same directory as the current file or
  2458. @c a subdirectory of it, the path of the file will be inserted relative to
  2459. @c the current directory.
  2460. @c
  2461. @kindex C-u C-c C-l
  2462. @cindex file name completion
  2463. @cindex completion, of file names
  2464. @item C-u C-c C-l
  2465. When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
  2466. a file will be inserted and you may use file name completion to select
  2467. the name of the file. The path to the file is inserted relative to the
  2468. directory of the current org file, if the linked file is in the current
  2469. directory or in a sub-directory of it, or if the path is written relative
  2470. to the current directory using @samp{../}. Otherwise an absolute path
  2471. is used, if possible with @samp{~/} for your home directory. You can
  2472. force an absolute path with two @kbd{C-u} prefixes.
  2473. @c
  2474. @item C-c C-l @r{(with cursor on existing link)}
  2475. When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
  2476. link and description parts of the link.
  2477. @c
  2478. @cindex following links
  2479. @kindex C-c C-o
  2480. @kindex RET
  2481. @item C-c C-o @r{or} @key{RET}
  2482. @vindex org-file-apps
  2483. Open link at point. This will launch a web browser for URLs (using
  2484. @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
  2485. the corresponding links, and execute the command in a shell link. When the
  2486. cursor is on an internal link, this commands runs the corresponding search.
  2487. When the cursor is on a TAG list in a headline, it creates the corresponding
  2488. TAGS view. If the cursor is on a time stamp, it compiles the agenda for that
  2489. date. Furthermore, it will visit text and remote files in @samp{file:} links
  2490. with Emacs and select a suitable application for local non-text files.
  2491. Classification of files is based on file extension only. See option
  2492. @code{org-file-apps}. If you want to override the default application and
  2493. visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
  2494. opening in Emacs, use a @kbd{C-u C-u} prefix.
  2495. @c
  2496. @kindex mouse-2
  2497. @kindex mouse-1
  2498. @item mouse-2
  2499. @itemx mouse-1
  2500. On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
  2501. would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
  2502. @c
  2503. @kindex mouse-3
  2504. @item mouse-3
  2505. @vindex org-display-internal-link-with-indirect-buffer
  2506. Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
  2507. internal links to be displayed in another window@footnote{See the
  2508. variable @code{org-display-internal-link-with-indirect-buffer}}.
  2509. @c
  2510. @cindex mark ring
  2511. @kindex C-c %
  2512. @item C-c %
  2513. Push the current position onto the mark ring, to be able to return
  2514. easily. Commands following an internal link do this automatically.
  2515. @c
  2516. @cindex links, returning to
  2517. @kindex C-c &
  2518. @item C-c &
  2519. Jump back to a recorded position. A position is recorded by the
  2520. commands following internal links, and by @kbd{C-c %}. Using this
  2521. command several times in direct succession moves through a ring of
  2522. previously recorded positions.
  2523. @c
  2524. @kindex C-c C-x C-n
  2525. @kindex C-c C-x C-p
  2526. @cindex links, finding next/previous
  2527. @item C-c C-x C-n
  2528. @itemx C-c C-x C-p
  2529. Move forward/backward to the next link in the buffer. At the limit of
  2530. the buffer, the search fails once, and then wraps around. The key
  2531. bindings for this are really too long, you might want to bind this also
  2532. to @kbd{C-n} and @kbd{C-p}
  2533. @lisp
  2534. (add-hook 'org-load-hook
  2535. (lambda ()
  2536. (define-key 'org-mode-map "\C-n" 'org-next-link)
  2537. (define-key 'org-mode-map "\C-p" 'org-previous-link)))
  2538. @end lisp
  2539. @end table
  2540. @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
  2541. @section Using links outside Org
  2542. You can insert and follow links that have Org syntax not only in
  2543. Org, but in any Emacs buffer. For this, you should create two
  2544. global commands, like this (please select suitable global keys
  2545. yourself):
  2546. @lisp
  2547. (global-set-key "\C-c L" 'org-insert-link-global)
  2548. (global-set-key "\C-c o" 'org-open-at-point-global)
  2549. @end lisp
  2550. @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
  2551. @section Link abbreviations
  2552. @cindex link abbreviations
  2553. @cindex abbreviation, links
  2554. Long URLs can be cumbersome to type, and often many similar links are
  2555. needed in a document. For this you can use link abbreviations. An
  2556. abbreviated link looks like this
  2557. @example
  2558. [[linkword:tag][description]]
  2559. @end example
  2560. @noindent
  2561. @vindex org-link-abbrev-alist
  2562. where the tag is optional. Such abbreviations are resolved according to
  2563. the information in the variable @code{org-link-abbrev-alist} that
  2564. relates the linkwords to replacement text. Here is an example:
  2565. @lisp
  2566. @group
  2567. (setq org-link-abbrev-alist
  2568. '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
  2569. ("google" . "http://www.google.com/search?q=")
  2570. ("ads" . "http://adsabs.harvard.edu/cgi-bin/
  2571. nph-abs_connect?author=%s&db_key=AST")))
  2572. @end group
  2573. @end lisp
  2574. If the replacement text contains the string @samp{%s}, it will be
  2575. replaced with the tag. Otherwise the tag will be appended to the string
  2576. in order to create the link. You may also specify a function that will
  2577. be called with the tag as the only argument to create the link.
  2578. With the above setting, you could link to a specific bug with
  2579. @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
  2580. @code{[[google:OrgMode]]} and find out what the Org author is
  2581. doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
  2582. If you need special abbreviations just for a single Org buffer, you
  2583. can define them in the file with
  2584. @example
  2585. #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
  2586. #+LINK: google http://www.google.com/search?q=%s
  2587. @end example
  2588. @noindent
  2589. In-buffer completion @pxref{Completion} can be used after @samp{[} to
  2590. complete link abbreviations.
  2591. @node Search options, Custom searches, Link abbreviations, Hyperlinks
  2592. @section Search options in file links
  2593. @cindex search option in file links
  2594. @cindex file links, searching
  2595. File links can contain additional information to make Emacs jump to a
  2596. particular location in the file when following a link. This can be a
  2597. line number or a search option after a double@footnote{For backward
  2598. compatibility, line numbers can also follow a single colon.} colon. For
  2599. example, when the command @kbd{C-c l} creates a link (@pxref{Handling
  2600. links}) to a file, it encodes the words in the current line as a search
  2601. string that can be used to find this line back later when following the
  2602. link with @kbd{C-c C-o}.
  2603. Here is the syntax of the different ways to attach a search to a file
  2604. link, together with an explanation:
  2605. @example
  2606. [[file:~/code/main.c::255]]
  2607. [[file:~/xx.org::My Target]]
  2608. [[file:~/xx.org::*My Target]]
  2609. [[file:~/xx.org::/regexp/]]
  2610. @end example
  2611. @table @code
  2612. @item 255
  2613. Jump to line 255.
  2614. @item My Target
  2615. Search for a link target @samp{<<My Target>>}, or do a text search for
  2616. @samp{my target}, similar to the search in internal links, see
  2617. @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
  2618. link will become an HTML reference to the corresponding named anchor in
  2619. the linked file.
  2620. @item *My Target
  2621. In an Org file, restrict search to headlines.
  2622. @item /regexp/
  2623. Do a regular expression search for @code{regexp}. This uses the Emacs
  2624. command @code{occur} to list all matches in a separate window. If the
  2625. target file is in Org mode, @code{org-occur} is used to create a
  2626. sparse tree with the matches.
  2627. @c If the target file is a directory,
  2628. @c @code{grep} will be used to search all files in the directory.
  2629. @end table
  2630. As a degenerate case, a file link with an empty file name can be used
  2631. to search the current file. For example, @code{[[file:::find me]]} does
  2632. a search for @samp{find me} in the current file, just as
  2633. @samp{[[find me]]} would.
  2634. @node Custom searches, , Search options, Hyperlinks
  2635. @section Custom Searches
  2636. @cindex custom search strings
  2637. @cindex search strings, custom
  2638. The default mechanism for creating search strings and for doing the
  2639. actual search related to a file link may not work correctly in all
  2640. cases. For example, BibTeX database files have many entries like
  2641. @samp{year="1993"} which would not result in good search strings,
  2642. because the only unique identification for a BibTeX entry is the
  2643. citation key.
  2644. @vindex org-create-file-search-functions
  2645. @vindex org-execute-file-search-functions
  2646. If you come across such a problem, you can write custom functions to set
  2647. the right search string for a particular file type, and to do the search
  2648. for the string in the file. Using @code{add-hook}, these functions need
  2649. to be added to the hook variables
  2650. @code{org-create-file-search-functions} and
  2651. @code{org-execute-file-search-functions}. See the docstring for these
  2652. variables for more information. Org actually uses this mechanism
  2653. for Bib@TeX{} database files, and you can use the corresponding code as
  2654. an implementation example. See the file @file{org-bibtex.el}.
  2655. @node TODO Items, Tags, Hyperlinks, Top
  2656. @chapter TODO Items
  2657. @cindex TODO items
  2658. Org mode does not maintain TODO lists as separate documents@footnote{Of
  2659. course, you can make a document that contains only long lists of TODO items,
  2660. but this is not required.}. Instead, TODO items are an integral part of the
  2661. notes file, because TODO items usually come up while taking notes! With Org
  2662. mode, simply mark any entry in a tree as being a TODO item. In this way,
  2663. information is not duplicated, and the entire context from which the TODO
  2664. item emerged is always present.
  2665. Of course, this technique for managing TODO items scatters them
  2666. throughout your notes file. Org mode compensates for this by providing
  2667. methods to give you an overview of all the things that you have to do.
  2668. @menu
  2669. * TODO basics:: Marking and displaying TODO entries
  2670. * TODO extensions:: Workflow and assignments
  2671. * Progress logging:: Dates and notes for progress
  2672. * Priorities:: Some things are more important than others
  2673. * Breaking down tasks:: Splitting a task into manageable pieces
  2674. * Checkboxes:: Tick-off lists
  2675. @end menu
  2676. @node TODO basics, TODO extensions, TODO Items, TODO Items
  2677. @section Basic TODO functionality
  2678. Any headline becomes a TODO item when it starts with the word
  2679. @samp{TODO}, for example:
  2680. @example
  2681. *** TODO Write letter to Sam Fortune
  2682. @end example
  2683. @noindent
  2684. The most important commands to work with TODO entries are:
  2685. @table @kbd
  2686. @kindex C-c C-t
  2687. @cindex cycling, of TODO states
  2688. @item C-c C-t
  2689. Rotate the TODO state of the current item among
  2690. @example
  2691. ,-> (unmarked) -> TODO -> DONE --.
  2692. '--------------------------------'
  2693. @end example
  2694. The same rotation can also be done ``remotely'' from the timeline and
  2695. agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
  2696. @kindex C-u C-c C-t
  2697. @item C-u C-c C-t
  2698. Select a specific keyword using completion or (if it has been set up)
  2699. the fast selection interface. For the latter, you need to assign keys
  2700. to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
  2701. more information.
  2702. @kindex S-@key{right}
  2703. @kindex S-@key{left}
  2704. @item S-@key{right}
  2705. @itemx S-@key{left}
  2706. Select the following/preceding TODO state, similar to cycling. Useful
  2707. mostly if more than two TODO states are possible (@pxref{TODO
  2708. extensions}). See also @ref{Conflicts} for a discussion of the interaction
  2709. with @code{shift-selection-mode}.
  2710. @kindex C-c C-v
  2711. @kindex C-c / t
  2712. @cindex sparse tree, for TODO
  2713. @item C-c C-v
  2714. @itemx C-c / t
  2715. @vindex org-todo-keywords
  2716. View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
  2717. the entire buffer, but shows all TODO items and the headings hierarchy
  2718. above them. With a prefix argument, search for a specific TODO. You will be
  2719. prompted for the keyword, and you can also give a list of keywords like
  2720. @code{KWD1|KWD2|...}. With numeric prefix argument N, show the tree for the
  2721. Nth keyword in the variable @code{org-todo-keywords}. With two prefix
  2722. arguments, find all TODO and DONE entries.
  2723. @kindex C-c a t
  2724. @item C-c a t
  2725. Show the global TODO list. Collects the TODO items from all agenda
  2726. files (@pxref{Agenda Views}) into a single buffer. The new buffer will
  2727. be in @code{agenda-mode}, which provides commands to examine and
  2728. manipulate the TODO entries from the new buffer (@pxref{Agenda
  2729. commands}). @xref{Global TODO list}, for more information.
  2730. @kindex S-M-@key{RET}
  2731. @item S-M-@key{RET}
  2732. Insert a new TODO entry below the current one.
  2733. @end table
  2734. @noindent
  2735. @vindex org-todo-state-tags-triggers
  2736. Changing a TODO state can also trigger tag changes. See the docstring of the
  2737. option @code{org-todo-state-tags-triggers} for details.
  2738. @node TODO extensions, Progress logging, TODO basics, TODO Items
  2739. @section Extended use of TODO keywords
  2740. @cindex extended TODO keywords
  2741. @vindex org-todo-keywords
  2742. By default, marked TODO entries have one of only two states: TODO and
  2743. DONE. Org mode allows you to classify TODO items in more complex ways
  2744. with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
  2745. special setup, the TODO keyword system can work differently in different
  2746. files.
  2747. Note that @i{tags} are another way to classify headlines in general and
  2748. TODO items in particular (@pxref{Tags}).
  2749. @menu
  2750. * Workflow states:: From TODO to DONE in steps
  2751. * TODO types:: I do this, Fred does the rest
  2752. * Multiple sets in one file:: Mixing it all, and still finding your way
  2753. * Fast access to TODO states:: Single letter selection of a state
  2754. * Per-file keywords:: Different files, different requirements
  2755. * Faces for TODO keywords:: Highlighting states
  2756. * TODO dependencies:: When one task needs to wait for others
  2757. @end menu
  2758. @node Workflow states, TODO types, TODO extensions, TODO extensions
  2759. @subsection TODO keywords as workflow states
  2760. @cindex TODO workflow
  2761. @cindex workflow states as TODO keywords
  2762. You can use TODO keywords to indicate different @emph{sequential} states
  2763. in the process of working on an item, for example@footnote{Changing
  2764. this variable only becomes effective after restarting Org mode in a
  2765. buffer.}:
  2766. @lisp
  2767. (setq org-todo-keywords
  2768. '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
  2769. @end lisp
  2770. The vertical bar separates the TODO keywords (states that @emph{need
  2771. action}) from the DONE states (which need @emph{no further action}). If
  2772. you don't provide the separator bar, the last state is used as the DONE
  2773. state.
  2774. @cindex completion, of TODO keywords
  2775. With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
  2776. to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
  2777. also use a numeric prefix argument to quickly select a specific state. For
  2778. example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
  2779. Or you can use @kbd{S-left} to go backward through the sequence. If you
  2780. define many keywords, you can use in-buffer completion
  2781. (@pxref{Completion}) or even a special one-key selection scheme
  2782. (@pxref{Fast access to TODO states}) to insert these words into the
  2783. buffer. Changing a TODO state can be logged with a timestamp, see
  2784. @ref{Tracking TODO state changes} for more information.
  2785. @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
  2786. @subsection TODO keywords as types
  2787. @cindex TODO types
  2788. @cindex names as TODO keywords
  2789. @cindex types as TODO keywords
  2790. The second possibility is to use TODO keywords to indicate different
  2791. @emph{types} of action items. For example, you might want to indicate
  2792. that items are for ``work'' or ``home''. Or, when you work with several
  2793. people on a single project, you might want to assign action items
  2794. directly to persons, by using their names as TODO keywords. This would
  2795. be set up like this:
  2796. @lisp
  2797. (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
  2798. @end lisp
  2799. In this case, different keywords do not indicate a sequence, but rather
  2800. different types. So the normal work flow would be to assign a task to a
  2801. person, and later to mark it DONE. Org mode supports this style by adapting
  2802. the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
  2803. @kbd{t} command in the timeline and agenda buffers.}. When used several
  2804. times in succession, it will still cycle through all names, in order to first
  2805. select the right type for a task. But when you return to the item after some
  2806. time and execute @kbd{C-c C-t} again, it will switch from any name directly
  2807. to DONE. Use prefix arguments or completion to quickly select a specific
  2808. name. You can also review the items of a specific TODO type in a sparse tree
  2809. by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things
  2810. Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items
  2811. from all agenda files into a single buffer, you would use the numeric prefix
  2812. argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
  2813. @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
  2814. @subsection Multiple keyword sets in one file
  2815. @cindex TODO keyword sets
  2816. Sometimes you may want to use different sets of TODO keywords in
  2817. parallel. For example, you may want to have the basic
  2818. @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
  2819. separate state indicating that an item has been canceled (so it is not
  2820. DONE, but also does not require action). Your setup would then look
  2821. like this:
  2822. @lisp
  2823. (setq org-todo-keywords
  2824. '((sequence "TODO" "|" "DONE")
  2825. (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
  2826. (sequence "|" "CANCELED")))
  2827. @end lisp
  2828. The keywords should all be different, this helps Org mode to keep track
  2829. of which subsequence should be used for a given entry. In this setup,
  2830. @kbd{C-c C-t} only operates within a subsequence, so it switches from
  2831. @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
  2832. (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
  2833. select the correct sequence. Besides the obvious ways like typing a
  2834. keyword or using completion, you may also apply the following commands:
  2835. @table @kbd
  2836. @kindex C-S-@key{right}
  2837. @kindex C-S-@key{left}
  2838. @kindex C-u C-u C-c C-t
  2839. @item C-u C-u C-c C-t
  2840. @itemx C-S-@key{right}
  2841. @itemx C-S-@key{left}
  2842. These keys jump from one TODO subset to the next. In the above example,
  2843. @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
  2844. @code{DONE} to @code{REPORT}, and any of the words in the second row to
  2845. @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
  2846. @code{shift-selection-mode} (@pxref{Conflicts}).
  2847. @kindex S-@key{right}
  2848. @kindex S-@key{left}
  2849. @item S-@key{right}
  2850. @itemx S-@key{left}
  2851. @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
  2852. keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
  2853. from @code{DONE} to @code{REPORT} in the example above. See also
  2854. @ref{Conflicts} for a discussion of the interaction with
  2855. @code{shift-selection-mode}.
  2856. @end table
  2857. @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
  2858. @subsection Fast access to TODO states
  2859. If you would like to quickly change an entry to an arbitrary TODO state
  2860. instead of cycling through the states, you can set up keys for
  2861. single-letter access to the states. This is done by adding the section
  2862. key after each keyword, in parenthesis. For example:
  2863. @lisp
  2864. (setq org-todo-keywords
  2865. '((sequence "TODO(t)" "|" "DONE(d)")
  2866. (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
  2867. (sequence "|" "CANCELED(c)")))
  2868. @end lisp
  2869. @vindex org-fast-tag-selection-include-todo
  2870. If you then press @code{C-c C-t} followed by the selection key, the entry
  2871. will be switched to this state. @key{SPC} can be used to remove any TODO
  2872. keyword from an entry.@footnote{Check also the variable
  2873. @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
  2874. state through the tags interface (@pxref{Setting tags}), in case you like to
  2875. mingle the two concepts. Note that this means you need to come up with
  2876. unique keys across both sets of keywords.}
  2877. @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
  2878. @subsection Setting up keywords for individual files
  2879. @cindex keyword options
  2880. @cindex per-file keywords
  2881. It can be very useful to use different aspects of the TODO mechanism in
  2882. different files. For file-local settings, you need to add special lines
  2883. to the file which set the keywords and interpretation for that file
  2884. only. For example, to set one of the two examples discussed above, you
  2885. need one of the following lines, starting in column zero anywhere in the
  2886. file:
  2887. @example
  2888. #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
  2889. @end example
  2890. @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
  2891. interpretation, but it means the same as @code{#+TODO}), or
  2892. @example
  2893. #+TYP_TODO: Fred Sara Lucy Mike | DONE
  2894. @end example
  2895. A setup for using several sets in parallel would be:
  2896. @example
  2897. #+TODO: TODO | DONE
  2898. #+TODO: REPORT BUG KNOWNCAUSE | FIXED
  2899. #+TODO: | CANCELED
  2900. @end example
  2901. @cindex completion, of option keywords
  2902. @kindex M-@key{TAB}
  2903. @noindent To make sure you are using the correct keyword, type
  2904. @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
  2905. @cindex DONE, final TODO keyword
  2906. Remember that the keywords after the vertical bar (or the last keyword
  2907. if no bar is there) must always mean that the item is DONE (although you
  2908. may use a different word). After changing one of these lines, use
  2909. @kbd{C-c C-c} with the cursor still in the line to make the changes
  2910. known to Org mode@footnote{Org mode parses these lines only when
  2911. Org mode is activated after visiting a file. @kbd{C-c C-c} with the
  2912. cursor in a line starting with @samp{#+} is simply restarting Org mode
  2913. for the current buffer.}.
  2914. @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
  2915. @subsection Faces for TODO keywords
  2916. @cindex faces, for TODO keywords
  2917. @vindex org-todo @r{(face)}
  2918. @vindex org-done @r{(face)}
  2919. @vindex org-todo-keyword-faces
  2920. Org mode highlights TODO keywords with special faces: @code{org-todo}
  2921. for keywords indicating that an item still has to be acted upon, and
  2922. @code{org-done} for keywords indicating that an item is finished. If
  2923. you are using more than 2 different states, you might want to use
  2924. special faces for some of them. This can be done using the variable
  2925. @code{org-todo-keyword-faces}. For example:
  2926. @lisp
  2927. @group
  2928. (setq org-todo-keyword-faces
  2929. '(("TODO" . org-warning)
  2930. ("DEFERRED" . shadow)
  2931. ("CANCELED" . (:foreground "blue" :weight bold))))
  2932. @end group
  2933. @end lisp
  2934. While using a list with face properties as shown for CANCELED
  2935. @emph{should} work, this does not aways seem to be the case. If
  2936. necessary, define a special face and use that.
  2937. @node TODO dependencies, , Faces for TODO keywords, TODO extensions
  2938. @subsection TODO dependencies
  2939. @cindex TODO dependencies
  2940. @cindex dependencies, of TODO states
  2941. @vindex org-enforce-todo-dependencies
  2942. The structure of Org files (hierarchy and lists) makes it easy to define TODO
  2943. dependencies. Usually, a parent TODO task should not be marked DONE until
  2944. all subtasks (defined as children tasks) are marked as DONE. And sometimes
  2945. there is a logical sequence to a number of (sub)tasks, so that one task
  2946. cannot be acted upon before all siblings above it are done. If you customize
  2947. the variable @code{org-enforce-todo-dependencies}, Org will block entries
  2948. from changing state to DONE while they have children that are not DONE.
  2949. Furthermore, if an entry has a property @code{ORDERED}, each of its children
  2950. will be blocked until all earlier siblings are marked DONE. Here is an
  2951. example:
  2952. @example
  2953. * TODO Blocked until (two) is done
  2954. ** DONE one
  2955. ** TODO two
  2956. * Parent
  2957. :PROPERTIES:
  2958. :ORDERED: t
  2959. :END:
  2960. ** TODO a
  2961. ** TODO b, needs to wait for (a)
  2962. ** TODO c, needs to wait for (a) and (b)
  2963. @end example
  2964. @table @kbd
  2965. @kindex C-c C-x o
  2966. @item C-c C-x o
  2967. @vindex org-track-ordered-property-with-tag
  2968. Toggle the @code{ORDERED} property of the current entry. A property is used
  2969. for this behavior because this should be local to the current entry, not
  2970. inherited like a tag. However, if you would like to @i{track} the value of
  2971. this property with a tag for better visibility, customize the variable
  2972. @code{org-track-ordered-property-with-tag}.
  2973. @kindex C-u C-u C-u C-c C-t
  2974. @item C-u C-u C-u C-c C-t
  2975. Change TODO state, circumventin any state blocking.
  2976. @end table
  2977. @vindex org-agenda-dim-blocked-tasks
  2978. If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
  2979. that cannot be closed because of such dependencies will be shown in a dimmed
  2980. font or even made invisible in agenda views (@pxref{Agenda Views}).
  2981. @cindex checkboxes and TODO dependencies
  2982. @vindex org-enforce-todo-dependencies
  2983. You can also block changes of TODO states by looking at checkboxes
  2984. (@pxref{Checkboxes}). If you set the variable
  2985. @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
  2986. checkboxes will be blocked from switching to DONE.
  2987. If you need more complex dependency structures, for example dependencies
  2988. between entries in different trees or files, check out the contributed
  2989. module @file{org-depend.el}.
  2990. @page
  2991. @node Progress logging, Priorities, TODO extensions, TODO Items
  2992. @section Progress logging
  2993. @cindex progress logging
  2994. @cindex logging, of progress
  2995. Org mode can automatically record a time stamp and possibly a note when
  2996. you mark a TODO item as DONE, or even each time you change the state of
  2997. a TODO item. This system is highly configurable, settings can be on a
  2998. per-keyword basis and can be localized to a file or even a subtree. For
  2999. information on how to clock working time for a task, see @ref{Clocking
  3000. work time}.
  3001. @menu
  3002. * Closing items:: When was this entry marked DONE?
  3003. * Tracking TODO state changes:: When did the status change?
  3004. @end menu
  3005. @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
  3006. @subsection Closing items
  3007. The most basic logging is to keep track of @emph{when} a certain TODO
  3008. item was finished. This is achieved with@footnote{The corresponding
  3009. in-buffer setting is: @code{#+STARTUP: logdone}}.
  3010. @lisp
  3011. (setq org-log-done 'time)
  3012. @end lisp
  3013. @noindent
  3014. Then each time you turn an entry from a TODO (not-done) state into any
  3015. of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
  3016. just after the headline. If you turn the entry back into a TODO item
  3017. through further state cycling, that line will be removed again. If you
  3018. want to record a note along with the timestamp, use@footnote{The
  3019. corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
  3020. @lisp
  3021. (setq org-log-done 'note)
  3022. @end lisp
  3023. @noindent
  3024. You will then be prompted for a note, and that note will be stored below
  3025. the entry with a @samp{Closing Note} heading.
  3026. In the timeline (@pxref{Timeline}) and in the agenda
  3027. (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
  3028. display the TODO items with a @samp{CLOSED} timestamp on each day,
  3029. giving you an overview of what has been done.
  3030. @node Tracking TODO state changes, , Closing items, Progress logging
  3031. @subsection Tracking TODO state changes
  3032. @cindex drawer, for state change recording
  3033. @vindex org-log-states-order-reversed
  3034. @vindex org-log-state-notes-into-drawer
  3035. When TODO keywords are used as workflow states (@pxref{Workflow states}), you
  3036. might want to keep track of when a state change occurred and maybe take a
  3037. note about this change. You can either record just a timestamp, or a
  3038. timestamped note for a change. These records will be inserted after the
  3039. headline as an itemized list, newest first@footnote{See the variable
  3040. @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
  3041. want to get the notes out of a way into a drawer (@pxref{Drawers}).
  3042. Customize the variable @code{org-log-state-notes-into-drawer} to get this
  3043. behavior - the recommended drawer for this is called @code{LOGBOOK}.
  3044. Since it is normally too much to record a note for every state, Org mode
  3045. expects configuration on a per-keyword basis for this. This is achieved by
  3046. adding special markers @samp{!} (for a time stamp) and @samp{@@} (for a note)
  3047. in parenthesis after each keyword. For example, with the setting
  3048. @lisp
  3049. (setq org-todo-keywords
  3050. '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
  3051. @end lisp
  3052. @noindent
  3053. @vindex org-log-done
  3054. you not only define global TODO keywords and fast access keys, but also
  3055. request that a time is recorded when the entry is turned into
  3056. DONE@footnote{It is possible that Org mode will record two time stamps
  3057. when you are using both @code{org-log-done} and state change logging.
  3058. However, it will never prompt for two notes - if you have configured
  3059. both, the state change recording note will take precedence and cancel
  3060. the @samp{Closing Note}.}, and that a note is recorded when switching to
  3061. WAIT or CANCELED. The setting for WAIT is even more special: The
  3062. @samp{!} after the slash means that in addition to the note taken when
  3063. entering the state, a time stamp should be recorded when @i{leaving} the
  3064. WAIT state, if and only if the @i{target} state does not configure
  3065. logging for entering it. So it has no effect when switching from WAIT
  3066. to DONE, because DONE is configured to record a timestamp only. But
  3067. when switching from WAIT back to TODO, the @samp{/!} in the WAIT
  3068. setting now triggers a timestamp even though TODO has no logging
  3069. configured.
  3070. You can use the exact same syntax for setting logging preferences local
  3071. to a buffer:
  3072. @example
  3073. #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
  3074. @end example
  3075. In order to define logging settings that are local to a subtree or a
  3076. single item, define a LOGGING property in this entry. Any non-empty
  3077. LOGGING property resets all logging settings to nil. You may then turn
  3078. on logging for this specific tree using STARTUP keywords like
  3079. @code{lognotedone} or @code{logrepeat}, as well as adding state specific
  3080. settings like @code{TODO(!)}. For example
  3081. @example
  3082. * TODO Log each state with only a time
  3083. :PROPERTIES:
  3084. :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
  3085. :END:
  3086. * TODO Only log when switching to WAIT, and when repeating
  3087. :PROPERTIES:
  3088. :LOGGING: WAIT(@@) logrepeat
  3089. :END:
  3090. * TODO No logging at all
  3091. :PROPERTIES:
  3092. :LOGGING: nil
  3093. :END:
  3094. @end example
  3095. @node Priorities, Breaking down tasks, Progress logging, TODO Items
  3096. @section Priorities
  3097. @cindex priorities
  3098. If you use Org mode extensively, you may end up enough TODO items that
  3099. it starts to make sense to prioritize them. Prioritizing can be done by
  3100. placing a @emph{priority cookie} into the headline of a TODO item, like
  3101. this
  3102. @example
  3103. *** TODO [#A] Write letter to Sam Fortune
  3104. @end example
  3105. @noindent
  3106. By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
  3107. @samp{C}. @samp{A} is the highest priority. An entry without a cookie
  3108. is treated as priority @samp{B}. Priorities make a difference only in
  3109. the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
  3110. no inherent meaning to Org mode.
  3111. Priorities can be attached to any outline tree entries; they do not need
  3112. to be TODO items.
  3113. @table @kbd
  3114. @kindex @kbd{C-c ,}
  3115. @item @kbd{C-c ,}
  3116. Set the priority of the current headline. The command prompts for a
  3117. priority character @samp{A}, @samp{B} or @samp{C}. When you press
  3118. @key{SPC} instead, the priority cookie is removed from the headline.
  3119. The priorities can also be changed ``remotely'' from the timeline and
  3120. agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
  3121. @c
  3122. @kindex S-@key{up}
  3123. @kindex S-@key{down}
  3124. @item S-@key{up}
  3125. @itemx S-@key{down}
  3126. @vindex org-priority-start-cycle-with-default
  3127. Increase/decrease priority of current headline@footnote{See also the option
  3128. @code{org-priority-start-cycle-with-default}.}. Note that these keys are
  3129. also used to modify time stamps (@pxref{Creating timestamps}). See also
  3130. @ref{Conflicts} for a discussion of the interaction with
  3131. @code{shift-selection-mode}.
  3132. @end table
  3133. @vindex org-highest-priority
  3134. @vindex org-lowest-priority
  3135. @vindex org-default-priority
  3136. You can change the range of allowed priorities by setting the variables
  3137. @code{org-highest-priority}, @code{org-lowest-priority}, and
  3138. @code{org-default-priority}. For an individual buffer, you may set
  3139. these values (highest, lowest, default) like this (please make sure that
  3140. the highest priority is earlier in the alphabet than the lowest
  3141. priority):
  3142. @example
  3143. #+PRIORITIES: A C B
  3144. @end example
  3145. @node Breaking down tasks, Checkboxes, Priorities, TODO Items
  3146. @section Breaking tasks down into subtasks
  3147. @cindex tasks, breaking down
  3148. @vindex org-agenda-todo-list-sublevels
  3149. It is often advisable to break down large tasks into smaller, manageable
  3150. subtasks. You can do this by creating an outline tree below a TODO item,
  3151. with detailed subtasks on the tree@footnote{To keep subtasks out of the
  3152. global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
  3153. the overview over the fraction of subtasks that are already completed, insert
  3154. either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
  3155. be updates each time the todo status of a child changes. For example:
  3156. @example
  3157. * Organize Party [33%]
  3158. ** TODO Call people [1/2]
  3159. *** TODO Peter
  3160. *** DONE Sarah
  3161. ** TODO Buy food
  3162. ** DONE Talk to neighbor
  3163. @end example
  3164. If you would like a TODO entry to automatically change to DONE when all
  3165. children are done, you can use the following setup:
  3166. @example
  3167. (defun org-summary-todo (n-done n-not-done)
  3168. "Switch entry to DONE when all subentries are done, to TODO otherwise."
  3169. (let (org-log-done org-log-states) ; turn off logging
  3170. (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
  3171. (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
  3172. @end example
  3173. Another possibility is the use of checkboxes to identify (a hierarchy of) a
  3174. large number of subtasks (@pxref{Checkboxes}).
  3175. @node Checkboxes, , Breaking down tasks, TODO Items
  3176. @section Checkboxes
  3177. @cindex checkboxes
  3178. Every item in a plain list (@pxref{Plain lists}) can be made into a
  3179. checkbox by starting it with the string @samp{[ ]}. This feature is
  3180. similar to TODO items (@pxref{TODO Items}), but is more lightweight.
  3181. Checkboxes are not included into the global TODO list, so they are often
  3182. great to split a task into a number of simple steps. Or you can use
  3183. them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
  3184. use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
  3185. Here is an example of a checkbox list.
  3186. @example
  3187. * TODO Organize party [2/4]
  3188. - [-] call people [1/3]
  3189. - [ ] Peter
  3190. - [X] Sarah
  3191. - [ ] Sam
  3192. - [X] order food
  3193. - [ ] think about what music to play
  3194. - [X] talk to the neighbors
  3195. @end example
  3196. Checkboxes work hierarchically, so if a checkbox item has children that
  3197. are checkboxes, toggling one of the children checkboxes will make the
  3198. parent checkbox reflect if none, some, or all of the children are
  3199. checked.
  3200. @cindex statistics, for checkboxes
  3201. @cindex checkbox statistics
  3202. The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
  3203. cookies indicating how many checkboxes present in this entry have been
  3204. checked off, and the total number of checkboxes are present. This can
  3205. give you an idea on how many checkboxes remain, even without opening a
  3206. folded entry. The cookies can be placed into a headline or into (the
  3207. first line of) a plain list item. Each cookie covers all checkboxes
  3208. structurally below the headline/item on which the cookie appear. You
  3209. have to insert the cookie yourself by typing either @samp{[/]} or
  3210. @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as in
  3211. the examples above. With @samp{[%]} you get information about the
  3212. percentage of checkboxes checked (in the above example, this would be
  3213. @samp{[50%]} and @samp{[33%]}, respectively).
  3214. @cindex blocking, of checkboxes
  3215. @cindex checkbox blocking
  3216. If the current outline node has an @code{ORDERED} property, checkboxes must
  3217. be checked off in sequence, and an error will be thrown if you try to check
  3218. off a box while there are unchecked boxes bove it.
  3219. @noindent The following commands work with checkboxes:
  3220. @table @kbd
  3221. @kindex C-c C-c
  3222. @item C-c C-c
  3223. Toggle checkbox status or (with prefix arg) checkbox presence at point. With
  3224. double prefix argument, set it to @samp{[-]}, which is considered to be an
  3225. intermediate state.
  3226. @kindex C-c C-x C-b
  3227. @item C-c C-x C-b
  3228. Toggle checkbox status or (with prefix arg) checkbox presence at point. With
  3229. double prefix argument, set it to @samp{[-]}, which is considered to be an
  3230. intermediate state.
  3231. @itemize @minus
  3232. @item
  3233. If there is an active region, toggle the first checkbox in the region
  3234. and set all remaining boxes to the same status as the first. With a prefix
  3235. arg, add or remove the checkbox for all items in the region.
  3236. @item
  3237. If the cursor is in a headline, toggle checkboxes in the region between
  3238. this headline and the next (so @emph{not} the entire subtree).
  3239. @item
  3240. If there is no active region, just toggle the checkbox at point.
  3241. @end itemize
  3242. @kindex M-S-@key{RET}
  3243. @item M-S-@key{RET}
  3244. Insert a new item with a checkbox.
  3245. This works only if the cursor is already in a plain list item
  3246. (@pxref{Plain lists}).
  3247. @kindex C-c C-x o
  3248. @item C-c C-x o
  3249. @vindex org-track-ordered-property-with-tag
  3250. Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
  3251. be checked off in sequence. A property is used for this behavior because
  3252. this should be local to the current entry, not inherited like a tag.
  3253. However, if you would like to @i{track} the value of this property with a tag
  3254. for better visibility, customize the variable
  3255. @code{org-track-ordered-property-with-tag}.
  3256. @kindex C-c #
  3257. @item C-c #
  3258. Update the checkbox statistics in the current outline entry. When
  3259. called with a @kbd{C-u} prefix, update the entire file. Checkbox
  3260. statistic cookies are updated automatically if you toggle checkboxes
  3261. with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you
  3262. delete boxes or add/change them by hand, use this command to get things
  3263. back into sync. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
  3264. @end table
  3265. @node Tags, Properties and Columns, TODO Items, Top
  3266. @chapter Tags
  3267. @cindex tags
  3268. @cindex headline tagging
  3269. @cindex matching, tags
  3270. @cindex sparse tree, tag based
  3271. An excellent way to implement labels and contexts for cross-correlating
  3272. information is to assign @i{tags} to headlines. Org mode has extensive
  3273. support for tags.
  3274. @vindex org-tag-faces
  3275. Every headline can contain a list of tags; they occur at the end of the
  3276. headline. Tags are normal words containing letters, numbers, @samp{_}, and
  3277. @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
  3278. @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
  3279. Tags will by default get a bold face with the same color as the headline.
  3280. You may specify special faces for specific tags using the variable
  3281. @code{org-tag-faces}, much in the same way as you can do for TODO keywords
  3282. (@pxref{Faces for TODO keywords}).
  3283. @menu
  3284. * Tag inheritance:: Tags use the tree structure of the outline
  3285. * Setting tags:: How to assign tags to a headline
  3286. * Tag searches:: Searching for combinations of tags
  3287. @end menu
  3288. @node Tag inheritance, Setting tags, Tags, Tags
  3289. @section Tag inheritance
  3290. @cindex tag inheritance
  3291. @cindex inheritance, of tags
  3292. @cindex sublevels, inclusion into tags match
  3293. @i{Tags} make use of the hierarchical structure of outline trees. If a
  3294. heading has a certain tag, all subheadings will inherit the tag as
  3295. well. For example, in the list
  3296. @example
  3297. * Meeting with the French group :work:
  3298. ** Summary by Frank :boss:notes:
  3299. *** TODO Prepare slides for him :action:
  3300. @end example
  3301. @noindent
  3302. the final heading will have the tags @samp{:work:}, @samp{:boss:},
  3303. @samp{:notes:}, and @samp{:action:} even though the final heading is not
  3304. explicitly marked with those tags. You can also set tags that all entries in
  3305. a file should inherit as if these tags would be defined in a hypothetical
  3306. level zero that surrounds the entire file.
  3307. @example
  3308. #+FILETAGS: :Peter:Boss:Secret:
  3309. @end example
  3310. @noindent
  3311. @vindex org-use-tag-inheritance
  3312. @vindex org-tags-exclude-from-inheritance
  3313. To limit tag inheritance to specific tags, or to turn it off entirely, use
  3314. the variables @code{org-use-tag-inheritance} and
  3315. @code{org-tags-exclude-from-inheritance}.
  3316. @vindex org-tags-match-list-sublevels
  3317. When a headline matches during a tags search while tag inheritance is turned
  3318. on, all the sublevels in the same tree will (for a simple match form) match
  3319. as well@footnote{This is only true if the search does not involve more
  3320. complex tests including properties (@pxref{Property searches}).}. The list
  3321. of matches may then become very long. If you only want to see the first tags
  3322. match in a subtree, configure the variable
  3323. @code{org-tags-match-list-sublevels} (not recommended).
  3324. @node Setting tags, Tag searches, Tag inheritance, Tags
  3325. @section Setting tags
  3326. @cindex setting tags
  3327. @cindex tags, setting
  3328. @kindex M-@key{TAB}
  3329. Tags can simply be typed into the buffer at the end of a headline.
  3330. After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
  3331. also a special command for inserting tags:
  3332. @table @kbd
  3333. @kindex C-c C-q
  3334. @item C-c C-q
  3335. @cindex completion, of tags
  3336. @vindex org-tags-column
  3337. Enter new tags for the current headline. Org mode will either offer
  3338. completion or a special single-key interface for setting tags, see
  3339. below. After pressing @key{RET}, the tags will be inserted and aligned
  3340. to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
  3341. tags in the current buffer will be aligned to that column, just to make
  3342. things look nice. TAGS are automatically realigned after promotion,
  3343. demotion, and TODO state changes (@pxref{TODO basics}).
  3344. @kindex C-c C-c
  3345. @item C-c C-c
  3346. When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
  3347. @end table
  3348. @vindex org-tag-alist
  3349. Org will support tag insertion based on a @emph{list of tags}. By
  3350. default this list is constructed dynamically, containing all tags
  3351. currently used in the buffer. You may also globally specify a hard list
  3352. of tags with the variable @code{org-tag-alist}. Finally you can set
  3353. the default tags for a given file with lines like
  3354. @example
  3355. #+TAGS: @@work @@home @@tennisclub
  3356. #+TAGS: laptop car pc sailboat
  3357. @end example
  3358. If you have globally defined your preferred set of tags using the
  3359. variable @code{org-tag-alist}, but would like to use a dynamic tag list
  3360. in a specific file, add an empty TAGS option line to that file:
  3361. @example
  3362. #+TAGS:
  3363. @end example
  3364. By default Org mode uses the standard minibuffer completion facilities for
  3365. entering tags. However, it also implements another, quicker, tag selection
  3366. method called @emph{fast tag selection}. This allows you to select and
  3367. deselect tags with just a single key press. For this to work well you should
  3368. assign unique letters to most of your commonly used tags. You can do this
  3369. globally by configuring the variable @code{org-tag-alist} in your
  3370. @file{.emacs} file. For example, you may find the need to tag many items in
  3371. different files with @samp{:@@home:}. In this case you can set something
  3372. like:
  3373. @lisp
  3374. (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
  3375. @end lisp
  3376. @noindent If the tag is only relevant to the file you are working on then you
  3377. can, instead, set the TAGS option line as:
  3378. @example
  3379. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
  3380. @end example
  3381. @noindent
  3382. You can also group together tags that are mutually exclusive. By using
  3383. braces, as in:
  3384. @example
  3385. #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
  3386. @end example
  3387. @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
  3388. and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
  3389. @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
  3390. these lines to activate any changes.
  3391. @noindent
  3392. To set these mutually exclusive groups in the variable @code{org-tags-alist}
  3393. you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
  3394. of the braces. The previous example would be set globally by the following
  3395. configuration:
  3396. @lisp
  3397. (setq org-tag-alist '((:startgroup . nil)
  3398. ("@@work" . ?w) ("@@home" . ?h)
  3399. ("@@tennisclub" . ?t)
  3400. (:endgroup . nil)
  3401. ("laptop" . ?l) ("pc" . ?p)))
  3402. @end lisp
  3403. If at least one tag has a selection key then pressing @kbd{C-c C-c} will
  3404. automatically present you with a special interface, listing inherited tags,
  3405. the tags of the current headline, and a list of all valid tags with
  3406. corresponding keys@footnote{Keys will automatically be assigned to tags which
  3407. have no configured keys.}. In this interface, you can use the following
  3408. keys:
  3409. @table @kbd
  3410. @item a-z...
  3411. Pressing keys assigned to tags will add or remove them from the list of
  3412. tags in the current line. Selecting a tag in a group of mutually
  3413. exclusive tags will turn off any other tags from that group.
  3414. @kindex @key{TAB}
  3415. @item @key{TAB}
  3416. Enter a tag in the minibuffer, even if the tag is not in the predefined
  3417. list. You will be able to complete on all tags present in the buffer.
  3418. @kindex @key{SPC}
  3419. @item @key{SPC}
  3420. Clear all tags for this line.
  3421. @kindex @key{RET}
  3422. @item @key{RET}
  3423. Accept the modified set.
  3424. @item C-g
  3425. Abort without installing changes.
  3426. @item q
  3427. If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
  3428. @item !
  3429. Turn off groups of mutually exclusive tags. Use this to (as an
  3430. exception) assign several tags from such a group.
  3431. @item C-c
  3432. Toggle auto-exit after the next change (see below).
  3433. If you are using expert mode, the first @kbd{C-c} will display the
  3434. selection window.
  3435. @end table
  3436. @noindent
  3437. This method lets you assign tags to a headline with very few keys. With
  3438. the above setup, you could clear the current tags and set @samp{@@home},
  3439. @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
  3440. C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
  3441. @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
  3442. alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
  3443. @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
  3444. @key{RET} @key{RET}}.
  3445. @vindex org-fast-tag-selection-single-key
  3446. If you find that most of the time, you need only a single key press to
  3447. modify your list of tags, set the variable
  3448. @code{org-fast-tag-selection-single-key}. Then you no longer have to
  3449. press @key{RET} to exit fast tag selection - it will immediately exit
  3450. after the first change. If you then occasionally need more keys, press
  3451. @kbd{C-c} to turn off auto-exit for the current tag selection process
  3452. (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
  3453. C-c}). If you set the variable to the value @code{expert}, the special
  3454. window is not even shown for single-key tag selection, it comes up only
  3455. when you press an extra @kbd{C-c}.
  3456. @node Tag searches, , Setting tags, Tags
  3457. @section Tag searches
  3458. @cindex tag searches
  3459. @cindex searching for tags
  3460. Once a system of tags has been set up, it can be used to collect related
  3461. information into special lists.
  3462. @table @kbd
  3463. @kindex C-c \
  3464. @kindex C-c / T
  3465. @item C-c \
  3466. @itemx C-c / T
  3467. Create a sparse tree with all headlines matching a tags search. With a
  3468. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  3469. @kindex C-c a m
  3470. @item C-c a m
  3471. Create a global list of tag matches from all agenda files.
  3472. @xref{Matching tags and properties}.
  3473. @kindex C-c a M
  3474. @item C-c a M
  3475. @vindex org-tags-match-list-sublevels
  3476. Create a global list of tag matches from all agenda files, but check
  3477. only TODO items and force checking subitems (see variable
  3478. @code{org-tags-match-list-sublevels}).
  3479. @end table
  3480. @cindex Boolean logic, for tag searches
  3481. A @i{tags} search string can use Boolean operators @samp{&} for AND and
  3482. @samp{|} for OR. @samp{&} binds more strongly than @samp{|}.
  3483. Parenthesis are currently not implemented. A tag may also be preceded
  3484. by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
  3485. positive selection. The AND operator @samp{&} is optional when @samp{+}
  3486. or @samp{-} is present. Examples:
  3487. @table @samp
  3488. @item +work-boss
  3489. Select headlines tagged @samp{:work:}, but discard those also tagged
  3490. @samp{:boss:}.
  3491. @item work|laptop
  3492. Selects lines tagged @samp{:work:} or @samp{:laptop:}.
  3493. @item work|laptop&night
  3494. Like before, but require the @samp{:laptop:} lines to be tagged also
  3495. @samp{:night:}.
  3496. @end table
  3497. @cindex TODO keyword matching, with tags search
  3498. You may also test for TODO keywords (@pxref{TODO extensions}) and properties
  3499. (@pxref{Properties and Columns}) at the same time as matching tags. For a
  3500. guide on how to match properties, see @ref{Property searches}. To match a
  3501. specific TODO keyword, include an expression like @samp{+TODO="NEXT"} as one
  3502. of the terms in a tags search.
  3503. There is also the possibility to end the tags part of the match (which may
  3504. include several terms connected with @samp{|}) with a @samp{/} and then
  3505. specify a Boolean expression just for TODO keywords. The syntax is then
  3506. similar to the tag matches, but should be applied with consideration: For
  3507. example, a positive selection on several TODO keywords can not meaningfully
  3508. be combined with boolean AND. However, @emph{negative selection} combined
  3509. with AND can be meaningful. To make sure that only lines are checked that
  3510. actually have any TODO keyword (resulting in a speed-up), use @kbd{C-c a M},
  3511. or equivalently start the TODO part after the slash with @samp{!}. Examples:
  3512. @table @samp
  3513. @item work+TODO="WAITING"
  3514. Select @samp{:work:}-tagged TODO lines with the specific TODO
  3515. keyword @samp{WAITING}.
  3516. @item work+TODO="WAITING"|home+TODO="WAITING"
  3517. Waiting tasks both at work and at home.
  3518. @item work/WAITING
  3519. Same as the first example.
  3520. @item work/!-WAITING-NEXT
  3521. Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
  3522. nor @samp{NEXT}
  3523. @item work/!+WAITING|+NEXT
  3524. Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
  3525. @samp{NEXT}.
  3526. @end table
  3527. @cindex regular expressions, with tags search
  3528. Any element of the tag/todo match can be a regular expression - in this
  3529. case it must be enclosed in curly braces. For example,
  3530. @samp{work+@{^boss.*@}} matches headlines that contain the tag
  3531. @samp{:work:} and any tag @i{starting} with @samp{boss}. You may also use a
  3532. regular expression in @samp{TODO=@{^W@}} which would match TODO keywords
  3533. starting with the letter @samp{W}.
  3534. @cindex level, require for tags/property match
  3535. @cindex category, require for tags/property match
  3536. @vindex org-odd-levels-only
  3537. You can also require a headline to be of a certain level or category, by
  3538. writing instead of any TAG an expression like @samp{LEVEL=3} or
  3539. @samp{CATEGORY="work"}, respectively. For example, a search
  3540. @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the
  3541. tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE.
  3542. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
  3543. the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
  3544. Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
  3545. other properties will slow down the search.
  3546. @node Properties and Columns, Dates and Times, Tags, Top
  3547. @chapter Properties and Columns
  3548. @cindex properties
  3549. Properties are a set of key-value pairs associated with an entry. There
  3550. are two main applications for properties in Org mode. First, properties
  3551. are like tags, but with a value. Second, you can use properties to
  3552. implement (very basic) database capabilities in an Org buffer. For
  3553. an example of the first application, imagine maintaining a file where
  3554. you document bugs and plan releases of a piece of software. Instead of
  3555. using tags like @code{:release_1:}, @code{:release_2:}, one can use a
  3556. property, say @code{:Release:}, that in different subtrees has different
  3557. values, such as @code{1.0} or @code{2.0}. For an example of the second
  3558. application of properties, imagine keeping track of your music CDs,
  3559. where properties could be things such as the album artist, date of
  3560. release, number of tracks, and so on.
  3561. Properties can be conveniently edited and viewed in column view
  3562. (@pxref{Column view}).
  3563. @menu
  3564. * Property syntax:: How properties are spelled out
  3565. * Special properties:: Access to other Org mode features
  3566. * Property searches:: Matching property values
  3567. * Property inheritance:: Passing values down the tree
  3568. * Column view:: Tabular viewing and editing
  3569. * Property API:: Properties for Lisp programmers
  3570. @end menu
  3571. @node Property syntax, Special properties, Properties and Columns, Properties and Columns
  3572. @section Property syntax
  3573. @cindex property syntax
  3574. @cindex drawer, for properties
  3575. Properties are key-value pairs. They need to be inserted into a special
  3576. drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
  3577. is specified on a single line, with the key (surrounded by colons)
  3578. first, and the value after it. Here is an example:
  3579. @example
  3580. * CD collection
  3581. ** Classic
  3582. *** Goldberg Variations
  3583. :PROPERTIES:
  3584. :Title: Goldberg Variations
  3585. :Composer: J.S. Bach
  3586. :Artist: Glen Gould
  3587. :Publisher: Deutsche Grammphon
  3588. :NDisks: 1
  3589. :END:
  3590. @end example
  3591. You may define the allowed values for a particular property @samp{:Xyz:}
  3592. by setting a property @samp{:Xyz_ALL:}. This special property is
  3593. @emph{inherited}, so if you set it in a level 1 entry, it will apply to
  3594. the entire tree. When allowed values are defined, setting the
  3595. corresponding property becomes easier and is less prone to typing
  3596. errors. For the example with the CD collection, we can predefine
  3597. publishers and the number of disks in a box like this:
  3598. @example
  3599. * CD collection
  3600. :PROPERTIES:
  3601. :NDisks_ALL: 1 2 3 4
  3602. :Publisher_ALL: "Deutsche Grammophon" Philips EMI
  3603. :END:
  3604. @end example
  3605. If you want to set properties that can be inherited by any entry in a
  3606. file, use a line like
  3607. @example
  3608. #+PROPERTY: NDisks_ALL 1 2 3 4
  3609. @end example
  3610. @vindex org-global-properties
  3611. Property values set with the global variable
  3612. @code{org-global-properties} can be inherited by all entries in all
  3613. Org files.
  3614. @noindent
  3615. The following commands help to work with properties:
  3616. @table @kbd
  3617. @kindex M-@key{TAB}
  3618. @item M-@key{TAB}
  3619. After an initial colon in a line, complete property keys. All keys used
  3620. in the current file will be offered as possible completions.
  3621. @kindex C-c C-x p
  3622. @item C-c C-x p
  3623. Set a property. This prompts for a property name and a value. If
  3624. necessary, the property drawer is created as well.
  3625. @item M-x org-insert-property-drawer
  3626. Insert a property drawer into the current entry. The drawer will be
  3627. inserted early in the entry, but after the lines with planning
  3628. information like deadlines.
  3629. @kindex C-c C-c
  3630. @item C-c C-c
  3631. With the cursor in a property drawer, this executes property commands.
  3632. @item C-c C-c s
  3633. Set a property in the current entry. Both the property and the value
  3634. can be inserted using completion.
  3635. @kindex S-@key{right}
  3636. @kindex S-@key{left}
  3637. @item S-@key{left}/@key{right}
  3638. Switch property at point to the next/previous allowed value.
  3639. @item C-c C-c d
  3640. Remove a property from the current entry.
  3641. @item C-c C-c D
  3642. Globally remove a property, from all entries in the current file.
  3643. @item C-c C-c c
  3644. Compute the property at point, using the operator and scope from the
  3645. nearest column format definition.
  3646. @end table
  3647. @node Special properties, Property searches, Property syntax, Properties and Columns
  3648. @section Special properties
  3649. @cindex properties, special
  3650. Special properties provide alternative access method to Org mode
  3651. features discussed in the previous chapters, like the TODO state or the
  3652. priority of an entry. This interface exists so that you can include
  3653. these states into columns view (@pxref{Column view}), or to use them in
  3654. queries. The following property names are special and should not be
  3655. used as keys in the properties drawer:
  3656. @example
  3657. TODO @r{The TODO keyword of the entry.}
  3658. TAGS @r{The tags defined directly in the headline.}
  3659. ALLTAGS @r{All tags, including inherited ones.}
  3660. PRIORITY @r{The priority of the entry, a string with a single letter.}
  3661. DEADLINE @r{The deadline time string, without the angular brackets.}
  3662. SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
  3663. TIMESTAMP @r{The first keyword-less time stamp in the entry.}
  3664. TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
  3665. CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
  3666. @r{must be run first to compute the values.}
  3667. @end example
  3668. @node Property searches, Property inheritance, Special properties, Properties and Columns
  3669. @section Property searches
  3670. @cindex properties, searching
  3671. @cindex searching, of properties
  3672. To create sparse trees and special lists with selection based on properties,
  3673. the same commands are used as for tag searches (@pxref{Tag searches}), and
  3674. the same logic applies. For example, here is a search string:
  3675. @example
  3676. +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
  3677. +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
  3678. @end example
  3679. @noindent
  3680. The type of comparison will depend on how the comparison value is written:
  3681. @itemize @minus
  3682. @item
  3683. If the comparison value is a plain number, a numerical comparison is done,
  3684. and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
  3685. @samp{>=}, and @samp{<>}.
  3686. @item
  3687. If the comparison value is enclosed in double
  3688. quotes, a string comparison is done, and the same operators are allowed.
  3689. @item
  3690. If the comparison value is enclosed in double quotes @emph{and} angular
  3691. brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
  3692. assumed to be date/time specifications in the standard Org way, and the
  3693. comparison will be done accordingly. Special values that will be recognized
  3694. are @code{"<now>"} for now (including time), and @code{"<today>"}, and
  3695. @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
  3696. specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
  3697. @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
  3698. respectively, can be used.
  3699. @item
  3700. If the comparison value is enclosed
  3701. in curly braces, a regexp match is performed, with @samp{=} meaning that the
  3702. regexp matches the property value, and @samp{<>} meaning that it does not
  3703. match.
  3704. @end itemize
  3705. So the search string in the example finds entries tagged @samp{:work:} but
  3706. not @samp{:boss:}, which also have a priority value @samp{A}, a
  3707. @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
  3708. property that is numerically smaller than 2, a @samp{:With:} property that is
  3709. matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
  3710. on or after October 11, 2008.
  3711. You can configure Org mode to use property inheritance during a search, but
  3712. beware that this can slow down searches considerably. See @ref{Property
  3713. inheritance} for details.
  3714. There is also a special command for creating sparse trees based on a
  3715. single property:
  3716. @table @kbd
  3717. @kindex C-c / p
  3718. @item C-c / p
  3719. Create a sparse tree based on the value of a property. This first
  3720. prompts for the name of a property, and then for a value. A sparse tree
  3721. is created with all entries that define this property with the given
  3722. value. If you enclose the value into curly braces, it is interpreted as
  3723. a regular expression and matched against the property values.
  3724. @end table
  3725. @node Property inheritance, Column view, Property searches, Properties and Columns
  3726. @section Property Inheritance
  3727. @cindex properties, inheritance
  3728. @cindex inheritance, of properties
  3729. @vindex org-use-property-inheritance
  3730. The outline structure of Org mode documents lends itself for an
  3731. inheritance model of properties: If the parent in a tree has a certain
  3732. property, the children can inherit this property. Org mode does not
  3733. turn this on by default, because it can slow down property searches
  3734. significantly and is often not needed. However, if you find inheritance
  3735. useful, you can turn it on by setting the variable
  3736. @code{org-use-property-inheritance}. It may be set to @code{t}, to make
  3737. all properties inherited from the parent, to a list of properties
  3738. that should be inherited, or to a regular expression that matches
  3739. inherited properties.
  3740. Org mode has a few properties for which inheritance is hard-coded, at
  3741. least for the special applications for which they are used:
  3742. @table @code
  3743. @item COLUMNS
  3744. The @code{:COLUMNS:} property defines the format of column view
  3745. (@pxref{Column view}). It is inherited in the sense that the level
  3746. where a @code{:COLUMNS:} property is defined is used as the starting
  3747. point for a column view table, independently of the location in the
  3748. subtree from where columns view is turned on.
  3749. @item CATEGORY
  3750. For agenda view, a category set through a @code{:CATEGORY:} property
  3751. applies to the entire subtree.
  3752. @item ARCHIVE
  3753. For archiving, the @code{:ARCHIVE:} property may define the archive
  3754. location for the entire subtree (@pxref{Moving subtrees}).
  3755. @item LOGGING
  3756. The LOGGING property may define logging settings for an entry or a
  3757. subtree (@pxref{Tracking TODO state changes}).
  3758. @end table
  3759. @node Column view, Property API, Property inheritance, Properties and Columns
  3760. @section Column view
  3761. A great way to view and edit properties in an outline tree is
  3762. @emph{column view}. In column view, each outline item is turned into a
  3763. table row. Columns in this table provide access to properties of the
  3764. entries. Org mode implements columns by overlaying a tabular structure
  3765. over the headline of each item. While the headlines have been turned
  3766. into a table row, you can still change the visibility of the outline
  3767. tree. For example, you get a compact table by switching to CONTENTS
  3768. view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
  3769. is active), but you can still open, read, and edit the entry below each
  3770. headline. Or, you can switch to column view after executing a sparse
  3771. tree command and in this way get a table only for the selected items.
  3772. Column view also works in agenda buffers (@pxref{Agenda Views}) where
  3773. queries have collected selected items, possibly from a number of files.
  3774. @menu
  3775. * Defining columns:: The COLUMNS format property
  3776. * Using column view:: How to create and use column view
  3777. * Capturing column view:: A dynamic block for column view
  3778. @end menu
  3779. @node Defining columns, Using column view, Column view, Column view
  3780. @subsection Defining columns
  3781. @cindex column view, for properties
  3782. @cindex properties, column view
  3783. Setting up a column view first requires defining the columns. This is
  3784. done by defining a column format line.
  3785. @menu
  3786. * Scope of column definitions:: Where defined, where valid?
  3787. * Column attributes:: Appearance and content of a column
  3788. @end menu
  3789. @node Scope of column definitions, Column attributes, Defining columns, Defining columns
  3790. @subsubsection Scope of column definitions
  3791. To define a column format for an entire file, use a line like
  3792. @example
  3793. #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  3794. @end example
  3795. To specify a format that only applies to a specific tree, add a
  3796. @code{:COLUMNS:} property to the top node of that tree, for example:
  3797. @example
  3798. ** Top node for columns view
  3799. :PROPERTIES:
  3800. :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  3801. :END:
  3802. @end example
  3803. If a @code{:COLUMNS:} property is present in an entry, it defines columns
  3804. for the entry itself, and for the entire subtree below it. Since the
  3805. column definition is part of the hierarchical structure of the document,
  3806. you can define columns on level 1 that are general enough for all
  3807. sublevels, and more specific columns further down, when you edit a
  3808. deeper part of the tree.
  3809. @node Column attributes, , Scope of column definitions, Defining columns
  3810. @subsubsection Column attributes
  3811. A column definition sets the attributes of a column. The general
  3812. definition looks like this:
  3813. @example
  3814. %[width]property[(title)][@{summary-type@}]
  3815. @end example
  3816. @noindent
  3817. Except for the percent sign and the property name, all items are
  3818. optional. The individual parts have the following meaning:
  3819. @example
  3820. width @r{An integer specifying the width of the column in characters.}
  3821. @r{If omitted, the width will be determined automatically.}
  3822. property @r{The property that should be edited in this column.}
  3823. (title) @r{The header text for the column. If omitted, the}
  3824. @r{property name is used.}
  3825. @{summary-type@} @r{The summary type. If specified, the column values for}
  3826. @r{parent nodes are computed from the children.}
  3827. @r{Supported summary types are:}
  3828. @{+@} @r{Sum numbers in this column.}
  3829. @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
  3830. @{$@} @r{Currency, short for @samp{+;%.2f}.}
  3831. @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
  3832. @{X@} @r{Checkbox status, [X] if all children are [X].}
  3833. @{X/@} @r{Checkbox status, [n/m].}
  3834. @{X%@} @r{Checkbox status, [n%].}
  3835. @end example
  3836. @noindent
  3837. Here is an example for a complete columns definition, along with allowed
  3838. values.
  3839. @example
  3840. :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.}
  3841. %10Time_Estimate@{:@} %CLOCKSUM
  3842. :Owner_ALL: Tammy Mark Karl Lisa Don
  3843. :Status_ALL: "In progress" "Not started yet" "Finished" ""
  3844. :Approved_ALL: "[ ]" "[X]"
  3845. @end example
  3846. The first column, @samp{%25ITEM}, means the first 25 characters of the
  3847. item itself, i.e. of the headline. You probably always should start the
  3848. column definition with the @samp{ITEM} specifier. The other specifiers
  3849. create columns @samp{Owner} with a list of names as allowed values, for
  3850. @samp{Status} with four different possible values, and for a checkbox
  3851. field @samp{Approved}. When no width is given after the @samp{%}
  3852. character, the column will be exactly as wide as it needs to be in order
  3853. to fully display all values. The @samp{Approved} column does have a
  3854. modified title (@samp{Approved?}, with a question mark). Summaries will
  3855. be created for the @samp{Time_Estimate} column by adding time duration
  3856. expressions like HH:MM, and for the @samp{Approved} column, by providing
  3857. an @samp{[X]} status if all children have been checked. The
  3858. @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
  3859. in the subtree.
  3860. @node Using column view, Capturing column view, Defining columns, Column view
  3861. @subsection Using column view
  3862. @table @kbd
  3863. @tsubheading{Turning column view on and off}
  3864. @kindex C-c C-x C-c
  3865. @item C-c C-x C-c
  3866. @vindex org-columns-default-format
  3867. Create the column view for the local environment. This command searches
  3868. the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
  3869. a format. When one is found, the column view table is established for
  3870. the entire tree, starting from the entry that contains the @code{:COLUMNS:}
  3871. property. If none is found, the format is taken from the @code{#+COLUMNS}
  3872. line or from the variable @code{org-columns-default-format}, and column
  3873. view is established for the current entry and its subtree.
  3874. @kindex r
  3875. @item r
  3876. Recreate the column view, to include recent changes made in the buffer.
  3877. @kindex g
  3878. @item g
  3879. Same as @kbd{r}.
  3880. @kindex q
  3881. @item q
  3882. Exit column view.
  3883. @tsubheading{Editing values}
  3884. @item @key{left} @key{right} @key{up} @key{down}
  3885. Move through the column view from field to field.
  3886. @kindex S-@key{left}
  3887. @kindex S-@key{right}
  3888. @item S-@key{left}/@key{right}
  3889. Switch to the next/previous allowed value of the field. For this, you
  3890. have to have specified allowed values for a property.
  3891. @item 1..9,0
  3892. Directly select the nth allowed value, @kbd{0} selects the 10th value.
  3893. @kindex n
  3894. @kindex p
  3895. @itemx n / p
  3896. Same as @kbd{S-@key{left}/@key{right}}
  3897. @kindex e
  3898. @item e
  3899. Edit the property at point. For the special properties, this will
  3900. invoke the same interface that you normally use to change that
  3901. property. For example, when editing a TAGS property, the tag completion
  3902. or fast selection interface will pop up.
  3903. @kindex C-c C-c
  3904. @item C-c C-c
  3905. When there is a checkbox at point, toggle it.
  3906. @kindex v
  3907. @item v
  3908. View the full value of this property. This is useful if the width of
  3909. the column is smaller than that of the value.
  3910. @kindex a
  3911. @item a
  3912. Edit the list of allowed values for this property. If the list is found
  3913. in the hierarchy, the modified values is stored there. If no list is
  3914. found, the new value is stored in the first entry that is part of the
  3915. current column view.
  3916. @tsubheading{Modifying the table structure}
  3917. @kindex <
  3918. @kindex >
  3919. @item < / >
  3920. Make the column narrower/wider by one character.
  3921. @kindex S-M-@key{right}
  3922. @item S-M-@key{right}
  3923. Insert a new column, to the left of the current column.
  3924. @kindex S-M-@key{left}
  3925. @item S-M-@key{left}
  3926. Delete the current column.
  3927. @end table
  3928. @node Capturing column view, , Using column view, Column view
  3929. @subsection Capturing column view
  3930. Since column view is just an overlay over a buffer, it cannot be
  3931. exported or printed directly. If you want to capture a column view, use
  3932. this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
  3933. of this block looks like this:
  3934. @cindex #+BEGIN: columnview
  3935. @example
  3936. * The column view
  3937. #+BEGIN: columnview :hlines 1 :id "label"
  3938. #+END:
  3939. @end example
  3940. @noindent This dynamic block has the following parameters:
  3941. @table @code
  3942. @item :id
  3943. This is most important parameter. Column view is a feature that is
  3944. often localized to a certain (sub)tree, and the capture block might be
  3945. in a different location in the file. To identify the tree whose view to
  3946. capture, you can use 3 values:
  3947. @example
  3948. local @r{use the tree in which the capture block is located}
  3949. global @r{make a global view, including all headings in the file}
  3950. "file:path-to-file"
  3951. @r{run column view at the top of this file}
  3952. "ID" @r{call column view in the tree that has an @code{:ID:}}
  3953. @r{property with the value @i{label}. You can use}
  3954. @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
  3955. @r{the current entry and copy it to the kill-ring.}
  3956. @end example
  3957. @item :hlines
  3958. When @code{t}, insert a hline after every line. When a number N, insert
  3959. a hline before each headline with level @code{<= N}.
  3960. @item :vlines
  3961. When set to @code{t}, enforce column groups to get vertical lines.
  3962. @item :maxlevel
  3963. When set to a number, don't capture entries below this level.
  3964. @item :skip-empty-rows
  3965. When set to @code{t}, skip row where the only non-empty specifier of the
  3966. column view is @code{ITEM}.
  3967. @end table
  3968. @noindent
  3969. The following commands insert or update the dynamic block:
  3970. @table @kbd
  3971. @kindex C-c C-x i
  3972. @item C-c C-x i
  3973. Insert a dynamic block capturing a column view. You will be prompted
  3974. for the scope or id of the view.
  3975. @kindex C-c C-c
  3976. @item C-c C-c
  3977. @kindex C-c C-x C-u
  3978. @itemx C-c C-x C-u
  3979. Update dynamical block at point. The cursor needs to be in the
  3980. @code{#+BEGIN} line of the dynamic block.
  3981. @kindex C-u C-c C-x C-u
  3982. @item C-u C-c C-x C-u
  3983. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  3984. you have several clock table blocks in a buffer.
  3985. @end table
  3986. You can add formulas to the column view table and you may add plotting
  3987. instructions in front of the table - these will survive an update of the
  3988. block. If there is a @code{#+TBLFM:} after the table, the table will
  3989. actually be recalculated automatically after an update.
  3990. @node Property API, , Column view, Properties and Columns
  3991. @section The Property API
  3992. @cindex properties, API
  3993. @cindex API, for properties
  3994. There is a full API for accessing and changing properties. This API can
  3995. be used by Emacs Lisp programs to work with properties and to implement
  3996. features based on them. For more information see @ref{Using the
  3997. property API}.
  3998. @node Dates and Times, Capture, Properties and Columns, Top
  3999. @chapter Dates and Times
  4000. @cindex dates
  4001. @cindex times
  4002. @cindex time stamps
  4003. @cindex date stamps
  4004. To assist project planning, TODO items can be labeled with a date and/or
  4005. a time. The specially formatted string carrying the date and time
  4006. information is called a @emph{timestamp} in Org mode. This may be a
  4007. little confusing because timestamp is often used as indicating when
  4008. something was created or last changed. However, in Org mode this term
  4009. is used in a much wider sense.
  4010. @menu
  4011. * Timestamps:: Assigning a time to a tree entry
  4012. * Creating timestamps:: Commands which insert timestamps
  4013. * Deadlines and scheduling:: Planning your work
  4014. * Clocking work time:: Tracking how long you spend on a task
  4015. * Effort estimates:: Planning work effort in advance
  4016. * Relative timer:: Notes with a running timer
  4017. @end menu
  4018. @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
  4019. @section Timestamps, deadlines and scheduling
  4020. @cindex time stamps
  4021. @cindex ranges, time
  4022. @cindex date stamps
  4023. @cindex deadlines
  4024. @cindex scheduling
  4025. A time stamp is a specification of a date (possibly with time or a range
  4026. of times) in a special format, either @samp{<2003-09-16 Tue>} or
  4027. @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
  4028. 12:00-12:30>}@footnote{This is the standard ISO date/time format. To
  4029. use an alternative format, see @ref{Custom time format}.}. A time stamp
  4030. can appear anywhere in the headline or body of an Org tree entry. Its
  4031. presence causes entries to be shown on specific dates in the agenda
  4032. (@pxref{Weekly/daily agenda}). We distinguish:
  4033. @table @var
  4034. @item Plain time stamp; Event; Appointment
  4035. @cindex timestamp
  4036. A simple time stamp just assigns a date/time to an item. This is just
  4037. like writing down an appointment or event in a paper agenda. In the
  4038. timeline and agenda displays, the headline of an entry associated with a
  4039. plain time stamp will be shown exactly on that date.
  4040. @example
  4041. * Meet Peter at the movies <2006-11-01 Wed 19:15>
  4042. * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
  4043. @end example
  4044. @item Time stamp with repeater interval
  4045. @cindex timestamp, with repeater interval
  4046. A time stamp may contain a @emph{repeater interval}, indicating that it
  4047. applies not only on the given date, but again and again after a certain
  4048. interval of N days (d), weeks (w), months(m), or years(y). The
  4049. following will show up in the agenda every Wednesday:
  4050. @example
  4051. * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
  4052. @end example
  4053. @item Diary-style sexp entries
  4054. For more complex date specifications, Org mode supports using the
  4055. special sexp diary entries implemented in the Emacs calendar/diary
  4056. package. For example
  4057. @example
  4058. * The nerd meeting on every 2nd Thursday of the month
  4059. <%%(diary-float t 4 2)>
  4060. @end example
  4061. @item Time/Date range
  4062. @cindex timerange
  4063. @cindex date range
  4064. Two time stamps connected by @samp{--} denote a range. The headline
  4065. will be shown on the first and last day of the range, and on any dates
  4066. that are displayed and fall in the range. Here is an example:
  4067. @example
  4068. ** Meeting in Amsterdam
  4069. <2004-08-23 Mon>--<2004-08-26 Thu>
  4070. @end example
  4071. @item Inactive time stamp
  4072. @cindex timestamp, inactive
  4073. @cindex inactive timestamp
  4074. Just like a plain time stamp, but with square brackets instead of
  4075. angular ones. These time stamps are inactive in the sense that they do
  4076. @emph{not} trigger an entry to show up in the agenda.
  4077. @example
  4078. * Gillian comes late for the fifth time [2006-11-01 Wed]
  4079. @end example
  4080. @end table
  4081. @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
  4082. @section Creating timestamps
  4083. @cindex creating timestamps
  4084. @cindex timestamps, creating
  4085. For Org mode to recognize time stamps, they need to be in the specific
  4086. format. All commands listed below produce time stamps in the correct
  4087. format.
  4088. @table @kbd
  4089. @kindex C-c .
  4090. @item C-c .
  4091. Prompt for a date and insert a corresponding time stamp. When the cursor is
  4092. at an existing time stamp in the buffer, the command is used to modify this
  4093. timestamp instead of inserting a new one. When this command is used twice in
  4094. succession, a time range is inserted.
  4095. @c
  4096. @kindex C-u C-c .
  4097. @item C-u C-c .
  4098. @vindex org-time-stamp-rounding-minutes
  4099. Like @kbd{C-c .}, but use the alternative format which contains date
  4100. and time. The default time can be rounded to multiples of 5 minutes,
  4101. see the option @code{org-time-stamp-rounding-minutes}.
  4102. @c
  4103. @kindex C-c !
  4104. @item C-c !
  4105. Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
  4106. an agenda entry.
  4107. @c
  4108. @kindex C-c <
  4109. @item C-c <
  4110. Insert a time stamp corresponding to the cursor date in the Calendar.
  4111. @c
  4112. @kindex C-c >
  4113. @item C-c >
  4114. Access the Emacs calendar for the current date. If there is a
  4115. timestamp in the current line, go to the corresponding date
  4116. instead.
  4117. @c
  4118. @kindex C-c C-o
  4119. @item C-c C-o
  4120. Access the agenda for the date given by the time stamp or -range at
  4121. point (@pxref{Weekly/daily agenda}).
  4122. @c
  4123. @kindex S-@key{left}
  4124. @kindex S-@key{right}
  4125. @item S-@key{left}
  4126. @itemx S-@key{right}
  4127. Change date at cursor by one day. These key bindings conflict with
  4128. CUA mode (@pxref{Conflicts}).
  4129. @c
  4130. @kindex S-@key{up}
  4131. @kindex S-@key{down}
  4132. @item S-@key{up}
  4133. @itemx S-@key{down}
  4134. Change the item under the cursor in a timestamp. The cursor can be on a
  4135. year, month, day, hour or minute. Note that if the cursor is in a
  4136. headline and not at a time stamp, these same keys modify the priority of
  4137. an item. (@pxref{Priorities}). The key bindings also conflict with
  4138. CUA mode (@pxref{Conflicts}).
  4139. @c
  4140. @kindex C-c C-y
  4141. @cindex evaluate time range
  4142. @item C-c C-y
  4143. Evaluate a time range by computing the difference between start and end.
  4144. With a prefix argument, insert result after the time range (in a table: into
  4145. the following column).
  4146. @end table
  4147. @menu
  4148. * The date/time prompt:: How Org mode helps you entering date and time
  4149. * Custom time format:: Making dates look different
  4150. @end menu
  4151. @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
  4152. @subsection The date/time prompt
  4153. @cindex date, reading in minibuffer
  4154. @cindex time, reading in minibuffer
  4155. @vindex org-read-date-prefer-future
  4156. When Org mode prompts for a date/time, the default is shown as an ISO
  4157. date, and the prompt therefore seems to ask for an ISO date. But it
  4158. will in fact accept any string containing some date and/or time
  4159. information, and it is really smart about interpreting your input. You
  4160. can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
  4161. copied from an email message. Org mode will find whatever information
  4162. is in there and derive anything you have not specified from the
  4163. @emph{default date and time}. The default is usually the current date
  4164. and time, but when modifying an existing time stamp, or when entering
  4165. the second stamp of a range, it is taken from the stamp in the buffer.
  4166. When filling in information, Org mode assumes that most of the time you
  4167. will want to enter a date in the future: If you omit the month/year and
  4168. the given day/month is @i{before} today, it will assume that you mean a
  4169. future date@footnote{See the variable
  4170. @code{org-read-date-prefer-future}.}.
  4171. For example, let's assume that today is @b{June 13, 2006}. Here is how
  4172. various inputs will be interpreted, the items filled in by Org mode are
  4173. in @b{bold}.
  4174. @example
  4175. 3-2-5 --> 2003-02-05
  4176. 14 --> @b{2006}-@b{06}-14
  4177. 12 --> @b{2006}-@b{07}-12
  4178. Fri --> nearest Friday (defaultdate or later)
  4179. sep 15 --> @b{2006}-09-15
  4180. feb 15 --> @b{2007}-02-15
  4181. sep 12 9 --> 2009-09-12
  4182. 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
  4183. 22 sept 0:34 --> @b{2006}-09-22 0:34
  4184. w4 --> ISO week for of the current year @b{2006}
  4185. 2012 w4 fri --> Friday of ISO week 4 in 2012
  4186. 2012-w04-5 --> Same as above
  4187. @end example
  4188. Furthermore you can specify a relative date by giving, as the
  4189. @emph{first} thing in the input: a plus/minus sign, a number and a
  4190. letter [dwmy] to indicate change in days weeks, months, years. With a
  4191. single plus or minus, the date is always relative to today. With a
  4192. double plus or minus, it is relative to the default date. If instead of
  4193. a single letter, you use the abbreviation of day name, the date will be
  4194. the nth such day. E.g.
  4195. @example
  4196. +0 --> today
  4197. . --> today
  4198. +4d --> four days from today
  4199. +4 --> same as above
  4200. +2w --> two weeks from today
  4201. ++5 --> five days from default date
  4202. +2tue --> second tuesday from now.
  4203. @end example
  4204. @vindex parse-time-months
  4205. @vindex parse-time-weekdays
  4206. The function understands English month and weekday abbreviations. If
  4207. you want to use unabbreviated names and/or other languages, configure
  4208. the variables @code{parse-time-months} and @code{parse-time-weekdays}.
  4209. @cindex calendar, for selecting date
  4210. @vindex org-popup-calendar-for-date-prompt
  4211. Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
  4212. you don't need/want the calendar, configure the variable
  4213. @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
  4214. prompt, either by clicking on a date in the calendar, or by pressing
  4215. @key{RET}, the date selected in the calendar will be combined with the
  4216. information entered at the prompt. You can control the calendar fully
  4217. from the minibuffer:
  4218. @kindex <
  4219. @kindex >
  4220. @kindex mouse-1
  4221. @kindex S-@key{right}
  4222. @kindex S-@key{left}
  4223. @kindex S-@key{down}
  4224. @kindex S-@key{up}
  4225. @kindex M-S-@key{right}
  4226. @kindex M-S-@key{left}
  4227. @kindex @key{RET}
  4228. @example
  4229. > / < @r{Scroll calendar forward/backward by one month.}
  4230. mouse-1 @r{Select date by clicking on it.}
  4231. S-@key{right}/@key{left} @r{One day forward/backward.}
  4232. S-@key{down}/@key{up} @r{One week forward/backward.}
  4233. M-S-@key{right}/@key{left} @r{One month forward/backward.}
  4234. @key{RET} @r{Choose date in calendar.}
  4235. @end example
  4236. @vindex org-read-date-display-live
  4237. The actions of the date/time prompt may seem complex, but I assure you they
  4238. will grow on you, and you will start getting annoyed by pretty much any other
  4239. way of entering a date/time out there. To help you understand what is going
  4240. on, the current interpretation of your input will be displayed live in the
  4241. minibuffer@footnote{If you find this distracting, turn the display of with
  4242. @code{org-read-date-display-live}.}.
  4243. @node Custom time format, , The date/time prompt, Creating timestamps
  4244. @subsection Custom time format
  4245. @cindex custom date/time format
  4246. @cindex time format, custom
  4247. @cindex date format, custom
  4248. @vindex org-display-custom-times
  4249. @vindex org-time-stamp-custom-formats
  4250. Org mode uses the standard ISO notation for dates and times as it is
  4251. defined in ISO 8601. If you cannot get used to this and require another
  4252. representation of date and time to keep you happy, you can get it by
  4253. customizing the variables @code{org-display-custom-times} and
  4254. @code{org-time-stamp-custom-formats}.
  4255. @table @kbd
  4256. @kindex C-c C-x C-t
  4257. @item C-c C-x C-t
  4258. Toggle the display of custom formats for dates and times.
  4259. @end table
  4260. @noindent
  4261. Org mode needs the default format for scanning, so the custom date/time
  4262. format does not @emph{replace} the default format - instead it is put
  4263. @emph{over} the default format using text properties. This has the
  4264. following consequences:
  4265. @itemize @bullet
  4266. @item
  4267. You cannot place the cursor onto a time stamp anymore, only before or
  4268. after.
  4269. @item
  4270. The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
  4271. each component of a time stamp. If the cursor is at the beginning of
  4272. the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
  4273. just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
  4274. time will be changed by one minute.
  4275. @item
  4276. If the time stamp contains a range of clock times or a repeater, these
  4277. will not be overlayed, but remain in the buffer as they were.
  4278. @item
  4279. When you delete a time stamp character-by-character, it will only
  4280. disappear from the buffer after @emph{all} (invisible) characters
  4281. belonging to the ISO timestamp have been removed.
  4282. @item
  4283. If the custom time stamp format is longer than the default and you are
  4284. using dates in tables, table alignment will be messed up. If the custom
  4285. format is shorter, things do work as expected.
  4286. @end itemize
  4287. @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
  4288. @section Deadlines and scheduling
  4289. A time stamp may be preceded by special keywords to facilitate planning:
  4290. @table @var
  4291. @item DEADLINE
  4292. @cindex DEADLINE keyword
  4293. Meaning: the task (most likely a TODO item, though not necessarily) is supposed
  4294. to be finished on that date.
  4295. @vindex org-deadline-warning-days
  4296. On the deadline date, the task will be listed in the agenda. In
  4297. addition, the agenda for @emph{today} will carry a warning about the
  4298. approaching or missed deadline, starting
  4299. @code{org-deadline-warning-days} before the due date, and continuing
  4300. until the entry is marked DONE. An example:
  4301. @example
  4302. *** TODO write article about the Earth for the Guide
  4303. The editor in charge is [[bbdb:Ford Prefect]]
  4304. DEADLINE: <2004-02-29 Sun>
  4305. @end example
  4306. You can specify a different lead time for warnings for a specific
  4307. deadlines using the following syntax. Here is an example with a warning
  4308. period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
  4309. @item SCHEDULED
  4310. @cindex SCHEDULED keyword
  4311. Meaning: you are planning to start working on that task on the given
  4312. date.
  4313. @vindex org-agenda-skip-scheduled-if-done
  4314. The headline will be listed under the given date@footnote{It will still
  4315. be listed on that date after it has been marked DONE. If you don't like
  4316. this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
  4317. addition, a reminder that the scheduled date has passed will be present
  4318. in the compilation for @emph{today}, until the entry is marked DONE.
  4319. I.e., the task will automatically be forwarded until completed.
  4320. @example
  4321. *** TODO Call Trillian for a date on New Years Eve.
  4322. SCHEDULED: <2004-12-25 Sat>
  4323. @end example
  4324. @noindent
  4325. @b{Important:} Scheduling an item in Org mode should @i{not} be
  4326. understood in the same way that we understand @i{scheduling a meeting}.
  4327. Setting a date for a meeting is just a simple appointment, you should
  4328. mark this entry with a simple plain time stamp, to get this item shown
  4329. on the date where it applies. This is a frequent mis-understanding from
  4330. Org-users. In Org mode, @i{scheduling} means setting a date when you
  4331. want to start working on an action item.
  4332. @end table
  4333. You may use time stamps with repeaters in scheduling and deadline
  4334. entries. Org mode will issue early and late warnings based on the
  4335. assumption that the time stamp represents the @i{nearest instance} of
  4336. the repeater. However, the use of diary sexp entries like
  4337. @c
  4338. @code{<%%(diary-float t 42)>}
  4339. @c
  4340. in scheduling and deadline timestamps is limited. Org mode does not
  4341. know enough about the internals of each sexp function to issue early and
  4342. late warnings. However, it will show the item on each day where the
  4343. sexp entry matches.
  4344. @menu
  4345. * Inserting deadline/schedule:: Planning items
  4346. * Repeated tasks:: Items that show up again and again
  4347. @end menu
  4348. @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
  4349. @subsection Inserting deadlines or schedules
  4350. The following commands allow to quickly insert a deadline or to schedule
  4351. an item:
  4352. @table @kbd
  4353. @c
  4354. @kindex C-c C-d
  4355. @item C-c C-d
  4356. Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
  4357. happen in the line directly following the headline. When called with a
  4358. prefix arg, an existing deadline will be removed from the entry.
  4359. @c FIXME Any CLOSED timestamp will be removed.????????
  4360. @c
  4361. @kindex C-c / d
  4362. @cindex sparse tree, for deadlines
  4363. @item C-c / d
  4364. @vindex org-deadline-warning-days
  4365. Create a sparse tree with all deadlines that are either past-due, or
  4366. which will become due within @code{org-deadline-warning-days}.
  4367. With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
  4368. prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
  4369. all deadlines due tomorrow.
  4370. @c
  4371. @kindex C-c C-s
  4372. @item C-c C-s
  4373. Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
  4374. happen in the line directly following the headline. Any CLOSED
  4375. timestamp will be removed. When called with a prefix argument, remove
  4376. the scheduling date from the entry.
  4377. @c
  4378. @kindex C-c C-x C-k
  4379. @kindex k a
  4380. @kindex k s
  4381. @item C-c C-x C-k
  4382. Mark the current entry for agenda action. After you have marked the entry
  4383. like this, you can open the agenda or the calendar to find an appropriate
  4384. date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
  4385. schedule the marked item.
  4386. @end table
  4387. @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
  4388. @subsection Repeated tasks
  4389. Some tasks need to be repeated again and again. Org mode helps to
  4390. organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
  4391. or plain time stamp. In the following example
  4392. @example
  4393. ** TODO Pay the rent
  4394. DEADLINE: <2005-10-01 Sat +1m>
  4395. @end example
  4396. the @code{+1m} is a repeater; the intended interpretation is that the task
  4397. has a deadline on <2005-10-01> and repeats itself every (one) month starting
  4398. from that time. If you need both a repeater and a special warning period in
  4399. a deadline entry, the repeater should come first and the warning period last:
  4400. @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
  4401. Deadlines and scheduled items produce entries in the agenda when they
  4402. are over-due, so it is important to be able to mark such an entry as
  4403. completed once you have done so. When you mark a DEADLINE or a SCHEDULE
  4404. with the TODO keyword DONE, it will no longer produce entries in the
  4405. agenda. The problem with this is, however, that then also the
  4406. @emph{next} instance of the repeated entry will not be active. Org mode
  4407. deals with this in the following way: When you try to mark such an entry
  4408. DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
  4409. time stamp by the repeater interval, and immediately set the entry state
  4410. back to TODO. In the example above, setting the state to DONE would
  4411. actually switch the date like this:
  4412. @example
  4413. ** TODO Pay the rent
  4414. DEADLINE: <2005-11-01 Tue +1m>
  4415. @end example
  4416. @vindex org-log-repeat
  4417. A timestamp@footnote{You can change this using the option
  4418. @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
  4419. @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
  4420. will also be prompted for a note.} will be added under the deadline, to keep
  4421. a record that you actually acted on the previous instance of this deadline.
  4422. As a consequence of shifting the base date, this entry will no longer be
  4423. visible in the agenda when checking past dates, but all future instances
  4424. will be visible.
  4425. With the @samp{+1m} cookie, the date shift will always be exactly one
  4426. month. So if you have not payed the rent for three months, marking this
  4427. entry DONE will still keep it as an overdue deadline. Depending on the
  4428. task, this may not be the best way to handle it. For example, if you
  4429. forgot to call you father for 3 weeks, it does not make sense to call
  4430. him 3 times in a single day to make up for it. Finally, there are tasks
  4431. like changing batteries which should always repeat a certain time
  4432. @i{after} the last time you did it. For these tasks, Org mode has
  4433. special repeaters markers with @samp{++} and @samp{.+}. For example:
  4434. @example
  4435. ** TODO Call Father
  4436. DEADLINE: <2008-02-10 Sun ++1w>
  4437. Marking this DONE will shift the date by at least one week,
  4438. but also by as many weeks as it takes to get this date into
  4439. the future. However, it stays on a Sunday, even if you called
  4440. and marked it done on Saturday.
  4441. ** TODO Check the batteries in the smoke detectors
  4442. DEADLINE: <2005-11-01 Tue .+1m>
  4443. Marking this DONE will shift the date to one month after
  4444. today.
  4445. @end example
  4446. You may have both scheduling and deadline information for a specific
  4447. task - just make sure that the repeater intervals on both are the same.
  4448. @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
  4449. @section Clocking work time
  4450. Org mode allows you to clock the time you spent on specific tasks in a
  4451. project. When you start working on an item, you can start the clock.
  4452. When you stop working on that task, or when you mark the task done, the
  4453. clock is stopped and the corresponding time interval is recorded. It
  4454. also computes the total time spent on each subtree of a project.
  4455. Normally, the clock does not survive xiting and re-entereing Emacs, but you
  4456. can arrange for the clock information to persisst accress Emacs sessions with
  4457. @lisp
  4458. (setq org-clock-persist t)
  4459. (org-clock-persistence-insinuate)
  4460. @end lisp
  4461. @table @kbd
  4462. @kindex C-c C-x C-i
  4463. @item C-c C-x C-i
  4464. @vindex org-clock-into-drawer
  4465. Start the clock on the current item (clock-in). This inserts the CLOCK
  4466. keyword together with a timestamp. If this is not the first clocking of
  4467. this item, the multiple CLOCK lines will be wrapped into a
  4468. @code{:CLOCK:} drawer (see also the variable
  4469. @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
  4470. select the task from a list of recently clocked tasks. With two @kbd{C-u
  4471. C-u} prefixes, clock into the task at point and mark it as the default task.
  4472. The default task will always be available when selecting a clocking task,
  4473. with letter @kbd{d}.
  4474. @kindex C-c C-x C-o
  4475. @item C-c C-x C-o
  4476. @vindex org-log-note-clock-out
  4477. Stop the clock (clock-out). This inserts another timestamp at the same
  4478. location where the clock was last started. It also directly computes
  4479. the resulting time in inserts it after the time range as @samp{=>
  4480. HH:MM}. See the variable @code{org-log-note-clock-out} for the
  4481. possibility to record an additional note together with the clock-out
  4482. time stamp@footnote{The corresponding in-buffer setting is:
  4483. @code{#+STARTUP: lognoteclock-out}}.
  4484. @kindex C-c C-y
  4485. @item C-c C-y
  4486. Recompute the time interval after changing one of the time stamps. This
  4487. is only necessary if you edit the time stamps directly. If you change
  4488. them with @kbd{S-@key{cursor}} keys, the update is automatic.
  4489. @kindex C-c C-t
  4490. @item C-c C-t
  4491. Changing the TODO state of an item to DONE automatically stops the clock
  4492. if it is running in this same item.
  4493. @kindex C-c C-x C-x
  4494. @item C-c C-x C-x
  4495. Cancel the current clock. This is useful if a clock was started by
  4496. mistake, or if you ended up working on something else.
  4497. @kindex C-c C-x C-j
  4498. @item C-c C-x C-j
  4499. Jump to the entry that contains the currently running clock. With a
  4500. @kbd{C-u} prefix arg, select the target task from a list of recently clocked
  4501. tasks.
  4502. @kindex C-c C-x C-d
  4503. @item C-c C-x C-d
  4504. @vindex org-remove-highlights-with-change
  4505. Display time summaries for each subtree in the current buffer. This
  4506. puts overlays at the end of each headline, showing the total time
  4507. recorded under that heading, including the time of any subheadings. You
  4508. can use visibility cycling to study the tree, but the overlays disappear
  4509. when you change the buffer (see variable
  4510. @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
  4511. @kindex C-c C-x C-r
  4512. @item C-c C-x C-r
  4513. Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
  4514. report as an Org mode table into the current file. When the cursor is
  4515. at an existing clock table, just update it. When called with a prefix
  4516. argument, jump to the first clock report in the current document and
  4517. update it.
  4518. @cindex #+BEGIN: clocktable
  4519. @example
  4520. #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
  4521. #+END: clocktable
  4522. @end example
  4523. @noindent
  4524. If such a block already exists at point, its content is replaced by the
  4525. new table. The @samp{BEGIN} line can specify options:
  4526. @example
  4527. :maxlevel @r{Maximum level depth to which times are listed in the table.}
  4528. :emphasize @r{When @code{t}, emphasize level one and level two items}
  4529. :scope @r{The scope to consider. This can be any of the following:}
  4530. nil @r{the current buffer or narrowed region}
  4531. file @r{the full current buffer}
  4532. subtree @r{the subtree where the clocktable is located}
  4533. treeN @r{the surrounding level N tree, for example @code{tree3}}
  4534. tree @r{the surrounding level 1 tree}
  4535. agenda @r{all agenda files}
  4536. ("file"..) @r{scan these files}
  4537. file-with-archives @r{current file and its archives}
  4538. agenda-with-archives @r{all agenda files, including archives}
  4539. :block @r{The time block to consider. This block is specified either}
  4540. @r{absolute, or relative to the current time and may be any of}
  4541. @r{these formats:}
  4542. 2007-12-31 @r{New year eve 2007}
  4543. 2007-12 @r{December 2007}
  4544. 2007-W50 @r{ISO-week 50 in 2007}
  4545. 2007 @r{the year 2007}
  4546. today, yesterday, today-N @r{a relative day}
  4547. thisweek, lastweek, thisweek-N @r{a relative week}
  4548. thismonth, lastmonth, thismonth-N @r{a relative month}
  4549. thisyear, lastyear, thisyear-N @r{a relative year}
  4550. @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
  4551. :tstart @r{A time string specifying when to start considering times}
  4552. :tend @r{A time string specifying when to stop considering times}
  4553. :step @r{@code{week} or @code{day}, to split the table into chunks.}
  4554. @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
  4555. :link @r{Link the item headlines in the table to their origins}
  4556. :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
  4557. @r{As a special case, @samp{:formula %} adds column with % time.}
  4558. @r{If you do not specify a formula here, any existing formula}
  4559. @r{below the clock table will survive updates and be evaluated.}
  4560. @end example
  4561. So to get a clock summary of the current level 1 tree, for the current
  4562. day, you could write
  4563. @example
  4564. #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
  4565. #+END: clocktable
  4566. @end example
  4567. and to use a specific time range you could write@footnote{Note that all
  4568. parameters must be specified in a single line - the line is broken here
  4569. only to fit it onto the manual.}
  4570. @example
  4571. #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
  4572. :tend "<2006-08-10 Thu 12:00>"
  4573. #+END: clocktable
  4574. @end example
  4575. A summary of the current subtree with % times would be
  4576. @example
  4577. #+BEGIN: clocktable :scope subtree :link t :formula %
  4578. #+END: clocktable
  4579. @end example
  4580. @kindex C-c C-c
  4581. @item C-c C-c
  4582. @kindex C-c C-x C-u
  4583. @itemx C-c C-x C-u
  4584. Update dynamical block at point. The cursor needs to be in the
  4585. @code{#+BEGIN} line of the dynamic block.
  4586. @kindex C-u C-c C-x C-u
  4587. @item C-u C-c C-x C-u
  4588. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  4589. you have several clock table blocks in a buffer.
  4590. @kindex S-@key{left}
  4591. @kindex S-@key{right}
  4592. @item S-@key{left}
  4593. @itemx S-@key{right}
  4594. Shift the current @code{:block} interval and update the table. The cursor
  4595. needs to be in the @code{#+BEGIN: clocktable} line for this command. If
  4596. @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
  4597. @end table
  4598. The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
  4599. the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
  4600. worked on or closed during a day.
  4601. @node Effort estimates, Relative timer, Clocking work time, Dates and Times
  4602. @section Effort estimates
  4603. @cindex effort estimates
  4604. @vindex org-effort-property
  4605. If you want to plan your work in a very detailed way, or if you need to
  4606. produce offers with quotations of the estimated work effort, you may want to
  4607. assign effort estimates to entries. If you are also clocking your work, you
  4608. may later want to compare the planned effort with the actual working time, a
  4609. great way to improve planning estimates. Effort estimates are stored in a
  4610. special property @samp{Effort}@footnote{You may change the property being
  4611. used with the variable @code{org-effort-property}.}. Clearly the best way to
  4612. work with effort estimates is through column view (@pxref{Column view}). You
  4613. should start by setting up discrete values for effort estimates, and a
  4614. @code{COLUMNS} format that displays these values together with clock sums (if
  4615. you want to clock your time). For a specific buffer you can use
  4616. @example
  4617. #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
  4618. #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
  4619. @end example
  4620. @noindent
  4621. @vindex org-global-properties
  4622. @vindex org-columns-default-format
  4623. or, even better, you can set up these values globally by customizing the
  4624. variables @code{org-global-properties} and @code{org-columns-default-format}.
  4625. In particular if you want to use this setup also in the agenda, a global
  4626. setup may be advised.
  4627. The way to assign estimates to individual items is then to switch to column
  4628. mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
  4629. value. The values you enter will immediately be summed up in the hierarchy.
  4630. In the column next to it, any clocked time will be displayed.
  4631. @vindex org-agenda-columns-add-appointments-to-effort-sum
  4632. If you switch to column view in the daily/weekly agenda, the effort column
  4633. will summarize the estimated work effort for each day@footnote{Please note
  4634. the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
  4635. column view}).}, and you can use this to find space in your schedule. To get
  4636. an overview of the entire part of the day that is committed, you can set the
  4637. option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
  4638. appointments on a day that take place over a specified time interval will
  4639. then also be added to the load estimate of the day.
  4640. Effort estimates can be used in secondary agenda filtering that is triggered
  4641. with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
  4642. these estimates defined consistently, two or three key presses will narrow
  4643. down the list to stuff that fits into an available time slot.
  4644. @node Relative timer, , Effort estimates, Dates and Times
  4645. @section Taking notes with a relative timer
  4646. @cindex relative timer
  4647. When taking notes during, for example, a meeting or a video viewing, it can
  4648. be useful to have access to times relative to a starting time. Org provides
  4649. such a relative timer and make it easy to create timed notes.
  4650. @table @kbd
  4651. @kindex C-c C-x .
  4652. @item C-c C-x .
  4653. Insert a relative time into the buffer. The first time you use this, the
  4654. timer will be started. When called with a prefix argument, the timer is
  4655. restarted.
  4656. @kindex C-c C-x -
  4657. @item C-c C-x -
  4658. Insert a description list item with the current relative time. With a prefix
  4659. argument, first reset the timer to 0.
  4660. @kindex M-@key{RET}
  4661. @item M-@key{RET}
  4662. Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
  4663. new timer items.
  4664. @kindex C-c C-x ,
  4665. @item C-c C-x ,
  4666. Pause the timer, or continue it if it is already paused. With prefix
  4667. argument, stop it entirely.
  4668. @kindex C-u C-c C-x ,
  4669. @item C-u C-c C-x ,
  4670. Stop the timer. After this, you can only start a new timer, not continue the
  4671. old one. This command also removes the timer from the mode line.
  4672. @kindex C-c C-x 0
  4673. @item C-c C-x 0
  4674. Reset the timer without inserting anything into the buffer. By default, the
  4675. timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
  4676. specific starting offset. The user is prompted for the offset, with a
  4677. default taken from a timer string at point, if any, So this can be used to
  4678. restart taking notes after a break in the process. When called with a double
  4679. prefix argument @kbd{C-c C-u}, change all timer strings in the active region
  4680. by a certain amount. This can be used to fix timer strings if the timer was
  4681. not started at exactly the right moment.
  4682. @end table
  4683. @node Capture, Agenda Views, Dates and Times, Top
  4684. @chapter Capture
  4685. @cindex capture
  4686. An important part of any organization system is the ability to quickly
  4687. capture new ideas and tasks, and to associate reference material with them.
  4688. Org uses the @file{remember} package to create tasks, and stores files
  4689. related to a task (@i{attachments}) in a special directory.
  4690. @menu
  4691. * Remember:: Capture new tasks/ideas with little interruption
  4692. * Attachments:: Add files to tasks.
  4693. @end menu
  4694. @node Remember, Attachments, Capture, Capture
  4695. @section Remember
  4696. @cindex @file{remember.el}
  4697. The @i{Remember} package by John Wiegley lets you store quick notes with
  4698. little interruption of your work flow. See
  4699. @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
  4700. information. It is an excellent way to add new notes and tasks to
  4701. Org files. Org significantly expands the possibilities of
  4702. @i{remember}: You may define templates for different note types, and
  4703. associate target files and headlines with specific templates. It also
  4704. allows you to select the location where a note should be stored
  4705. interactively, on the fly.
  4706. @menu
  4707. * Setting up Remember:: Some code for .emacs to get things going
  4708. * Remember templates:: Define the outline of different note types
  4709. * Storing notes:: Directly get the note to where it belongs
  4710. * Refiling notes:: Moving a note or task to a project
  4711. @end menu
  4712. @node Setting up Remember, Remember templates, Remember, Remember
  4713. @subsection Setting up Remember
  4714. The following customization will tell @i{remember} to use org files as
  4715. target, and to create annotations compatible with Org links.
  4716. @example
  4717. (org-remember-insinuate)
  4718. (setq org-directory "~/path/to/my/orgfiles/")
  4719. (setq org-default-notes-file (concat org-directory "/notes.org"))
  4720. (define-key global-map "\C-cr" 'org-remember)
  4721. @end example
  4722. The last line binds the command @code{org-remember} to a global
  4723. key@footnote{Please select your own key, @kbd{C-c r} is only a
  4724. suggestion.}. @code{org-remember} basically just calls @code{remember},
  4725. but it makes a few things easier: If there is an active region, it will
  4726. automatically copy the region into the remember buffer. It also allows
  4727. to jump to the buffer and location where remember notes are being
  4728. stored: Just call @code{org-remember} with a prefix argument. If you
  4729. use two prefix arguments, Org jumps to the location where the last
  4730. remember note was stored.
  4731. The remember buffer will actually use @code{org-mode} as its major mode, so
  4732. that all editing features of Org-mode are available. In addition to this, a
  4733. minor mode @code{org-remember-mode} is turned on, for the single purpose that
  4734. you can use its keymap @code{org-remember-mode-map} to overwrite some of
  4735. Org-mode's key bindings.
  4736. You can also call @code{org-remember} in a special way from the agenda,
  4737. using the @kbd{k r} key combination. With this access, any time stamps
  4738. inserted by the selected remember template (see below) will default to
  4739. the cursor date in the agenda, rather than to the current date.
  4740. @node Remember templates, Storing notes, Setting up Remember, Remember
  4741. @subsection Remember templates
  4742. @cindex templates, for remember
  4743. In combination with Org, you can use templates to generate
  4744. different types of @i{remember} notes. For example, if you would like
  4745. to use one template to create general TODO entries, another one for
  4746. journal entries, and a third one for collecting random ideas, you could
  4747. use:
  4748. @example
  4749. (setq org-remember-templates
  4750. '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
  4751. ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
  4752. ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
  4753. @end example
  4754. @vindex org-remember-default-headline
  4755. @vindex org-directory
  4756. @noindent In these entries, the first string is just a name, and the
  4757. character specifies how to select the template. It is useful if the
  4758. character is also the first letter of the name. The next string specifies
  4759. the template. Two more (optional) strings give the file in which, and the
  4760. headline under which the new note should be stored. The file (if not present
  4761. or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
  4762. @code{org-remember-default-headline}. If the file name is not an absolute
  4763. path, it will be interpreted relative to @code{org-directory}. The heading
  4764. can also be the symbols @code{top} or @code{bottom} to send note as level 1
  4765. entries to the beginning or end of the file, respectively.
  4766. An optional sixth element specifies the contexts in which the user can select
  4767. the template. This element can be a list of major modes or a function.
  4768. @code{org-remember} will first check whether the function returns @code{t} or
  4769. if we are in any of the listed major mode, and exclude templates for which
  4770. this condition is not fulfilled. Templates that do not specify this element
  4771. at all, or that use @code{nil} or @code{t} as a value will always be
  4772. selectable.
  4773. So for example:
  4774. @example
  4775. (setq org-remember-templates
  4776. '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
  4777. ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check)
  4778. ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
  4779. @end example
  4780. The first template will only be available when invoking @code{org-remember}
  4781. from an buffer in @code{emacs-lisp-mode}. The second template will only be
  4782. available when the function @code{my-check} returns @code{t}. The third
  4783. template will be proposed in any context.
  4784. When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
  4785. something, Org will prompt for a key to select the template (if you have
  4786. more than one template) and then prepare the buffer like
  4787. @example
  4788. * TODO
  4789. [[file:link to where you called remember]]
  4790. @end example
  4791. @noindent
  4792. During expansion of the template, special @kbd{%}-escapes allow dynamic
  4793. insertion of content:
  4794. @example
  4795. %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.}
  4796. @r{You may specify a default value and a completion table with}
  4797. @r{%^@{prompt|default|completion2|completion3...@}}
  4798. @r{The arrow keys access a prompt-specific history.}
  4799. %a @r{annotation, normally the link created with @code{org-store-link}}
  4800. %A @r{like @code{%a}, but prompt for the description part}
  4801. %i @r{initial content, the region when remember is called with C-u.}
  4802. @r{The entire text will be indented like @code{%i} itself.}
  4803. %t @r{time stamp, date only}
  4804. %T @r{time stamp with date and time}
  4805. %u, %U @r{like the above, but inactive time stamps}
  4806. %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
  4807. @r{You may define a prompt like @code{%^@{Birthday@}t}}
  4808. %n @r{user name (taken from @code{user-full-name})}
  4809. %c @r{Current kill ring head.}
  4810. %x @r{Content of the X clipboard.}
  4811. %^C @r{Interactive selection of which kill or clip to use.}
  4812. %^L @r{Like @code{%^C}, but insert as link.}
  4813. %^g @r{prompt for tags, with completion on tags in target file.}
  4814. %k @r{title of currently clocked task}
  4815. %K @r{link to currently clocked task}
  4816. %^G @r{prompt for tags, with completion all tags in all agenda files.}
  4817. %^@{prop@}p @r{Prompt the user for a value for property @code{prop}}
  4818. %:keyword @r{specific information for certain link types, see below}
  4819. %[pathname] @r{insert the contents of the file given by @code{pathname}}
  4820. %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result}
  4821. %! @r{immediately store note after completing the template}
  4822. @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
  4823. %& @r{jump to target location immediately after storing note}
  4824. @end example
  4825. @noindent
  4826. For specific link types, the following keywords will be
  4827. defined@footnote{If you define your own link types (@pxref{Adding
  4828. hyperlink types}), any property you store with
  4829. @code{org-store-link-props} can be accessed in remember templates in a
  4830. similar way.}:
  4831. @vindex org-from-is-user-regexp
  4832. @example
  4833. Link type | Available keywords
  4834. -------------------+----------------------------------------------
  4835. bbdb | %:name %:company
  4836. bbdb | %::server %:port %:nick
  4837. vm, wl, mh, rmail | %:type %:subject %:message-id
  4838. | %:from %:fromname %:fromaddress
  4839. | %:to %:toname %:toaddress
  4840. | %: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}.}}
  4841. gnus | %:group, @r{for messages also all email fields}
  4842. w3, w3m | %:url
  4843. info | %:file %:node
  4844. calendar | %:date"
  4845. @end example
  4846. @noindent
  4847. To place the cursor after template expansion use:
  4848. @example
  4849. %? @r{After completing the template, position cursor here.}
  4850. @end example
  4851. @noindent
  4852. If you change your mind about which template to use, call
  4853. @code{org-remember} in the remember buffer. You may then select a new
  4854. template that will be filled with the previous context information.
  4855. @node Storing notes, Refiling notes, Remember templates, Remember
  4856. @subsection Storing notes
  4857. @vindex org-remember-clock-out-on-exit
  4858. When you are finished preparing a note with @i{remember}, you have to press
  4859. @kbd{C-c C-c} to file the note away. If you have started the clock in the
  4860. remember buffer, you will first be asked if you want to clock out
  4861. now@footnote{To avoid this query, configure the variable
  4862. @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
  4863. will continue to run after the note was filed away.
  4864. The handler will then store the note in the file and under the headline
  4865. specified in the template, or it will use the default file and headlines.
  4866. The window configuration will be restored, sending you back to the working
  4867. context before the call to @code{remember}. To re-use the location found
  4868. during the last call to @code{remember}, exit the remember buffer with
  4869. @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}.
  4870. Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
  4871. the currently clocked item.
  4872. @vindex org-remember-store-without-prompt
  4873. If you want to store the note directly to a different place, use
  4874. @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the
  4875. variable @code{org-remember-store-without-prompt} to make this behavior
  4876. the default.}. The handler will then first prompt for a target file -
  4877. if you press @key{RET}, the value specified for the template is used.
  4878. Then the command offers the headings tree of the selected file, with the
  4879. cursor position at the default headline (if you had specified one in the
  4880. template). You can either immediately press @key{RET} to get the note
  4881. placed there. Or you can use the following keys to find a different
  4882. location:
  4883. @example
  4884. @key{TAB} @r{Cycle visibility.}
  4885. @key{down} / @key{up} @r{Next/previous visible headline.}
  4886. n / p @r{Next/previous visible headline.}
  4887. f / b @r{Next/previous headline same level.}
  4888. u @r{One level up.}
  4889. @c 0-9 @r{Digit argument.}
  4890. @end example
  4891. @noindent
  4892. Pressing @key{RET} or @key{left} or @key{right}
  4893. then leads to the following result.
  4894. @vindex org-reverse-note-order
  4895. @multitable @columnfractions 0.2 0.15 0.65
  4896. @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
  4897. @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
  4898. @item @tab @tab depending on @code{org-reverse-note-order}.
  4899. @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
  4900. @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
  4901. @item @tab @tab depending on @code{org-reverse-note-order}.
  4902. @item not on headline @tab @key{RET}
  4903. @tab at cursor position, level taken from context.
  4904. @end multitable
  4905. Before inserting the text into a tree, the function ensures that the text has
  4906. a headline, i.e. a first line that starts with a @samp{*}. If not, a
  4907. headline is constructed from the current date. If you have indented the text
  4908. of the note below the headline, the indentation will be adapted if inserting
  4909. the note into the tree requires demotion from level 1.
  4910. @node Refiling notes, , Storing notes, Remember
  4911. @subsection Refiling notes
  4912. @cindex refiling notes
  4913. Remember is usually used to quickly capture notes and tasks into one or
  4914. a few capture lists. When reviewing the captured data, you may want to
  4915. refile some of the entries into a different list, for example into a
  4916. project. Cutting, finding the right location and then pasting the note
  4917. is cumbersome. To simplify this process, you can use the following
  4918. special command:
  4919. @table @kbd
  4920. @kindex C-c C-w
  4921. @item C-c C-w
  4922. @vindex org-reverse-note-order
  4923. @vindex org-refile-targets
  4924. @vindex org-refile-use-outline-path
  4925. @vindex org-outline-path-complete-in-steps
  4926. Refile the entry or region at point. This command offers possible locations
  4927. for refiling the entry and lets you select one with completion. The item (or
  4928. all items in the region) is filed below the target heading as a subitem.
  4929. Depending on @code{org-reverse-note-order}, it will be either the first or
  4930. last subitem.@*
  4931. By default, all level 1 headlines in the current buffer are considered to be
  4932. targets, but you can have more complex definitions across a number of files.
  4933. See the variable @code{org-refile-targets} for details. If you would like to
  4934. select a location via a file-path-like completion along the outline path, see
  4935. the variables @code{org-refile-use-outline-path} and
  4936. @code{org-outline-path-complete-in-steps}.
  4937. @kindex C-u C-c C-w
  4938. @item C-u C-c C-w
  4939. Use the refile interface to jump to a heading.
  4940. @kindex C-u C-u C-c C-w
  4941. @item C-u C-u C-c C-w
  4942. Jump to the location where @code{org-refile} last moved a tree to.
  4943. @end table
  4944. @node Attachments, , Remember, Capture
  4945. @section Attachments
  4946. @cindex attachments
  4947. @vindex org-attach-directory
  4948. It is often useful to associate reference material with an outline node/task.
  4949. Small chunks of plain text can simply be stored in the subtree of a project.
  4950. Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
  4951. files that live elsewhere on your computer or in the cloud, like emails or
  4952. source code files belonging to a project. Another method is @i{attachments},
  4953. which are files located in a directory belonging to an outline node. Org
  4954. uses directories named by the unique ID of each entry. These directories are
  4955. located in the @file{data} directory which lives in the same directory where
  4956. your org-file lives@footnote{If you move entries or Org-files from one
  4957. directory to the next, you may want to configure @code{org-attach-directory}
  4958. to contain an absolute path.}. If you initialize this directory with
  4959. @code{git init}, Org will automatically commit changes when it sees them.
  4960. The attachment system has been contributed to Org by John Wiegley.
  4961. In cases where this seems better, you can also attach a directory of your
  4962. choice to an entry. You can also make children inherit the attachment
  4963. directory from a parent, so that an entire subtree uses the same attached
  4964. directory.
  4965. @noindent The following commands deal with attachments.
  4966. @table @kbd
  4967. @kindex C-c C-a
  4968. @item C-c C-a
  4969. The dispatcher for commands related to the attachment system. After these
  4970. keys, a list of commands is displayed and you need to press an additional key
  4971. to select a command:
  4972. @table @kbd
  4973. @kindex C-c C-a a
  4974. @item a
  4975. @vindex org-attach-method
  4976. Select a file and move it into the task's attachment directory. The file
  4977. will be copied, moved, or linked, depending on @code{org-attach-method}.
  4978. Note that hard links are not supported on all systems.
  4979. @kindex C-c C-a c
  4980. @kindex C-c C-a m
  4981. @kindex C-c C-a l
  4982. @item c/m/l
  4983. Attach a file using the copy/move/link method.
  4984. Note that hard links are not supported on all systems.
  4985. @kindex C-c C-a n
  4986. @item n
  4987. Create a new attachment as an Emacs buffer.
  4988. @kindex C-c C-a z
  4989. @item z
  4990. Synchronize the current task with its attachment directory, in case you added
  4991. attachments yourself.
  4992. @kindex C-c C-a o
  4993. @item o
  4994. @vindex org-file-apps
  4995. Open current task's attachment. If there are more than one, prompt for a
  4996. file name first. Opening will follow the rules set by @code{org-file-apps}.
  4997. For more details, see the information on following hyperlinks
  4998. (@pxref{Handling links}).
  4999. @kindex C-c C-a O
  5000. @item O
  5001. Also open the attachment, but force opening the file in Emacs.
  5002. @kindex C-c C-a f
  5003. @item f
  5004. Open the current task's attachment directory.
  5005. @kindex C-c C-a F
  5006. @item F
  5007. Also open the directory, but force using @code{dired} in Emacs.
  5008. @kindex C-c C-a d
  5009. @item d
  5010. Select and delete a single attachment.
  5011. @kindex C-c C-a D
  5012. @item D
  5013. Delete all of a task's attachments. A safer way is to open the directory in
  5014. dired and delete from there.
  5015. @kindex C-c C-a s
  5016. @item C-c C-a s
  5017. Set a specific directory as the entry's attachment directory. This works by
  5018. putting the directory path into the @code{ATTACH_DIR} property.
  5019. @kindex C-c C-a i
  5020. @item C-c C-a i
  5021. Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
  5022. same directory for attachments as the parent.
  5023. @end table
  5024. @end table
  5025. @node Agenda Views, Embedded LaTeX, Capture, Top
  5026. @chapter Agenda Views
  5027. @cindex agenda views
  5028. Due to the way Org works, TODO items, time-stamped items, and
  5029. tagged headlines can be scattered throughout a file or even a number of
  5030. files. To get an overview of open action items, or of events that are
  5031. important for a particular date, this information must be collected,
  5032. sorted and displayed in an organized way.
  5033. Org can select items based on various criteria, and display them
  5034. in a separate buffer. Seven different view types are provided:
  5035. @itemize @bullet
  5036. @item
  5037. an @emph{agenda} that is like a calendar and shows information
  5038. for specific dates,
  5039. @item
  5040. a @emph{TODO list} that covers all unfinished
  5041. action items,
  5042. @item
  5043. a @emph{match view}, showings headlines based on the tags, properties and
  5044. TODO state associated with them,
  5045. @item
  5046. a @emph{timeline view} that shows all events in a single Org file,
  5047. in time-sorted view,
  5048. @item
  5049. a @emph{keyword search view} that shows all entries from multiple files
  5050. that contain specified keywords.
  5051. @item
  5052. a @emph{stuck projects view} showing projects that currently don't move
  5053. along, and
  5054. @item
  5055. @emph{custom views} that are special tag/keyword searches and
  5056. combinations of different views.
  5057. @end itemize
  5058. @noindent
  5059. The extracted information is displayed in a special @emph{agenda
  5060. buffer}. This buffer is read-only, but provides commands to visit the
  5061. corresponding locations in the original Org files, and even to
  5062. edit these files remotely.
  5063. @vindex org-agenda-window-setup
  5064. @vindex org-agenda-restore-windows-after-quit
  5065. Two variables control how the agenda buffer is displayed and whether the
  5066. window configuration is restored when the agenda exits:
  5067. @code{org-agenda-window-setup} and
  5068. @code{org-agenda-restore-windows-after-quit}.
  5069. @menu
  5070. * Agenda files:: Files being searched for agenda information
  5071. * Agenda dispatcher:: Keyboard access to agenda views
  5072. * Built-in agenda views:: What is available out of the box?
  5073. * Presentation and sorting:: How agenda items are prepared for display
  5074. * Agenda commands:: Remote editing of Org trees
  5075. * Custom agenda views:: Defining special searches and views
  5076. * Agenda column view:: Using column view for collected entries
  5077. @end menu
  5078. @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
  5079. @section Agenda files
  5080. @cindex agenda files
  5081. @cindex files for agenda
  5082. @vindex org-agenda-files
  5083. The information to be shown is normally collected from all @emph{agenda
  5084. files}, the files listed in the variable
  5085. @code{org-agenda-files}@footnote{If the value of that variable is not a
  5086. list, but a single file name, then the list of agenda files will be
  5087. maintained in that external file.}. If a directory is part of this list,
  5088. all files with the extension @file{.org} in this directory will be part
  5089. of the list.
  5090. Thus even if you only work with a single Org file, this file should
  5091. be put into that list@footnote{When using the dispatcher, pressing
  5092. @kbd{<} before selecting a command will actually limit the command to
  5093. the current file, and ignore @code{org-agenda-files} until the next
  5094. dispatcher command.}. You can customize @code{org-agenda-files}, but
  5095. the easiest way to maintain it is through the following commands
  5096. @cindex files, adding to agenda list
  5097. @table @kbd
  5098. @kindex C-c [
  5099. @item C-c [
  5100. Add current file to the list of agenda files. The file is added to
  5101. the front of the list. If it was already in the list, it is moved to
  5102. the front. With a prefix argument, file is added/moved to the end.
  5103. @kindex C-c ]
  5104. @item C-c ]
  5105. Remove current file from the list of agenda files.
  5106. @kindex C-,
  5107. @kindex C-'
  5108. @item C-,
  5109. @itemx C-'
  5110. Cycle through agenda file list, visiting one file after the other.
  5111. @kindex M-x org-iswitchb
  5112. @item M-x org-iswitchb
  5113. Command to use an @code{iswitchb}-like interface to switch to and between Org
  5114. buffers.
  5115. @end table
  5116. @noindent
  5117. The Org menu contains the current list of files and can be used
  5118. to visit any of them.
  5119. If you would like to focus the agenda temporarily onto a file not in
  5120. this list, or onto just one file in the list or even only a subtree in a
  5121. file, this can be done in different ways. For a single agenda command,
  5122. you may press @kbd{<} once or several times in the dispatcher
  5123. (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
  5124. extended period, use the following commands:
  5125. @table @kbd
  5126. @kindex C-c C-x <
  5127. @item C-c C-x <
  5128. Permanently restrict the agenda to the current subtree. When with a
  5129. prefix argument, or with the cursor before the first headline in a file,
  5130. the agenda scope is set to the entire file. This restriction remains in
  5131. effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
  5132. or @kbd{>} in the agenda dispatcher. If there is a window displaying an
  5133. agenda view, the new restriction takes effect immediately.
  5134. @kindex C-c C-x >
  5135. @item C-c C-x >
  5136. Remove the permanent restriction created by @kbd{C-c C-x <}.
  5137. @end table
  5138. @noindent
  5139. When working with @file{Speedbar}, you can use the following commands in
  5140. the Speedbar frame:
  5141. @table @kbd
  5142. @kindex <
  5143. @item < @r{in the speedbar frame}
  5144. Permanently restrict the agenda to the item at the cursor in the
  5145. Speedbar frame, either an Org file or a subtree in such a file.
  5146. If there is a window displaying an agenda view, the new restriction takes
  5147. effect immediately.
  5148. @kindex >
  5149. @item > @r{in the speedbar frame}
  5150. Lift the restriction again.
  5151. @end table
  5152. @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
  5153. @section The agenda dispatcher
  5154. @cindex agenda dispatcher
  5155. @cindex dispatching agenda commands
  5156. The views are created through a dispatcher that should be bound to a
  5157. global key, for example @kbd{C-c a} (@pxref{Installation}). In the
  5158. following we will assume that @kbd{C-c a} is indeed how the dispatcher
  5159. is accessed and list keyboard access to commands accordingly. After
  5160. pressing @kbd{C-c a}, an additional letter is required to execute a
  5161. command. The dispatcher offers the following default commands:
  5162. @table @kbd
  5163. @item a
  5164. Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
  5165. @item t @r{/} T
  5166. Create a list of all TODO items (@pxref{Global TODO list}).
  5167. @item m @r{/} M
  5168. Create a list of headlines matching a TAGS expression (@pxref{Matching
  5169. tags and properties}).
  5170. @item L
  5171. Create the timeline view for the current buffer (@pxref{Timeline}).
  5172. @item s
  5173. Create a list of entries selected by a boolean expression of keywords
  5174. and/or regular expressions that must or must not occur in the entry.
  5175. @item /
  5176. @vindex org-agenda-text-search-extra-files
  5177. Search for a regular expression in all agenda files and additionally in
  5178. the files listed in @code{org-agenda-text-search-extra-files}. This
  5179. uses the Emacs command @code{multi-occur}. A prefix argument can be
  5180. used to specify the number of context lines for each match, default is
  5181. 1.
  5182. @item # @r{/} !
  5183. Create a list of stuck projects (@pxref{Stuck projects}).
  5184. @item <
  5185. Restrict an agenda command to the current buffer@footnote{For backward
  5186. compatibility, you can also press @kbd{1} to restrict to the current
  5187. buffer.}. After pressing @kbd{<}, you still need to press the character
  5188. selecting the command.
  5189. @item < <
  5190. If there is an active region, restrict the following agenda command to
  5191. the region. Otherwise, restrict it to the current subtree@footnote{For
  5192. backward compatibility, you can also press @kbd{0} to restrict to the
  5193. current buffer.}. After pressing @kbd{< <}, you still need to press the
  5194. character selecting the command.
  5195. @end table
  5196. You can also define custom commands that will be accessible through the
  5197. dispatcher, just like the default commands. This includes the
  5198. possibility to create extended agenda buffers that contain several
  5199. blocks together, for example the weekly agenda, the global TODO list and
  5200. a number of special tags matches. @xref{Custom agenda views}.
  5201. @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
  5202. @section The built-in agenda views
  5203. In this section we describe the built-in views.
  5204. @menu
  5205. * Weekly/daily agenda:: The calendar page with current tasks
  5206. * Global TODO list:: All unfinished action items
  5207. * Matching tags and properties:: Structured information with fine-tuned search
  5208. * Timeline:: Time-sorted view for single file
  5209. * Keyword search:: Finding entries by keyword
  5210. * Stuck projects:: Find projects you need to review
  5211. @end menu
  5212. @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
  5213. @subsection The weekly/daily agenda
  5214. @cindex agenda
  5215. @cindex weekly agenda
  5216. @cindex daily agenda
  5217. The purpose of the weekly/daily @emph{agenda} is to act like a page of a
  5218. paper agenda, showing all the tasks for the current week or day.
  5219. @table @kbd
  5220. @cindex org-agenda, command
  5221. @kindex C-c a a
  5222. @item C-c a a
  5223. @vindex org-agenda-ndays
  5224. Compile an agenda for the current week from a list of org files. The agenda
  5225. shows the entries for each day. With a numeric prefix@footnote{For backward
  5226. compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
  5227. listed before the agenda. This feature is deprecated, use the dedicated TODO
  5228. list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
  5229. C-c a a}) you may set the number of days to be displayed (see also the
  5230. variable @code{org-agenda-ndays})
  5231. @end table
  5232. Remote editing from the agenda buffer means, for example, that you can
  5233. change the dates of deadlines and appointments from the agenda buffer.
  5234. The commands available in the Agenda buffer are listed in @ref{Agenda
  5235. commands}.
  5236. @subsubheading Calendar/Diary integration
  5237. @cindex calendar integration
  5238. @cindex diary integration
  5239. Emacs contains the calendar and diary by Edward M. Reingold. The
  5240. calendar displays a three-month calendar with holidays from different
  5241. countries and cultures. The diary allows you to keep track of
  5242. anniversaries, lunar phases, sunrise/set, recurrent appointments
  5243. (weekly, monthly) and more. In this way, it is quite complementary to
  5244. Org. It can be very useful to combine output from Org with
  5245. the diary.
  5246. In order to include entries from the Emacs diary into Org mode's
  5247. agenda, you only need to customize the variable
  5248. @lisp
  5249. (setq org-agenda-include-diary t)
  5250. @end lisp
  5251. @noindent After that, everything will happen automatically. All diary
  5252. entries including holidays, anniversaries etc will be included in the
  5253. agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
  5254. @key{RET} can be used from the agenda buffer to jump to the diary
  5255. file in order to edit existing diary entries. The @kbd{i} command to
  5256. insert new entries for the current date works in the agenda buffer, as
  5257. well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
  5258. Sunrise/Sunset times, show lunar phases and to convert to other
  5259. calendars, respectively. @kbd{c} can be used to switch back and forth
  5260. between calendar and agenda.
  5261. If you are using the diary only for sexp entries and holidays, it is
  5262. faster to not use the above setting, but instead to copy or even move
  5263. the entries into an Org file. Org mode evaluates diary-style sexp
  5264. entries, and does it faster because there is no overhead for first
  5265. creating the diary display. Note that the sexp entries must start at
  5266. the left margin, no white space is allowed before them. For example,
  5267. the following segment of an Org file will be processed and entries
  5268. will be made in the agenda:
  5269. @example
  5270. * Birthdays and similar stuff
  5271. #+CATEGORY: Holiday
  5272. %%(org-calendar-holiday) ; special function for holiday names
  5273. #+CATEGORY: Ann
  5274. %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
  5275. %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
  5276. @end example
  5277. @subsubheading Appointment reminders
  5278. @cindex @file{appt.el}
  5279. @cindex appointment reminders
  5280. Org can interact with Emacs appointments notification facility.
  5281. To add all the appointments of your agenda files, use the command
  5282. @code{org-agenda-to-appt}. This commands also lets you filter through
  5283. the list of your appointments and add only those belonging to a specific
  5284. category or matching a regular expression. See the docstring for
  5285. details.
  5286. @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
  5287. @subsection The global TODO list
  5288. @cindex global TODO list
  5289. @cindex TODO list, global
  5290. The global TODO list contains all unfinished TODO items, formatted and
  5291. collected into a single place.
  5292. @table @kbd
  5293. @kindex C-c a t
  5294. @item C-c a t
  5295. Show the global TODO list. This collects the TODO items from all
  5296. agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
  5297. @code{agenda-mode}, so there are commands to examine and manipulate
  5298. the TODO entries directly from that buffer (@pxref{Agenda commands}).
  5299. @kindex C-c a T
  5300. @item C-c a T
  5301. @cindex TODO keyword matching
  5302. @vindex org-todo-keywords
  5303. Like the above, but allows selection of a specific TODO keyword. You
  5304. can also do this by specifying a prefix argument to @kbd{C-c a t}. With
  5305. a @kbd{C-u} prefix you are prompted for a keyword, and you may also
  5306. specify several keywords by separating them with @samp{|} as boolean OR
  5307. operator. With a numeric prefix, the Nth keyword in
  5308. @code{org-todo-keywords} is selected.
  5309. @kindex r
  5310. The @kbd{r} key in the agenda buffer regenerates it, and you can give
  5311. a prefix argument to this command to change the selected TODO keyword,
  5312. for example @kbd{3 r}. If you often need a search for a specific
  5313. keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
  5314. Matching specific TODO keywords can also be done as part of a tags
  5315. search (@pxref{Tag searches}).
  5316. @end table
  5317. Remote editing of TODO items means that you can change the state of a
  5318. TODO entry with a single key press. The commands available in the
  5319. TODO list are described in @ref{Agenda commands}.
  5320. @cindex sublevels, inclusion into TODO list
  5321. Normally the global TODO list simply shows all headlines with TODO
  5322. keywords. This list can become very long. There are two ways to keep
  5323. it more compact:
  5324. @itemize @minus
  5325. @item
  5326. @vindex org-agenda-todo-ignore-scheduled
  5327. @vindex org-agenda-todo-ignore-deadlines
  5328. @vindex org-agenda-todo-ignore-with-date
  5329. Some people view a TODO item that has been @emph{scheduled} for execution or
  5330. have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}
  5331. Configure the variables @code{org-agenda-todo-ignore-scheduled},
  5332. @code{org-agenda-todo-ignore-deadlines}, and/or
  5333. @code{org-agenda-todo-ignore-with-date} to exclude such items from the
  5334. global TODO list.
  5335. @item
  5336. @vindex org-agenda-todo-list-sublevels
  5337. TODO items may have sublevels to break up the task into subtasks. In
  5338. such cases it may be enough to list only the highest level TODO headline
  5339. and omit the sublevels from the global list. Configure the variable
  5340. @code{org-agenda-todo-list-sublevels} to get this behavior.
  5341. @end itemize
  5342. @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
  5343. @subsection Matching tags and properties
  5344. @cindex matching, of tags
  5345. @cindex matching, of properties
  5346. @cindex tags view
  5347. @cindex match view
  5348. If headlines in the agenda files are marked with @emph{tags}
  5349. (@pxref{Tags}), you can select headlines based on the tags that apply
  5350. to them and collect them into an agenda buffer.
  5351. @table @kbd
  5352. @kindex C-c a m
  5353. @item C-c a m
  5354. Produce a list of all headlines that match a given set of tags. The
  5355. command prompts for a selection criterion, which is a boolean logic
  5356. expression with tags, like @samp{+work+urgent-withboss} or
  5357. @samp{work|home} (@pxref{Tags}). If you often need a specific search,
  5358. define a custom command for it (@pxref{Agenda dispatcher}).
  5359. @kindex C-c a M
  5360. @item C-c a M
  5361. @vindex org-tags-match-list-sublevels
  5362. @vindex org-agenda-tags-todo-honor-ignore-options
  5363. Like @kbd{C-c a m}, but only select headlines that are also TODO items and
  5364. force checking subitems (see variable @code{org-tags-match-list-sublevels}).
  5365. To exclude scheduled/deadline items, see the variable
  5366. @code{org-agenda-tags-todo-honor-ignore-options}. Matching specific TODO
  5367. keywords together with a tags match is also possible, see @ref{Tag searches}.
  5368. @end table
  5369. The commands available in the tags list are described in @ref{Agenda
  5370. commands}.
  5371. @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
  5372. @subsection Timeline for a single file
  5373. @cindex timeline, single file
  5374. @cindex time-sorted view
  5375. The timeline summarizes all time-stamped items from a single Org mode
  5376. file in a @emph{time-sorted view}. The main purpose of this command is
  5377. to give an overview over events in a project.
  5378. @table @kbd
  5379. @kindex C-c a L
  5380. @item C-c a L
  5381. Show a time-sorted view of the org file, with all time-stamped items.
  5382. When called with a @kbd{C-u} prefix, all unfinished TODO entries
  5383. (scheduled or not) are also listed under the current date.
  5384. @end table
  5385. @noindent
  5386. The commands available in the timeline buffer are listed in
  5387. @ref{Agenda commands}.
  5388. @node Keyword search, Stuck projects, Timeline, Built-in agenda views
  5389. @subsection Keyword search
  5390. @cindex keyword search
  5391. @cindex searching, for keywords
  5392. This agenda view is a general text search facility for Org mode entries.
  5393. It is particularly useful to find notes.
  5394. @table @kbd
  5395. @kindex C-c a s
  5396. @item C-c a s
  5397. This is a special search that lets you select entries by keywords or
  5398. regular expression, using a boolean logic. For example, the search
  5399. string
  5400. @example
  5401. +computer +wifi -ethernet -@{8\.11[bg]@}
  5402. @end example
  5403. @noindent
  5404. will search for note entries that contain the keywords @code{computer}
  5405. and @code{wifi}, but not the keyword @code{ethernet}, and which are also
  5406. not matched by the regular expression @code{8\.11[bg]}, meaning to
  5407. exclude both 8.11b and 8.11g.
  5408. @vindex org-agenda-text-search-extra-files
  5409. Note that in addition to the agenda files, this command will also search
  5410. the files listed in @code{org-agenda-text-search-extra-files}.
  5411. @end table
  5412. @node Stuck projects, , Keyword search, Built-in agenda views
  5413. @subsection Stuck projects
  5414. If you are following a system like David Allen's GTD to organize your
  5415. work, one of the ``duties'' you have is a regular review to make sure
  5416. that all projects move along. A @emph{stuck} project is a project that
  5417. has no defined next actions, so it will never show up in the TODO lists
  5418. Org mode produces. During the review, you need to identify such
  5419. projects and define next actions for them.
  5420. @table @kbd
  5421. @kindex C-c a #
  5422. @item C-c a #
  5423. List projects that are stuck.
  5424. @kindex C-c a !
  5425. @item C-c a !
  5426. @vindex org-stuck-projects
  5427. Customize the variable @code{org-stuck-projects} to define what a stuck
  5428. project is and how to find it.
  5429. @end table
  5430. You almost certainly will have to configure this view before it will
  5431. work for you. The built-in default assumes that all your projects are
  5432. level-2 headlines, and that a project is not stuck if it has at least
  5433. one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
  5434. Let's assume that you, in your own way of using Org mode, identify
  5435. projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
  5436. indicate a project that should not be considered yet. Let's further
  5437. assume that the TODO keyword DONE marks finished projects, and that NEXT
  5438. and TODO indicate next actions. The tag @@SHOP indicates shopping and
  5439. is a next action even without the NEXT tag. Finally, if the project
  5440. contains the special word IGNORE anywhere, it should not be listed
  5441. either. In this case you would start by identifying eligible projects
  5442. with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
  5443. TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
  5444. are not stuck. The correct customization for this is
  5445. @lisp
  5446. (setq org-stuck-projects
  5447. '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
  5448. "\\<IGNORE\\>"))
  5449. @end lisp
  5450. @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
  5451. @section Presentation and sorting
  5452. @cindex presentation, of agenda items
  5453. @vindex org-agenda-prefix-format
  5454. Before displaying items in an agenda view, Org mode visually prepares
  5455. the items and sorts them. Each item occupies a single line. The line
  5456. starts with a @emph{prefix} that contains the @emph{category}
  5457. (@pxref{Categories}) of the item and other important information. You can
  5458. customize the prefix using the option @code{org-agenda-prefix-format}.
  5459. The prefix is followed by a cleaned-up version of the outline headline
  5460. associated with the item.
  5461. @menu
  5462. * Categories:: Not all tasks are equal
  5463. * Time-of-day specifications:: How the agenda knows the time
  5464. * Sorting of agenda items:: The order of things
  5465. @end menu
  5466. @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
  5467. @subsection Categories
  5468. @cindex category
  5469. The category is a broad label assigned to each agenda item. By default,
  5470. the category is simply derived from the file name, but you can also
  5471. specify it with a special line in the buffer, like this@footnote{For
  5472. backward compatibility, the following also works: If there are several
  5473. such lines in a file, each specifies the category for the text below it.
  5474. The first category also applies to any text before the first CATEGORY
  5475. line. However, using this method is @emph{strongly} deprecated as it is
  5476. incompatible with the outline structure of the document. The correct
  5477. method for setting multiple categories in a buffer is using a
  5478. property.}:
  5479. @example
  5480. #+CATEGORY: Thesis
  5481. @end example
  5482. @noindent
  5483. If you would like to have a special CATEGORY for a single entry or a
  5484. (sub)tree, give the entry a @code{:CATEGORY:} property with the
  5485. special category you want to apply as the value.
  5486. @noindent
  5487. The display in the agenda buffer looks best if the category is not
  5488. longer than 10 characters.
  5489. @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
  5490. @subsection Time-of-day specifications
  5491. @cindex time-of-day specification
  5492. Org mode checks each agenda item for a time-of-day specification. The
  5493. time can be part of the time stamp that triggered inclusion into the
  5494. agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
  5495. ranges can be specified with two time stamps, like
  5496. @c
  5497. @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
  5498. In the headline of the entry itself, a time(range) may also appear as
  5499. plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
  5500. integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
  5501. specifications in diary entries are recognized as well.
  5502. For agenda display, Org mode extracts the time and displays it in a
  5503. standard 24 hour format as part of the prefix. The example times in
  5504. the previous paragraphs would end up in the agenda like this:
  5505. @example
  5506. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  5507. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  5508. 19:00...... The Vogon reads his poem
  5509. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  5510. @end example
  5511. @cindex time grid
  5512. If the agenda is in single-day mode, or for the display of today, the
  5513. timed entries are embedded in a time grid, like
  5514. @example
  5515. 8:00...... ------------------
  5516. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  5517. 10:00...... ------------------
  5518. 12:00...... ------------------
  5519. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  5520. 14:00...... ------------------
  5521. 16:00...... ------------------
  5522. 18:00...... ------------------
  5523. 19:00...... The Vogon reads his poem
  5524. 20:00...... ------------------
  5525. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  5526. @end example
  5527. @vindex org-agenda-use-time-grid
  5528. @vindex org-agenda-time-grid
  5529. The time grid can be turned on and off with the variable
  5530. @code{org-agenda-use-time-grid}, and can be configured with
  5531. @code{org-agenda-time-grid}.
  5532. @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
  5533. @subsection Sorting of agenda items
  5534. @cindex sorting, of agenda items
  5535. @cindex priorities, of agenda items
  5536. Before being inserted into a view, the items are sorted. How this is
  5537. done depends on the type of view.
  5538. @itemize @bullet
  5539. @item
  5540. @vindex org-agenda-files
  5541. For the daily/weekly agenda, the items for each day are sorted. The
  5542. default order is to first collect all items containing an explicit
  5543. time-of-day specification. These entries will be shown at the beginning
  5544. of the list, as a @emph{schedule} for the day. After that, items remain
  5545. grouped in categories, in the sequence given by @code{org-agenda-files}.
  5546. Within each category, items are sorted by priority (@pxref{Priorities}),
  5547. which is composed of the base priority (2000 for priority @samp{A}, 1000
  5548. for @samp{B}, and 0 for @samp{C}), plus additional increments for
  5549. overdue scheduled or deadline items.
  5550. @item
  5551. For the TODO list, items remain in the order of categories, but within
  5552. each category, sorting takes place according to priority
  5553. (@pxref{Priorities}).
  5554. @item
  5555. For tags matches, items are not sorted at all, but just appear in the
  5556. sequence in which they are found in the agenda files.
  5557. @end itemize
  5558. @vindex org-agenda-sorting-strategy
  5559. Sorting can be customized using the variable
  5560. @code{org-agenda-sorting-strategy}, and may also include criteria based on
  5561. the estimated effort of an entry (@pxref{Effort estimates}).
  5562. @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
  5563. @section Commands in the agenda buffer
  5564. @cindex commands, in agenda buffer
  5565. Entries in the agenda buffer are linked back to the org file or diary
  5566. file where they originate. You are not allowed to edit the agenda
  5567. buffer itself, but commands are provided to show and jump to the
  5568. original entry location, and to edit the org-files ``remotely'' from
  5569. the agenda buffer. In this way, all information is stored only once,
  5570. removing the risk that your agenda and note files may diverge.
  5571. Some commands can be executed with mouse clicks on agenda lines. For
  5572. the other commands, the cursor needs to be in the desired line.
  5573. @table @kbd
  5574. @tsubheading{Motion}
  5575. @cindex motion commands in agenda
  5576. @kindex n
  5577. @item n
  5578. Next line (same as @key{up} and @kbd{C-p}).
  5579. @kindex p
  5580. @item p
  5581. Previous line (same as @key{down} and @kbd{C-n}).
  5582. @tsubheading{View/Go to org file}
  5583. @kindex mouse-3
  5584. @kindex @key{SPC}
  5585. @item mouse-3
  5586. @itemx @key{SPC}
  5587. Display the original location of the item in another window.
  5588. With prefix arg, make sure that the entire entry is made visible in the
  5589. outline, not only the heading.
  5590. @c
  5591. @kindex L
  5592. @item L
  5593. Display original location and recenter that window.
  5594. @c
  5595. @kindex mouse-2
  5596. @kindex mouse-1
  5597. @kindex @key{TAB}
  5598. @item mouse-2
  5599. @itemx mouse-1
  5600. @itemx @key{TAB}
  5601. Go to the original location of the item in another window. Under Emacs
  5602. 22, @kbd{mouse-1} will also works for this.
  5603. @c
  5604. @kindex @key{RET}
  5605. @itemx @key{RET}
  5606. Go to the original location of the item and delete other windows.
  5607. @c
  5608. @kindex f
  5609. @item f
  5610. @vindex org-agenda-start-with-follow-mode
  5611. Toggle Follow mode. In Follow mode, as you move the cursor through
  5612. the agenda buffer, the other window always shows the corresponding
  5613. location in the org file. The initial setting for this mode in new
  5614. agenda buffers can be set with the variable
  5615. @code{org-agenda-start-with-follow-mode}.
  5616. @c
  5617. @kindex b
  5618. @item b
  5619. Display the entire subtree of the current item in an indirect buffer. With a
  5620. numeric prefix argument N, go up to level N and then take that tree. If N is
  5621. negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
  5622. previously used indirect buffer.
  5623. @c
  5624. @kindex l
  5625. @item l
  5626. @vindex org-log-done
  5627. @vindex org-agenda-log-mode-items
  5628. Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
  5629. logging was on (variable @code{org-log-done}) are shown in the agenda, as are
  5630. entries that have been clocked on that day. You can configure the entry
  5631. types that should be included in log mode using the variable
  5632. @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
  5633. all possible logbook entries, including state changes. When called with two
  5634. prefix args @kbd{C-u C-u}, show only logging information, nothing else.
  5635. @c
  5636. @kindex v
  5637. @item v
  5638. Toggle Archives mode. In archives mode, trees that are marked
  5639. @code{ARCHIVED} are also scanned when producing the agenda. When you call
  5640. this command with a @kbd{C-u} prefix argument, even all archive files are
  5641. included. To exit archives mode, press @kbd{v} again.
  5642. @c
  5643. @kindex R
  5644. @item R
  5645. @vindex org-agenda-start-with-clockreport-mode
  5646. Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will
  5647. always show a table with the clocked times for the timespan and file scope
  5648. covered by the current agenda view. The initial setting for this mode in new
  5649. agenda buffers can be set with the variable
  5650. @code{org-agenda-start-with-clockreport-mode}.
  5651. @tsubheading{Change display}
  5652. @cindex display changing, in agenda
  5653. @kindex o
  5654. @item o
  5655. Delete other windows.
  5656. @c
  5657. @kindex d
  5658. @kindex w
  5659. @kindex m
  5660. @kindex y
  5661. @item d w m y
  5662. Switch to day/week/month/year view. When switching to day or week view,
  5663. this setting becomes the default for subsequent agenda commands. Since
  5664. month and year views are slow to create, they do not become the default.
  5665. A numeric prefix argument may be used to jump directly to a specific day
  5666. of the year, ISO week, month, or year, respectively. For example,
  5667. @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
  5668. setting day, week, or month view, a year may be encoded in the prefix
  5669. argument as well. For example, @kbd{200712 w} will jump to week 12 in
  5670. 2007. If such a year specification has only one or two digits, it will
  5671. be mapped to the interval 1938-2037.
  5672. @c
  5673. @kindex D
  5674. @item D
  5675. Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
  5676. @c
  5677. @kindex G
  5678. @item G
  5679. @vindex org-agenda-use-time-grid
  5680. @vindex org-agenda-time-grid
  5681. Toggle the time grid on and off. See also the variables
  5682. @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
  5683. @c
  5684. @kindex r
  5685. @item r
  5686. Recreate the agenda buffer, for example to reflect the changes
  5687. after modification of the time stamps of items with S-@key{left} and
  5688. S-@key{right}. When the buffer is the global TODO list, a prefix
  5689. argument is interpreted to create a selective list for a specific TODO
  5690. keyword.
  5691. @kindex g
  5692. @item g
  5693. Same as @kbd{r}.
  5694. @c
  5695. @kindex s
  5696. @kindex C-x C-s
  5697. @item s
  5698. @itemx C-x C-s
  5699. Save all Org buffers in the current Emacs session, and also the locations of
  5700. IDs.
  5701. @c
  5702. @kindex @key{right}
  5703. @item @key{right}
  5704. @vindex org-agenda-ndays
  5705. Display the following @code{org-agenda-ndays} days. For example, if
  5706. the display covers a week, switch to the following week. With prefix
  5707. arg, go forward that many times @code{org-agenda-ndays} days.
  5708. @c
  5709. @kindex @key{left}
  5710. @item @key{left}
  5711. Display the previous dates.
  5712. @c
  5713. @kindex .
  5714. @item .
  5715. Go to today.
  5716. @c
  5717. @kindex C-c C-x C-c
  5718. @item C-c C-x C-c
  5719. @vindex org-columns-default-format
  5720. Invoke column view (@pxref{Column view}) in the agenda buffer. The column
  5721. view format is taken from the entry at point, or (if there is no entry at
  5722. point), from the first entry in the agenda view. So whatever the format for
  5723. that entry would be in the original buffer (taken from a property, from a
  5724. @code{#+COLUMNS} line, or from the default variable
  5725. @code{org-columns-default-format}), will be used in the agenda.
  5726. @tsubheading{Secondary filtering and query editing}
  5727. @cindex filtering, by tag and effort, in agenda
  5728. @cindex tag filtering, in agenda
  5729. @cindex effort filtering, in agenda
  5730. @cindex query editing, in agenda
  5731. @kindex /
  5732. @item /
  5733. Filter the current agenda view with respect to a tag and/or effort estimates.
  5734. The difference between this and a custom agenda commands is that filtering is
  5735. very fast, so that you can switch quickly between different filters without
  5736. having to recreate the agenda.
  5737. You will be prompted for a tag selection letter. Pressing @key{TAB} at that
  5738. prompt will offer use completion to select a tag (including any tags that do
  5739. not have a selection character). The command then hides all entries that do
  5740. not contain or inherit this tag. When called with prefix arg, remove the
  5741. entries that @emph{do} have the tag. A second @kbd{/} at the prompt will
  5742. turn off the filter and unhide any hidden entries. If the first key you
  5743. press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
  5744. requiring or forbidding the selected additional tag. Instead of pressing
  5745. @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\}
  5746. command.
  5747. In order to filter for effort estimates, you should set-up allowed
  5748. efforts globally, for example
  5749. @lisp
  5750. (setq org-global-properties
  5751. '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
  5752. @end lisp
  5753. You can then filter for an effort by first typing an operator, one of @kbd{<},
  5754. @kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in
  5755. your array of allowed values, where @kbd{0} means the 10th value. The filter
  5756. will then restrict to entries with effort smaller-or-equal, equal, or
  5757. larger-or-equal than the selected value. If the digits 0-9 are not used as
  5758. fast access keys to tags, you can also simply press the index digit directly
  5759. without an operator. In this case, @kbd{<} will be assumed.
  5760. @kindex \
  5761. @item \
  5762. Narrow the current agenda filter by an additional condition. When called with
  5763. prefix arg, remove the entries that @emph{do} have the tag, or that do match
  5764. the effort criterion. You can achieve the same effect by pressing @kbd{+} or
  5765. @kbd{-} as the first key after the @kbd{/} command.
  5766. @kindex [
  5767. @kindex ]
  5768. @kindex @{
  5769. @kindex @}
  5770. @item [ ] @{ @}
  5771. In the @i{search view} (@pxref{Keyword search}), these keys add new search
  5772. words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and
  5773. @kbd{@}}) to the query string. The opening bracket/brace will add a positive
  5774. search term prefixed by @samp{+}, indicating that this search term @i{must}
  5775. occur/match in the entry. The closing bracket/brace will add a negative
  5776. search term which @i{must not} occur/match in the entry for it to be
  5777. selected.
  5778. @tsubheading{Remote editing}
  5779. @cindex remote editing, from agenda
  5780. @item 0-9
  5781. Digit argument.
  5782. @c
  5783. @cindex undoing remote-editing events
  5784. @cindex remote editing, undo
  5785. @kindex C-_
  5786. @item C-_
  5787. Undo a change due to a remote editing command. The change is undone
  5788. both in the agenda buffer and in the remote buffer.
  5789. @c
  5790. @kindex t
  5791. @item t
  5792. Change the TODO state of the item, both in the agenda and in the
  5793. original org file.
  5794. @c
  5795. @kindex C-k
  5796. @item C-k
  5797. @vindex org-agenda-confirm-kill
  5798. Delete the current agenda item along with the entire subtree belonging
  5799. to it in the original Org file. If the text to be deleted remotely
  5800. is longer than one line, the kill needs to be confirmed by the user. See
  5801. variable @code{org-agenda-confirm-kill}.
  5802. @c
  5803. @kindex a
  5804. @item a
  5805. Toggle the ARCHIVE tag for the current headline.
  5806. @c
  5807. @kindex A
  5808. @item A
  5809. Move the subtree corresponding to the current entry to its @emph{Archive
  5810. Sibling}.
  5811. @c
  5812. @kindex $
  5813. @item $
  5814. Archive the subtree corresponding to the current headline. This means the
  5815. entry will be moved to the configured archive location, most likely a
  5816. different file.
  5817. @c
  5818. @kindex T
  5819. @item T
  5820. @vindex org-agenda-show-inherited-tags
  5821. Show all tags associated with the current item. This is useful if you have
  5822. turned off @code{org-agenda-show-inherited-tags}, but still want to see all
  5823. tags of a headline occasionally.
  5824. @c
  5825. @kindex :
  5826. @item :
  5827. Set tags for the current headline. If there is an active region in the
  5828. agenda, change a tag for all headings in the region.
  5829. @c
  5830. @kindex ,
  5831. @item ,
  5832. Set the priority for the current item. Org mode prompts for the
  5833. priority character. If you reply with @key{SPC}, the priority cookie
  5834. is removed from the entry.
  5835. @c
  5836. @kindex P
  5837. @item P
  5838. Display weighted priority of current item.
  5839. @c
  5840. @kindex +
  5841. @kindex S-@key{up}
  5842. @item +
  5843. @itemx S-@key{up}
  5844. Increase the priority of the current item. The priority is changed in
  5845. the original buffer, but the agenda is not resorted. Use the @kbd{r}
  5846. key for this.
  5847. @c
  5848. @kindex -
  5849. @kindex S-@key{down}
  5850. @item -
  5851. @itemx S-@key{down}
  5852. Decrease the priority of the current item.
  5853. @c
  5854. @kindex z
  5855. @item z
  5856. @vindex org-log-state-notes-into-drawer
  5857. Add a note to the entry. This note will be recorded, and then files to the
  5858. same location where state change notes a put. Depending on
  5859. @code{org-log-state-notes-into-drawer}, this maybe inside a drawer.
  5860. @c
  5861. @kindex C-c C-a
  5862. @item C-c C-a
  5863. Dispatcher for all command related to attachments.
  5864. @c
  5865. @kindex C-c C-s
  5866. @item C-c C-s
  5867. Schedule this item
  5868. @c
  5869. @kindex C-c C-d
  5870. @item C-c C-d
  5871. Set a deadline for this item.
  5872. @c
  5873. @kindex k
  5874. @item k
  5875. Agenda actions, to set dates for selected items to the cursor date.
  5876. This command also works in the calendar! The command prompts for an
  5877. additional key:
  5878. @example
  5879. m @r{Mark the entry at point for action. You can also make entries}
  5880. @r{in Org files with @kbd{C-c C-x C-k}.}
  5881. d @r{Set the deadline of the marked entry to the date at point.}
  5882. s @r{Schedule the marked entry at the date at point.}
  5883. r @r{Call @code{org-remember} with the cursor date as default date.}
  5884. @end example
  5885. Press @kbd{r} afterward to refresh the agenda and see the effect of the
  5886. command.
  5887. @c
  5888. @kindex S-@key{right}
  5889. @item S-@key{right}
  5890. Change the time stamp associated with the current line by one day into the
  5891. future. With a numeric prefix argument, change it by that many days. For
  5892. example, @kbd{3 6 5 S-@key{right}} will change it by a year. The stamp is
  5893. changed in the original org file, but the change is not directly reflected in
  5894. the agenda buffer. Use the @kbd{r} key to update the buffer.
  5895. @c
  5896. @kindex S-@key{left}
  5897. @item S-@key{left}
  5898. Change the time stamp associated with the current line by one day
  5899. into the past.
  5900. @c
  5901. @kindex >
  5902. @item >
  5903. Change the time stamp associated with the current line to today.
  5904. The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
  5905. on my keyboard.
  5906. @c
  5907. @kindex I
  5908. @item I
  5909. Start the clock on the current item. If a clock is running already, it
  5910. is stopped first.
  5911. @c
  5912. @kindex O
  5913. @item O
  5914. Stop the previously started clock.
  5915. @c
  5916. @kindex X
  5917. @item X
  5918. Cancel the currently running clock.
  5919. @kindex J
  5920. @item J
  5921. Jump to the running clock in another window.
  5922. @tsubheading{Calendar commands}
  5923. @cindex calendar commands, from agenda
  5924. @kindex c
  5925. @item c
  5926. Open the Emacs calendar and move to the date at the agenda cursor.
  5927. @c
  5928. @item c
  5929. When in the calendar, compute and show the Org mode agenda for the
  5930. date at the cursor.
  5931. @c
  5932. @cindex diary entries, creating from agenda
  5933. @kindex i
  5934. @item i
  5935. Insert a new entry into the diary. Prompts for the type of entry
  5936. (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
  5937. entry in the diary, just as @kbd{i d} etc. would do in the calendar.
  5938. The date is taken from the cursor position.
  5939. @c
  5940. @kindex M
  5941. @item M
  5942. Show the phases of the moon for the three months around current date.
  5943. @c
  5944. @kindex S
  5945. @item S
  5946. Show sunrise and sunset times. The geographical location must be set
  5947. with calendar variables, see documentation of the Emacs calendar.
  5948. @c
  5949. @kindex C
  5950. @item C
  5951. Convert the date at cursor into many other cultural and historic
  5952. calendars.
  5953. @c
  5954. @kindex H
  5955. @item H
  5956. Show holidays for three month around the cursor date.
  5957. @item M-x org-export-icalendar-combine-agenda-files
  5958. Export a single iCalendar file containing entries from all agenda files.
  5959. This is a globally available command, and also available in the agenda menu.
  5960. @tsubheading{Exporting to a file}
  5961. @kindex C-x C-w
  5962. @item C-x C-w
  5963. @cindex exporting agenda views
  5964. @cindex agenda views, exporting
  5965. @vindex org-agenda-exporter-settings
  5966. Write the agenda view to a file. Depending on the extension of the
  5967. selected file name, the view will be exported as HTML (extension
  5968. @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
  5969. plain text (any other extension). Use the variable
  5970. @code{org-agenda-exporter-settings} to set options for @file{ps-print}
  5971. and for @file{htmlize} to be used during export.
  5972. @tsubheading{Quit and Exit}
  5973. @kindex q
  5974. @item q
  5975. Quit agenda, remove the agenda buffer.
  5976. @c
  5977. @kindex x
  5978. @cindex agenda files, removing buffers
  5979. @item x
  5980. Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
  5981. for the compilation of the agenda. Buffers created by the user to
  5982. visit org files will not be removed.
  5983. @end table
  5984. @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views
  5985. @section Custom agenda views
  5986. @cindex custom agenda views
  5987. @cindex agenda views, custom
  5988. Custom agenda commands serve two purposes: to store and quickly access
  5989. frequently used TODO and tags searches, and to create special composite
  5990. agenda buffers. Custom agenda commands will be accessible through the
  5991. dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
  5992. @menu
  5993. * Storing searches:: Type once, use often
  5994. * Block agenda:: All the stuff you need in a single buffer
  5995. * Setting Options:: Changing the rules
  5996. * Exporting Agenda Views:: Writing agendas to files
  5997. * Using the agenda elsewhere:: Using agenda information in other programs
  5998. @end menu
  5999. @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
  6000. @subsection Storing searches
  6001. The first application of custom searches is the definition of keyboard
  6002. shortcuts for frequently used searches, either creating an agenda
  6003. buffer, or a sparse tree (the latter covering of course only the current
  6004. buffer).
  6005. @kindex C-c a C
  6006. @vindex org-agenda-custom-commands
  6007. Custom commands are configured in the variable
  6008. @code{org-agenda-custom-commands}. You can customize this variable, for
  6009. example by pressing @kbd{C-c a C}. You can also directly set it with
  6010. Emacs Lisp in @file{.emacs}. The following example contains all valid
  6011. search types:
  6012. @lisp
  6013. @group
  6014. (setq org-agenda-custom-commands
  6015. '(("w" todo "WAITING")
  6016. ("W" todo-tree "WAITING")
  6017. ("u" tags "+boss-urgent")
  6018. ("v" tags-todo "+boss-urgent")
  6019. ("U" tags-tree "+boss-urgent")
  6020. ("f" occur-tree "\\<FIXME\\>")
  6021. ("h" . "HOME+Name tags searches") ; description for "h" prefix
  6022. ("hl" tags "+home+Lisa")
  6023. ("hp" tags "+home+Peter")
  6024. ("hk" tags "+home+Kim")))
  6025. @end group
  6026. @end lisp
  6027. @noindent
  6028. The initial string in each entry defines the keys you have to press
  6029. after the dispatcher command @kbd{C-c a} in order to access the command.
  6030. Usually this will be just a single character, but if you have many
  6031. similar commands, you can also define two-letter combinations where the
  6032. first character is the same in several combinations and serves as a
  6033. prefix key@footnote{You can provide a description for a prefix key by
  6034. inserting a cons cell with the prefix and the description.}. The second
  6035. parameter is the search type, followed by the string or regular
  6036. expression to be used for the matching. The example above will
  6037. therefore define:
  6038. @table @kbd
  6039. @item C-c a w
  6040. as a global search for TODO entries with @samp{WAITING} as the TODO
  6041. keyword
  6042. @item C-c a W
  6043. as the same search, but only in the current buffer and displaying the
  6044. results as a sparse tree
  6045. @item C-c a u
  6046. as a global tags search for headlines marked @samp{:boss:} but not
  6047. @samp{:urgent:}
  6048. @item C-c a v
  6049. as the same search as @kbd{C-c a u}, but limiting the search to
  6050. headlines that are also TODO items
  6051. @item C-c a U
  6052. as the same search as @kbd{C-c a u}, but only in the current buffer and
  6053. displaying the result as a sparse tree
  6054. @item C-c a f
  6055. to create a sparse tree (again: current buffer only) with all entries
  6056. containing the word @samp{FIXME}
  6057. @item C-c a h
  6058. as a prefix command for a HOME tags search where you have to press an
  6059. additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
  6060. Peter, or Kim) as additional tag to match.
  6061. @end table
  6062. @node Block agenda, Setting Options, Storing searches, Custom agenda views
  6063. @subsection Block agenda
  6064. @cindex block agenda
  6065. @cindex agenda, with block views
  6066. Another possibility is the construction of agenda views that comprise
  6067. the results of @emph{several} commands, each of which creates a block in
  6068. the agenda buffer. The available commands include @code{agenda} for the
  6069. daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
  6070. for the global TODO list (as constructed with @kbd{C-c a t}), and the
  6071. matching commands discussed above: @code{todo}, @code{tags}, and
  6072. @code{tags-todo}. Here are two examples:
  6073. @lisp
  6074. @group
  6075. (setq org-agenda-custom-commands
  6076. '(("h" "Agenda and Home-related tasks"
  6077. ((agenda "")
  6078. (tags-todo "home")
  6079. (tags "garden")))
  6080. ("o" "Agenda and Office-related tasks"
  6081. ((agenda "")
  6082. (tags-todo "work")
  6083. (tags "office")))))
  6084. @end group
  6085. @end lisp
  6086. @noindent
  6087. This will define @kbd{C-c a h} to create a multi-block view for stuff
  6088. you need to attend to at home. The resulting agenda buffer will contain
  6089. your agenda for the current week, all TODO items that carry the tag
  6090. @samp{home}, and also all lines tagged with @samp{garden}. Finally the
  6091. command @kbd{C-c a o} provides a similar view for office tasks.
  6092. @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
  6093. @subsection Setting options for custom commands
  6094. @cindex options, for custom agenda views
  6095. @vindex org-agenda-custom-commands
  6096. Org mode contains a number of variables regulating agenda construction
  6097. and display. The global variables define the behavior for all agenda
  6098. commands, including the custom commands. However, if you want to change
  6099. some settings just for a single custom view, you can do so. Setting
  6100. options requires inserting a list of variable names and values at the
  6101. right spot in @code{org-agenda-custom-commands}. For example:
  6102. @lisp
  6103. @group
  6104. (setq org-agenda-custom-commands
  6105. '(("w" todo "WAITING"
  6106. ((org-agenda-sorting-strategy '(priority-down))
  6107. (org-agenda-prefix-format " Mixed: ")))
  6108. ("U" tags-tree "+boss-urgent"
  6109. ((org-show-following-heading nil)
  6110. (org-show-hierarchy-above nil)))
  6111. ("N" search ""
  6112. ((org-agenda-files '("~org/notes.org"))
  6113. (org-agenda-text-search-extra-files nil)))))
  6114. @end group
  6115. @end lisp
  6116. @noindent
  6117. Now the @kbd{C-c a w} command will sort the collected entries only by
  6118. priority, and the prefix format is modified to just say @samp{ Mixed: }
  6119. instead of giving the category of the entry. The sparse tags tree of
  6120. @kbd{C-c a U} will now turn out ultra-compact, because neither the
  6121. headline hierarchy above the match, nor the headline following the match
  6122. will be shown. The command @kbd{C-c a N} will do a text search limited
  6123. to only a single file.
  6124. @vindex org-agenda-custom-commands
  6125. For command sets creating a block agenda,
  6126. @code{org-agenda-custom-commands} has two separate spots for setting
  6127. options. You can add options that should be valid for just a single
  6128. command in the set, and options that should be valid for all commands in
  6129. the set. The former are just added to the command entry, the latter
  6130. must come after the list of command entries. Going back to the block
  6131. agenda example (@pxref{Block agenda}), let's change the sorting strategy
  6132. for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
  6133. the results for GARDEN tags query in the opposite order,
  6134. @code{priority-up}. This would look like this:
  6135. @lisp
  6136. @group
  6137. (setq org-agenda-custom-commands
  6138. '(("h" "Agenda and Home-related tasks"
  6139. ((agenda)
  6140. (tags-todo "home")
  6141. (tags "garden"
  6142. ((org-agenda-sorting-strategy '(priority-up)))))
  6143. ((org-agenda-sorting-strategy '(priority-down))))
  6144. ("o" "Agenda and Office-related tasks"
  6145. ((agenda)
  6146. (tags-todo "work")
  6147. (tags "office")))))
  6148. @end group
  6149. @end lisp
  6150. As you see, the values and parenthesis setting is a little complex.
  6151. When in doubt, use the customize interface to set this variable - it
  6152. fully supports its structure. Just one caveat: When setting options in
  6153. this interface, the @emph{values} are just lisp expressions. So if the
  6154. value is a string, you need to add the double quotes around the value
  6155. yourself.
  6156. @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views
  6157. @subsection Exporting Agenda Views
  6158. @cindex agenda views, exporting
  6159. If you are away from your computer, it can be very useful to have a printed
  6160. version of some agenda views to carry around. Org mode can export custom
  6161. agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
  6162. @file{htmlize.el}.}, Postscript, and iCalendar files. If you want to do this
  6163. only occasionally, use the command
  6164. @table @kbd
  6165. @kindex C-x C-w
  6166. @item C-x C-w
  6167. @cindex exporting agenda views
  6168. @cindex agenda views, exporting
  6169. @vindex org-agenda-exporter-settings
  6170. Write the agenda view to a file. Depending on the extension of the
  6171. selected file name, the view will be exported as HTML (extension
  6172. @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
  6173. iCalendar (extension @file{.ics}), or plain text (any other extension).
  6174. Use the variable @code{org-agenda-exporter-settings} to
  6175. set options for @file{ps-print} and for @file{htmlize} to be used during
  6176. export, for example
  6177. @lisp
  6178. (setq org-agenda-exporter-settings
  6179. '((ps-number-of-columns 2)
  6180. (ps-landscape-mode t)
  6181. (htmlize-output-type 'css)))
  6182. @end lisp
  6183. @end table
  6184. If you need to export certain agenda views frequently, you can associate
  6185. any custom agenda command with a list of output file names
  6186. @footnote{If you want to store standard views like the weekly agenda
  6187. or the global TODO list as well, you need to define custom commands for
  6188. them in order to be able to specify file names.}. Here is an example
  6189. that first does define custom commands for the agenda and the global
  6190. todo list, together with a number of files to which to export them.
  6191. Then we define two block agenda commands and specify file names for them
  6192. as well. File names can be relative to the current working directory,
  6193. or absolute.
  6194. @lisp
  6195. @group
  6196. (setq org-agenda-custom-commands
  6197. '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
  6198. ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
  6199. ("h" "Agenda and Home-related tasks"
  6200. ((agenda "")
  6201. (tags-todo "home")
  6202. (tags "garden"))
  6203. nil
  6204. ("~/views/home.html"))
  6205. ("o" "Agenda and Office-related tasks"
  6206. ((agenda)
  6207. (tags-todo "work")
  6208. (tags "office"))
  6209. nil
  6210. ("~/views/office.ps" "~/calendars/office.ics"))))
  6211. @end group
  6212. @end lisp
  6213. The extension of the file name determines the type of export. If it is
  6214. @file{.html}, Org mode will use the @file{htmlize.el} package to convert
  6215. the buffer to HTML and save it to this file name. If the extension is
  6216. @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
  6217. postscript output. If the extension is @file{.ics}, iCalendar export is
  6218. run export over all files that were used to construct the agenda, and
  6219. limit the export to entries listed in the agenda now. Any other
  6220. extension produces a plain ASCII file.
  6221. The export files are @emph{not} created when you use one of those
  6222. commands interactively because this might use too much overhead.
  6223. Instead, there is a special command to produce @emph{all} specified
  6224. files in one step:
  6225. @table @kbd
  6226. @kindex C-c a e
  6227. @item C-c a e
  6228. Export all agenda views that have export file names associated with
  6229. them.
  6230. @end table
  6231. You can use the options section of the custom agenda commands to also
  6232. set options for the export commands. For example:
  6233. @lisp
  6234. (setq org-agenda-custom-commands
  6235. '(("X" agenda ""
  6236. ((ps-number-of-columns 2)
  6237. (ps-landscape-mode t)
  6238. (org-agenda-prefix-format " [ ] ")
  6239. (org-agenda-with-colors nil)
  6240. (org-agenda-remove-tags t))
  6241. ("theagenda.ps"))))
  6242. @end lisp
  6243. @noindent
  6244. This command sets two options for the postscript exporter, to make it
  6245. print in two columns in landscape format - the resulting page can be cut
  6246. in two and then used in a paper agenda. The remaining settings modify
  6247. the agenda prefix to omit category and scheduling information, and
  6248. instead include a checkbox to check off items. We also remove the tags
  6249. to make the lines compact, and we don't want to use colors for the
  6250. black-and-white printer. Settings specified in
  6251. @code{org-agenda-exporter-settings} will also apply, but the settings
  6252. in @code{org-agenda-custom-commands} take precedence.
  6253. @noindent
  6254. From the command line you may also use
  6255. @example
  6256. emacs -f org-batch-store-agenda-views -kill
  6257. @end example
  6258. @noindent
  6259. or, if you need to modify some parameters@footnote{Quoting may depend on the
  6260. system you use, please check th FAQ for examples.}
  6261. @example
  6262. emacs -eval '(org-batch-store-agenda-views \
  6263. org-agenda-ndays 30 \
  6264. org-agenda-start-day "2007-11-01" \
  6265. org-agenda-include-diary nil \
  6266. org-agenda-files (quote ("~/org/project.org")))' \
  6267. -kill
  6268. @end example
  6269. @noindent
  6270. which will create the agenda views restricted to the file
  6271. @file{~/org/project.org}, without diary entries and with 30 days
  6272. extent.
  6273. @node Using the agenda elsewhere, , Exporting Agenda Views, Custom agenda views
  6274. @subsection Using agenda information outside of Org
  6275. @cindex agenda, pipe
  6276. @cindex Scripts, for agenda processing
  6277. @vindex org-agenda-custom-commands
  6278. Org provides commands to access agenda information for the command
  6279. line in emacs batch mode. This extracted information can be sent
  6280. directly to a printer, or it can be read by a program that does further
  6281. processing of the data. The first of these commands is the function
  6282. @code{org-batch-agenda}, that produces an agenda view and sends it as
  6283. ASCII text to STDOUT. The command takes a single string as parameter.
  6284. If the string has length 1, it is used as a key to one of the commands
  6285. you have configured in @code{org-agenda-custom-commands}, basically any
  6286. key you can use after @kbd{C-c a}. For example, to directly print the
  6287. current TODO list, you could use
  6288. @example
  6289. emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
  6290. @end example
  6291. If the parameter is a string with 2 or more characters, it is used as a
  6292. tags/todo match string. For example, to print your local shopping list
  6293. (all items with the tag @samp{shop}, but excluding the tag
  6294. @samp{NewYork}), you could use
  6295. @example
  6296. emacs -batch -l ~/.emacs \
  6297. -eval '(org-batch-agenda "+shop-NewYork")' | lpr
  6298. @end example
  6299. @noindent
  6300. You may also modify parameters on the fly like this:
  6301. @example
  6302. emacs -batch -l ~/.emacs \
  6303. -eval '(org-batch-agenda "a" \
  6304. org-agenda-ndays 30 \
  6305. org-agenda-include-diary nil \
  6306. org-agenda-files (quote ("~/org/project.org")))' \
  6307. | lpr
  6308. @end example
  6309. @noindent
  6310. which will produce a 30 day agenda, fully restricted to the Org file
  6311. @file{~/org/projects.org}, not even including the diary.
  6312. If you want to process the agenda data in more sophisticated ways, you
  6313. can use the command @code{org-batch-agenda-csv} to get a comma-separated
  6314. list of values for each agenda item. Each line in the output will
  6315. contain a number of fields separated by commas. The fields in a line
  6316. are:
  6317. @example
  6318. category @r{The category of the item}
  6319. head @r{The headline, without TODO kwd, TAGS and PRIORITY}
  6320. type @r{The type of the agenda entry, can be}
  6321. todo @r{selected in TODO match}
  6322. tagsmatch @r{selected in tags match}
  6323. diary @r{imported from diary}
  6324. deadline @r{a deadline}
  6325. scheduled @r{scheduled}
  6326. timestamp @r{appointment, selected by timestamp}
  6327. closed @r{entry was closed on date}
  6328. upcoming-deadline @r{warning about nearing deadline}
  6329. past-scheduled @r{forwarded scheduled item}
  6330. block @r{entry has date block including date}
  6331. todo @r{The TODO keyword, if any}
  6332. tags @r{All tags including inherited ones, separated by colons}
  6333. date @r{The relevant date, like 2007-2-14}
  6334. time @r{The time, like 15:00-16:50}
  6335. extra @r{String with extra planning info}
  6336. priority-l @r{The priority letter if any was given}
  6337. priority-n @r{The computed numerical priority}
  6338. @end example
  6339. @noindent
  6340. Time and date will only be given if a timestamp (or deadline/scheduled)
  6341. lead to the selection of the item.
  6342. A CSV list like this is very easy to use in a post processing script.
  6343. For example, here is a Perl program that gets the TODO list from
  6344. Emacs/Org and prints all the items, preceded by a checkbox:
  6345. @example
  6346. @group
  6347. #!/usr/bin/perl
  6348. # define the Emacs command to run
  6349. $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
  6350. # run it and capture the output
  6351. $agenda = qx@{$cmd 2>/dev/null@};
  6352. # loop over all lines
  6353. foreach $line (split(/\n/,$agenda)) @{
  6354. # get the individual values
  6355. ($category,$head,$type,$todo,$tags,$date,$time,$extra,
  6356. $priority_l,$priority_n) = split(/,/,$line);
  6357. # process and print
  6358. print "[ ] $head\n";
  6359. @}
  6360. @end group
  6361. @end example
  6362. @node Agenda column view, , Custom agenda views, Agenda Views
  6363. @section Using column view in the agenda
  6364. @cindex column view, in agenda
  6365. @cindex agenda, column view
  6366. Column view (@pxref{Column view}) is normally used to view and edit
  6367. properties embedded in the hierarchical structure of an Org file. It can be
  6368. quite useful to use column view also from the agenda, where entries are
  6369. collected by certain criteria.
  6370. @table @kbd
  6371. @kindex C-c C-x C-c
  6372. @item C-c C-x C-c
  6373. Turn on column view in the agenda.
  6374. @end table
  6375. To understand how to use this properly, it is important to realize that the
  6376. entries in the agenda are no longer in their proper outline environment.
  6377. This causes the following issues:
  6378. @enumerate
  6379. @item
  6380. @vindex org-columns-default-format
  6381. @vindex org-overriding-columns-format
  6382. Org needs to make a decision which @code{COLUMNS} format to use. Since the
  6383. entries in the agenda are collected from different files, and different files
  6384. may have different @code{COLUMNS} formats, this is a non-trivial problem.
  6385. Org first checks if the variable @code{org-overriding-columns-format} is
  6386. currently set, and if yes takes the format from there. Otherwise it takes
  6387. the format associated with the first item in the agenda, or, if that item
  6388. does not have a specific format (defined in a property, or in it's file), it
  6389. uses @code{org-columns-default-format}.
  6390. @item
  6391. If any of the columns has a summary type defined (@pxref{Column attributes}),
  6392. turning on column view in the agenda will visit all relevant agenda files and
  6393. make sure that the computations of this property are up to date. This is
  6394. also true for the special @code{CLOCKSUM} property. Org will then sum the
  6395. values displayed in the agenda. In the daily/weekly agenda, the sums will
  6396. cover a single day, in all other views they cover the entire block. It is
  6397. vital to realize that the agenda may show the same entry @emph{twice} (for
  6398. example as scheduled and as a deadline), and it may show two entries from the
  6399. same hierarchy (for example a @emph{parent} and it's @emph{child}). In these
  6400. cases, the summation in the agenda will lead to incorrect results because
  6401. some values will count double.
  6402. @item
  6403. When the column view in the agenda shows the @code{CLOCKSUM}, that is always
  6404. the entire clocked time for this item. So even in the daily/weekly agenda,
  6405. the clocksum listed in column view may originate from times outside the
  6406. current view. This has the advantage that you can compare these values with
  6407. a column listing the planned total effort for a task - one of the major
  6408. applications for column view in the agenda. If you want information about
  6409. clocked time in the displayed period use clock table mode (press @kbd{R} in
  6410. the agenda).
  6411. @end enumerate
  6412. @node Embedded LaTeX, Exporting, Agenda Views, Top
  6413. @chapter Embedded LaTeX
  6414. @cindex @TeX{} interpretation
  6415. @cindex La@TeX{} interpretation
  6416. Plain ASCII is normally sufficient for almost all note taking. One
  6417. exception, however, are scientific notes which need to be able to contain
  6418. mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
  6419. is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
  6420. features described here as ``La@TeX{}'' are really from @TeX{}, but for
  6421. simplicity I am blurring this distinction.} is widely used to typeset
  6422. scientific documents. Org mode supports embedding La@TeX{} code into its
  6423. files, because many academics are used to reading La@TeX{} source code, and
  6424. because it can be readily processed into images for HTML production.
  6425. It is not necessary to mark La@TeX{} macros and code in any special way.
  6426. If you observe a few conventions, Org mode knows how to find it and what
  6427. to do with it.
  6428. @menu
  6429. * Math symbols:: TeX macros for symbols and Greek letters
  6430. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  6431. * LaTeX fragments:: Complex formulas made easy
  6432. * Processing LaTeX fragments:: Previewing LaTeX processing
  6433. * CDLaTeX mode:: Speed up entering of formulas
  6434. @end menu
  6435. @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
  6436. @section Math symbols
  6437. @cindex math symbols
  6438. @cindex TeX macros
  6439. You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
  6440. indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
  6441. for these macros is available, just type @samp{\} and maybe a few letters,
  6442. and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
  6443. code, Org mode allows these macros to be present without surrounding math
  6444. delimiters, for example:
  6445. @example
  6446. Angles are written as Greek letters \alpha, \beta and \gamma.
  6447. @end example
  6448. During HTML export (@pxref{HTML export}), these symbols are translated
  6449. into the proper syntax for HTML, for the above examples this is
  6450. @samp{&alpha;} and @samp{&rarr;}, respectively. If you need such a symbol
  6451. inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
  6452. @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
  6453. @section Subscripts and superscripts
  6454. @cindex subscript
  6455. @cindex superscript
  6456. Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
  6457. and subscripts. Again, these can be used without embedding them in
  6458. math-mode delimiters. To increase the readability of ASCII text, it is
  6459. not necessary (but OK) to surround multi-character sub- and superscripts
  6460. with curly braces. For example
  6461. @example
  6462. The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
  6463. the sun is R_@{sun@} = 6.96 x 10^8 m.
  6464. @end example
  6465. To avoid interpretation as raised or lowered text, you can quote
  6466. @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
  6467. During HTML export (@pxref{HTML export}), subscript and superscripts
  6468. are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
  6469. @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
  6470. @section LaTeX fragments
  6471. @cindex LaTeX fragments
  6472. @vindex org-format-latex-header
  6473. With symbols, sub- and superscripts, HTML is pretty much at its end when
  6474. it comes to representing mathematical formulas@footnote{Yes, there is
  6475. MathML, but that is not yet fully supported by many browsers, and there
  6476. is no decent converter for turning La@TeX{} or ASCII representations of
  6477. formulas into MathML. So for the time being, converting formulas into
  6478. images seems the way to go.}. More complex expressions need a dedicated
  6479. formula processor. To this end, Org mode can contain arbitrary La@TeX{}
  6480. fragments. It provides commands to preview the typeset result of these
  6481. fragments, and upon export to HTML, all fragments will be converted to
  6482. images and inlined into the HTML document@footnote{The La@TeX{} export
  6483. will not use images for displaying La@TeX{} fragments but include these
  6484. fragments directly into the La@TeX{} code.}. For this to work you
  6485. need to be on a system with a working La@TeX{} installation. You also
  6486. need the @file{dvipng} program, available at
  6487. @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
  6488. will be used when processing a fragment can be configured with the
  6489. variable @code{org-format-latex-header}.
  6490. La@TeX{} fragments don't need any special marking at all. The following
  6491. snippets will be identified as La@TeX{} source code:
  6492. @itemize @bullet
  6493. @item
  6494. Environments of any kind. The only requirement is that the
  6495. @code{\begin} statement appears on a new line, preceded by only
  6496. whitespace.
  6497. @item
  6498. Text within the usual La@TeX{} math delimiters. To avoid conflicts with
  6499. currency specifications, single @samp{$} characters are only recognized as
  6500. math delimiters if the enclosed text contains at most two line breaks, is
  6501. directly attached to the @samp{$} characters with no whitespace in between,
  6502. and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
  6503. For the other delimiters, there is no such restriction, so when in doubt, use
  6504. @samp{\(...\)} as inline math delimiters.
  6505. @end itemize
  6506. @noindent For example:
  6507. @example
  6508. \begin@{equation@} % arbitrary environments,
  6509. x=\sqrt@{b@} % even tables, figures
  6510. \end@{equation@} % etc
  6511. If $a^2=b$ and \( b=2 \), then the solution must be
  6512. either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
  6513. @end example
  6514. @noindent
  6515. @vindex org-format-latex-options
  6516. If you need any of the delimiter ASCII sequences for other purposes, you
  6517. can configure the option @code{org-format-latex-options} to deselect the
  6518. ones you do not wish to have interpreted by the La@TeX{} converter.
  6519. @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
  6520. @section Processing LaTeX fragments
  6521. @cindex LaTeX fragments, preview
  6522. La@TeX{} fragments can be processed to produce a preview images of the
  6523. typeset expressions:
  6524. @table @kbd
  6525. @kindex C-c C-x C-l
  6526. @item C-c C-x C-l
  6527. Produce a preview image of the La@TeX{} fragment at point and overlay it
  6528. over the source code. If there is no fragment at point, process all
  6529. fragments in the current entry (between two headlines). When called
  6530. with a prefix argument, process the entire subtree. When called with
  6531. two prefix arguments, or when the cursor is before the first headline,
  6532. process the entire buffer.
  6533. @kindex C-c C-c
  6534. @item C-c C-c
  6535. Remove the overlay preview images.
  6536. @end table
  6537. During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
  6538. converted into images and inlined into the document if the following
  6539. setting is active:
  6540. @lisp
  6541. (setq org-export-with-LaTeX-fragments t)
  6542. @end lisp
  6543. @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
  6544. @section Using CDLaTeX to enter math
  6545. @cindex CDLaTeX
  6546. CDLaTeX mode is a minor mode that is normally used in combination with a
  6547. major La@TeX{} mode like AUCTeX in order to speed-up insertion of
  6548. environments and math templates. Inside Org mode, you can make use of
  6549. some of the features of CDLaTeX mode. You need to install
  6550. @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
  6551. AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
  6552. Don't use CDLaTeX mode itself under Org mode, but use the light
  6553. version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
  6554. on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
  6555. Org files with
  6556. @lisp
  6557. (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
  6558. @end lisp
  6559. When this mode is enabled, the following features are present (for more
  6560. details see the documentation of CDLaTeX mode):
  6561. @itemize @bullet
  6562. @kindex C-c @{
  6563. @item
  6564. Environment templates can be inserted with @kbd{C-c @{}.
  6565. @item
  6566. @kindex @key{TAB}
  6567. The @key{TAB} key will do template expansion if the cursor is inside a
  6568. La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
  6569. inside such a fragment, see the documentation of the function
  6570. @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
  6571. expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
  6572. correctly inside the first brace. Another @key{TAB} will get you into
  6573. the second brace. Even outside fragments, @key{TAB} will expand
  6574. environment abbreviations at the beginning of a line. For example, if
  6575. you write @samp{equ} at the beginning of a line and press @key{TAB},
  6576. this abbreviation will be expanded to an @code{equation} environment.
  6577. To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
  6578. @item
  6579. @kindex _
  6580. @kindex ^
  6581. @vindex cdlatex-simplify-sub-super-scripts
  6582. Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
  6583. characters together with a pair of braces. If you use @key{TAB} to move
  6584. out of the braces, and if the braces surround only a single character or
  6585. macro, they are removed again (depending on the variable
  6586. @code{cdlatex-simplify-sub-super-scripts}).
  6587. @item
  6588. @kindex `
  6589. Pressing the backquote @kbd{`} followed by a character inserts math
  6590. macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
  6591. after the backquote, a help window will pop up.
  6592. @item
  6593. @kindex '
  6594. Pressing the normal quote @kbd{'} followed by another character modifies
  6595. the symbol before point with an accent or a font. If you wait more than
  6596. 1.5 seconds after the backquote, a help window will pop up. Character
  6597. modification will work only inside La@TeX{} fragments, outside the quote
  6598. is normal.
  6599. @end itemize
  6600. @node Exporting, Publishing, Embedded LaTeX, Top
  6601. @chapter Exporting
  6602. @cindex exporting
  6603. Org mode documents can be exported into a variety of other formats. For
  6604. printing and sharing of notes, ASCII export produces a readable and
  6605. simple version of an Org file. HTML export allows you to publish a
  6606. notes file on the web, while the XOXO format provides a solid base for
  6607. exchange with a broad range of other applications. La@TeX{} export lets
  6608. you use Org mode and its structured editing functions to easily create
  6609. La@TeX{} files. To incorporate entries with associated times like
  6610. deadlines or appointments into a desktop calendar program like iCal,
  6611. Org mode can also produce extracts in the iCalendar format. Currently
  6612. Org mode only supports export, not import of these different formats.
  6613. Org supports export of selected regions when @code{transient-mark-mode} is
  6614. enabled (default in Emacs 23).
  6615. @menu
  6616. * Markup rules:: Which structures are recognized?
  6617. * Selective export:: Using tags to select and exclude trees
  6618. * Export options:: Per-file export settings
  6619. * The export dispatcher:: How to access exporter commands
  6620. * ASCII export:: Exporting to plain ASCII
  6621. * HTML export:: Exporting to HTML
  6622. * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
  6623. * XOXO export:: Exporting to XOXO
  6624. * iCalendar export:: Exporting in iCalendar format
  6625. @end menu
  6626. @node Markup rules, Selective export, Exporting, Exporting
  6627. @section Markup rules
  6628. When exporting Org mode documents, the exporter tries to reflect the
  6629. structure of the document as accurately as possible in the back-end. Since
  6630. export targets like HTML or La@TeX{} allow much richer formatting, Org mode
  6631. has rules how to prepare text for rich export. This section summarizes the
  6632. markup rule used in an Org mode buffer.
  6633. @menu
  6634. * Document title:: How the document title is determined
  6635. * Headings and sections:: The main structure of the exported document
  6636. * Table of contents:: If, where, how to create a table of contents
  6637. * Initial text:: Text before the first headline
  6638. * Lists:: Plain lists are exported
  6639. * Paragraphs:: What determines beginning and ending
  6640. * Literal examples:: Source code and other examples
  6641. * Include files:: Include the contents of a file during export
  6642. * Tables exported:: Tables are exported richly
  6643. * Inlined images:: How to inline images during export
  6644. * Footnote markup::
  6645. * Emphasis and monospace:: To bold or not to bold
  6646. * TeX macros and LaTeX fragments:: Create special, rich export.
  6647. * Horizontal rules:: A line across the page
  6648. * Comment lines:: Some lines will not be exported
  6649. @end menu
  6650. @node Document title, Headings and sections, Markup rules, Markup rules
  6651. @subheading Document title
  6652. @cindex document title, markup rules
  6653. @noindent
  6654. The title of the exported document is taken from the special line
  6655. @example
  6656. #+TITLE: This is the title of the document
  6657. @end example
  6658. @noindent
  6659. If this line does not exist, the title is derived from the first non-empty,
  6660. non-comment line in the buffer. If no such line exists, or if you have
  6661. turned off exporting of the text before the first headline (see below), the
  6662. title will be the file name without extension.
  6663. If you are exporting only a subtree by marking is as the region, the heading
  6664. of the subtree will become the title of the document. If the subtree has a
  6665. property @code{EXPORT_TITLE}, that will take precedence.
  6666. @node Headings and sections, Table of contents, Document title, Markup rules
  6667. @subheading Headings and sections
  6668. @cindex headings and sections, markup rules
  6669. @vindex org-headline-levels
  6670. The outline structure of the document as described in @ref{Document
  6671. Structure} forms the basis for defining sections of the exported document.
  6672. However, since the outline structure is also used for (for example) lists of
  6673. tasks, only the first three outline levels will be used as headings. Deeper
  6674. levels will become itemized lists. You can change the location of this
  6675. switch, globally by setting the variable @code{org-headline-levels}, or on a
  6676. per file basis with a line
  6677. @example
  6678. #+OPTIONS: H:4
  6679. @end example
  6680. @node Table of contents, Initial text, Headings and sections, Markup rules
  6681. @subheading Table of contents
  6682. @cindex table of contents, markup rules
  6683. @vindex org-export-with-toc
  6684. The table of contents is normally inserted directly before the first headline
  6685. of the file. If you would like to get it to a different location, insert the
  6686. string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
  6687. location. The depth of the table of contents is by default the same as the
  6688. number of headline levels, but you can choose a smaller number or turn off
  6689. the table of contents entirely by configuring the variable
  6690. @code{org-export-with-toc}, or on a per-file basis with a line like
  6691. @example
  6692. #+OPTIONS: toc:2 (only to two levels in TOC)
  6693. #+OPTIONS: toc:nil (no TOC at all)
  6694. @end example
  6695. @node Initial text, Lists, Table of contents, Markup rules
  6696. @subheading Text before the first headline
  6697. @cindex text before first headline, markup rules
  6698. @cindex #+TEXT
  6699. Org mode normally exports the text before the first headline, and even uses
  6700. the first line as the document title. The text will be fully marked up. If
  6701. you need to include literal HTML or La@TeX{} code, use the special constructs
  6702. described below in the sections for the individual exporters.
  6703. @vindex org-export-skip-text-before-1st-heading
  6704. Some people like to use the space before the first headline for setup and
  6705. internal links and therefore would like to control the exported text before
  6706. the first headline in a different way. You can do so by setting the variable
  6707. @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
  6708. basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
  6709. @noindent
  6710. If you still want to have some text before the first headline, use the
  6711. @code{#+TEXT} construct:
  6712. @example
  6713. #+OPTIONS: skip:t
  6714. #+TEXT: This text will go before the *first* headline.
  6715. #+TEXT: [TABLE-OF-CONTENTS]
  6716. #+TEXT: This goes between the table of contents and the first headline
  6717. @end example
  6718. @node Lists, Paragraphs, Initial text, Markup rules
  6719. @subheading Lists
  6720. @cindex lists, markup rules
  6721. Plain lists as described in @ref{Plain lists} are translated to the back-ends
  6722. syntax for such lists. Most back-ends support unordered, ordered, and
  6723. description lists.
  6724. @node Paragraphs, Literal examples, Lists, Markup rules
  6725. @subheading Paragraphs, line breaks, and quoting
  6726. @cindex paragraphs, markup rules
  6727. Paragraphs are separated by at least one empty line. If you need to enforce
  6728. a line break within a paragraph, use @samp{\\} at the end of a line.
  6729. To keep the line breaks in a region, but otherwise use normal formatting, you
  6730. can use this construct, which can also be used to format poetry.
  6731. @example
  6732. #+BEGIN_VERSE
  6733. Great clouds overhead
  6734. Tiny black birds rise and fall
  6735. Snow covers Emacs
  6736. -- AlexSchroeder
  6737. #+END_VERSE
  6738. @end example
  6739. When quoting a passage from another document, it is customary to format this
  6740. as a paragraph that is indented on both the left and the right margin. You
  6741. can include quotations in Org mode documents like this:
  6742. @example
  6743. #+BEGIN_QUOTE
  6744. Everything should be made as simple as possible,
  6745. but not any simpler -- Albert Einstein
  6746. #+END_QUOTE
  6747. @end example
  6748. @node Literal examples, Include files, Paragraphs, Markup rules
  6749. @subheading Literal examples
  6750. @cindex literal examples, markup rules
  6751. @cindex code line refenences, markup rules
  6752. You can include literal examples that should not be subjected to
  6753. markup. Such examples will be typeset in monospace, so this is well suited
  6754. for source code and similar examples.
  6755. @cindex #+BEGIN_EXAMPLE
  6756. @example
  6757. #+BEGIN_EXAMPLE
  6758. Some example from a text file.
  6759. #+END_EXAMPLE
  6760. @end example
  6761. For simplicity when using small examples, you can also start the example
  6762. lines with a colon followed by a space. There may also be additional
  6763. whitespace before the colon:
  6764. @example
  6765. Here is an example
  6766. : Some example from a text file.
  6767. @end example
  6768. @cindex formatting source code, markup rules
  6769. If the example is source code from a programming language, or any other text
  6770. that can be marked up by font-lock in Emacs, you can ask for the example to
  6771. look like the fontified Emacs buffer@footnote{Currently this works only for
  6772. the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or
  6773. later.}. This is done with the @samp{src} block, where you also need to
  6774. specify the name of the major mode that should be used to fontify the
  6775. example:
  6776. @cindex #+BEGIN_SRC
  6777. @example
  6778. #+BEGIN_SRC emacs-lisp
  6779. (defun org-xor (a b)
  6780. "Exclusive or."
  6781. (if a (not b) b))
  6782. #+END_SRC
  6783. @end example
  6784. Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
  6785. switch to the end of the @code{BEGIN} line, to get the lines of the example
  6786. numbered. If you use a @code{+n} switch, the numbering from the previous
  6787. numbered snippet will be continued in the current one. In literal examples,
  6788. Org will interpret strings like @samp{(ref:name)} as labels, and use them as
  6789. targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference
  6790. name enclosed in single parenthesis). In HTML, hovering the mouse over such
  6791. a link will remote-highlight the corresponding code line, which is kind of
  6792. cool. If the example/src snippet is numbered, you can also add a @code{-r}
  6793. switch. Then labels will be @i{removed} from the source code and the links
  6794. will be @i{replaced}@footnote{If you want to explain the use of such labels
  6795. themelves in org-mode example code, you can use the @code{-k} switch to make
  6796. sure they are not touched.} with line numbers from the code listing. Here is
  6797. an example:
  6798. @example
  6799. #+BEGIN_SRC emacs-lisp -n -r
  6800. (save-excursion (ref:sc)
  6801. (goto-char (point-min)) (ref:jump)
  6802. #+END SRC
  6803. In line [[(sc)]] we remember the current positon. [[(jump)][Line (jump)]]
  6804. jumps to point-min.
  6805. @end example
  6806. @vindex org-coderef-label-format
  6807. If the syntax for the label format conflicts with the language syntax, use a
  6808. @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
  6809. -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
  6810. HTML export also allows examples to be published as text areas, @pxref{Text
  6811. areas in HTML export}.
  6812. @table @kbd
  6813. @kindex C-c '
  6814. @item C-c '
  6815. Edit the source code example at point in its native mode. This works by
  6816. switching to an indirect buffer, narrowing the buffer and switching to the
  6817. other mode. You need to exit by pressing @kbd{C-c '} again@footnote{Upon
  6818. exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to
  6819. keep them from being interpreted by Org as outline nodes or special
  6820. comments. These commas will be striped for editing with @kbd{C-c '}, and
  6821. also for export.}. Fixed-width
  6822. regions (where each line starts with a colon followed by a space) will be
  6823. edited using @code{artist-mode}@footnote{You may select a different-mode with
  6824. the variable @code{org-edit-fixed-width-region-mode}.} to allow creating
  6825. ASCII drawings easily. Using this command in an empty line will create a new
  6826. fixed-width region.
  6827. @kindex C-c l
  6828. @item C-c l
  6829. Calling @code{org-store-link} while editing a source code example in a
  6830. temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
  6831. that it is unique in the current buffer, and insert it with the proper
  6832. formatting like @samp{(ref:label)} at the end of the current line. Then the
  6833. label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
  6834. @end table
  6835. @node Include files, Tables exported, Literal examples, Markup rules
  6836. @subheading Include files
  6837. @cindex include files, markup rules
  6838. During export, you can include the content of another file. For example, to
  6839. include your .emacs file, you could use:
  6840. @cindex #+INCLUDE
  6841. @example
  6842. #+INCLUDE: "~/.emacs" src emacs-lisp
  6843. @end example
  6844. The optional second and third parameter are the markup (@samp{quote},
  6845. @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
  6846. language for formatting the contents. The markup is optional, if it is not
  6847. given, the text will be assumed to be in Org mode format and will be
  6848. processed normally. The include line will also allow additional keyword
  6849. parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
  6850. first line and for each following line, as well as any options accepted by
  6851. the selected markup. For example, to include a file as an item, use
  6852. @example
  6853. #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
  6854. @end example
  6855. @table @kbd
  6856. @kindex C-c '
  6857. @item C-c '
  6858. Visit the include file at point.
  6859. @end table
  6860. @node Tables exported, Inlined images, Include files, Markup rules
  6861. @subheading Tables
  6862. @cindex tables, markup rules
  6863. Both the native Org mode tables (@pxref{Tables}) and tables formatted with
  6864. the @file{table.el} package will be exported properly. For Org mode tables,
  6865. the lines before the first horizontal separator line will become table header
  6866. lines. You can use the following lines somewhere before the table to assign
  6867. a caption and a label for cross references:
  6868. @example
  6869. #+CAPTION: This is the caption for the next table (or link)
  6870. #+LABEL: tbl:basic-data
  6871. @end example
  6872. @node Inlined images, Footnote markup, Tables exported, Markup rules
  6873. @subheading Inlined Images
  6874. @cindex inlined images, markup rules
  6875. Some backends (HTML and LaTeX) allow to directly include images into the
  6876. exported document. Org does this, if a link to an image files does not have
  6877. a description part, for example @code{[[./img/a.jpg]]}. If you wish to
  6878. define a caption for the image and maybe a label for internal cross
  6879. references, you can use (before, but close to the link)
  6880. @example
  6881. #+CAPTION: This is the caption for the next figure link (or table)
  6882. #+LABEL: fig:SED-HR4049
  6883. @end example
  6884. You may also define additional attributes for the figure. As this is
  6885. backend-specific, see the sections about the individual backends for more
  6886. information.
  6887. @node Footnote markup, Emphasis and monospace, Inlined images, Markup rules
  6888. @subheading Footnote markup
  6889. @cindex footnotes, markup rules
  6890. @cindex @file{footnote.el}
  6891. Footnotes defined in the way descriped in @ref{Footnotes} will be exported by
  6892. all backends. Org does allow multiple references to the same note, and
  6893. different backends support this to varying degree.
  6894. @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
  6895. @subheading Emphasis and monospace
  6896. @cindex underlined text, markup rules
  6897. @cindex bold text, markup rules
  6898. @cindex italic text, markup rules
  6899. @cindex verbatim text, markup rules
  6900. @cindex code text, markup rules
  6901. @cindex strike-through text, markup rules
  6902. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
  6903. and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
  6904. in the code and verbatim string is not processed for Org mode specific
  6905. syntax, it is exported verbatim.
  6906. @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
  6907. @subheading @TeX{} macros and La@TeX{} fragments
  6908. @cindex LaTeX fragments, markup rules
  6909. @cindex TeX macros, markup rules
  6910. @cindex HTML entities
  6911. @cindex LaTeX entities
  6912. @vindex org-html-entities
  6913. A @TeX{}-like syntax is used to specify special characters. Where possible,
  6914. these will be transformed into the native format of the exporter back-end.
  6915. Strings like @code{\alpha} will be exported as @code{&alpha;} in the HTML
  6916. output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
  6917. @code{\nbsp} will become @code{&nbsp;} in HTML and @code{~} in La@TeX{}.
  6918. This applies for a large number of entities, with names taken from both HTML
  6919. and La@TeX{}, see the variable @code{org-html-entities} for the complete
  6920. list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
  6921. after having typed the backslash and maybe a few characters
  6922. (@pxref{Completion}).
  6923. La@TeX{} fragments are converted into images for HTML export, and they are
  6924. written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}.
  6925. Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
  6926. @samp{...} are all converted into special commands creating hyphens of
  6927. different lengths or a compact set of dots.
  6928. @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
  6929. @subheading Horizontal rules
  6930. @cindex horizontal rules, markup rules
  6931. A line consisting of only dashes, and at least 5 of them, will be
  6932. exported as a horizontal line (@samp{<hr/>} in HTML).
  6933. @node Comment lines, , Horizontal rules, Markup rules
  6934. @subheading Comment lines
  6935. @cindex comment lines
  6936. @cindex exporting, not
  6937. Lines starting with @samp{#} in column zero are treated as comments and will
  6938. never be exported. Also entire subtrees starting with the word
  6939. @samp{COMMENT} will never be exported. Finally, regions surrounded by
  6940. @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
  6941. @table @kbd
  6942. @kindex C-c ;
  6943. @item C-c ;
  6944. Toggle the COMMENT keyword at the beginning of an entry.
  6945. @end table
  6946. @node Selective export, Export options, Markup rules, Exporting
  6947. @section Selective export
  6948. @cindex export, selective by tags
  6949. @vindex org-export-select-tags
  6950. @vindex org-export-exclude-tags
  6951. You may use tags to select the parts of a document that should be exported,
  6952. or to exclude parts from export. This behavior is governed by two variables:
  6953. @code{org-export-select-tags} and @code{org-export-exclude-tags}.
  6954. Org first checks if any of the @emph{select} tags is present in the buffer.
  6955. If yes, all trees that do not carry one of these tags will be excluded. If a
  6956. selected tree is a subtree, the heading hierarchy above it will also be
  6957. selected for export, but not the text below those headings.
  6958. @noindent
  6959. If none of the select tags is found, the whole buffer will be selected for
  6960. export.
  6961. @noindent
  6962. Finally, all subtrees that are marked by any of the @emph{exclude} tags will
  6963. be removed from the export buffer.
  6964. @node Export options, The export dispatcher, Selective export, Exporting
  6965. @section Export options
  6966. @cindex options, for export
  6967. @cindex completion, of option keywords
  6968. The exporter recognizes special lines in the buffer which provide
  6969. additional information. These lines may be put anywhere in the file.
  6970. The whole set of lines can be inserted into the buffer with @kbd{C-c
  6971. C-e t}. For individual lines, a good way to make sure the keyword is
  6972. correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
  6973. (@pxref{Completion}).
  6974. @table @kbd
  6975. @kindex C-c C-e t
  6976. @item C-c C-e t
  6977. Insert template with export options, see example below.
  6978. @end table
  6979. @cindex #+TITLE:
  6980. @cindex #+AUTHOR:
  6981. @cindex #+DATE:
  6982. @cindex #+EMAIL:
  6983. @cindex #+LANGUAGE:
  6984. @cindex #+TEXT:
  6985. @cindex #+OPTIONS:
  6986. @cindex #+LINK_UP:
  6987. @cindex #+LINK_HOME:
  6988. @cindex #+EXPORT_SELECT_TAGS:
  6989. @cindex #+EXPORT_EXCLUDE_TAGS:
  6990. @vindex user-full-name
  6991. @vindex user-mail-address
  6992. @vindex org-export-default-language
  6993. @example
  6994. #+TITLE: the title to be shown (default is the buffer name)
  6995. #+AUTHOR: the author (default taken from @code{user-full-name})
  6996. #+DATE: A date, fixed, of a format string for @code{format-time-string}
  6997. #+EMAIL: his/her email address (default from @code{user-mail-address})
  6998. #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
  6999. #+TEXT: Some descriptive text to be inserted at the beginning.
  7000. #+TEXT: Several lines may be given.
  7001. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
  7002. #+LINK_UP: the ``up'' link of an exported page
  7003. #+LINK_HOME: the ``home'' link of an exported page
  7004. #+EXPORT_SELECT_TAGS: Tags that select a tree for export
  7005. #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
  7006. @end example
  7007. @noindent
  7008. The OPTIONS line is a compact@footnote{If you want to configure many options
  7009. this way, you can use several OPTIONS lines.} form to specify export settings. Here
  7010. you can:
  7011. @cindex headline levels
  7012. @cindex section-numbers
  7013. @cindex table of contents
  7014. @cindex line-break preservation
  7015. @cindex quoted HTML tags
  7016. @cindex fixed-width sections
  7017. @cindex tables
  7018. @cindex @TeX{}-like syntax for sub- and superscripts
  7019. @cindex footnotes
  7020. @cindex special strings
  7021. @cindex emphasized text
  7022. @cindex @TeX{} macros
  7023. @cindex La@TeX{} fragments
  7024. @cindex author info, in export
  7025. @cindex time info, in export
  7026. @example
  7027. H: @r{set the number of headline levels for export}
  7028. num: @r{turn on/off section-numbers}
  7029. toc: @r{turn on/off table of contents, or set level limit (integer)}
  7030. \n: @r{turn on/off line-break-preservation}
  7031. @@: @r{turn on/off quoted HTML tags}
  7032. :: @r{turn on/off fixed-width sections}
  7033. |: @r{turn on/off tables}
  7034. ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
  7035. @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
  7036. @r{the simple @code{a_b} will be left as it is.}
  7037. -: @r{turn on/off conversion of special strings.}
  7038. f: @r{turn on/off footnotes like this[1].}
  7039. todo: @r{turn on/off inclusion of TODO keywords into exported text}
  7040. pri: @r{turn on/off priority cookies}
  7041. tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
  7042. <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
  7043. *: @r{turn on/off emphasized text (bold, italic, underlined)}
  7044. TeX: @r{turn on/off simple @TeX{} macros in plain text}
  7045. LaTeX: @r{turn on/off La@TeX{} fragments}
  7046. skip: @r{turn on/off skipping the text before the first heading}
  7047. author: @r{turn on/off inclusion of author name/email into exported file}
  7048. creator: @r{turn on/off inclusion of creator info into exported file}
  7049. timestamp: @r{turn on/off inclusion creation time into exported file}
  7050. d: @r{turn on/off inclusion of drawers}
  7051. @end example
  7052. These options take effect in both the HTML and La@TeX{} export, except
  7053. for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
  7054. @code{nil} for the La@TeX{} export.
  7055. When exporting only a single subtree by selecting it with @kbd{C-c @@} before
  7056. calling an export command, the subtree can overrule some of the file's export
  7057. settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
  7058. @code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}.
  7059. @node The export dispatcher, ASCII export, Export options, Exporting
  7060. @section The export dispatcher
  7061. @cindex dispatcher, for export commands
  7062. All export commands can be reached using the export dispatcher, which is a
  7063. prefix key that prompts for an additional key specifying the command.
  7064. Normally the entire file is exported, but if there is an active region that
  7065. contains one outline tree, the first heading is used as document title and
  7066. the subtrees are exported.
  7067. @table @kbd
  7068. @kindex C-c C-e
  7069. @item C-c C-e
  7070. @vindex org-export-run-in-background
  7071. Dispatcher for export and publishing commands. Displays a help-window
  7072. listing the additional key(s) needed to launch an export or publishing
  7073. command. The prefix arg is passed through to the exporter. A double prefix
  7074. @kbd{C-u C-u} causes most commands to be executed in the background, in a
  7075. separate emacs process@footnote{To make this behavior the default, customize
  7076. the variable @code{org-export-run-in-background}.}.
  7077. @kindex C-c C-e v
  7078. @item C-c C-e v
  7079. Like @kbd{C-c C-e}, but only export the text that is currently visible
  7080. (i.e. not hidden by outline visibility).
  7081. @kindex C-u C-u C-c C-e
  7082. @item C-u C-u C-c C-e
  7083. @vindex org-export-run-in-background
  7084. Call an the exporter, but reverse the setting of
  7085. @code{org-export-run-in-background}, i.e. request background processing if
  7086. not set, or force processing in the current Emacs process if st.
  7087. @end table
  7088. @node ASCII export, HTML export, The export dispatcher, Exporting
  7089. @section ASCII export
  7090. @cindex ASCII export
  7091. ASCII export produces a simple and very readable version of an Org mode
  7092. file.
  7093. @cindex region, active
  7094. @cindex active region
  7095. @cindex transient-mark-mode
  7096. @table @kbd
  7097. @kindex C-c C-e a
  7098. @item C-c C-e a
  7099. Export as ASCII file. For an org file @file{myfile.org}, the ASCII file
  7100. will be @file{myfile.txt}. The file will be overwritten without
  7101. warning. If there is an active region@footnote{this requires
  7102. @code{transient-mark-mode} to be turned on}, only the region will be
  7103. exported. If the selected region is a single tree@footnote{To select the
  7104. current subtree, use @kbd{C-c @@}.}, the tree head will
  7105. become the document title. If the tree head entry has or inherits an
  7106. @code{EXPORT_FILE_NAME} property, that name will be used for the
  7107. export.
  7108. @kindex C-c C-e v a
  7109. @item C-c C-e v a
  7110. Export only the visible part of the document.
  7111. @end table
  7112. @cindex headline levels, for exporting
  7113. In the exported version, the first 3 outline levels will become
  7114. headlines, defining a general document structure. Additional levels
  7115. will be exported as itemized lists. If you want that transition to occur
  7116. at a different level, specify it with a prefix argument. For example,
  7117. @example
  7118. @kbd{C-1 C-c C-e a}
  7119. @end example
  7120. @noindent
  7121. creates only top level headlines and does the rest as items. When
  7122. headlines are converted to items, the indentation of the text following
  7123. the headline is changed to fit nicely under the item. This is done with
  7124. the assumption that the first body line indicates the base indentation of
  7125. the body text. Any indentation larger than this is adjusted to preserve
  7126. the layout relative to the first line. Should there be lines with less
  7127. indentation than the first, these are left alone.
  7128. @node HTML export, LaTeX and PDF export, ASCII export, Exporting
  7129. @section HTML export
  7130. @cindex HTML export
  7131. Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
  7132. HTML formatting, in ways similar to John Gruber's @emph{markdown}
  7133. language, but with additional support for tables.
  7134. @menu
  7135. * HTML Export commands:: How to invoke HTML export
  7136. * Quoting HTML tags:: Using direct HTML in Org mode
  7137. * Links:: Transformation of links for HTML
  7138. * Images in HTML export:: How to insert figures into HTML output
  7139. * Text areas in HTML export:: An alternative way to show an example
  7140. * CSS support:: Changing the appearance of the output
  7141. * Javascript support:: Info and Folding in a web browser
  7142. @end menu
  7143. @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
  7144. @subsection HTML export commands
  7145. @cindex region, active
  7146. @cindex active region
  7147. @cindex transient-mark-mode
  7148. @table @kbd
  7149. @kindex C-c C-e h
  7150. @item C-c C-e h
  7151. Export as HTML file @file{myfile.html}. For an org file @file{myfile.org},
  7152. the ASCII file will be @file{myfile.html}. The file will be overwritten
  7153. without warning. If there is an active region@footnote{this requires
  7154. @code{transient-mark-mode} to be turned on}, only the region will be
  7155. exported. If the selected region is a single tree@footnote{To select the
  7156. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  7157. title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
  7158. property, that name will be used for the export.
  7159. @kindex C-c C-e b
  7160. @item C-c C-e b
  7161. Export as HTML file and immediately open it with a browser.
  7162. @kindex C-c C-e H
  7163. @item C-c C-e H
  7164. Export to a temporary buffer, do not create a file.
  7165. @kindex C-c C-e R
  7166. @item C-c C-e R
  7167. Export the active region to a temporary buffer. With a prefix argument, do
  7168. not produce the file header and footer, but just the plain HTML section for
  7169. the region. This is good for cut-and-paste operations.
  7170. @kindex C-c C-e v h
  7171. @kindex C-c C-e v b
  7172. @kindex C-c C-e v H
  7173. @kindex C-c C-e v R
  7174. @item C-c C-e v h
  7175. @item C-c C-e v b
  7176. @item C-c C-e v H
  7177. @item C-c C-e v R
  7178. Export only the visible part of the document.
  7179. @item M-x org-export-region-as-html
  7180. Convert the region to HTML under the assumption that it was Org mode
  7181. syntax before. This is a global command that can be invoked in any
  7182. buffer.
  7183. @item M-x org-replace-region-by-HTML
  7184. Replace the active region (assumed to be in Org mode syntax) by HTML
  7185. code.
  7186. @end table
  7187. @cindex headline levels, for exporting
  7188. In the exported version, the first 3 outline levels will become headlines,
  7189. defining a general document structure. Additional levels will be exported as
  7190. itemized lists. If you want that transition to occur at a different level,
  7191. specify it with a numeric prefix argument. For example,
  7192. @example
  7193. @kbd{C-2 C-c C-e b}
  7194. @end example
  7195. @noindent
  7196. creates two levels of headings and does the rest as items.
  7197. @node Quoting HTML tags, Links, HTML Export commands, HTML export
  7198. @subsection Quoting HTML tags
  7199. Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
  7200. @samp{&gt;} in HTML export. If you want to include simple HTML tags
  7201. which should be interpreted as such, mark them with @samp{@@} as in
  7202. @samp{@@<b>bold text@@</b>}. Note that this really works only for
  7203. simple tags. For more extensive HTML that should be copied verbatim to
  7204. the exported file use either
  7205. @example
  7206. #+HTML: Literal HTML code for export
  7207. @end example
  7208. @noindent or
  7209. @cindex #+BEGIN_HTML
  7210. @example
  7211. #+BEGIN_HTML
  7212. All lines between these markers are exported literally
  7213. #+END_HTML
  7214. @end example
  7215. @node Links, Images in HTML export, Quoting HTML tags, HTML export
  7216. @subsection Links
  7217. @cindex links, in HTML export
  7218. @cindex internal links, in HTML export
  7219. @cindex external links, in HTML export
  7220. Internal links (@pxref{Internal links}) will continue to work in HTML. This
  7221. does include automatic links created by radio targets (@pxref{Radio
  7222. targets}). Links to external files will still work if the target file is on
  7223. the same @i{relative} path as the published Org file. Links to other
  7224. @file{.org} files will be translated into HTML links under the assumption
  7225. that an HTML version also exists of the linked file, at the same relative
  7226. path. @samp{id:} links can then be used to jump to specific entries across
  7227. files. For information related to linking files while publishing them to a
  7228. publishing directory see @ref{Publishing links}.
  7229. If you want to specify attributes for links, you can do so using a special
  7230. @code{#+ATTR_HTML} line to define attributes that will be added to the
  7231. @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
  7232. and @code{style} attributes for a link:
  7233. @example
  7234. #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
  7235. [[http://orgmode.org]]
  7236. @end example
  7237. @node Images in HTML export, Text areas in HTML export, Links, HTML export
  7238. @subsection Images
  7239. @cindex images, inline in HTML
  7240. @cindex inlining images in HTML
  7241. @vindex org-export-html-inline-images
  7242. HTML export can inline images given as links in the Org file, and
  7243. it can make an image the clickable part of a link. By
  7244. default@footnote{but see the variable
  7245. @code{org-export-html-inline-images}}, images are inlined if a link does
  7246. not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
  7247. while @samp{[[file:myimg.jpg][the image]]} will just produce a link
  7248. @samp{the image} that points to the image. If the description part
  7249. itself is a @code{file:} link or a @code{http:} URL pointing to an
  7250. image, this image will be inlined and activated so that clicking on the
  7251. image will activate the link. For example, to include a thumbnail that
  7252. will link to a high resolution version of the image, you could use:
  7253. @example
  7254. [[file:highres.jpg][file:thumb.jpg]]
  7255. @end example
  7256. If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML},
  7257. for example:
  7258. @example
  7259. #+CAPTION: A black cat stalking a spider
  7260. #+ATTR_HTML: alt="cat/spider image" title="one second before action"
  7261. [[./img/a.jpg]]
  7262. @end example
  7263. @noindent
  7264. and you could use @code{http} addresses just as well.
  7265. @node Text areas in HTML export, CSS support, Images in HTML export, HTML export
  7266. @subsection Text areas
  7267. @cindex text areas, in HTML
  7268. An alternative way to publish literal code examples in HTML is to use text
  7269. areas, where the example can even be edited before pasting it into an
  7270. application. It is triggered by a @code{-t} switch at an @code{example} or
  7271. @code{src} block. Using this switch disables any options for syntax and
  7272. label highlighting, and line numbering, which may be present. You may also
  7273. use @code{-h} and @code{-w} switches to specify the height and width of the
  7274. text area, which default to the number of lines in the example, and 80,
  7275. respectively. For example
  7276. @example
  7277. #+BEGIN_EXAMPLE -t -w 40
  7278. (defun org-xor (a b)
  7279. "Exclusive or."
  7280. (if a (not b) b))
  7281. #+END_EXAMPLE
  7282. @end example
  7283. @node CSS support, Javascript support, Text areas in HTML export, HTML export
  7284. @subsection CSS support
  7285. @cindex CSS, for HTML export
  7286. @cindex HTML export, CSS
  7287. You can also give style information for the exported file. The HTML exporter
  7288. assigns the following special CSS classes to appropriate parts of the
  7289. document - your style specifications may change these, in addition to any of
  7290. the standard classes like for headlines, tables etc.
  7291. @example
  7292. .todo @r{TODO keywords, all not-done states}
  7293. .done @r{the DONE keywords, all stated the count as done}
  7294. WAITING @r{Each TODO keyword also uses a class named after itself}
  7295. .timestamp @r{time stamp}
  7296. .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
  7297. .tag @r{tag in a headline}
  7298. .target @r{target for links}
  7299. div.figure @r{how to format an inlined image}
  7300. .linenr @r{the line number in a code example}
  7301. .code-highlighted @r{for highlighting referenced code lines}
  7302. .section-number-N @r{section number in headlines, different for each level}
  7303. @end example
  7304. @vindex org-export-html-style-default
  7305. @vindex org-export-html-style-include-default
  7306. @vindex org-export-html-style
  7307. @vindex org-export-html-extra
  7308. @vindex org-export-html-style-default
  7309. Each exported files contains a compact default style that defines these
  7310. classes in a basic way@footnote{This style is defined in the constant
  7311. @code{org-export-html-style-default}, which you should not modify. To turn
  7312. inclusion of these defaults off, customize
  7313. @code{org-export-html-style-include-default}}. You may overwrite these
  7314. settings, or add to them by using the variables @code{org-export-html-style}
  7315. (for Org-wide settings) and @code{org-export-html-style-extra} (for more
  7316. granular settings, like file-local settings). To set the latter variable
  7317. individually for each file, you can use
  7318. @example
  7319. #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  7320. @end example
  7321. @noindent
  7322. For longer style definitions, you can use several such lines. You could also
  7323. directly write a @code{<style>} @code{</style>} section in this way, without
  7324. referring to an external file.
  7325. @c FIXME: More about header and footer styles
  7326. @c FIXME: Talk about links and targets.
  7327. @node Javascript support, , CSS support, HTML export
  7328. @subsection Javascript supported display of web pages
  7329. @emph{Sebastian Rose} has written a JavaScript program especially designed to
  7330. enhance the web viewing experience of HTML files created with Org. This
  7331. program allows you to view large files in two different ways. The first one
  7332. is an @emph{Info}-like mode where each section is displayed separately and
  7333. navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
  7334. as well, press @kbd{?} for an overview of the available keys). The second
  7335. view type is a @emph{folding} view much like Org provides inside Emacs. The
  7336. script is available at @url{http://orgmode.org/org-info.js} and you can find
  7337. the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
  7338. We are serving the script from our site, but if you use it a lot, you might
  7339. not want to be dependent on @url{orgmode.org} and prefer to install a local
  7340. copy on your own web server.
  7341. To use the script, you need to make sure that the @file{org-jsinfo.el} module
  7342. gets loaded. It should be loaded by default, but you can try @kbd{M-x
  7343. customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
  7344. this is indeed the case. All it then takes to make use of the program is
  7345. adding a single line to the Org file:
  7346. @example
  7347. #+INFOJS_OPT: view:info toc:nil
  7348. @end example
  7349. @noindent
  7350. If this line is found, the HTML header will automatically contain the code
  7351. needed to invoke the script. Using the line above, you can set the following
  7352. viewing options:
  7353. @example
  7354. path: @r{The path to the script. The default is to grab the script from}
  7355. @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
  7356. @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
  7357. view: @r{Initial view when website is first shown. Possible values are:}
  7358. info @r{Info-like interface with one section per page.}
  7359. overview @r{Folding interface, initially showing only top-level.}
  7360. content @r{Folding interface, starting with all headlines visible.}
  7361. showall @r{Folding interface, all headlines and text visible.}
  7362. sdepth: @r{Maximum headline level that will still become an independent}
  7363. @r{section for info and folding modes. The default is taken from}
  7364. @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
  7365. @r{If this is smaller than in @code{org-headline-levels}, each}
  7366. @r{info/folding section can still contain children headlines.}
  7367. toc: @r{Should the table of content @emph{initially} be visible?}
  7368. @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.}
  7369. tdepth: @r{The depth of the table of contents. The defaults are taken from}
  7370. @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
  7371. ftoc: @r{Does the css of the page specify a fixed position for the toc?}
  7372. @r{If yes, the toc will never be displayed as a section.}
  7373. ltoc: @r{Should there be short contents (children) in each section?}
  7374. @r{Make this @code{above} it the section should be above initial text.}
  7375. mouse: @r{Headings are highlighted when the mouse is over them. Should be}
  7376. @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
  7377. buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
  7378. @r{default), only one such button will be present.}
  7379. @end example
  7380. @vindex org-infojs-options
  7381. @vindex org-export-html-use-infojs
  7382. You can choose default values for these options by customizing the variable
  7383. @code{org-infojs-options}. If you always want to apply the script to your
  7384. pages, configure the variable @code{org-export-html-use-infojs}.
  7385. @node LaTeX and PDF export, XOXO export, HTML export, Exporting
  7386. @section LaTeX and PDF export
  7387. @cindex LaTeX export
  7388. @cindex PDF export
  7389. Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
  7390. further processing, this backend is also used to produce PDF output. Since
  7391. the LaTeX output uses @file{hyperref} to implement links and cross
  7392. references, the PDF output file will be fully linked.
  7393. @menu
  7394. * LaTeX/PDF export commands:: Which key invokes which commands
  7395. * Quoting LaTeX code:: Incorporating literal LaTeX code
  7396. * Sectioning structure:: Changing sectioning in LaTeX output
  7397. * Tables in LaTeX export:: Options for exporting tables to LaTeX
  7398. * Images in LaTeX export:: How to insert figures into LaTeX output
  7399. @end menu
  7400. @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
  7401. @subsection LaTeX export commands
  7402. @cindex region, active
  7403. @cindex active region
  7404. @cindex transient-mark-mode
  7405. @table @kbd
  7406. @kindex C-c C-e l
  7407. @item C-c C-e l
  7408. Export as La@TeX{} file @file{myfile.tex}. For an org file
  7409. @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
  7410. be overwritten without warning. If there is an active region@footnote{this
  7411. requires @code{transient-mark-mode} to be turned on}, only the region will be
  7412. exported. If the selected region is a single tree@footnote{To select the
  7413. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  7414. title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
  7415. property, that name will be used for the export.
  7416. @kindex C-c C-e L
  7417. @item C-c C-e L
  7418. Export to a temporary buffer, do not create a file.
  7419. @kindex C-c C-e v l
  7420. @kindex C-c C-e v L
  7421. @item C-c C-e v l
  7422. @item C-c C-e v L
  7423. Export only the visible part of the document.
  7424. @item M-x org-export-region-as-latex
  7425. Convert the region to La@TeX{} under the assumption that it was Org mode
  7426. syntax before. This is a global command that can be invoked in any
  7427. buffer.
  7428. @item M-x org-replace-region-by-latex
  7429. Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
  7430. code.
  7431. @kindex C-c C-e p
  7432. @item C-c C-e p
  7433. Export as LaTeX and then process to PDF.
  7434. @kindex C-c C-e d
  7435. @item C-c C-e d
  7436. Export as LaTeX and then process to PDF, then open the resulting PDF file.
  7437. @end table
  7438. @cindex headline levels, for exporting
  7439. @vindex org-latex-low-levels
  7440. In the exported version, the first 3 outline levels will become
  7441. headlines, defining a general document structure. Additional levels
  7442. will be exported as description lists. The exporter can ignore them or
  7443. convert them to a custom string depending on
  7444. @code{org-latex-low-levels}.
  7445. If you want that transition to occur at a different level, specify it
  7446. with a numeric prefix argument. For example,
  7447. @example
  7448. @kbd{C-2 C-c C-e l}
  7449. @end example
  7450. @noindent
  7451. creates two levels of headings and does the rest as items.
  7452. @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
  7453. @subsection Quoting LaTeX code
  7454. Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
  7455. inserted into the La@TeX{} file. This includes simple macros like
  7456. @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
  7457. you can add special code that should only be present in La@TeX{} export with
  7458. the following constructs:
  7459. @example
  7460. #+LaTeX: Literal LaTeX code for export
  7461. @end example
  7462. @noindent or
  7463. @cindex #+BEGIN_LaTeX
  7464. @example
  7465. #+BEGIN_LaTeX
  7466. All lines between these markers are exported literally
  7467. #+END_LaTeX
  7468. @end example
  7469. @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
  7470. @subsection Sectioning structure
  7471. @cindex LaTeX class
  7472. @cindex LaTeX sectioning structure
  7473. By default, the La@TeX{} output uses the class @code{article}.
  7474. @vindex org-export-latex-default-class
  7475. @vindex org-export-latex-classes
  7476. You can change this globally by setting a different value for
  7477. @code{org-export-latex-default-class} or locally by adding an option like
  7478. @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
  7479. property that applies when exporting a region containing only this (sub)tree.
  7480. The class should be listed in @code{org-export-latex-classes}, where you can
  7481. also define the sectioning structure for each class, as well as defining
  7482. additional classes.
  7483. @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
  7484. @subsection Tables in LaTeX export
  7485. @cindex tables, in LaTeX export
  7486. For LaTeX export of a table, you can specify a label and a caption
  7487. (@pxref{Markup rules}). You can also use the @code{ATTR_LaTeX} line to
  7488. request a longtable environment for the table, so that it may span several
  7489. pages:
  7490. @example
  7491. #+CAPTION: A long table
  7492. #+LABEL: tbl:long
  7493. #+ATTR_LaTeX: longtable
  7494. | ..... | ..... |
  7495. | ..... | ..... |
  7496. @end example
  7497. @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export
  7498. @subsection Images in LaTeX export
  7499. @cindex images, inline in LaTeX
  7500. @cindex inlining images in LaTeX
  7501. Images that are linked to without a description part in the link, like
  7502. @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
  7503. output files resulting from LaTeX output. Org will use an
  7504. @code{\includegraphics} macro to insert the image. If you have specified a
  7505. caption and/or a label as described in @ref{Markup rules}, the figure will
  7506. be wrapped into a @code{figure} environment and thus become a floating
  7507. element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the
  7508. options that can be used in the optional argument of the
  7509. @code{\includegraphics} macro.
  7510. @example
  7511. #+CAPTION: The black-body emission of the disk around HR 4049
  7512. #+LABEL: fig:SED-HR4049
  7513. #+ATTR_LaTeX: width=5cm,angle=90
  7514. [[./img/sed-hr4049.pdf]]
  7515. @end example
  7516. @vindex org-export-latex-inline-image-extensions
  7517. If you need references to a label created in this way, write
  7518. @samp{\ref@{fig:SED-HR4049@}} just like in LaTeX. The default settings will
  7519. recognize files types that can be included as images during processing by
  7520. pdflatex (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
  7521. files in a different way, you may need to customize the variable
  7522. @code{org-export-latex-inline-image-extensions}.
  7523. @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting
  7524. @section XOXO export
  7525. @cindex XOXO export
  7526. Org mode contains an exporter that produces XOXO-style output.
  7527. Currently, this exporter only handles the general outline structure and
  7528. does not interpret any additional Org mode features.
  7529. @table @kbd
  7530. @kindex C-c C-e x
  7531. @item C-c C-e x
  7532. Export as XOXO file @file{myfile.html}.
  7533. @kindex C-c C-e v
  7534. @item C-c C-e v x
  7535. Export only the visible part of the document.
  7536. @end table
  7537. @node iCalendar export, , XOXO export, Exporting
  7538. @section iCalendar export
  7539. @cindex iCalendar export
  7540. @vindex org-icalendar-include-todo
  7541. @vindex org-icalendar-use-deadline
  7542. @vindex org-icalendar-use-scheduled
  7543. @vindex org-icalendar-categories
  7544. Some people like to use Org mode for keeping track of projects, but still
  7545. prefer a standard calendar application for anniversaries and appointments.
  7546. In this case it can be useful to have deadlines and other time-stamped items
  7547. in Org files show up in the calendar application. Org mode can export
  7548. calendar information in the standard iCalendar format. If you also want to
  7549. have TODO entries included in the export, configure the variable
  7550. @code{org-icalendar-include-todo}. iCalendar export will export plain time
  7551. stamps as VEVENT, and TODO items as VTODO. It will also create events from
  7552. deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO
  7553. items will be used to set the start and due dates for the todo
  7554. entry@footnote{See the variables @code{org-icalendar-use-deadline} and
  7555. @code{org-icalendar-use-scheduled}.}. As categories, it will use the tags
  7556. locally defined in the heading, and the file/tree category@footnote{To add
  7557. inherited tags or the TODO state, configure the variable
  7558. @code{org-icalendar-categories}.}.
  7559. @vindex org-icalendar-store-UID
  7560. The iCalendar standard requires each entry to have a globally unique
  7561. identifier (UID). Org creates these identifiers during export. If you set
  7562. the variable @code{org-icalendar-store-UID}, the UID will be stored in the
  7563. @code{:ID:} property of the entry and re-used next time you report this
  7564. entry. Since a single entry can give rise to multiple iCalendar entries (as
  7565. a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
  7566. prefixes to the UID, depending on what triggered the inclusion of the entry.
  7567. In this way the UID remains unique, but a synchronization program can still
  7568. figure out from which entry all the different instances originate.
  7569. @table @kbd
  7570. @kindex C-c C-e i
  7571. @item C-c C-e i
  7572. Create iCalendar entries for the current file and store them in the same
  7573. directory, using a file extension @file{.ics}.
  7574. @kindex C-c C-e I
  7575. @item C-c C-e I
  7576. @vindex org-agenda-files
  7577. Like @kbd{C-c C-e i}, but do this for all files in
  7578. @code{org-agenda-files}. For each of these files, a separate iCalendar
  7579. file will be written.
  7580. @kindex C-c C-e c
  7581. @item C-c C-e c
  7582. @vindex org-combined-agenda-icalendar-file
  7583. Create a single large iCalendar file from all files in
  7584. @code{org-agenda-files} and write it to the file given by
  7585. @code{org-combined-agenda-icalendar-file}.
  7586. @end table
  7587. @vindex org-use-property-inheritance
  7588. @vindex org-icalendar-include-body
  7589. The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
  7590. property can be inherited from higher in the hierarchy if you configure
  7591. @code{org-use-property-inheritance} accordingly.} properties if the selected
  7592. entries have them. If not, the summary will be derived from the headline,
  7593. and the description from the body (limited to
  7594. @code{org-icalendar-include-body} characters).
  7595. How this calendar is best read and updated, that depends on the application
  7596. you are using. The FAQ covers this issue.
  7597. @node Publishing, Miscellaneous, Exporting, Top
  7598. @chapter Publishing
  7599. @cindex publishing
  7600. Org includes@footnote{@file{org-publish.el} is not distributed with
  7601. Emacs 21, if you are still using Emacs 21, you need you need to download
  7602. this file separately.} a publishing management system that allows you to
  7603. configure automatic HTML conversion of @emph{projects} composed of
  7604. interlinked org files. This system is called @emph{org-publish}. You can
  7605. also configure org-publish to automatically upload your exported HTML
  7606. pages and related attachments, such as images and source code files, to
  7607. a web server. Org-publish turns Org into a web-site authoring tool.
  7608. You can also use Org-publish to convert files into La@TeX{}, or even
  7609. combine HTML and La@TeX{} conversion so that files are available in both
  7610. formats on the server@footnote{Since La@TeX{} files on a server are not
  7611. that helpful, you surely want to perform further conversion on them --
  7612. e.g. convert them to @code{PDF} format.}.
  7613. Org-publish has been contributed to Org by David O'Toole.
  7614. @menu
  7615. * Configuration:: Defining projects
  7616. * Sample configuration:: Example projects
  7617. * Triggering publication:: Publication commands
  7618. @end menu
  7619. @node Configuration, Sample configuration, Publishing, Publishing
  7620. @section Configuration
  7621. Publishing needs significant configuration to specify files, destination
  7622. and many other properties of a project.
  7623. @menu
  7624. * Project alist:: The central configuration variable
  7625. * Sources and destinations:: From here to there
  7626. * Selecting files:: What files are part of the project?
  7627. * Publishing action:: Setting the function doing the publishing
  7628. * Publishing options:: Tweaking HTML export
  7629. * Publishing links:: Which links keep working after publishing?
  7630. * Project page index:: Publishing a list of project files
  7631. @end menu
  7632. @node Project alist, Sources and destinations, Configuration, Configuration
  7633. @subsection The variable @code{org-publish-project-alist}
  7634. @cindex org-publish-project-alist
  7635. @cindex projects, for publishing
  7636. @vindex org-publish-project-alist
  7637. Org-publish is configured almost entirely through setting the value of
  7638. one variable, called @code{org-publish-project-alist}.
  7639. Each element of the list configures one project, and may be in one of
  7640. the two following forms:
  7641. @lisp
  7642. ("project-name" :property value :property value ...)
  7643. @r{or}
  7644. ("project-name" :components ("project-name" "project-name" ...))
  7645. @end lisp
  7646. In both cases, projects are configured by specifying property values.
  7647. A project defines the set of files that will be published, as well as
  7648. the publishing configuration to use when publishing those files. When
  7649. a project takes the second form listed above, the individual members
  7650. of the ``components'' property are taken to be components of the
  7651. project, which group together files requiring different publishing
  7652. options. When you publish such a ``meta-project'' all the components
  7653. will also publish. The @code{:components} are published in the sequence
  7654. provided.
  7655. @node Sources and destinations, Selecting files, Project alist, Configuration
  7656. @subsection Sources and destinations for files
  7657. @cindex directories, for publishing
  7658. Most properties are optional, but some should always be set. In
  7659. particular, org-publish needs to know where to look for source files,
  7660. and where to put published files.
  7661. @multitable @columnfractions 0.3 0.7
  7662. @item @code{:base-directory}
  7663. @tab Directory containing publishing source files
  7664. @item @code{:publishing-directory}
  7665. @tab Directory (possibly remote) where output files will be published.
  7666. @item @code{:preparation-function}
  7667. @tab Function called before starting the publishing process, for example to
  7668. run @code{make} for updating files to be published.
  7669. @item @code{:completion-function}
  7670. @tab Function called after finishing the publishing process, for example to
  7671. change permissions of the resulting files.
  7672. @end multitable
  7673. @noindent
  7674. @node Selecting files, Publishing action, Sources and destinations, Configuration
  7675. @subsection Selecting files
  7676. @cindex files, selecting for publishing
  7677. By default, all files with extension @file{.org} in the base directory
  7678. are considered part of the project. This can be modified by setting the
  7679. properties
  7680. @multitable @columnfractions 0.25 0.75
  7681. @item @code{:base-extension}
  7682. @tab Extension (without the dot!) of source files. This actually is a
  7683. regular expression. Set this to the symbol @code{any} if you want to get all
  7684. files in @code{:base-directory}, even without extension.
  7685. @item @code{:exclude}
  7686. @tab Regular expression to match file names that should not be
  7687. published, even though they have been selected on the basis of their
  7688. extension.
  7689. @item @code{:include}
  7690. @tab List of files to be included regardless of @code{:base-extension}
  7691. and @code{:exclude}.
  7692. @end multitable
  7693. @node Publishing action, Publishing options, Selecting files, Configuration
  7694. @subsection Publishing action
  7695. @cindex action, for publishing
  7696. Publishing means that a file is copied to the destination directory and
  7697. possibly transformed in the process. The default transformation is to export
  7698. Org files as HTML files, and this is done by the function
  7699. @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
  7700. export}). But you also can publish your files in La@TeX{} by using the
  7701. function @code{org-publish-org-to-latex} instead, or as PDF files using
  7702. @code{org-publish-org-to-pdf}. Other files like images only need to be
  7703. copied to the publishing destination. For non-Org files, you need to provide
  7704. your own publishing function:
  7705. @multitable @columnfractions 0.3 0.7
  7706. @item @code{:publishing-function}
  7707. @tab Function executing the publication of a file. This may also be a
  7708. list of functions, which will all be called in turn.
  7709. @end multitable
  7710. The function must accept two arguments: a property list containing at
  7711. least a @code{:publishing-directory} property, and the name of the file
  7712. to be published. It should take the specified file, make the necessary
  7713. transformation (if any) and place the result into the destination folder.
  7714. You can write your own publishing function, but @code{org-publish}
  7715. provides one for attachments (files that only need to be copied):
  7716. @code{org-publish-attachment}.
  7717. @node Publishing options, Publishing links, Publishing action, Configuration
  7718. @subsection Options for the HTML/LaTeX exporters
  7719. @cindex options, for publishing
  7720. The property list can be used to set many export options for the HTML
  7721. and La@TeX{} exporters. In most cases, these properties correspond to user
  7722. variables in Org. The table below lists these properties along
  7723. with the variable they belong to. See the documentation string for the
  7724. respective variable for details.
  7725. @vindex org-export-html-link-up
  7726. @vindex org-export-html-link-home
  7727. @vindex org-export-default-language
  7728. @vindex org-display-custom-times
  7729. @vindex org-export-headline-levels
  7730. @vindex org-export-with-section-numbers
  7731. @vindex org-export-section-number-format
  7732. @vindex org-export-with-toc
  7733. @vindex org-export-preserve-breaks
  7734. @vindex org-export-with-archived-trees
  7735. @vindex org-export-with-emphasize
  7736. @vindex org-export-with-sub-superscripts
  7737. @vindex org-export-with-special-strings
  7738. @vindex org-export-with-footnotes
  7739. @vindex org-export-with-drawers
  7740. @vindex org-export-with-tags
  7741. @vindex org-export-with-todo-keywords
  7742. @vindex org-export-with-priority
  7743. @vindex org-export-with-TeX-macros
  7744. @vindex org-export-with-LaTeX-fragments
  7745. @vindex org-export-skip-text-before-1st-heading
  7746. @vindex org-export-with-fixed-width
  7747. @vindex org-export-with-timestamps
  7748. @vindex org-export-author-info
  7749. @vindex org-export-creator-info
  7750. @vindex org-export-with-tables
  7751. @vindex org-export-highlight-first-table-line
  7752. @vindex org-export-html-style-include-default
  7753. @vindex org-export-html-style
  7754. @vindex org-export-html-style-extra
  7755. @vindex org-export-html-link-org-files-as-html
  7756. @vindex org-export-html-inline-images
  7757. @vindex org-export-html-extension
  7758. @vindex org-export-html-table-tag
  7759. @vindex org-export-html-expand
  7760. @vindex org-export-html-with-timestamp
  7761. @vindex org-export-publishing-directory
  7762. @vindex org-export-html-preamble
  7763. @vindex org-export-html-postamble
  7764. @vindex org-export-html-auto-preamble
  7765. @vindex org-export-html-auto-postamble
  7766. @vindex user-full-name
  7767. @vindex user-mail-address
  7768. @vindex org-export-select-tags
  7769. @vindex org-export-exclude-tags
  7770. @multitable @columnfractions 0.32 0.68
  7771. @item @code{:link-up} @tab @code{org-export-html-link-up}
  7772. @item @code{:link-home} @tab @code{org-export-html-link-home}
  7773. @item @code{:language} @tab @code{org-export-default-language}
  7774. @item @code{:customtime} @tab @code{org-display-custom-times}
  7775. @item @code{:headline-levels} @tab @code{org-export-headline-levels}
  7776. @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
  7777. @item @code{:section-number-format} @tab @code{org-export-section-number-format}
  7778. @item @code{:table-of-contents} @tab @code{org-export-with-toc}
  7779. @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
  7780. @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
  7781. @item @code{:emphasize} @tab @code{org-export-with-emphasize}
  7782. @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
  7783. @item @code{:special-strings} @tab @code{org-export-with-special-strings}
  7784. @item @code{:footnotes} @tab @code{org-export-with-footnotes}
  7785. @item @code{:drawers} @tab @code{org-export-with-drawers}
  7786. @item @code{:tags} @tab @code{org-export-with-tags}
  7787. @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
  7788. @item @code{:priority} @tab @code{org-export-with-priority}
  7789. @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
  7790. @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
  7791. @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
  7792. @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
  7793. @item @code{:timestamps} @tab @code{org-export-with-timestamps}
  7794. @item @code{:author-info} @tab @code{org-export-author-info}
  7795. @item @code{:creator-info} @tab @code{org-export-creator-info}
  7796. @item @code{:tables} @tab @code{org-export-with-tables}
  7797. @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
  7798. @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
  7799. @item @code{:style} @tab @code{org-export-html-style}
  7800. @item @code{:style-extra} @tab @code{org-export-html-style-extra}
  7801. @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
  7802. @item @code{:inline-images} @tab @code{org-export-html-inline-images}
  7803. @item @code{:html-extension} @tab @code{org-export-html-extension}
  7804. @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
  7805. @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
  7806. @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
  7807. @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
  7808. @item @code{:preamble} @tab @code{org-export-html-preamble}
  7809. @item @code{:postamble} @tab @code{org-export-html-postamble}
  7810. @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
  7811. @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
  7812. @item @code{:author} @tab @code{user-full-name}
  7813. @item @code{:email} @tab @code{user-mail-address}
  7814. @item @code{:select-tags} @tab @code{org-export-select-tags}
  7815. @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
  7816. @end multitable
  7817. If you use several email addresses, separate them by a semi-column.
  7818. Most of the @code{org-export-with-*} variables have the same effect in
  7819. both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
  7820. @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
  7821. La@TeX{} export.
  7822. @vindex org-publish-project-alist
  7823. When a property is given a value in @code{org-publish-project-alist},
  7824. its setting overrides the value of the corresponding user variable (if
  7825. any) during publishing. Options set within a file (@pxref{Export
  7826. options}), however, override everything.
  7827. @node Publishing links, Project page index, Publishing options, Configuration
  7828. @subsection Links between published files
  7829. @cindex links, publishing
  7830. To create a link from one Org file to another, you would use
  7831. something like @samp{[[file:foo.org][The foo]]} or simply
  7832. @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link
  7833. becomes a link to @file{foo.html}. In this way, you can interlink the
  7834. pages of your "org web" project and the links will work as expected when
  7835. you publish them to HTML.
  7836. You may also link to related files, such as images. Provided you are
  7837. careful with relative pathnames, and provided you have also configured
  7838. @code{org-publish} to upload the related files, these links will work
  7839. too. See @ref{Complex example} for an example of this usage.
  7840. Sometime an Org file to be published may contain links that are
  7841. only valid in your production environment, but not in the publishing
  7842. location. In this case, use the property
  7843. @multitable @columnfractions 0.4 0.6
  7844. @item @code{:link-validation-function}
  7845. @tab Function to validate links
  7846. @end multitable
  7847. @noindent
  7848. to define a function for checking link validity. This function must
  7849. accept two arguments, the file name and a directory relative to which
  7850. the file name is interpreted in the production environment. If this
  7851. function returns @code{nil}, then the HTML generator will only insert a
  7852. description into the HTML file, but no link. One option for this
  7853. function is @code{org-publish-validate-link} which checks if the given
  7854. file is part of any project in @code{org-publish-project-alist}.
  7855. @node Project page index, , Publishing links, Configuration
  7856. @subsection Project page index
  7857. @cindex index, of published pages
  7858. The following properties may be used to control publishing of an
  7859. index of files or summary page for a given project.
  7860. @multitable @columnfractions 0.25 0.75
  7861. @item @code{:auto-index}
  7862. @tab When non-nil, publish an index during org-publish-current-project or
  7863. org-publish-all.
  7864. @item @code{:index-filename}
  7865. @tab Filename for output of index. Defaults to @file{index.org} (which
  7866. becomes @file{index.html}).
  7867. @item @code{:index-title}
  7868. @tab Title of index page. Defaults to name of file.
  7869. @item @code{:index-function}
  7870. @tab Plug-in function to use for generation of index.
  7871. Defaults to @code{org-publish-org-index}, which generates a plain list
  7872. of links to all files in the project.
  7873. @end multitable
  7874. @node Sample configuration, Triggering publication, Configuration, Publishing
  7875. @section Sample configuration
  7876. Below we provide two example configurations. The first one is a simple
  7877. project publishing only a set of Org files. The second example is
  7878. more complex, with a multi-component project.
  7879. @menu
  7880. * Simple example:: One-component publishing
  7881. * Complex example:: A multi-component publishing example
  7882. @end menu
  7883. @node Simple example, Complex example, Sample configuration, Sample configuration
  7884. @subsection Example: simple publishing configuration
  7885. This example publishes a set of Org files to the @file{public_html}
  7886. directory on the local machine.
  7887. @lisp
  7888. (setq org-publish-project-alist
  7889. '(("org"
  7890. :base-directory "~/org/"
  7891. :publishing-directory "~/public_html"
  7892. :section-numbers nil
  7893. :table-of-contents nil
  7894. :style "<link rel=\"stylesheet\"
  7895. href=\"../other/mystyle.css\"
  7896. type=\"text/css\">")))
  7897. @end lisp
  7898. @node Complex example, , Simple example, Sample configuration
  7899. @subsection Example: complex publishing configuration
  7900. This more complicated example publishes an entire website, including
  7901. org files converted to HTML, image files, emacs lisp source code, and
  7902. style sheets. The publishing-directory is remote and private files are
  7903. excluded.
  7904. To ensure that links are preserved, care should be taken to replicate
  7905. your directory structure on the web server, and to use relative file
  7906. paths. For example, if your org files are kept in @file{~/org} and your
  7907. publishable images in @file{~/images}, you'd link to an image with
  7908. @c
  7909. @example
  7910. file:../images/myimage.png
  7911. @end example
  7912. @c
  7913. On the web server, the relative path to the image should be the
  7914. same. You can accomplish this by setting up an "images" folder in the
  7915. right place on the web server, and publishing images to it.
  7916. @lisp
  7917. (setq org-publish-project-alist
  7918. '(("orgfiles"
  7919. :base-directory "~/org/"
  7920. :base-extension "org"
  7921. :publishing-directory "/ssh:user@@host:~/html/notebook/"
  7922. :publishing-function org-publish-org-to-html
  7923. :exclude "PrivatePage.org" ;; regexp
  7924. :headline-levels 3
  7925. :section-numbers nil
  7926. :table-of-contents nil
  7927. :style "<link rel=\"stylesheet\"
  7928. href=\"../other/mystyle.css\" type=\"text/css\">"
  7929. :auto-preamble t
  7930. :auto-postamble nil)
  7931. ("images"
  7932. :base-directory "~/images/"
  7933. :base-extension "jpg\\|gif\\|png"
  7934. :publishing-directory "/ssh:user@@host:~/html/images/"
  7935. :publishing-function org-publish-attachment)
  7936. ("other"
  7937. :base-directory "~/other/"
  7938. :base-extension "css\\|el"
  7939. :publishing-directory "/ssh:user@@host:~/html/other/"
  7940. :publishing-function org-publish-attachment)
  7941. ("website" :components ("orgfiles" "images" "other"))))
  7942. @end lisp
  7943. @node Triggering publication, , Sample configuration, Publishing
  7944. @section Triggering publication
  7945. Once org-publish is properly configured, you can publish with the
  7946. following functions:
  7947. @table @kbd
  7948. @item C-c C-e C
  7949. Prompt for a specific project and publish all files that belong to it.
  7950. @item C-c C-e P
  7951. Publish the project containing the current file.
  7952. @item C-c C-e F
  7953. Publish only the current file.
  7954. @item C-c C-e A
  7955. Publish all projects.
  7956. @end table
  7957. Org uses timestamps to track when a file has changed. The above
  7958. functions normally only publish changed files. You can override this and
  7959. force publishing of all files by giving a prefix argument.
  7960. @node Miscellaneous, Extensions, Publishing, Top
  7961. @chapter Miscellaneous
  7962. @menu
  7963. * Completion:: M-TAB knows what you need
  7964. * Customization:: Adapting Org to your taste
  7965. * In-buffer settings:: Overview of the #+KEYWORDS
  7966. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  7967. * Clean view:: Getting rid of leading stars in the outline
  7968. * TTY keys:: Using Org on a tty
  7969. * Interaction:: Other Emacs packages
  7970. * Bugs:: Things which do not work perfectly
  7971. @end menu
  7972. @node Completion, Customization, Miscellaneous, Miscellaneous
  7973. @section Completion
  7974. @cindex completion, of @TeX{} symbols
  7975. @cindex completion, of TODO keywords
  7976. @cindex completion, of dictionary words
  7977. @cindex completion, of option keywords
  7978. @cindex completion, of tags
  7979. @cindex completion, of property keys
  7980. @cindex completion, of link abbreviations
  7981. @cindex @TeX{} symbol completion
  7982. @cindex TODO keywords completion
  7983. @cindex dictionary word completion
  7984. @cindex option keyword completion
  7985. @cindex tag completion
  7986. @cindex link abbreviations, completion of
  7987. Org supports in-buffer completion. This type of completion does
  7988. not make use of the minibuffer. You simply type a few letters into
  7989. the buffer and use the key to complete text right there.
  7990. @table @kbd
  7991. @kindex M-@key{TAB}
  7992. @item M-@key{TAB}
  7993. Complete word at point
  7994. @itemize @bullet
  7995. @item
  7996. At the beginning of a headline, complete TODO keywords.
  7997. @item
  7998. After @samp{\}, complete @TeX{} symbols supported by the exporter.
  7999. @item
  8000. After @samp{*}, complete headlines in the current buffer so that they
  8001. can be used in search links like @samp{[[*find this headline]]}.
  8002. @item
  8003. After @samp{:} in a headline, complete tags. The list of tags is taken
  8004. from the variable @code{org-tag-alist} (possibly set through the
  8005. @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
  8006. dynamically from all tags used in the current buffer.
  8007. @item
  8008. After @samp{:} and not in a headline, complete property keys. The list
  8009. of keys is constructed dynamically from all keys used in the current
  8010. buffer.
  8011. @item
  8012. After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
  8013. @item
  8014. After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
  8015. @samp{OPTIONS} which set file-specific options for Org mode. When the
  8016. option keyword is already complete, pressing @kbd{M-@key{TAB}} again
  8017. will insert example settings for this keyword.
  8018. @item
  8019. In the line after @samp{#+STARTUP: }, complete startup keywords,
  8020. i.e. valid keys for this line.
  8021. @item
  8022. Elsewhere, complete dictionary words using Ispell.
  8023. @end itemize
  8024. @end table
  8025. @node Customization, In-buffer settings, Completion, Miscellaneous
  8026. @section Customization
  8027. @cindex customization
  8028. @cindex options, for customization
  8029. @cindex variables, for customization
  8030. There are more than 180 variables that can be used to customize
  8031. Org. For the sake of compactness of the manual, I am not
  8032. describing the variables here. A structured overview of customization
  8033. variables is available with @kbd{M-x org-customize}. Or select
  8034. @code{Browse Org Group} from the @code{Org->Customization} menu. Many
  8035. settings can also be activated on a per-file basis, by putting special
  8036. lines into the buffer (@pxref{In-buffer settings}).
  8037. @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
  8038. @section Summary of in-buffer settings
  8039. @cindex in-buffer settings
  8040. @cindex special keywords
  8041. Org mode uses special lines in the buffer to define settings on a
  8042. per-file basis. These lines start with a @samp{#+} followed by a
  8043. keyword, a colon, and then individual words defining a setting. Several
  8044. setting words can be in the same line, but you can also have multiple
  8045. lines for the keyword. While these settings are described throughout
  8046. the manual, here is a summary. After changing any of those lines in the
  8047. buffer, press @kbd{C-c C-c} with the cursor still in the line to
  8048. activate the changes immediately. Otherwise they become effective only
  8049. when the file is visited again in a new Emacs session.
  8050. @vindex org-archive-location
  8051. @table @kbd
  8052. @item #+ARCHIVE: %s_done::
  8053. This line sets the archive location for the agenda file. It applies for
  8054. all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
  8055. of the file. The first such line also applies to any entries before it.
  8056. The corresponding variable is @code{org-archive-location}.
  8057. @item #+CATEGORY:
  8058. This line sets the category for the agenda file. The category applies
  8059. for all subsequent lines until the next @samp{#+CATEGORY} line, or the
  8060. end of the file. The first such line also applies to any entries before it.
  8061. @item #+COLUMNS: %25ITEM .....
  8062. Set the default format for columns view. This format applies when
  8063. columns view is invoked in location where no @code{COLUMNS} property
  8064. applies.
  8065. @item #+CONSTANTS: name1=value1 ...
  8066. @vindex org-table-formula-constants
  8067. @vindex org-table-formula
  8068. Set file-local values for constants to be used in table formulas. This
  8069. line set the local variable @code{org-table-formula-constants-local}.
  8070. The global version of this variable is
  8071. @code{org-table-formula-constants}.
  8072. @item #+FILETAGS: :tag1:tag2:tag3:
  8073. Set tags that can be inherited by any entry in the file, including the
  8074. top-level entries.
  8075. @item #+DRAWERS: NAME1 .....
  8076. @vindex org-drawers
  8077. Set the file-local set of drawers. The corresponding global variable is
  8078. @code{org-drawers}.
  8079. @item #+LINK: linkword replace
  8080. @vindex org-link-abbrev-alist
  8081. These lines (several are allowed) specify link abbreviations.
  8082. @xref{Link abbreviations}. The corresponding variable is
  8083. @code{org-link-abbrev-alist}.
  8084. @item #+PRIORITIES: highest lowest default
  8085. @vindex org-highest-priority
  8086. @vindex org-lowest-priority
  8087. @vindex org-default-priority
  8088. This line sets the limits and the default for the priorities. All three
  8089. must be either letters A-Z or numbers 0-9. The highest priority must
  8090. have a lower ASCII number that the lowest priority.
  8091. @item #+PROPERTY: Property_Name Value
  8092. This line sets a default inheritance value for entries in the current
  8093. buffer, most useful for specifying the allowed values of a property.
  8094. @item #+SETUPFILE: file
  8095. This line defines a file that holds more in-buffer setup. Normally this is
  8096. entirely ignored. Only when the buffer is parsed for option-setting lines
  8097. (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
  8098. settings line, or when exporting), then the contents of this file are parsed
  8099. as if they had been included in the buffer. In particular, the file can be
  8100. any other Org mode file with internal setup. You can visit the file the
  8101. cursor is in the line with @kbd{C-c '}.
  8102. @item #+STARTUP:
  8103. @vindex org-startup-folded
  8104. This line sets options to be used at startup of Org mode, when an
  8105. Org file is being visited. The first set of options deals with the
  8106. initial visibility of the outline tree. The corresponding variable for
  8107. global default settings is @code{org-startup-folded}, with a default
  8108. value @code{t}, which means @code{overview}.
  8109. @cindex @code{overview}, STARTUP keyword
  8110. @cindex @code{content}, STARTUP keyword
  8111. @cindex @code{showall}, STARTUP keyword
  8112. @example
  8113. overview @r{top-level headlines only}
  8114. content @r{all headlines}
  8115. showall @r{no folding at all, show everything}
  8116. @end example
  8117. @vindex org-startup-align-all-tables
  8118. Then there are options for aligning tables upon visiting a file. This
  8119. is useful in files containing narrowed table columns. The corresponding
  8120. variable is @code{org-startup-align-all-tables}, with a default value
  8121. @code{nil}.
  8122. @cindex @code{align}, STARTUP keyword
  8123. @cindex @code{noalign}, STARTUP keyword
  8124. @example
  8125. align @r{align all tables}
  8126. noalign @r{don't align tables on startup}
  8127. @end example
  8128. @vindex org-log-done
  8129. @vindex org-log-note-clock-out
  8130. @vindex org-log-repeat
  8131. Logging closing and reinstating TODO items, and clock intervals
  8132. (variables @code{org-log-done}, @code{org-log-note-clock-out}, and
  8133. @code{org-log-repeat}) can be configured using these options.
  8134. @cindex @code{logdone}, STARTUP keyword
  8135. @cindex @code{lognotedone}, STARTUP keyword
  8136. @cindex @code{nologdone}, STARTUP keyword
  8137. @cindex @code{lognoteclock-out}, STARTUP keyword
  8138. @cindex @code{nolognoteclock-out}, STARTUP keyword
  8139. @cindex @code{logrepeat}, STARTUP keyword
  8140. @cindex @code{lognoterepeat}, STARTUP keyword
  8141. @cindex @code{nologrepeat}, STARTUP keyword
  8142. @example
  8143. logdone @r{record a timestamp when an item is marked DONE}
  8144. lognotedone @r{record timestamp and a note when DONE}
  8145. nologdone @r{don't record when items are marked DONE}
  8146. logrepeat @r{record a time when reinstating a repeating item}
  8147. lognoterepeat @r{record a note when reinstating a repeating item}
  8148. nologrepeat @r{do not record when reinstating repeating item}
  8149. lognoteclock-out @r{record a note when clocking out}
  8150. nolognoteclock-out @r{don't record a note when clocking out}
  8151. @end example
  8152. @vindex org-hide-leading-stars
  8153. @vindex org-odd-levels-only
  8154. Here are the options for hiding leading stars in outline headings, and for
  8155. indenting outlines. The corresponding variables are
  8156. @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
  8157. default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
  8158. @cindex @code{hidestars}, STARTUP keyword
  8159. @cindex @code{showstars}, STARTUP keyword
  8160. @cindex @code{odd}, STARTUP keyword
  8161. @cindex @code{even}, STARTUP keyword
  8162. @example
  8163. hidestars @r{make all but one of the stars starting a headline invisible.}
  8164. showstars @r{show all stars starting a headline}
  8165. indent @r{virtual indentation according to outline level}
  8166. noindent @r{no virtual indentation according to outline level}
  8167. odd @r{allow only odd outline levels (1,3,...)}
  8168. oddeven @r{allow all outline levels}
  8169. @end example
  8170. @vindex org-put-time-stamp-overlays
  8171. @vindex org-time-stamp-overlay-formats
  8172. To turn on custom format overlays over time stamps (variables
  8173. @code{org-put-time-stamp-overlays} and
  8174. @code{org-time-stamp-overlay-formats}), use
  8175. @cindex @code{customtime}, STARTUP keyword
  8176. @example
  8177. customtime @r{overlay custom time format}
  8178. @end example
  8179. @vindex constants-unit-system
  8180. The following options influence the table spreadsheet (variable
  8181. @code{constants-unit-system}).
  8182. @cindex @code{constcgs}, STARTUP keyword
  8183. @cindex @code{constSI}, STARTUP keyword
  8184. @example
  8185. constcgs @r{@file{constants.el} should use the c-g-s unit system}
  8186. constSI @r{@file{constants.el} should use the SI unit system}
  8187. @end example
  8188. @vindex org-footnote-define-inline
  8189. @vindex org-footnote-auto-label
  8190. To influence footnote settings, use the following keywords. The
  8191. corresponding variables are @code{org-footnote-define-inline} and
  8192. @code{org-footnote-auto-label}.
  8193. @cindex @code{fninline}, STARTUP keyword
  8194. @cindex @code{fnnoinline}, STARTUP keyword
  8195. @cindex @code{fnlocal}, STARTUP keyword
  8196. @cindex @code{fnprompt}, STARTUP keyword
  8197. @cindex @code{fnauto}, STARTUP keyword
  8198. @cindex @code{fnconfirm}, STARTUP keyword
  8199. @cindex @code{fnplain}, STARTUP keyword
  8200. @example
  8201. fninline @r{define footnotes inline}
  8202. fnnoinline @r{define footnotes in separate section}
  8203. fnlocal @r{define footnotes near first reference, but not inline}
  8204. fnprompt @r{prompt for footnote labels}
  8205. fnauto @r{create [fn:1]-like labels automatically (default)}
  8206. fnconfirm @r{offer automatic label for editing or confirmation}
  8207. fnplain @r{create [1]-like labels automatically}
  8208. @end example
  8209. @item #+TAGS: TAG1(c1) TAG2(c2)
  8210. @vindex org-tag-alist
  8211. These lines (several such lines are allowed) specify the valid tags in
  8212. this file, and (potentially) the corresponding @emph{fast tag selection}
  8213. keys. The corresponding variable is @code{org-tag-alist}.
  8214. @item #+TBLFM:
  8215. This line contains the formulas for the table directly above the line.
  8216. @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:
  8217. These lines provide settings for exporting files. For more details see
  8218. @ref{Export options}.
  8219. @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
  8220. @vindex org-todo-keywords
  8221. These lines set the TODO keywords and their interpretation in the
  8222. current file. The corresponding variable is @code{org-todo-keywords}.
  8223. @end table
  8224. @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
  8225. @section The very busy C-c C-c key
  8226. @kindex C-c C-c
  8227. @cindex C-c C-c, overview
  8228. The key @kbd{C-c C-c} has many purposes in Org, which are all
  8229. mentioned scattered throughout this manual. One specific function of
  8230. this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
  8231. other circumstances it means something like @emph{Hey Org, look
  8232. here and update according to what you see here}. Here is a summary of
  8233. what this means in different contexts.
  8234. @itemize @minus
  8235. @item
  8236. If there are highlights in the buffer from the creation of a sparse
  8237. tree, or from clock display, remove these highlights.
  8238. @item
  8239. If the cursor is in one of the special @code{#+KEYWORD} lines, this
  8240. triggers scanning the buffer for these lines and updating the
  8241. information.
  8242. @item
  8243. If the cursor is inside a table, realign the table. This command
  8244. works even if the automatic table editor has been turned off.
  8245. @item
  8246. If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
  8247. the entire table.
  8248. @item
  8249. If the cursor is inside a table created by the @file{table.el} package,
  8250. activate that table.
  8251. @item
  8252. If the current buffer is a remember buffer, close the note and file it.
  8253. With a prefix argument, file it, without further interaction, to the
  8254. default location.
  8255. @item
  8256. If the cursor is on a @code{<<<target>>>}, update radio targets and
  8257. corresponding links in this buffer.
  8258. @item
  8259. If the cursor is in a property line or at the start or end of a property
  8260. drawer, offer property commands.
  8261. @item
  8262. If the cursor is at a footnote reference, go to the corresponding
  8263. definition, and vice versa.
  8264. @item
  8265. If the cursor is in a plain list item with a checkbox, toggle the status
  8266. of the checkbox.
  8267. @item
  8268. If the cursor is on a numbered item in a plain list, renumber the
  8269. ordered list.
  8270. @item
  8271. If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
  8272. block is updated.
  8273. @end itemize
  8274. @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
  8275. @section A cleaner outline view
  8276. @cindex hiding leading stars
  8277. @cindex dynamic indentation
  8278. @cindex odd-levels-only outlines
  8279. @cindex clean outline view
  8280. Some people find it noisy and distracting that the Org headlines are starting
  8281. with a potentially large number of stars, and that text below the headlines
  8282. is not indented. This is not really a problem when you are writing a book
  8283. where the outline headings are really section headlines. However, in a more
  8284. list-oriented outline, it is clear that an indented structure is a lot
  8285. cleaner, as can be seen by comparing the two columns in the following
  8286. example:
  8287. @example
  8288. @group
  8289. * Top level headline | * Top level headline
  8290. ** Second level | * Second level
  8291. *** 3rd level | * 3rd level
  8292. some text | some text
  8293. *** 3rd level | * 3rd level
  8294. more text | more text
  8295. * Another top level headline | * Another top level headline
  8296. @end group
  8297. @end example
  8298. @noindent
  8299. It is non-trivial to make such a look work in Emacs, but Org contains three
  8300. separate features that, combined, achieve just that.
  8301. @enumerate
  8302. @item
  8303. @emph{Indentation of text below headlines}@*
  8304. You may indent text below each headline to make the left boundary line up
  8305. with the headline, like
  8306. @example
  8307. *** 3rd level
  8308. more text, now indented
  8309. @end example
  8310. @vindex org-adapt-indentation
  8311. A good way to get this indentation is by hand, and Org supports this with
  8312. paragraph filling, line wrapping, and structure editing@footnote{See also the
  8313. variable @code{org-adapt-indentation}.} preserving or adapting the
  8314. indentation appropriate. A different approach would be to have a way to
  8315. automatically indent lines according to outline structure by adding overlays
  8316. or text properties. But I have not yet found a robust and efficient way to
  8317. do this in large files.
  8318. @item
  8319. @vindex org-hide-leading-stars
  8320. @emph{Hiding leading stars}@* You can modify the display in such a way that
  8321. all leading stars become invisible. To do this in a global way, configure
  8322. the variable @code{org-hide-leading-stars} or change this on a per-file basis
  8323. with
  8324. @example
  8325. #+STARTUP: hidestars
  8326. @end example
  8327. @noindent
  8328. Note that the opposite behavior is selected with @code{showstars}.
  8329. With hidden stars, the tree becomes:
  8330. @example
  8331. @group
  8332. * Top level headline
  8333. * Second level
  8334. * 3rd level
  8335. ...
  8336. @end group
  8337. @end example
  8338. @noindent
  8339. @vindex org-hide @r{(face)}
  8340. Note that the leading stars are not truly replaced by whitespace, they
  8341. are only fontified with the face @code{org-hide} that uses the
  8342. background color as font color. If you are not using either white or
  8343. black background, you may have to customize this face to get the wanted
  8344. effect. Another possibility is to set this font such that the extra
  8345. stars are @i{almost} invisible, for example using the color
  8346. @code{grey90} on a white background.
  8347. @item
  8348. @cindex org-odd-levels-only
  8349. Things become cleaner still if you skip all the even levels and use only odd
  8350. levels 1, 3, 5..., effectively adding two stars to go from one outline level
  8351. to the next@footnote{When you need to specify a level for a property search
  8352. or refile targets, @samp{LEVEL=2} will correspond to 3 stars etc.}. In this
  8353. way we get the outline view shown at the beginning of this section. In order
  8354. to make the structure editing and export commands handle this convention
  8355. correctly, configure the variable @code{org-odd-levels-only}, or set this on
  8356. a per-file basis with one of the following lines:
  8357. @example
  8358. #+STARTUP: odd
  8359. #+STARTUP: oddeven
  8360. @end example
  8361. You can convert an Org file from single-star-per-level to the
  8362. double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
  8363. RET} in that file. The reverse operation is @kbd{M-x
  8364. org-convert-to-oddeven-levels}.
  8365. @end enumerate
  8366. @node TTY keys, Interaction, Clean view, Miscellaneous
  8367. @section Using Org on a tty
  8368. @cindex tty key bindings
  8369. Because Org contains a large number of commands, by default much of
  8370. Org's core commands are bound to keys that are generally not
  8371. accessible on a tty, such as the cursor keys (@key{left}, @key{right},
  8372. @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
  8373. together with modifiers like @key{Meta} and/or @key{Shift}. To access
  8374. these commands on a tty when special keys are unavailable, the following
  8375. alternative bindings can be used. The tty bindings below will likely be
  8376. more cumbersome; you may find for some of the bindings below that a
  8377. customized work-around suits you better. For example, changing a time
  8378. stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
  8379. tty you would rather use @kbd{C-c .} to re-insert the timestamp.
  8380. @multitable @columnfractions 0.15 0.2 0.2
  8381. @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
  8382. @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
  8383. @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
  8384. @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
  8385. @item @kbd{M-@key{right}} @tab @kbd{C-c C-x i} @tab @kbd{@key{Esc} @key{right}}
  8386. @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
  8387. @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
  8388. @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
  8389. @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
  8390. @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
  8391. @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
  8392. @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
  8393. @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
  8394. @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
  8395. @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
  8396. @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
  8397. @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
  8398. @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
  8399. @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
  8400. @end multitable
  8401. @node Interaction, Bugs, TTY keys, Miscellaneous
  8402. @section Interaction with other packages
  8403. @cindex packages, interaction with other
  8404. Org lives in the world of GNU Emacs and interacts in various ways
  8405. with other code out there.
  8406. @menu
  8407. * Cooperation:: Packages Org cooperates with
  8408. * Conflicts:: Packages that lead to conflicts
  8409. @end menu
  8410. @node Cooperation, Conflicts, Interaction, Interaction
  8411. @subsection Packages that Org cooperates with
  8412. @table @asis
  8413. @cindex @file{calc.el}
  8414. @item @file{calc.el} by Dave Gillespie
  8415. Org uses the Calc package for implementing spreadsheet
  8416. functionality in its tables (@pxref{The spreadsheet}). Org
  8417. checks for the availability of Calc by looking for the function
  8418. @code{calc-eval} which should be autoloaded in your setup if Calc has
  8419. been installed properly. As of Emacs 22, Calc is part of the Emacs
  8420. distribution. Another possibility for interaction between the two
  8421. packages is using Calc for embedded calculations. @xref{Embedded Mode,
  8422. , Embedded Mode, Calc, GNU Emacs Calc Manual}.
  8423. @cindex @file{constants.el}
  8424. @item @file{constants.el} by Carsten Dominik
  8425. @vindex org-table-formula-constants
  8426. In a table formula (@pxref{The spreadsheet}), it is possible to use
  8427. names for natural constants or units. Instead of defining your own
  8428. constants in the variable @code{org-table-formula-constants}, install
  8429. the @file{constants} package which defines a large number of constants
  8430. and units, and lets you use unit prefixes like @samp{M} for
  8431. @samp{Mega} etc. You will need version 2.0 of this package, available
  8432. at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
  8433. the function @code{constants-get}, which has to be autoloaded in your
  8434. setup. See the installation instructions in the file
  8435. @file{constants.el}.
  8436. @item @file{cdlatex.el} by Carsten Dominik
  8437. @cindex @file{cdlatex.el}
  8438. Org mode can make use of the CDLaTeX package to efficiently enter
  8439. La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
  8440. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
  8441. @cindex @file{imenu.el}
  8442. Imenu allows menu access to an index of items in a file. Org mode
  8443. supports Imenu - all you need to do to get the index is the following:
  8444. @lisp
  8445. (add-hook 'org-mode-hook
  8446. (lambda () (imenu-add-to-menubar "Imenu")))
  8447. @end lisp
  8448. @vindex org-imenu-depth
  8449. By default the index is two levels deep - you can modify the depth using
  8450. the option @code{org-imenu-depth}.
  8451. @item @file{remember.el} by John Wiegley
  8452. @cindex @file{remember.el}
  8453. Org cooperates with remember, see @ref{Remember}.
  8454. @file{Remember.el} is not part of Emacs, find it on the web.
  8455. @item @file{speedbar.el} by Eric M. Ludlam
  8456. @cindex @file{speedbar.el}
  8457. Speedbar is a package that creates a special frame displaying files and
  8458. index items in files. Org mode supports Speedbar and allows you to
  8459. drill into Org files directly from the Speedbar. It also allows to
  8460. restrict the scope of agenda commands to a file or a subtree by using
  8461. the command @kbd{<} in the Speedbar frame.
  8462. @cindex @file{table.el}
  8463. @item @file{table.el} by Takaaki Ota
  8464. @kindex C-c C-c
  8465. @cindex table editor, @file{table.el}
  8466. @cindex @file{table.el}
  8467. Complex ASCII tables with automatic line wrapping, column- and
  8468. row-spanning, and alignment can be created using the Emacs table
  8469. package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
  8470. and also part of Emacs 22).
  8471. When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
  8472. will call @command{table-recognize-table} and move the cursor into the
  8473. table. Inside a table, the keymap of Org mode is inactive. In order
  8474. to execute Org mode-related commands, leave the table.
  8475. @table @kbd
  8476. @kindex C-c C-c
  8477. @item C-c C-c
  8478. Recognize @file{table.el} table. Works when the cursor is in a
  8479. table.el table.
  8480. @c
  8481. @kindex C-c ~
  8482. @item C-c ~
  8483. Insert a table.el table. If there is already a table at point, this
  8484. command converts it between the table.el format and the Org mode
  8485. format. See the documentation string of the command
  8486. @code{org-convert-table} for the restrictions under which this is
  8487. possible.
  8488. @end table
  8489. @file{table.el} is part of Emacs 22.
  8490. @cindex @file{footnote.el}
  8491. @item @file{footnote.el} by Steven L. Baur
  8492. Org mode recognizes numerical footnotes as provided by this package.
  8493. However, Org-mode also has its own footnote support (@pxref{Footnotes}),
  8494. which makes using @file{footnote.el} unnecessary.
  8495. @end table
  8496. @node Conflicts, , Cooperation, Interaction
  8497. @subsection Packages that lead to conflicts with Org mode
  8498. @table @asis
  8499. @cindex @code{shift-selection-mode}
  8500. @vindex org-support-shift-select
  8501. In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
  8502. cursor motions combined with the shift key should start or enlarge regions.
  8503. This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
  8504. timestamps, TODO keywords, priorities, and item bullet types if the cursor is
  8505. at such a location. By default, @kbd{S-@key{cursor}} commands outside
  8506. special contexts don't do anything, but you can customize the variable
  8507. @code{org-support-shift-select}. Org-mode then tries to accommodate shift
  8508. selection by (i) using it outside of the special contexts where special
  8509. commands apply, and by (ii) extending an existing active region even if the
  8510. cursor moves across a special context.
  8511. @cindex @file{CUA.el}
  8512. @item @file{CUA.el} by Kim. F. Storm
  8513. @vindex org-replace-disputed-keys
  8514. Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
  8515. (as well as pc-select-mode and s-region-mode) to select and extend the
  8516. region. In fact, Emacs 23 has this built-in in the form of
  8517. @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
  8518. 23 you probably don't want to use another package for this purpose. However,
  8519. if you prefer to leave these keys to a different package while working in
  8520. Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
  8521. Org will move the following key bindings in Org files, and in the agenda
  8522. buffer (but not during date selection).
  8523. @example
  8524. S-UP -> M-p S-DOWN -> M-n
  8525. S-LEFT -> M-- S-RIGHT -> M-+
  8526. C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
  8527. @end example
  8528. @vindex org-disputed-keys
  8529. Yes, these are unfortunately more difficult to remember. If you want
  8530. to have other replacement keys, look at the variable
  8531. @code{org-disputed-keys}.
  8532. @item @file{windmove.el} by Hovav Shacham
  8533. @cindex @file{windmove.el}
  8534. Also this package uses the @kbd{S-<cursor>} keys, so everything written
  8535. in the paragraph above about CUA mode also applies here.
  8536. @end table
  8537. @node Bugs, , Interaction, Miscellaneous
  8538. @section Bugs
  8539. @cindex bugs
  8540. Here is a list of things that should work differently, but which I
  8541. have found too hard to fix.
  8542. @itemize @bullet
  8543. @item
  8544. If a table field starts with a link, and if the corresponding table
  8545. column is narrowed (@pxref{Narrow columns}) to a width too small to
  8546. display the link, the field would look entirely empty even though it is
  8547. not. To prevent this, Org throws an error. The work-around is to
  8548. make the column wide enough to fit the link, or to add some text (at
  8549. least 2 characters) before the link in the same field.
  8550. @item
  8551. Narrowing table columns does not work on XEmacs, because the
  8552. @code{format} function does not transport text properties.
  8553. @item
  8554. Text in an entry protected with the @samp{QUOTE} keyword should not
  8555. autowrap.
  8556. @item
  8557. When the application called by @kbd{C-c C-o} to open a file link fails
  8558. (for example because the application does not exist or refuses to open
  8559. the file), it does so silently. No error message is displayed.
  8560. @item
  8561. Recalculating a table line applies the formulas from left to right.
  8562. If a formula uses @emph{calculated} fields further down the row,
  8563. multiple recalculation may be needed to get all fields consistent. You
  8564. may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to
  8565. recalculate until convergence.
  8566. @item
  8567. The exporters work well, but could be made more efficient.
  8568. @end itemize
  8569. @node Extensions, Hacking, Miscellaneous, Top
  8570. @appendix Extensions
  8571. This appendix lists the extension modules that have been written for Org.
  8572. Many of these extensions live in the @file{contrib} directory of the Org
  8573. distribution, others are available somewhere on the web.
  8574. @menu
  8575. * Extensions in the contrib directory:: These come with the Org distro
  8576. * Other extensions:: These you have to find on the web.
  8577. @end menu
  8578. @node Extensions in the contrib directory, Other extensions, Extensions, Extensions
  8579. @section Extensions in the @file{contrib} directory
  8580. A number of extension are distributed with Org when you download it from its
  8581. homepage. Please note that these extensions are @emph{not} distributed as
  8582. part of Emacs, so if you use Org as delivered with Emacs, you still need to
  8583. go to @url{http://orgmode.org} to get access to these modules.
  8584. @table @asis
  8585. @item @file{org-annotate-file.el} by @i{Philip Jackson}
  8586. Annotate a file with org syntax, in a separate file, with links back to the
  8587. annotated file.
  8588. @item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German}
  8589. Call @i{remember} directly from Firefox/Opera, or from Adobe Reader. When
  8590. activating a special link or bookmark, Emacs receives a trigger to create a
  8591. note with a link back to the website. Requires some setup, a detailed
  8592. description is in @file{contrib/packages/org-annotation-helper}.
  8593. @item @file{org-bookmark.el} by @i{Tokuya Kameshima}
  8594. Support for links to Emacs bookmarks.
  8595. @item @file{org-depend.el} by @i{Carsten Dominik}
  8596. TODO dependencies for Org-mode. Make TODO state changes in one entry trigger
  8597. changes in another, or be blocked by the state of another entry. Also,
  8598. easily create chains of TODO items with exactly one active item at any time.
  8599. @item @file{org-elisp-symbol.el} by @i{Bastien Guerry}
  8600. Org links to emacs-lisp symbols. This can create annotated links that
  8601. exactly point to the definition location of a variable of function.
  8602. @item @file{org-eval.el} by @i{Carsten Dominik}
  8603. The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows text to
  8604. be included in a document that is the result of evaluating some code. Other
  8605. scripting languages like @code{perl} can be supported with this package as
  8606. well.
  8607. @item @file{org-eval-light.el} by @i{Eric Schulte}
  8608. User-controlled evaluation of code in an Org buffer.
  8609. @item @file{org-exp-blocks.el} by @i{Eric Schulte}
  8610. Preprocess user-defined blocks for export.
  8611. @item @file{org-expiry.el} by @i{Bastien Guerry}
  8612. Expiry mechanism for Org entries.
  8613. @item @file{org-indent.el} by @i{Carsten Dominik}
  8614. Dynamic indentation of Org outlines. The plan is to indent an outline
  8615. according to level, but so far this is too hard for a proper and stable
  8616. implementation. Still, it works somewhat.
  8617. @item @file{org-interactive-query.el} by @i{Christopher League}
  8618. Interactive modification of tags queries. After running a general query in
  8619. Org, this package allows you to narrow down the results by adding more tags
  8620. or keywords.
  8621. @item @file{org-mairix.el} by @i{Georg C. F. Greve}
  8622. Hook mairix search into Org for different MUAs.
  8623. @item @file{org-man.el} by @i{Carsten Dominik}
  8624. Support for links to manpages in Org-mode.
  8625. @item @file{org-mtags.el} by @i{Carsten Dominik}
  8626. Support for some Muse-like tags in Org-mode. This package allows you to
  8627. write @code{<example>} and @code{<src>} and other syntax copied from Emacs
  8628. Muse, right inside an Org file. The goal here is to make it easy to publish
  8629. the same file using either org-publish or Muse.
  8630. @item @file{org-panel.el} by @i{Lennart Borgman}
  8631. Simplified and display-aided access to some Org commands.
  8632. @item @file{org-registry.el} by @i{Bastien Guerry}
  8633. A registry for Org links, to find out from where links point to a given file
  8634. or location.
  8635. @item @file{org2rem.el} by @i{Bastien Guerry}
  8636. Convert org appointments into reminders for the @file{remind} program.
  8637. @item @file{org-screen.el} by @i{Andrew Hyatt}
  8638. Visit screen sessions through Org-mode links.
  8639. @item @file{org-toc.el} by @i{Bastien Guerry}
  8640. Table of contents in a separate buffer, with fast access to sections and easy
  8641. visibility cycling.
  8642. @item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy}
  8643. Convert Org-mode tables to SQL insertions. Documentation for this can be
  8644. found on the Worg pages.
  8645. @end table
  8646. @node Other extensions, , Extensions in the contrib directory, Extensions
  8647. @section Other extensions
  8648. @i{TO BE DONE}
  8649. @node Hacking, History and Acknowledgments, Extensions, Top
  8650. @appendix Hacking
  8651. This appendix covers some aspects where users can extend the functionality of
  8652. Org.
  8653. @menu
  8654. * Adding hyperlink types:: New custom link types
  8655. * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
  8656. * Dynamic blocks:: Automatically filled blocks
  8657. * Special agenda views:: Customized views
  8658. * Using the property API:: Writing programs that use entry properties
  8659. * Using the mapping API:: Mapping over all or selected entries
  8660. @end menu
  8661. @node Adding hyperlink types, Tables in arbitrary syntax, Hacking, Hacking
  8662. @section Adding hyperlink types
  8663. @cindex hyperlinks, adding new types
  8664. Org has a large number of hyperlink types built-in
  8665. (@pxref{Hyperlinks}). If you would like to add new link types, it
  8666. provides an interface for doing so. Let's look at an example file
  8667. @file{org-man.el} that will add support for creating links like
  8668. @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
  8669. emacs:
  8670. @lisp
  8671. ;;; org-man.el - Support for links to manpages in Org
  8672. (require 'org)
  8673. (org-add-link-type "man" 'org-man-open)
  8674. (add-hook 'org-store-link-functions 'org-man-store-link)
  8675. (defcustom org-man-command 'man
  8676. "The Emacs command to be used to display a man page."
  8677. :group 'org-link
  8678. :type '(choice (const man) (const woman)))
  8679. (defun org-man-open (path)
  8680. "Visit the manpage on PATH.
  8681. PATH should be a topic that can be thrown at the man command."
  8682. (funcall org-man-command path))
  8683. (defun org-man-store-link ()
  8684. "Store a link to a manpage."
  8685. (when (memq major-mode '(Man-mode woman-mode))
  8686. ;; This is a man page, we do make this link
  8687. (let* ((page (org-man-get-page-name))
  8688. (link (concat "man:" page))
  8689. (description (format "Manpage for %s" page)))
  8690. (org-store-link-props
  8691. :type "man"
  8692. :link link
  8693. :description description))))
  8694. (defun org-man-get-page-name ()
  8695. "Extract the page name from the buffer name."
  8696. ;; This works for both `Man-mode' and `woman-mode'.
  8697. (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
  8698. (match-string 1 (buffer-name))
  8699. (error "Cannot create link to this man page")))
  8700. (provide 'org-man)
  8701. ;;; org-man.el ends here
  8702. @end lisp
  8703. @noindent
  8704. You would activate this new link type in @file{.emacs} with
  8705. @lisp
  8706. (require 'org-man)
  8707. @end lisp
  8708. @noindent
  8709. Let's go through the file and see what it does.
  8710. @enumerate
  8711. @item
  8712. It does @code{(require 'org)} to make sure that @file{org.el} has been
  8713. loaded.
  8714. @item
  8715. The next line calls @code{org-add-link-type} to define a new link type
  8716. with prefix @samp{man}. The call also contains the name of a function
  8717. that will be called to follow such a link.
  8718. @item
  8719. @vindex org-store-link-functions
  8720. The next line adds a function to @code{org-store-link-functions}, in
  8721. order to allow the command @kbd{C-c l} to record a useful link in a
  8722. buffer displaying a man page.
  8723. @end enumerate
  8724. The rest of the file defines the necessary variables and functions.
  8725. First there is a customization variable that determines which emacs
  8726. command should be used to display man pages. There are two options,
  8727. @code{man} and @code{woman}. Then the function to follow a link is
  8728. defined. It gets the link path as an argument - in this case the link
  8729. path is just a topic for the manual command. The function calls the
  8730. value of @code{org-man-command} to display the man page.
  8731. Finally the function @code{org-man-store-link} is defined. When you try
  8732. to store a link with @kbd{C-c l}, also this function will be called to
  8733. try to make a link. The function must first decide if it is supposed to
  8734. create the link for this buffer type, we do this by checking the value
  8735. of the variable @code{major-mode}. If not, the function must exit and
  8736. return the value @code{nil}. If yes, the link is created by getting the
  8737. manual topic from the buffer name and prefixing it with the string
  8738. @samp{man:}. Then it must call the command @code{org-store-link-props}
  8739. and set the @code{:type} and @code{:link} properties. Optionally you
  8740. can also set the @code{:description} property to provide a default for
  8741. the link description when the link is later inserted into an Org
  8742. buffer with @kbd{C-c C-l}.
  8743. @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Hacking
  8744. @section Tables and lists in arbitrary syntax
  8745. @cindex tables, in other modes
  8746. @cindex lists, in other modes
  8747. @cindex Orgtbl mode
  8748. Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
  8749. frequent feature request has been to make it work with native tables in
  8750. specific languages, for example La@TeX{}. However, this is extremely
  8751. hard to do in a general way, would lead to a customization nightmare,
  8752. and would take away much of the simplicity of the Orgtbl mode table
  8753. editor.
  8754. This appendix describes a different approach. We keep the Orgtbl mode
  8755. table in its native format (the @i{source table}), and use a custom
  8756. function to @i{translate} the table to the correct syntax, and to
  8757. @i{install} it in the right location (the @i{target table}). This puts
  8758. the burden of writing conversion functions on the user, but it allows
  8759. for a very flexible system.
  8760. Bastien added the ability to do the same with lists. You can use Org's
  8761. facilities to edit and structure lists by turning @code{orgstruct-mode}
  8762. on, then locally exporting such lists in another format (HTML, La@TeX{}
  8763. or Texinfo.)
  8764. @menu
  8765. * Radio tables:: Sending and receiving
  8766. * A LaTeX example:: Step by step, almost a tutorial
  8767. * Translator functions:: Copy and modify
  8768. * Radio lists:: Doing the same for lists
  8769. @end menu
  8770. @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
  8771. @subsection Radio tables
  8772. @cindex radio tables
  8773. To define the location of the target table, you first need to create two
  8774. lines that are comments in the current mode, but contain magic words for
  8775. Orgtbl mode to find. Orgtbl mode will insert the translated table
  8776. between these lines, replacing whatever was there before. For example:
  8777. @example
  8778. /* BEGIN RECEIVE ORGTBL table_name */
  8779. /* END RECEIVE ORGTBL table_name */
  8780. @end example
  8781. @noindent
  8782. Just above the source table, we put a special line that tells
  8783. Orgtbl mode how to translate this table and where to install it. For
  8784. example:
  8785. @example
  8786. #+ORGTBL: SEND table_name translation_function arguments....
  8787. @end example
  8788. @noindent
  8789. @code{table_name} is the reference name for the table that is also used
  8790. in the receiver lines. @code{translation_function} is the Lisp function
  8791. that does the translation. Furthermore, the line can contain a list of
  8792. arguments (alternating key and value) at the end. The arguments will be
  8793. passed as a property list to the translation function for
  8794. interpretation. A few standard parameters are already recognized and
  8795. acted upon before the translation function is called:
  8796. @table @code
  8797. @item :skip N
  8798. Skip the first N lines of the table. Hlines do count as separate lines for
  8799. this parameter!
  8800. @item :skipcols (n1 n2 ...)
  8801. List of columns that should be skipped. If the table has a column with
  8802. calculation marks, that column is automatically discarded as well.
  8803. Please note that the translator function sees the table @emph{after} the
  8804. removal of these columns, the function never knows that there have been
  8805. additional columns.
  8806. @end table
  8807. @noindent
  8808. The one problem remaining is how to keep the source table in the buffer
  8809. without disturbing the normal workings of the file, for example during
  8810. compilation of a C file or processing of a La@TeX{} file. There are a
  8811. number of different solutions:
  8812. @itemize @bullet
  8813. @item
  8814. The table could be placed in a block comment if that is supported by the
  8815. language. For example, in C mode you could wrap the table between
  8816. @samp{/*} and @samp{*/} lines.
  8817. @item
  8818. Sometimes it is possible to put the table after some kind of @i{END}
  8819. statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
  8820. in La@TeX{}.
  8821. @item
  8822. You can just comment the table line by line whenever you want to process
  8823. the file, and uncomment it whenever you need to edit the table. This
  8824. only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
  8825. make this comment-toggling very easy, in particular if you bind it to a
  8826. key.
  8827. @end itemize
  8828. @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
  8829. @subsection A LaTeX example of radio tables
  8830. @cindex LaTeX, and Orgtbl mode
  8831. The best way to wrap the source table in La@TeX{} is to use the
  8832. @code{comment} environment provided by @file{comment.sty}. It has to be
  8833. activated by placing @code{\usepackage@{comment@}} into the document
  8834. header. Orgtbl mode can insert a radio table skeleton@footnote{By
  8835. default this works only for La@TeX{}, HTML, and Texinfo. Configure the
  8836. variable @code{orgtbl-radio-tables} to install templates for other
  8837. modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
  8838. be prompted for a table name, let's say we use @samp{salesfigures}. You
  8839. will then get the following template:
  8840. @cindex #+ORGTBL: SEND
  8841. @example
  8842. % BEGIN RECEIVE ORGTBL salesfigures
  8843. % END RECEIVE ORGTBL salesfigures
  8844. \begin@{comment@}
  8845. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  8846. | | |
  8847. \end@{comment@}
  8848. @end example
  8849. @noindent
  8850. @vindex LaTeX-verbatim-environments
  8851. The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
  8852. @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
  8853. into the receiver location with name @code{salesfigures}. You may now
  8854. fill in the table, feel free to use the spreadsheet features@footnote{If
  8855. the @samp{#+TBLFM} line contains an odd number of dollar characters,
  8856. this may cause problems with font-lock in LaTeX mode. As shown in the
  8857. example you can fix this by adding an extra line inside the
  8858. @code{comment} environment that is used to balance the dollar
  8859. expressions. If you are using AUCTeX with the font-latex library, a
  8860. much better solution is to add the @code{comment} environment to the
  8861. variable @code{LaTeX-verbatim-environments}.}:
  8862. @example
  8863. % BEGIN RECEIVE ORGTBL salesfigures
  8864. % END RECEIVE ORGTBL salesfigures
  8865. \begin@{comment@}
  8866. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  8867. | Month | Days | Nr sold | per day |
  8868. |-------+------+---------+---------|
  8869. | Jan | 23 | 55 | 2.4 |
  8870. | Feb | 21 | 16 | 0.8 |
  8871. | March | 22 | 278 | 12.6 |
  8872. #+TBLFM: $4=$3/$2;%.1f
  8873. % $ (optional extra dollar to keep font-lock happy, see footnote)
  8874. \end@{comment@}
  8875. @end example
  8876. @noindent
  8877. When you are done, press @kbd{C-c C-c} in the table to get the converted
  8878. table inserted between the two marker lines.
  8879. Now let's assume you want to make the table header by hand, because you
  8880. want to control how columns are aligned etc. In this case we make sure
  8881. that the table translator does skip the first 2 lines of the source
  8882. table, and tell the command to work as a @i{splice}, i.e. to not produce
  8883. header and footer commands of the target table:
  8884. @example
  8885. \begin@{tabular@}@{lrrr@}
  8886. Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
  8887. % BEGIN RECEIVE ORGTBL salesfigures
  8888. % END RECEIVE ORGTBL salesfigures
  8889. \end@{tabular@}
  8890. %
  8891. \begin@{comment@}
  8892. #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
  8893. | Month | Days | Nr sold | per day |
  8894. |-------+------+---------+---------|
  8895. | Jan | 23 | 55 | 2.4 |
  8896. | Feb | 21 | 16 | 0.8 |
  8897. | March | 22 | 278 | 12.6 |
  8898. #+TBLFM: $4=$3/$2;%.1f
  8899. \end@{comment@}
  8900. @end example
  8901. The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
  8902. Orgtbl mode. It uses a @code{tabular} environment to typeset the table
  8903. and marks horizontal lines with @code{\hline}. Furthermore, it
  8904. interprets the following parameters (see also @ref{Translator functions}):
  8905. @table @code
  8906. @item :splice nil/t
  8907. When set to t, return only table body lines, don't wrap them into a
  8908. tabular environment. Default is nil.
  8909. @item :fmt fmt
  8910. A format to be used to wrap each field, should contain @code{%s} for the
  8911. original field value. For example, to wrap each field value in dollars,
  8912. you could use @code{:fmt "$%s$"}. This may also be a property list with
  8913. column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
  8914. A function of one argument can be used in place of the strings; the
  8915. function must return a formatted string.
  8916. @item :efmt efmt
  8917. Use this format to print numbers with exponentials. The format should
  8918. have @code{%s} twice for inserting mantissa and exponent, for example
  8919. @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
  8920. may also be a property list with column numbers and formats, for example
  8921. @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
  8922. @code{efmt} has been applied to a value, @code{fmt} will also be
  8923. applied. Similar to @code{fmt}, functions of two arguments can be
  8924. supplied instead of strings.
  8925. @end table
  8926. @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
  8927. @subsection Translator functions
  8928. @cindex HTML, and Orgtbl mode
  8929. @cindex translator function
  8930. Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
  8931. (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
  8932. @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
  8933. Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
  8934. code that produces tables during HTML export.}, these all use a generic
  8935. translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
  8936. itself is a very short function that computes the column definitions for the
  8937. @code{tabular} environment, defines a few field and line separators and then
  8938. hands over to the generic translator. Here is the entire code:
  8939. @lisp
  8940. @group
  8941. (defun orgtbl-to-latex (table params)
  8942. "Convert the Orgtbl mode TABLE to LaTeX."
  8943. (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
  8944. org-table-last-alignment ""))
  8945. (params2
  8946. (list
  8947. :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
  8948. :tend "\\end@{tabular@}"
  8949. :lstart "" :lend " \\\\" :sep " & "
  8950. :efmt "%s\\,(%s)" :hline "\\hline")))
  8951. (orgtbl-to-generic table (org-combine-plists params2 params))))
  8952. @end group
  8953. @end lisp
  8954. As you can see, the properties passed into the function (variable
  8955. @var{PARAMS}) are combined with the ones newly defined in the function
  8956. (variable @var{PARAMS2}). The ones passed into the function (i.e. the
  8957. ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
  8958. would like to use the La@TeX{} translator, but wanted the line endings to
  8959. be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
  8960. overrule the default with
  8961. @example
  8962. #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
  8963. @end example
  8964. For a new language, you can either write your own converter function in
  8965. analogy with the La@TeX{} translator, or you can use the generic function
  8966. directly. For example, if you have a language where a table is started
  8967. with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
  8968. started with @samp{!BL!}, ended with @samp{!EL!} and where the field
  8969. separator is a TAB, you could call the generic translator like this (on
  8970. a single line!):
  8971. @example
  8972. #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
  8973. :lstart "!BL! " :lend " !EL!" :sep "\t"
  8974. @end example
  8975. @noindent
  8976. Please check the documentation string of the function
  8977. @code{orgtbl-to-generic} for a full list of parameters understood by
  8978. that function and remember that you can pass each of them into
  8979. @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
  8980. using the generic function.
  8981. Of course you can also write a completely new function doing complicated
  8982. things the generic translator cannot do. A translator function takes
  8983. two arguments. The first argument is the table, a list of lines, each
  8984. line either the symbol @code{hline} or a list of fields. The second
  8985. argument is the property list containing all parameters specified in the
  8986. @samp{#+ORGTBL: SEND} line. The function must return a single string
  8987. containing the formatted table. If you write a generally useful
  8988. translator, please post it on @code{emacs-orgmode@@gnu.org} so that
  8989. others can benefit from your work.
  8990. @node Radio lists, , Translator functions, Tables in arbitrary syntax
  8991. @subsection Radio lists
  8992. @cindex radio lists
  8993. @cindex org-list-insert-radio-list
  8994. Sending and receiving radio lists works exactly the same way than
  8995. sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
  8996. need to load the @code{org-export-latex.el} package to use radio lists
  8997. since the relevant code is there for now.}. As for radio tables, you
  8998. can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by
  8999. calling @code{org-list-insert-radio-list}.
  9000. Here are the differences with radio tables:
  9001. @itemize @minus
  9002. @item
  9003. Use @code{ORGLST} instead of @code{ORGTBL}.
  9004. @item
  9005. The available translation functions for radio lists don't take
  9006. parameters.
  9007. @item
  9008. `C-c C-c' will work when pressed on the first item of the list.
  9009. @end itemize
  9010. Here is a La@TeX{} example. Let's say that you have this in your
  9011. La@TeX{} file:
  9012. @example
  9013. % BEGIN RECEIVE ORGLST to-buy
  9014. % END RECEIVE ORGLST to-buy
  9015. \begin@{comment@}
  9016. #+ORGLIST: SEND to-buy orgtbl-to-latex
  9017. - a new house
  9018. - a new computer
  9019. + a new keyboard
  9020. + a new mouse
  9021. - a new life
  9022. \end@{comment@}
  9023. @end example
  9024. Pressing `C-c C-c' on @code{a new house} and will insert the converted
  9025. La@TeX{} list between the two marker lines.
  9026. @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
  9027. @section Dynamic blocks
  9028. @cindex dynamic blocks
  9029. Org documents can contain @emph{dynamic blocks}. These are
  9030. specially marked regions that are updated by some user-written function.
  9031. A good example for such a block is the clock table inserted by the
  9032. command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
  9033. Dynamic block are enclosed by a BEGIN-END structure that assigns a name
  9034. to the block and can also specify parameters for the function producing
  9035. the content of the block.
  9036. #+BEGIN:dynamic block
  9037. @example
  9038. #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
  9039. #+END:
  9040. @end example
  9041. Dynamic blocks are updated with the following commands
  9042. @table @kbd
  9043. @kindex C-c C-x C-u
  9044. @item C-c C-x C-u
  9045. Update dynamic block at point.
  9046. @kindex C-u C-c C-x C-u
  9047. @item C-u C-c C-x C-u
  9048. Update all dynamic blocks in the current file.
  9049. @end table
  9050. Updating a dynamic block means to remove all the text between BEGIN and
  9051. END, parse the BEGIN line for parameters and then call the specific
  9052. writer function for this block to insert the new content. If you want
  9053. to use the original content in the writer function, you can use the
  9054. extra parameter @code{:content}.
  9055. For a block with name @code{myblock}, the writer function is
  9056. @code{org-dblock-write:myblock} with as only parameter a property list
  9057. with the parameters given in the begin line. Here is a trivial example
  9058. of a block that keeps track of when the block update function was last
  9059. run:
  9060. @example
  9061. #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
  9062. #+END:
  9063. @end example
  9064. @noindent
  9065. The corresponding block writer function could look like this:
  9066. @lisp
  9067. (defun org-dblock-write:block-update-time (params)
  9068. (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
  9069. (insert "Last block update at: "
  9070. (format-time-string fmt (current-time)))))
  9071. @end lisp
  9072. If you want to make sure that all dynamic blocks are always up-to-date,
  9073. you could add the function @code{org-update-all-dblocks} to a hook, for
  9074. example @code{before-save-hook}. @code{org-update-all-dblocks} is
  9075. written in a way that is does nothing in buffers that are not in
  9076. @code{org-mode}.
  9077. @node Special agenda views, Using the property API, Dynamic blocks, Hacking
  9078. @section Special agenda views
  9079. @cindex agenda views, user-defined
  9080. Org provides a special hook that can be used to narrow down the
  9081. selection made by any of the agenda views. You may specify a function
  9082. that is used at each match to verify if the match should indeed be part
  9083. of the agenda view, and if not, how much should be skipped.
  9084. Let's say you want to produce a list of projects that contain a WAITING
  9085. tag anywhere in the project tree. Let's further assume that you have
  9086. marked all tree headings that define a project with the TODO keyword
  9087. PROJECT. In this case you would run a TODO search for the keyword
  9088. PROJECT, but skip the match unless there is a WAITING tag anywhere in
  9089. the subtree belonging to the project line.
  9090. To achieve this, you must write a function that searches the subtree for
  9091. the tag. If the tag is found, the function must return @code{nil} to
  9092. indicate that this match should not be skipped. If there is no such
  9093. tag, return the location of the end of the subtree, to indicate that
  9094. search should continue from there.
  9095. @lisp
  9096. (defun my-skip-unless-waiting ()
  9097. "Skip trees that are not waiting"
  9098. (let ((subtree-end (save-excursion (org-end-of-subtree t))))
  9099. (if (re-search-forward ":waiting:" subtree-end t)
  9100. nil ; tag found, do not skip
  9101. subtree-end))) ; tag not found, continue after end of subtree
  9102. @end lisp
  9103. Now you may use this function in an agenda custom command, for example
  9104. like this:
  9105. @lisp
  9106. (org-add-agenda-custom-command
  9107. '("b" todo "PROJECT"
  9108. ((org-agenda-skip-function 'my-skip-unless-waiting)
  9109. (org-agenda-overriding-header "Projects waiting for something: "))))
  9110. @end lisp
  9111. @vindex org-agenda-overriding-header
  9112. Note that this also binds @code{org-agenda-overriding-header} to get a
  9113. meaningful header in the agenda view.
  9114. @vindex org-odd-levels-only
  9115. @vindex org-agenda-skip-function
  9116. A general way to create custom searches is to base them on a search for
  9117. entries with a certain level limit. If you want to study all entries with
  9118. your custom search function, simply do a search for
  9119. @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
  9120. level number corresponds to order in the hierarchy, not to the number of
  9121. stars.}, and then use @code{org-agenda-skip-function} to select the entries
  9122. you really want to have.
  9123. You may also put a Lisp form into @code{org-agenda-skip-function}. In
  9124. particular, you may use the functions @code{org-agenda-skip-entry-if}
  9125. and @code{org-agenda-skip-subtree-if} in this form, for example:
  9126. @table @code
  9127. @item '(org-agenda-skip-entry-if 'scheduled)
  9128. Skip current entry if it has been scheduled.
  9129. @item '(org-agenda-skip-entry-if 'notscheduled)
  9130. Skip current entry if it has not been scheduled.
  9131. @item '(org-agenda-skip-entry-if 'deadline)
  9132. Skip current entry if it has a deadline.
  9133. @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
  9134. Skip current entry if it has a deadline, or if it is scheduled.
  9135. @item '(org-agenda-skip-entry-if 'timestamp)
  9136. Skip current entry if it has any timestamp, may also be deadline or scheduled.
  9137. @item '(org-agenda-skip-entry 'regexp "regular expression")
  9138. Skip current entry if the regular expression matches in the entry.
  9139. @item '(org-agenda-skip-entry 'notregexp "regular expression")
  9140. Skip current entry unless the regular expression matches.
  9141. @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
  9142. Same as above, but check and skip the entire subtree.
  9143. @end table
  9144. Therefore we could also have written the search for WAITING projects
  9145. like this, even without defining a special function:
  9146. @lisp
  9147. (org-add-agenda-custom-command
  9148. '("b" todo "PROJECT"
  9149. ((org-agenda-skip-function '(org-agenda-skip-subtree-if
  9150. 'regexp ":waiting:"))
  9151. (org-agenda-overriding-header "Projects waiting for something: "))))
  9152. @end lisp
  9153. @node Using the property API, Using the mapping API, Special agenda views, Hacking
  9154. @section Using the property API
  9155. @cindex API, for properties
  9156. @cindex properties, API
  9157. Here is a description of the functions that can be used to work with
  9158. properties.
  9159. @defun org-entry-properties &optional pom which
  9160. Get all properties of the entry at point-or-marker POM.
  9161. This includes the TODO keyword, the tags, time strings for deadline,
  9162. scheduled, and clocking, and any additional properties defined in the
  9163. entry. The return value is an alist, keys may occur multiple times
  9164. if the property key was used several times.
  9165. POM may also be nil, in which case the current entry is used.
  9166. If WHICH is nil or `all', get all properties. If WHICH is
  9167. `special' or `standard', only get that subclass.
  9168. @end defun
  9169. @vindex org-use-property-inheritance
  9170. @defun org-entry-get pom property &optional inherit
  9171. Get value of PROPERTY for entry at point-or-marker POM. By default,
  9172. this only looks at properties defined locally in the entry. If INHERIT
  9173. is non-nil and the entry does not have the property, then also check
  9174. higher levels of the hierarchy. If INHERIT is the symbol
  9175. @code{selective}, use inheritance if and only if the setting of
  9176. @code{org-use-property-inheritance} selects PROPERTY for inheritance.
  9177. @end defun
  9178. @defun org-entry-delete pom property
  9179. Delete the property PROPERTY from entry at point-or-marker POM.
  9180. @end defun
  9181. @defun org-entry-put pom property value
  9182. Set PROPERTY to VALUE for entry at point-or-marker POM.
  9183. @end defun
  9184. @defun org-buffer-property-keys &optional include-specials
  9185. Get all property keys in the current buffer.
  9186. @end defun
  9187. @defun org-insert-property-drawer
  9188. Insert a property drawer at point.
  9189. @end defun
  9190. @defun org-entry-put-multivalued-property pom property &rest values
  9191. Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
  9192. strings. They will be concatenated, with spaces as separators.
  9193. @end defun
  9194. @defun org-entry-get-multivalued-property pom property
  9195. Treat the value of the property PROPERTY as a whitespace-separated list of
  9196. values and return the values as a list of strings.
  9197. @end defun
  9198. @defun org-entry-add-to-multivalued-property pom property value
  9199. Treat the value of the property PROPERTY as a whitespace-separated list of
  9200. values and make sure that VALUE is in this list.
  9201. @end defun
  9202. @defun org-entry-remove-from-multivalued-property pom property value
  9203. Treat the value of the property PROPERTY as a whitespace-separated list of
  9204. values and make sure that VALUE is @emph{not} in this list.
  9205. @end defun
  9206. @defun org-entry-member-in-multivalued-property pom property value
  9207. Treat the value of the property PROPERTY as a whitespace-separated list of
  9208. values and check if VALUE is in this list.
  9209. @end defun
  9210. @node Using the mapping API, , Using the property API, Hacking
  9211. @section Using the mapping API
  9212. @cindex API, for mapping
  9213. @cindex mapping entries, API
  9214. Org has sophisticated mapping capabilities to find all entries satisfying
  9215. certain criteria. Internally, this functionality is used to produce agenda
  9216. views, but there is also an API that can be used to execute arbitrary
  9217. functions for each or selected entries. The main entry point for this API
  9218. is:
  9219. @defun org-map-entries func &optional match scope &rest skip
  9220. Call FUNC at each headline selected by MATCH in SCOPE.
  9221. FUNC is a function or a lisp form. The function will be called without
  9222. arguments, with the cursor positioned at the beginning of the headline.
  9223. The return values of all calls to the function will be collected and
  9224. returned as a list.
  9225. MATCH is a tags/property/todo match as it is used in the agenda match view.
  9226. Only headlines that are matched by this query will be considered during
  9227. the iteration. When MATCH is nil or t, all headlines will be
  9228. visited by the iteration.
  9229. SCOPE determines the scope of this command. It can be any of:
  9230. @example
  9231. nil @r{the current buffer, respecting the restriction if any}
  9232. tree @r{the subtree started with the entry at point}
  9233. file @r{the current buffer, without restriction}
  9234. file-with-archives
  9235. @r{the current buffer, and any archives associated with it}
  9236. agenda @r{all agenda files}
  9237. agenda-with-archives
  9238. @r{all agenda files with any archive files associated with them}
  9239. (file1 file2 ...)
  9240. @r{if this is a list, all files in the list will be scanned}
  9241. @end example
  9242. The remaining args are treated as settings for the skipping facilities of
  9243. the scanner. The following items can be given here:
  9244. @vindex org-agenda-skip-function
  9245. @example
  9246. archive @r{skip trees with the archive tag}
  9247. comment @r{skip trees with the COMMENT keyword}
  9248. function or Lisp form
  9249. @r{will be used as value for @code{org-agenda-skip-function},}
  9250. @r{so whenever the the function returns t, FUNC}
  9251. @r{will not be called for that entry and search will}
  9252. @r{continue from the point where the function leaves it}
  9253. @end example
  9254. @end defun
  9255. The function given to that mapping routine can really do anything you like.
  9256. It can use the property API (@pxref{Using the property API}) to gather more
  9257. information about the entry, or in order to change metadata in the entry.
  9258. Here are a couple of functions that might be handy:
  9259. @defun org-todo &optional arg
  9260. Change the TODO state of the entry, see the docstring of the functions for
  9261. the many possible values for the argument ARG.
  9262. @end defun
  9263. @defun org-priority &optional action
  9264. Change the priority of the entry, see the docstring of this function for the
  9265. possible values for ACTION.
  9266. @end defun
  9267. @defun org-toggle-tag tag &optional onoff
  9268. Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
  9269. or @code{off} will not toggle tag, but ensure that it is either on or off.
  9270. @end defun
  9271. @defun org-promote
  9272. Promote the current entry.
  9273. @end defun
  9274. @defun org-demote
  9275. Demote the current entry.
  9276. @end defun
  9277. Here is a simple example that will turn all entries in the current file with
  9278. a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
  9279. Entries in comment trees and in archive trees will be ignored.
  9280. @lisp
  9281. (org-map-entries
  9282. '(org-todo "UPCOMING")
  9283. "+TOMORROW" 'file 'archive 'comment)
  9284. @end lisp
  9285. The following example counts the number of entries with TODO keyword
  9286. @code{WAITING}, in all agenda files.
  9287. @lisp
  9288. (length (org-map-entries t "/+WAITING" 'agenda))
  9289. @end lisp
  9290. @node History and Acknowledgments, Main Index, Hacking, Top
  9291. @appendix History and Acknowledgments
  9292. @cindex acknowledgments
  9293. @cindex history
  9294. @cindex thanks
  9295. Org was borne in 2003, out of frustration over the user interface
  9296. of the Emacs Outline mode. I was trying to organize my notes and
  9297. projects, and using Emacs seemed to be the natural way to go. However,
  9298. having to remember eleven different commands with two or three keys per
  9299. command, only to hide and show parts of the outline tree, that seemed
  9300. entirely unacceptable to me. Also, when using outlines to take notes, I
  9301. constantly want to restructure the tree, organizing it parallel to my
  9302. thoughts and plans. @emph{Visibility cycling} and @emph{structure
  9303. editing} were originally implemented in the package
  9304. @file{outline-magic.el}, but quickly moved to the more general
  9305. @file{org.el}. As this environment became comfortable for project
  9306. planning, the next step was adding @emph{TODO entries}, basic @emph{time
  9307. stamps}, and @emph{table support}. These areas highlight the two main
  9308. goals that Org still has today: To create a new, outline-based,
  9309. plain text mode with innovative and intuitive editing features, and to
  9310. incorporate project planning functionality directly into a notes file.
  9311. A special thanks goes to @i{Bastien Guerry} who has not only written a large
  9312. number of extensions to Org (most of them integrated into the core by now),
  9313. but has also helped the development and maintenance of Org so much that he
  9314. should be considered the main co-contributor to this package.
  9315. Since the first release, literally thousands of emails to me or on
  9316. @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
  9317. reports, feedback, new ideas, and sometimes patches and add-on code.
  9318. Many thanks to everyone who has helped to improve this package. I am
  9319. trying to keep here a list of the people who had significant influence
  9320. in shaping one or more aspects of Org. The list may not be
  9321. complete, if I have forgotten someone, please accept my apologies and
  9322. let me know.
  9323. @itemize @bullet
  9324. @item
  9325. @i{Russel Adams} came up with the idea for drawers.
  9326. @item
  9327. @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
  9328. @item
  9329. @i{Christophe Bataillon} created the great unicorn logo that we use on the
  9330. Org-mode website.
  9331. @item
  9332. @i{Alex Bochannek} provided a patch for rounding time stamps.
  9333. @item
  9334. @i{Tom Breton} wrote @file{og-choose.el}.
  9335. @item
  9336. @i{Charles Cave}'s suggestion sparked the implementation of templates
  9337. for Remember.
  9338. @item
  9339. @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
  9340. specified time.
  9341. @item
  9342. @i{Gregory Chernov} patched support for lisp forms into table
  9343. calculations and improved XEmacs compatibility, in particular by porting
  9344. @file{nouline.el} to XEmacs.
  9345. @item
  9346. @i{Sacha Chua} suggested to copy some linking code from Planner.
  9347. @item
  9348. @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
  9349. came up with the idea of properties, and that there should be an API for
  9350. them.
  9351. @item
  9352. @i{Kees Dullemond} used to edit projects lists directly in HTML and so
  9353. inspired some of the early development, including HTML export. He also
  9354. asked for a way to narrow wide table columns.
  9355. @item
  9356. @i{Christian Egli} converted the documentation into Texinfo format,
  9357. patched CSS formatting into the HTML exporter, and inspired the agenda.
  9358. @item
  9359. @i{David Emery} provided a patch for custom CSS support in exported
  9360. HTML agendas.
  9361. @item
  9362. @i{Nic Ferrier} contributed mailcap and XOXO support.
  9363. @item
  9364. @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
  9365. @item
  9366. @i{John Foerch} figured out how to make incremental search show context
  9367. around a match in a hidden outline tree.
  9368. @item
  9369. @i{Niels Giesen} had the idea to automatically archive DONE trees.
  9370. @item
  9371. @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
  9372. has been prolific with patches, ideas, and bug reports.
  9373. @item
  9374. @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
  9375. @item
  9376. @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
  9377. task state change logging, and the clocktable. His clear explanations have
  9378. been critical when we started to adopt the GIT version control system.
  9379. @item
  9380. @i{Manuel Hermenegildo} has contributed various ideas, small fixed and
  9381. patches.
  9382. @item
  9383. @i{Phil Jackson} wrote @file{org-irc.el}.
  9384. @item
  9385. @i{Scott Jaderholm} proposed footnotes, control over whitespace between
  9386. folded entries, and column view for properties.
  9387. @item
  9388. @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
  9389. @item
  9390. @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
  9391. provided frequent feedback and some patches.
  9392. @item
  9393. @i{Matt Lundin} has proposed last-row references for table formulas and named
  9394. invisible anchors. He has also worked a lot on the FAQ.
  9395. @item
  9396. @i{Jason F. McBrayer} suggested agenda export to CSV format.
  9397. @item
  9398. @i{Max Mikhanosha} came up with the idea of refiling.
  9399. @item
  9400. @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
  9401. basis.
  9402. @item
  9403. @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
  9404. happy.
  9405. @item
  9406. @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
  9407. and to be able to quickly restrict the agenda to a subtree.
  9408. @item
  9409. @i{Todd Neal} provided patches for links to Info files and elisp forms.
  9410. @item
  9411. @i{Tim O'Callaghan} suggested in-file links, search options for general
  9412. file links, and TAGS.
  9413. @item
  9414. @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
  9415. into Japanese.
  9416. @item
  9417. @i{Oliver Oppitz} suggested multi-state TODO items.
  9418. @item
  9419. @i{Scott Otterson} sparked the introduction of descriptive text for
  9420. links, among other things.
  9421. @item
  9422. @i{Pete Phillips} helped during the development of the TAGS feature, and
  9423. provided frequent feedback.
  9424. @item
  9425. @i{T.V. Raman} reported bugs and suggested improvements.
  9426. @item
  9427. @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
  9428. control.
  9429. @item
  9430. @i{Paul Rivier} provided the basic implementation of named footnotes.
  9431. @item
  9432. @i{Kevin Rogers} contributed code to access VM files on remote hosts.
  9433. @item
  9434. @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
  9435. webpages derived from Org using an Info-like, or a folding interface with
  9436. single key navigation.
  9437. @item
  9438. @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
  9439. conflict with @file{allout.el}.
  9440. @item
  9441. @i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with
  9442. extensive patches.
  9443. @item
  9444. @i{Philip Rooke} created the Org reference card, provided lots
  9445. of feedback, developed and applied standards to the Org documentation.
  9446. @item
  9447. @i{Christian Schlauer} proposed angular brackets around links, among
  9448. other things.
  9449. @item
  9450. @i{Eric Schulte} wrote @file{org-plot.el}.
  9451. @item
  9452. Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
  9453. @file{organizer-mode.el}.
  9454. @item
  9455. @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
  9456. examples, and remote highlighting for referenced code lines.
  9457. @item
  9458. @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
  9459. now packaged into Org's @file{contrib} directory.
  9460. @item
  9461. @i{Daniel Sinder} came up with the idea of internal archiving by locking
  9462. subtrees.
  9463. @item
  9464. @i{Dale Smith} proposed link abbreviations.
  9465. @item
  9466. @i{James TD Smith} has contributed a large number of patches for useful
  9467. tweaks and features.
  9468. @item
  9469. @i{Adam Spiers} asked for global linking commands, inspired the link
  9470. extension system, added support for mairix, and proposed the mapping API.
  9471. @item
  9472. @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
  9473. with links transformation to Org syntax.
  9474. @item
  9475. @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
  9476. chapter about publishing.
  9477. @item
  9478. @i{J@"urgen Vollmer} contributed code generating the table of contents
  9479. in HTML output.
  9480. @item
  9481. @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
  9482. keyword.
  9483. @item
  9484. @i{David Wainberg} suggested archiving, and improvements to the linking
  9485. system.
  9486. @item
  9487. @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
  9488. @file{muse.el}, which have some overlap with Org. Initially the development
  9489. of Org was fully independent because I was not aware of the existence of
  9490. these packages. But with time I have occasionally looked at John's code and
  9491. learned a lot from it. John has also contributed a number of great ideas and
  9492. patches directly to Org, including the attachment system
  9493. (@file{org-attach.el}), integration with Apple Mail
  9494. (@file{org-mac-message.el}), and hierarchical dependencies of TODO items.
  9495. @item
  9496. @i{Carsten Wimmer} suggested some changes and helped fix a bug in
  9497. linking to Gnus.
  9498. @item
  9499. @i{Roland Winkler} requested additional key bindings to make Org
  9500. work on a tty.
  9501. @item
  9502. @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
  9503. and contributed various ideas and code snippets.
  9504. @end itemize
  9505. @node Main Index, Key Index, History and Acknowledgments, Top
  9506. @unnumbered Concept Index
  9507. @printindex cp
  9508. @node Key Index, Variable and Faces Index, Main Index, Top
  9509. @unnumbered Key Index
  9510. @printindex ky
  9511. @node Variable and Faces Index, , Key Index, Top
  9512. @unnumbered Variable Index
  9513. This is not a complete index of variables and faces, only the ones that are
  9514. mentioned in the manual. For a more complete list, use @kbd{M-x
  9515. org-customize @key{RET}} and then klick yourself through the tree.
  9516. @printindex vr
  9517. @bye
  9518. @ignore
  9519. arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
  9520. @end ignore
  9521. @c Local variables:
  9522. @c ispell-local-dictionary: "en_US-w_accents"
  9523. @c ispell-local-pdict: "./.aspell.org.pws"
  9524. @c fill-column: 77
  9525. @c End: