org.texi 333 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609
  1. \input texinfo
  2. @c %**start of header
  3. @setfilename ../../info/org
  4. @settitle Org Mode Manual
  5. @set VERSION 5.19
  6. @set DATE January 2008
  7. @dircategory Emacs
  8. @direntry
  9. * Org Mode: (org). Outline-based notes management and organizer
  10. @end direntry
  11. @c Version and Contact Info
  12. @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
  13. @set AUTHOR Carsten Dominik
  14. @set MAINTAINER Carsten Dominik
  15. @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
  16. @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
  17. @c %**end of header
  18. @finalout
  19. @c Macro definitions
  20. @c Subheadings inside a table.
  21. @macro tsubheading{text}
  22. @ifinfo
  23. @subsubheading \text\
  24. @end ifinfo
  25. @ifnotinfo
  26. @item @b{\text\}
  27. @end ifnotinfo
  28. @end macro
  29. @copying
  30. This manual is for Org-mode (version @value{VERSION}).
  31. Copyright @copyright{} 2004, 2005, 2006, 2007, 2008 Free Software Foundation
  32. @quotation
  33. Permission is granted to copy, distribute and/or modify this document
  34. under the terms of the GNU Free Documentation License, Version 1.1 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
  38. license is included in the section entitled ``GNU Free Documentation
  39. License.''
  40. (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
  41. this GNU Manual, like GNU software. Copies published by the Free
  42. Software Foundation raise funds for GNU development.''
  43. @end quotation
  44. @end copying
  45. @titlepage
  46. @title Org Mode Manual
  47. @subtitle Release @value{VERSION}
  48. @author by Carsten Dominik
  49. @c The following two commands start the copyright page.
  50. @page
  51. @vskip 0pt plus 1filll
  52. @insertcopying
  53. @end titlepage
  54. @c Output the table of contents at the beginning.
  55. @contents
  56. @ifnottex
  57. @node Top, Introduction, (dir), (dir)
  58. @top Org Mode Manual
  59. @insertcopying
  60. @end ifnottex
  61. @menu
  62. * Introduction:: Getting started
  63. * Document structure:: A tree works like your brain
  64. * Tables:: Pure magic for quick formatting
  65. * Hyperlinks:: Notes in context
  66. * TODO items:: Every tree branch can be a TODO item
  67. * Tags:: Tagging headlines and matching sets of tags
  68. * Properties and columns:: Storing information about an entry
  69. * Dates and times:: Making items useful for planning
  70. * Remember:: Quickly adding nodes to the outline tree
  71. * Agenda views:: Collecting information into views
  72. * Embedded LaTeX:: LaTeX fragments and formulas
  73. * Exporting:: Sharing and publishing of notes
  74. * Publishing:: Create a web site of linked Org-mode files
  75. * Miscellaneous:: All the rest which did not fit elsewhere
  76. * Extensions and Hacking:: It is possible to write add-on code
  77. * History and Acknowledgments:: How Org-mode came into being
  78. * Main Index::
  79. * Key Index:: Key bindings and where they are described
  80. @detailmenu
  81. --- The Detailed Node Listing ---
  82. Introduction
  83. * Summary:: Brief summary of what Org-mode does
  84. * Installation:: How to install a downloaded version of Org-mode
  85. * Activation:: How to activate Org-mode for certain buffers.
  86. * Feedback:: Bug reports, ideas, patches etc.
  87. * Conventions:: Type-setting conventions in the manual
  88. Document Structure
  89. * Outlines:: Org-mode is based on outline-mode
  90. * Headlines:: How to typeset org-tree headlines
  91. * Visibility cycling:: Show and hide, much simplified
  92. * Motion:: Jumping to other headlines
  93. * Structure editing:: Changing sequence and level of headlines
  94. * Archiving:: Move done task trees to a different place
  95. * Sparse trees:: Matches embedded in context
  96. * Plain lists:: Additional structure within an entry
  97. * Drawers:: Tucking stuff away
  98. * orgstruct-mode:: Structure editing outside Org-mode
  99. Archiving
  100. * ARCHIVE tag:: Marking a tree as inactive
  101. * Moving subtrees:: Moving a tree to an archive file
  102. Tables
  103. * Built-in table editor:: Simple tables
  104. * Narrow columns:: Stop wasting space in tables
  105. * Column groups:: Grouping to trigger vertical lines
  106. * orgtbl-mode:: The table editor as minor mode
  107. * The spreadsheet:: The table editor has spreadsheet capabilities.
  108. The spreadsheet
  109. * References:: How to refer to another field or range
  110. * Formula syntax for Calc:: Using Calc to compute stuff
  111. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  112. * Field formulas:: Formulas valid for a single field
  113. * Column formulas:: Formulas valid for an entire column
  114. * Editing and debugging formulas:: Fixing formulas
  115. * Updating the table:: Recomputing all dependent fields
  116. * Advanced features:: Field names, parameters and automatic recalc
  117. Hyperlinks
  118. * Link format:: How links in Org-mode are formatted
  119. * Internal links:: Links to other places in the current file
  120. * External links:: URL-like links to the world
  121. * Handling links:: Creating, inserting and following
  122. * Using links outside Org-mode:: Linking from my C source code?
  123. * Link abbreviations:: Shortcuts for writing complex links
  124. * Search options:: Linking to a specific location
  125. * Custom searches:: When the default search is not enough
  126. Internal links
  127. * Radio targets:: Make targets trigger links in plain text.
  128. TODO items
  129. * TODO basics:: Marking and displaying TODO entries
  130. * TODO extensions:: Workflow and assignments
  131. * Progress logging:: Dates and notes for progress
  132. * Priorities:: Some things are more important than others
  133. * Breaking down tasks:: Splitting a task into manageable pieces
  134. * Checkboxes:: Tick-off lists
  135. Extended use of TODO keywords
  136. * Workflow states:: From TODO to DONE in steps
  137. * TODO types:: I do this, Fred does the rest
  138. * Multiple sets in one file:: Mixing it all, and still finding your way
  139. * Fast access to TODO states:: Single letter selection of a state
  140. * Per-file keywords:: Different files, different requirements
  141. * Faces for TODO keywords:: Highlighting states
  142. Progress Logging
  143. * Closing items:: When was this entry marked DONE?
  144. * Tracking TODO state changes:: When did the status change?
  145. Tags
  146. * Tag inheritance:: Tags use the tree structure of the outline
  147. * Setting tags:: How to assign tags to a headline
  148. * Tag searches:: Searching for combinations of tags
  149. Properties and Columns
  150. * Property syntax:: How properties are spelled out
  151. * Special properties:: Access to other Org-mode features
  152. * Property searches:: Matching property values
  153. * Property inheritance:: Passing values down the tree
  154. * Column view:: Tabular viewing and editing
  155. * Property API:: Properties for Lisp programmers
  156. Column View
  157. * Defining columns:: The COLUMNS format property
  158. * Using column view:: How to create and use column view
  159. * Capturing Column View:: A dynamic block for column view
  160. Defining Columns
  161. * Scope of column definitions:: Where defined, where valid?
  162. * Column attributes:: Appearance and content of a column
  163. Dates and Times
  164. * Time stamps:: Assigning a time to a tree entry
  165. * Creating timestamps:: Commands which insert timestamps
  166. * Deadlines and scheduling:: Planning your work
  167. * Clocking work time::
  168. Creating timestamps
  169. * The date/time prompt:: How org-mode helps you entering date and time
  170. * Custom time format:: Making dates look differently
  171. Deadlines and Scheduling
  172. * Inserting deadline/schedule:: Planning items
  173. * Repeated tasks:: Items that show up again and again
  174. Remember
  175. * Setting up remember:: Some code for .emacs to get things going
  176. * Remember templates:: Define the outline of different note types
  177. * Storing notes:: Directly get the note to where it belongs
  178. * Refiling notes:: Moving a note or task to a project
  179. Agenda Views
  180. * Agenda files:: Files being searched for agenda information
  181. * Agenda dispatcher:: Keyboard access to agenda views
  182. * Built-in agenda views:: What is available out of the box?
  183. * Presentation and sorting:: How agenda items are prepared for display
  184. * Agenda commands:: Remote editing of org trees
  185. * Custom agenda views:: Defining special searches and views
  186. The built-in agenda views
  187. * Weekly/Daily agenda:: The calendar page with current tasks
  188. * Global TODO list:: All unfinished action items
  189. * Matching tags and properties:: Structured information with fine-tuned search
  190. * Timeline:: Time-sorted view for single file
  191. * Stuck projects:: Find projects you need to review
  192. Presentation and sorting
  193. * Categories:: Not all tasks are equal
  194. * Time-of-day specifications:: How the agenda knows the time
  195. * Sorting of agenda items:: The order of things
  196. Custom agenda views
  197. * Storing searches:: Type once, use often
  198. * Block agenda:: All the stuff you need in a single buffer
  199. * Setting Options:: Changing the rules
  200. * Exporting Agenda Views:: Writing agendas to files.
  201. * Extracting Agenda Information for other programs::
  202. Embedded LaTeX
  203. * Math symbols:: TeX macros for symbols and Greek letters
  204. * Subscripts and Superscripts:: Simple syntax for raising/lowering text
  205. * LaTeX fragments:: Complex formulas made easy
  206. * Processing LaTeX fragments:: Previewing LaTeX processing
  207. * CDLaTeX mode:: Speed up entering of formulas
  208. Exporting
  209. * ASCII export:: Exporting to plain ASCII
  210. * HTML export:: Exporting to HTML
  211. * LaTeX export:: Exporting to LaTeX
  212. * XOXO export:: Exporting to XOXO
  213. * iCalendar export:: Exporting in iCalendar format
  214. * Text interpretation:: How the exporter looks at the file
  215. HTML export
  216. * HTML Export commands:: How to invoke LaTeX export
  217. * Quoting HTML tags:: Using direct HTML in Org-mode
  218. * Links:: Transformation of links for HTML
  219. * Images:: How to include images
  220. * CSS support:: Changing the appearence of the output
  221. LaTeX export
  222. * LaTeX export commands:: How to invoke LaTeX export
  223. * Quoting LaTeX code:: Incorporating literal LaTeX code
  224. * Sectioning structure::
  225. Text interpretation by the exporter
  226. * Comment lines:: Some lines will not be exported
  227. * Initial text:: Text before the first headline
  228. * Footnotes:: Numbers like [1]
  229. * Quoted examples:: Inserting quoted chnuks of text
  230. * Enhancing text:: Subscripts, symbols and more
  231. * Export options:: How to influence the export settings
  232. Publishing
  233. * Configuration:: Defining projects
  234. * Sample configuration:: Example projects
  235. * Triggering publication:: Publication commands
  236. Configuration
  237. * Project alist:: The central configuration variable
  238. * Sources and destinations:: From here to there
  239. * Selecting files:: What files are part of the project?
  240. * Publishing action:: Setting the function doing the publishing
  241. * Publishing options:: Tweaking HTML export
  242. * Publishing links:: Which links keep working after publishing?
  243. * Project page index:: Publishing a list of project files
  244. Sample configuration
  245. * Simple example:: One-component publishing
  246. * Complex example:: A multi-component publishing example
  247. Miscellaneous
  248. * Completion:: M-TAB knows what you need
  249. * Customization:: Adapting Org-mode to your taste
  250. * In-buffer settings:: Overview of the #+KEYWORDS
  251. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  252. * Clean view:: Getting rid of leading stars in the outline
  253. * TTY keys:: Using Org-mode on a tty
  254. * Interaction:: Other Emacs packages
  255. * Bugs:: Things which do not work perfectly
  256. Interaction with other packages
  257. * Cooperation:: Packages Org-mode cooperates with
  258. * Conflicts:: Packages that lead to conflicts
  259. Extensions, Hooks and Hacking
  260. * Extensions:: Existing 3rd-part extensions
  261. * Adding hyperlink types:: New custom link types
  262. * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
  263. * Dynamic blocks:: Automatically filled blocks
  264. * Special agenda views:: Customized views
  265. * Using the property API:: Writing programs that use entry properties
  266. Tables and Lists in arbitrary syntax
  267. * Radio tables:: Sending and receiving
  268. * A LaTeX example:: Step by step, almost a tutorial
  269. * Translator functions:: Copy and modify
  270. * Radio lists:: Doing the same for lists.
  271. @end detailmenu
  272. @end menu
  273. @node Introduction, Document structure, Top, Top
  274. @chapter Introduction
  275. @cindex introduction
  276. @menu
  277. * Summary:: Brief summary of what Org-mode does
  278. * Installation:: How to install a downloaded version of Org-mode
  279. * Activation:: How to activate Org-mode for certain buffers.
  280. * Feedback:: Bug reports, ideas, patches etc.
  281. * Conventions:: Type-setting conventions in the manual
  282. @end menu
  283. @node Summary, Installation, Introduction, Introduction
  284. @section Summary
  285. @cindex summary
  286. Org-mode is a mode for keeping notes, maintaining TODO lists, and doing
  287. project planning with a fast and effective plain-text system.
  288. Org-mode develops organizational tasks around NOTES files that contain
  289. lists or information about projects as plain text. Org-mode is
  290. implemented on top of outline-mode, which makes it possible to keep the
  291. content of large files well structured. Visibility cycling and
  292. structure editing help to work with the tree. Tables are easily created
  293. with a built-in table editor. Org-mode supports TODO items, deadlines,
  294. time stamps, and scheduling. It dynamically compiles entries into an
  295. agenda that utilizes and smoothly integrates much of the Emacs calendar
  296. and diary. Plain text URL-like links connect to websites, emails,
  297. Usenet messages, BBDB entries, and any files related to the projects.
  298. For printing and sharing of notes, an Org-mode file can be exported as a
  299. structured ASCII file, as HTML, or (TODO and agenda items only) as an
  300. iCalendar file. It can also serve as a publishing tool for a set of
  301. linked webpages.
  302. An important design aspect that distinguishes Org-mode from for example
  303. Planner/Muse is that it encourages to store every piece of information
  304. only once. In Planner, you have project pages, day pages and possibly
  305. other files, duplicating some information such as tasks. In Org-mode,
  306. you only have notes files. In your notes you mark entries as tasks,
  307. label them with tags and timestamps. All necessary lists like a
  308. schedule for the day, the agenda for a meeting, tasks lists selected by
  309. tags etc are created dynamically when you need them.
  310. Org-mode keeps simple things simple. When first fired up, it should
  311. feel like a straightforward, easy to use outliner. Complexity is not
  312. imposed, but a large amount of functionality is available when you need
  313. it. Org-mode is a toolbox and can be used in different ways, for
  314. example as:
  315. @example
  316. @r{@bullet{} outline extension with visibility cycling and structure editing}
  317. @r{@bullet{} ASCII system and table editor for taking structured notes}
  318. @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
  319. @r{@bullet{} TODO list editor}
  320. @r{@bullet{} full agenda and planner with deadlines and work scheduling}
  321. @r{@bullet{} environment to implement David Allen's GTD system}
  322. @r{@bullet{} a basic database application}
  323. @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
  324. @r{@bullet{} publishing tool to create a set of interlinked webpages}
  325. @end example
  326. Org-mode's automatic, context sensitive table editor with spreadsheet
  327. capabilities can be integrated into any major mode by activating the
  328. minor Orgtbl-mode. Using a translation step, it can be used to maintain
  329. tables in arbitrary file types, for example in La@TeX{}. The structure
  330. editing and list creation capabilities can be used outside Org-mode with
  331. the minor Orgstruct-mode.
  332. @cindex FAQ
  333. There is a website for Org-mode which provides links to the newest
  334. version of Org-mode, as well as additional information, frequently asked
  335. questions (FAQ), links to tutorials etc. This page is located at
  336. @uref{http://orgmode.org}.
  337. @page
  338. @node Installation, Activation, Summary, Introduction
  339. @section Installation
  340. @cindex installation
  341. @cindex XEmacs
  342. @b{Important:} @i{If Org-mode is part of the Emacs distribution or an
  343. XEmacs package, please skip this section and go directly to
  344. @ref{Activation}.}
  345. If you have downloaded Org-mode from the Web, you must take the
  346. following steps to install it: Go into the Org-mode distribution
  347. directory and edit the top section of the file @file{Makefile}. You
  348. must set the name of the Emacs binary (likely either @file{emacs} or
  349. @file{xemacs}), and the paths to the directories where local Lisp and
  350. Info files are kept. If you don't have access to the system-wide
  351. directories, create your own two directories for these files, enter them
  352. into the Makefile, and make sure Emacs finds the Lisp files by adding
  353. the following line to @file{.emacs}:
  354. @example
  355. (setq load-path (cons "~/path/to/lispdir" load-path))
  356. @end example
  357. @b{XEmacs users now need to install the file @file{noutline.el} from
  358. the @file{xemacs} subdirectory of the Org-mode distribution. Use the
  359. command:}
  360. @example
  361. @b{make install-noutline}
  362. @end example
  363. @noindent Now byte-compile and install the Lisp files with the shell
  364. commands:
  365. @example
  366. make
  367. make install
  368. @end example
  369. @noindent If you want to install the info documentation, use this command:
  370. @example
  371. make install-info
  372. @end example
  373. @noindent Then add to @file{.emacs}:
  374. @lisp
  375. ;; This line only if org-mode is not part of the X/Emacs distribution.
  376. (require 'org-install)
  377. @end lisp
  378. @node Activation, Feedback, Installation, Introduction
  379. @section Activation
  380. @cindex activation
  381. @cindex autoload
  382. @cindex global keybindings
  383. @cindex keybindings, global
  384. @iftex
  385. @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
  386. PDF documentation as viewed by Acrobat reader to your .emacs file, the
  387. single quote character comes out incorrectly and the code will not work.
  388. You need to fix the single quotes by hand, or copy from Info
  389. documentation.}
  390. @end iftex
  391. Add the following lines to your @file{.emacs} file. The last two lines
  392. define @emph{global} keys for the commands @command{org-store-link} and
  393. @command{org-agenda} - please choose suitable keys yourself.
  394. @lisp
  395. ;; The following lines are always needed. Choose your own keys.
  396. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
  397. (global-set-key "\C-cl" 'org-store-link)
  398. (global-set-key "\C-ca" 'org-agenda)
  399. @end lisp
  400. Furthermore, you must activate @code{font-lock-mode} in org-mode
  401. buffers, because significant functionality depends on font-locking being
  402. active. You can do this with either one of the following two lines
  403. (XEmacs user must use the second option):
  404. @lisp
  405. (global-font-lock-mode 1) ; for all buffers
  406. (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
  407. @end lisp
  408. @cindex org-mode, turning on
  409. With this setup, all files with extension @samp{.org} will be put
  410. into Org-mode. As an alternative, make the first line of a file look
  411. like this:
  412. @example
  413. MY PROJECTS -*- mode: org; -*-
  414. @end example
  415. @noindent which will select Org-mode for this buffer no matter what
  416. the file's name is. See also the variable
  417. @code{org-insert-mode-line-in-empty-file}.
  418. @node Feedback, Conventions, Activation, Introduction
  419. @section Feedback
  420. @cindex feedback
  421. @cindex bug reports
  422. @cindex maintainer
  423. @cindex author
  424. If you find problems with Org-mode, or if you have questions, remarks,
  425. or ideas about it, please contact the maintainer @value{MAINTAINER} at
  426. @value{MAINTAINEREMAIL}.
  427. For bug reports, please provide as much information as possible,
  428. including the version information of Emacs (@kbd{C-h v emacs-version
  429. @key{RET}}) and Org-mode (@kbd{C-h v org-version @key{RET}}), as well as
  430. the Org-mode related setup in @file{.emacs}. If an error occurs, a
  431. backtrace can be very useful (see below on how to create one). Often a
  432. small example file helps, along with clear information about:
  433. @enumerate
  434. @item What exactly did you do?
  435. @item What did you expect to happen?
  436. @item What happened instead?
  437. @end enumerate
  438. @noindent Thank you for helping to improve this mode.
  439. @subsubheading How to create a useful backtrace
  440. @cindex backtrace of an error
  441. If working with Org-mode produces an error with a message you don't
  442. understand, you may have hit a bug. The best way to report this is by
  443. providing, in addition to what was mentioned above, a @emph{Backtrace}.
  444. This is information from the built-in debugger about where and how the
  445. error occurred. Here is how to produce a useful backtrace:
  446. @enumerate
  447. @item
  448. Start a fresh Emacs or XEmacs, and make sure that it will load the
  449. original Lisp code in @file{org.el} instead of the compiled version in
  450. @file{org.elc}. The backtrace contains much more information if it is
  451. produced with uncompiled code. To do this, either rename @file{org.elc}
  452. to something else before starting Emacs, or ask Emacs explicitly to load
  453. @file{org.el} by using the command line
  454. @example
  455. emacs -l /path/to/org.el
  456. @end example
  457. @item
  458. Go to the @code{Options} menu and select @code{Enter Debugger on Error}
  459. (XEmacs has this option in the @code{Troubleshooting} sub-menu).
  460. @item
  461. Do whatever you have to do to hit the error. Don't forget to
  462. document the steps you take.
  463. @item
  464. When you hit the error, a @file{*Backtrace*} buffer will appear on the
  465. screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
  466. attach it to your bug report.
  467. @end enumerate
  468. @node Conventions, , Feedback, Introduction
  469. @section Typesetting conventions used in this manual
  470. Org-mode uses three types of keywords: TODO keywords, tags, and property
  471. names. In this manual we use the following conventions:
  472. @table @code
  473. @item TODO
  474. @itemx WAITING
  475. TODO keywords are written with all capitals, even if they are
  476. user-defined.
  477. @item boss
  478. @itemx ARCHIVE
  479. User-defined tags are written in lowercase; built-in tags with special
  480. meaning are written with all capitals.
  481. @item Release
  482. @itemx PRIORITY
  483. User-defined properties are capitalized; built-in properties with
  484. special meaning are written with all capitals.
  485. @end table
  486. @node Document structure, Tables, Introduction, Top
  487. @chapter Document Structure
  488. @cindex document structure
  489. @cindex structure of document
  490. Org-mode is based on outline mode and provides flexible commands to
  491. edit the structure of the document.
  492. @menu
  493. * Outlines:: Org-mode is based on outline-mode
  494. * Headlines:: How to typeset org-tree headlines
  495. * Visibility cycling:: Show and hide, much simplified
  496. * Motion:: Jumping to other headlines
  497. * Structure editing:: Changing sequence and level of headlines
  498. * Archiving:: Move done task trees to a different place
  499. * Sparse trees:: Matches embedded in context
  500. * Plain lists:: Additional structure within an entry
  501. * Drawers:: Tucking stuff away
  502. * orgstruct-mode:: Structure editing outside Org-mode
  503. @end menu
  504. @node Outlines, Headlines, Document structure, Document structure
  505. @section Outlines
  506. @cindex outlines
  507. @cindex outline-mode
  508. Org-mode is implemented on top of outline-mode. Outlines allow a
  509. document to be organized in a hierarchical structure, which (at least
  510. for me) is the best representation of notes and thoughts. An overview
  511. of this structure is achieved by folding (hiding) large parts of the
  512. document to show only the general document structure and the parts
  513. currently being worked on. Org-mode greatly simplifies the use of
  514. outlines by compressing the entire show/hide functionality into a single
  515. command @command{org-cycle}, which is bound to the @key{TAB} key.
  516. @node Headlines, Visibility cycling, Outlines, Document structure
  517. @section Headlines
  518. @cindex headlines
  519. @cindex outline tree
  520. Headlines define the structure of an outline tree. The headlines in
  521. Org-mode start with one or more stars, on the left margin@footnote{See
  522. the variable @code{org-special-ctrl-a/e} to configure special behavior
  523. of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
  524. @example
  525. * Top level headline
  526. ** Second level
  527. *** 3rd level
  528. some text
  529. *** 3rd level
  530. more text
  531. * Another top level headline
  532. @end example
  533. @noindent Some people find the many stars too noisy and would prefer an
  534. outline that has whitespace followed by a single star as headline
  535. starters. @ref{Clean view} describes a setup to realize this.
  536. An empty line after the end of a subtree is considered part of it and
  537. will be hidden when the subtree is folded. However, if you leave at
  538. least two empty lines, one empty line will remain visible after folding
  539. the subtree, in order to structure the collapsed view. See the
  540. variable @code{org-cycle-separator-lines} to modify this behavior.
  541. @node Visibility cycling, Motion, Headlines, Document structure
  542. @section Visibility cycling
  543. @cindex cycling, visibility
  544. @cindex visibility cycling
  545. @cindex trees, visibility
  546. @cindex show hidden text
  547. @cindex hide text
  548. Outlines make it possible to hide parts of the text in the buffer.
  549. Org-mode uses just two commands, bound to @key{TAB} and
  550. @kbd{S-@key{TAB}} to change the visibility in the buffer.
  551. @cindex subtree visibility states
  552. @cindex subtree cycling
  553. @cindex folded, subtree visibility state
  554. @cindex children, subtree visibility state
  555. @cindex subtree, subtree visibility state
  556. @table @kbd
  557. @kindex @key{TAB}
  558. @item @key{TAB}
  559. @emph{Subtree cycling}: Rotate current subtree among the states
  560. @example
  561. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  562. '-----------------------------------'
  563. @end example
  564. The cursor must be on a headline for this to work@footnote{see, however,
  565. the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
  566. beginning of the buffer and the first line is not a headline, then
  567. @key{TAB} actually runs global cycling (see below)@footnote{see the
  568. option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
  569. argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
  570. @cindex global visibility states
  571. @cindex global cycling
  572. @cindex overview, global visibility state
  573. @cindex contents, global visibility state
  574. @cindex show all, global visibility state
  575. @kindex S-@key{TAB}
  576. @item S-@key{TAB}
  577. @itemx C-u @key{TAB}
  578. @emph{Global cycling}: Rotate the entire buffer among the states
  579. @example
  580. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  581. '--------------------------------------'
  582. @end example
  583. When @kbd{S-@key{TAB}} is called with a numerical prefix N, the CONTENTS
  584. view up to headlines of level N will be shown.
  585. Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field.
  586. @cindex show all, command
  587. @kindex C-c C-a
  588. @item C-c C-a
  589. Show all.
  590. @kindex C-c C-r
  591. @item C-c C-r
  592. Reveal context around point, showing the current entry, the following
  593. heading and the hierarchy above. Useful for working near a location
  594. that has been exposed by a sparse tree command (@pxref{Sparse trees}) or
  595. an agenda command (@pxref{Agenda commands}). With prefix arg show, on
  596. each
  597. level, all sibling headings.
  598. @kindex C-c C-x b
  599. @item C-c C-x b
  600. Show the current subtree in an indirect buffer@footnote{The indirect
  601. buffer
  602. @ifinfo
  603. (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
  604. @end ifinfo
  605. @ifnotinfo
  606. (see the Emacs manual for more information about indirect buffers)
  607. @end ifnotinfo
  608. will contain the entire buffer, but will be narrowed to the current
  609. tree. Editing the indirect buffer will also change the original buffer,
  610. but without affecting visibility in that buffer.}. With numerical
  611. prefix ARG, go up to this level and then take that tree. If ARG is
  612. negative, go up that many levels. With @kbd{C-u} prefix, do not remove
  613. the previously used indirect buffer.
  614. @end table
  615. When Emacs first visits an Org-mode file, the global state is set to
  616. OVERVIEW, i.e. only the top level headlines are visible. This can be
  617. configured through the variable @code{org-startup-folded}, or on a
  618. per-file basis by adding one of the following lines anywhere in the
  619. buffer:
  620. @example
  621. #+STARTUP: overview
  622. #+STARTUP: content
  623. #+STARTUP: showall
  624. @end example
  625. @node Motion, Structure editing, Visibility cycling, Document structure
  626. @section Motion
  627. @cindex motion, between headlines
  628. @cindex jumping, to headlines
  629. @cindex headline navigation
  630. The following commands jump to other headlines in the buffer.
  631. @table @kbd
  632. @kindex C-c C-n
  633. @item C-c C-n
  634. Next heading.
  635. @kindex C-c C-p
  636. @item C-c C-p
  637. Previous heading.
  638. @kindex C-c C-f
  639. @item C-c C-f
  640. Next heading same level.
  641. @kindex C-c C-b
  642. @item C-c C-b
  643. Previous heading same level.
  644. @kindex C-c C-u
  645. @item C-c C-u
  646. Backward to higher level heading.
  647. @kindex C-c C-j
  648. @item C-c C-j
  649. Jump to a different place without changing the current outline
  650. visibility. Shows the document structure in a temporary buffer, where
  651. you can use the following keys to find your destination:
  652. @example
  653. @key{TAB} @r{Cycle visibility.}
  654. @key{down} / @key{up} @r{Next/previous visible headline.}
  655. n / p @r{Next/previous visible headline.}
  656. f / b @r{Next/previous headline same level.}
  657. u @r{One level up.}
  658. 0-9 @r{Digit argument.}
  659. @key{RET} @r{Select this location.}
  660. @end example
  661. @end table
  662. @node Structure editing, Archiving, Motion, Document structure
  663. @section Structure editing
  664. @cindex structure editing
  665. @cindex headline, promotion and demotion
  666. @cindex promotion, of subtrees
  667. @cindex demotion, of subtrees
  668. @cindex subtree, cut and paste
  669. @cindex pasting, of subtrees
  670. @cindex cutting, of subtrees
  671. @cindex copying, of subtrees
  672. @cindex subtrees, cut and paste
  673. @table @kbd
  674. @kindex M-@key{RET}
  675. @item M-@key{RET}
  676. Insert new heading with same level as current. If the cursor is in a
  677. plain list item, a new item is created (@pxref{Plain lists}). To force
  678. creation of a new headline, use a prefix arg, or first press @key{RET}
  679. to get to the beginning of the next line. When this command is used in
  680. the middle of a line, the line is split and the rest of the line becomes
  681. the new headline. If the command is used at the beginning of a
  682. headline, the new headline is created before the current line. If at
  683. the beginning of any other line, the content of that line is made the
  684. new heading. If the command is used at the end of a folded subtree
  685. (i.e. behind the ellipses at the end of a headline), then a headline
  686. like the current one will be inserted after the end of the subtree.
  687. @kindex C-@key{RET}
  688. @item C-@key{RET}
  689. Insert a new heading after the current subtree, same level as the
  690. current headline. This command works from anywhere in the entry.
  691. @kindex M-S-@key{RET}
  692. @item M-S-@key{RET}
  693. Insert new TODO entry with same level as current heading.
  694. @kindex M-@key{left}
  695. @item M-@key{left}
  696. Promote current heading by one level.
  697. @kindex M-@key{right}
  698. @item M-@key{right}
  699. Demote current heading by one level.
  700. @kindex M-S-@key{left}
  701. @item M-S-@key{left}
  702. Promote the current subtree by one level.
  703. @kindex M-S-@key{right}
  704. @item M-S-@key{right}
  705. Demote the current subtree by one level.
  706. @kindex M-S-@key{up}
  707. @item M-S-@key{up}
  708. Move subtree up (swap with previous subtree of same
  709. level).
  710. @kindex M-S-@key{down}
  711. @item M-S-@key{down}
  712. Move subtree down (swap with next subtree of same level).
  713. @kindex C-c C-x C-w
  714. @kindex C-c C-x C-k
  715. @item C-c C-x C-w
  716. @itemx C-c C-x C-k
  717. Kill subtree, i.e. remove it from buffer but save in kill ring.
  718. With prefix arg, kill N sequential subtrees.
  719. @kindex C-c C-x M-w
  720. @item C-c C-x M-w
  721. Copy subtree to kill ring. With prefix arg, copy N sequential subtrees.
  722. @kindex C-c C-x C-y
  723. @item C-c C-x C-y
  724. Yank subtree from kill ring. This does modify the level of the subtree to
  725. make sure the tree fits in nicely at the yank position. The yank
  726. level can also be specified with a prefix arg, or by yanking after a
  727. headline marker like @samp{****}.
  728. @kindex C-c C-w
  729. @item C-c C-w
  730. Refile entry to a different location. @xref{Refiling notes}.
  731. @kindex C-c ^
  732. @item C-c ^
  733. Sort same-level entries. When there is an active region, all entries in
  734. the region will be sorted. Otherwise the children of the current
  735. headline are sorted. The command prompts for the sorting method, which
  736. can be alphabetically, numerically, by time (using the first time stamp
  737. in each entry), by priority, and each of these in reverse order. You
  738. can also supply your own function to extract the sorting key. With a
  739. @kbd{C-u} prefix, sorting will be case-sensitive. With two @kbd{C-u
  740. C-u} prefixes, duplicate entries will also be removed.
  741. @end table
  742. @cindex region, active
  743. @cindex active region
  744. @cindex transient-mark-mode
  745. When there is an active region (transient-mark-mode), promotion and
  746. demotion work on all headlines in the region. To select a region of
  747. headlines, it is best to place both point and mark at the beginning of a
  748. line, mark at the beginning of the first headline, and point at the line
  749. just after the last headline to change. Note that when the cursor is
  750. inside a table (@pxref{Tables}), the Meta-Cursor keys have different
  751. functionality.
  752. @node Archiving, Sparse trees, Structure editing, Document structure
  753. @section Archiving
  754. @cindex archiving
  755. When a project represented by a (sub)tree is finished, you may want
  756. to move the tree out of the way and to stop it from contributing to the
  757. agenda. Org-mode knows two ways of archiving. You can mark a tree with
  758. the ARCHIVE tag, or you can move an entire (sub)tree to a different
  759. location.
  760. @menu
  761. * ARCHIVE tag:: Marking a tree as inactive
  762. * Moving subtrees:: Moving a tree to an archive file
  763. @end menu
  764. @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
  765. @subsection The ARCHIVE tag
  766. @cindex internal archiving
  767. A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
  768. its location in the outline tree, but behaves in the following way:
  769. @itemize @minus
  770. @item
  771. It does not open when you attempt to do so with a visibility cycling
  772. command (@pxref{Visibility cycling}). You can force cycling archived
  773. subtrees with @kbd{C-@key{TAB}}, or by setting the option
  774. @code{org-cycle-open-archived-trees}. Also normal outline commands like
  775. @code{show-all} will open archived subtrees.
  776. @item
  777. During sparse tree construction (@pxref{Sparse trees}), matches in
  778. archived subtrees are not exposed, unless you configure the option
  779. @code{org-sparse-tree-open-archived-trees}.
  780. @item
  781. During agenda view construction (@pxref{Agenda views}), the content of
  782. archived trees is ignored unless you configure the option
  783. @code{org-agenda-skip-archived-trees}.
  784. @item
  785. Archived trees are not exported (@pxref{Exporting}), only the headline
  786. is. Configure the details using the variable
  787. @code{org-export-with-archived-trees}.
  788. @end itemize
  789. The following commands help managing the ARCHIVE tag:
  790. @table @kbd
  791. @kindex C-c C-x C-a
  792. @item C-c C-x C-a
  793. Toggle the ARCHIVE tag for the current headline. When the tag is set,
  794. the headline changes to a shadowish face, and the subtree below it is
  795. hidden.
  796. @kindex C-u C-c C-x C-a
  797. @item C-u C-c C-x C-a
  798. Check if any direct children of the current headline should be archived.
  799. To do this, each subtree is checked for open TODO entries. If none are
  800. found, the command offers to set the ARCHIVE tag for the child. If the
  801. cursor is @emph{not} on a headline when this command is invoked, the
  802. level 1 trees will be checked.
  803. @kindex C-@kbd{TAB}
  804. @item C-@kbd{TAB}
  805. Cycle a tree even if it is tagged with ARCHIVE.
  806. @end table
  807. @node Moving subtrees, , ARCHIVE tag, Archiving
  808. @subsection Moving subtrees
  809. @cindex external archiving
  810. Once an entire project is finished, you may want to move it to a
  811. different location, either in the current file, or even in a different
  812. file, the archive file.
  813. @table @kbd
  814. @kindex C-c C-x C-s
  815. @item C-c C-x C-s
  816. Archive the subtree starting at the cursor position to the location
  817. given by @code{org-archive-location}. Context information that could be
  818. lost like the file name, the category, inherited tags, and the todo
  819. state will be store as properties in the entry.
  820. @kindex C-u C-c C-x C-s
  821. @item C-u C-c C-x C-s
  822. Check if any direct children of the current headline could be moved to
  823. the archive. To do this, each subtree is checked for open TODO entries.
  824. If none are found, the command offers to move it to the archive
  825. location. If the cursor is @emph{not} on a headline when this command
  826. is invoked, the level 1 trees will be checked.
  827. @end table
  828. @cindex archive locations
  829. The default archive location is a file in the same directory as the
  830. current file, with the name derived by appending @file{_archive} to the
  831. current file name. For information and examples on how to change this,
  832. see the documentation string of the variable
  833. @code{org-archive-location}. There is also an in-buffer option for
  834. setting this variable, for example@footnote{For backward compatibility,
  835. the following also works: If there are several such lines in a file,
  836. each specifies the archive location for the text below it. The first
  837. such line also applies to any text before its definition. However,
  838. using this method is @emph{strongly} deprecated as it is incompatible
  839. with the outline structure of the document. The correct method for
  840. setting multiple archive locations in a buffer is using a property.}:
  841. @example
  842. #+ARCHIVE: %s_done::
  843. @end example
  844. @noindent
  845. If you would like to have a special ARCHIVE location for a single entry
  846. or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
  847. location as the value (@pxref{Properties and columns}).
  848. @node Sparse trees, Plain lists, Archiving, Document structure
  849. @section Sparse trees
  850. @cindex sparse trees
  851. @cindex trees, sparse
  852. @cindex folding, sparse trees
  853. @cindex occur, command
  854. An important feature of Org-mode is the ability to construct
  855. @emph{sparse trees} for selected information in an outline tree, so that
  856. the entire document is folded as much as possible, but the selected
  857. information is made visible along with the headline structure above
  858. it@footnote{See also the variables @code{org-show-hierarchy-above},
  859. @code{org-show-following-heading}, and @code{org-show-siblings} for
  860. detailed control on how much context is shown around each match.}. Just
  861. try it out and you will see immediately how it works.
  862. Org-mode contains several commands creating such trees, all these
  863. commands can be accessed through a dispatcher:
  864. @table @kbd
  865. @kindex C-c /
  866. @item C-c /
  867. This prompts for an extra key to select a sparse-tree creating command.
  868. @kindex C-c / r
  869. @item C-c / r
  870. Occur. Prompts for a regexp and shows a sparse tree with all matches.
  871. If the match is in a headline, the headline is made visible. If the
  872. match is in the body of an entry, headline and body are made visible.
  873. In order to provide minimal context, also the full hierarchy of
  874. headlines above the match is shown, as well as the headline following
  875. the match. Each match is also highlighted; the highlights disappear
  876. when the buffer is changed by an editing command, or by pressing
  877. @kbd{C-c C-c}. When called with a @kbd{C-u} prefix argument, previous
  878. highlights are kept, so several calls to this command can be stacked.
  879. @end table
  880. @noindent
  881. For frequently used sparse trees of specific search strings, you can
  882. use the variable @code{org-agenda-custom-commands} to define fast
  883. keyboard access to specific sparse trees. These commands will then be
  884. accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
  885. For example:
  886. @lisp
  887. (setq org-agenda-custom-commands
  888. '(("f" occur-tree "FIXME")))
  889. @end lisp
  890. @noindent will define the key @kbd{C-c a f} as a shortcut for creating
  891. a sparse tree matching the string @samp{FIXME}.
  892. The other sparse tree commands select headings based on TODO keywords,
  893. tags, or properties and will be discussed later in this manual.
  894. @kindex C-c C-e v
  895. @cindex printing sparse trees
  896. @cindex visible text, printing
  897. To print a sparse tree, you can use the Emacs command
  898. @code{ps-print-buffer-with-faces} which does not print invisible parts
  899. of the document @footnote{This does not work under XEmacs, because
  900. XEmacs uses selective display for outlining, not text properties.}.
  901. Or you can use the command @kbd{C-c C-e v} to export only the visible
  902. part of the document and print the resulting file.
  903. @node Plain lists, Drawers, Sparse trees, Document structure
  904. @section Plain lists
  905. @cindex plain lists
  906. @cindex lists, plain
  907. @cindex lists, ordered
  908. @cindex ordered lists
  909. Within an entry of the outline tree, hand-formatted lists can provide
  910. additional structure. They also provide a way to create lists of
  911. checkboxes (@pxref{Checkboxes}). Org-mode supports editing such lists,
  912. and the HTML exporter (@pxref{Exporting}) parses and formats them.
  913. Org-mode knows ordered and unordered lists. Unordered list items start
  914. with @samp{-}, @samp{+}, or @samp{*}@footnote{When using @samp{*} as a
  915. bullet, lines must be indented or they will be seen as top-level
  916. headlines. Also, when you are hiding leading stars to get a clean
  917. outline view, plain list items starting with a star are visually
  918. indistinguishable from true headlines. In short: even though @samp{*}
  919. is supported, it may be better to not use it for plain list items.} as
  920. bullets. Ordered list items start with a numeral followed by either a
  921. period or a right parenthesis, such as @samp{1.} or @samp{1)}. Items
  922. belonging to the same list must have the same indentation on the first
  923. line. In particular, if an ordered list reaches number @samp{10.}, then
  924. the 2--digit numbers must be written left-aligned with the other numbers
  925. in the list. Indentation also determines the end of a list item. It
  926. ends before the next line that is indented like the bullet/number, or
  927. less. Empty lines are part of the previous item, so you can have
  928. several paragraphs in one item. If you would like an empty line to
  929. terminate all currently open plain lists, configure the variable
  930. @code{org-empty-line-terminates-plain-lists}. Here is an example:
  931. @example
  932. @group
  933. ** Lord of the Rings
  934. My favorite scenes are (in this order)
  935. 1. The attack of the Rohirrim
  936. 2. Eowyns fight with the witch king
  937. + this was already my favorite scene in the book
  938. + I really like Miranda Otto.
  939. 3. Peter Jackson being shot by Legolas
  940. - on DVD only
  941. He makes a really funny face when it happens.
  942. But in the end, not individual scenes matter but the film as a whole.
  943. @end group
  944. @end example
  945. Org-mode supports these lists by tuning filling and wrapping commands to
  946. deal with them correctly@footnote{Org-mode only changes the filling
  947. settings for Emacs. For XEmacs, you should use Kyle E. Jones'
  948. @file{filladapt.el}. To turn this on, put into @file{.emacs}:
  949. @code{(require 'filladapt)}}.
  950. The following commands act on items when the cursor is in the first line
  951. of an item (the line with the bullet or number).
  952. @table @kbd
  953. @kindex @key{TAB}
  954. @item @key{TAB}
  955. Items can be folded just like headline levels if you set the variable
  956. @code{org-cycle-include-plain-lists}. The level of an item is then
  957. given by the indentation of the bullet/number. Items are always
  958. subordinate to real headlines, however; the hierarchies remain
  959. completely separated.
  960. If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
  961. fixes the indentation of the curent line in a heuristic way.
  962. @kindex M-@key{RET}
  963. @item M-@key{RET}
  964. Insert new item at current level. With prefix arg, force a new heading
  965. (@pxref{Structure editing}). If this command is used in the middle of a
  966. line, the line is @emph{split} and the rest of the line becomes the new
  967. item. If this command is executed in the @emph{whitespace before a bullet or
  968. number}, the new item is created @emph{before} the current item. If the
  969. command is executed in the white space before the text that is part of
  970. an item but does not contain the bullet, a bullet is added to the
  971. current line.
  972. @kindex M-S-@key{RET}
  973. @item M-S-@key{RET}
  974. Insert a new item with a checkbox (@pxref{Checkboxes}).
  975. @kindex S-@key{up}
  976. @kindex S-@key{down}
  977. @item S-@key{up}
  978. @itemx S-@key{down}
  979. Jump to the previous/next item in the current list.
  980. @kindex M-S-@key{up}
  981. @kindex M-S-@key{down}
  982. @item M-S-@key{up}
  983. @itemx M-S-@key{down}
  984. Move the item including subitems up/down (swap with previous/next item
  985. of same indentation). If the list is ordered, renumbering is
  986. automatic.
  987. @kindex M-S-@key{left}
  988. @kindex M-S-@key{right}
  989. @item M-S-@key{left}
  990. @itemx M-S-@key{right}
  991. Decrease/increase the indentation of the item, including subitems.
  992. Initially, the item tree is selected based on current indentation.
  993. When these commands are executed several times in direct succession,
  994. the initially selected region is used, even if the new indentation
  995. would imply a different hierarchy. To use the new hierarchy, break
  996. the command chain with a cursor motion or so.
  997. @kindex C-c C-c
  998. @item C-c C-c
  999. If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
  1000. state of the checkbox. If not, this command makes sure that all the
  1001. items on this list level use the same bullet. Furthermore, if this is
  1002. an ordered list, make sure the numbering is ok.
  1003. @kindex C-c -
  1004. @item C-c -
  1005. Cycle the entire list level through the different itemize/enumerate
  1006. bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}).
  1007. With prefix arg, select the nth bullet from this list.
  1008. @end table
  1009. @node Drawers, orgstruct-mode, Plain lists, Document structure
  1010. @section Drawers
  1011. @cindex drawers
  1012. @cindex visibility cycling, drawers
  1013. Sometimes you want to keep information associated with an entry, but you
  1014. normally don't want to see it. For this, Org-mode has @emph{drawers}.
  1015. Drawers need to be configured with the variable
  1016. @code{org-drawers}@footnote{You can define drawers on a per-file basis
  1017. with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
  1018. look like this:
  1019. @example
  1020. ** This is a headline
  1021. Still outside the drawer
  1022. :DRAWERNAME:
  1023. This is inside the drawer.
  1024. :END:
  1025. After the drawer.
  1026. @end example
  1027. Visibility cycling (@pxref{Visibility cycling}) on the headline will
  1028. hide and show the entry, but keep the drawer collapsed to a single line.
  1029. In order to look inside the drawer, you need to move the cursor to the
  1030. drawer line and press @key{TAB} there. Org-mode uses a drawer for
  1031. storing properties (@pxref{Properties and columns}).
  1032. @node orgstruct-mode, , Drawers, Document structure
  1033. @section The Orgstruct minor mode
  1034. @cindex orgstruct-mode
  1035. @cindex minor mode for structure editing
  1036. If you like the intuitive way the Org-mode structure editing and list
  1037. formatting works, you might want to use these commands in other modes
  1038. like text-mode or mail-mode as well. The minor mode Orgstruct-mode
  1039. makes this possible. You can always toggle the mode with @kbd{M-x
  1040. orgstruct-mode}. To turn it on by default, for example in mail mode,
  1041. use
  1042. @lisp
  1043. (add-hook 'mail-mode-hook 'turn-on-orgstruct)
  1044. @end lisp
  1045. When this mode is active and the cursor is on a line that looks to
  1046. Org-mode like a headline of the first line of a list item, most
  1047. structure editing commands will work, even if the same keys normally
  1048. have different functionality in the major mode you are using. If the
  1049. cursor is not in one of those special lines, Orgstruct-mode lurks
  1050. silently in the shadow.
  1051. @node Tables, Hyperlinks, Document structure, Top
  1052. @chapter Tables
  1053. @cindex tables
  1054. @cindex editing tables
  1055. Org-mode comes with a fast and intuitive table editor. Spreadsheet-like
  1056. calculations are supported in connection with the Emacs @file{calc}
  1057. package
  1058. @ifinfo
  1059. (@pxref{Calc,,,calc,Gnu Emacs Calculator Manual}).
  1060. @end ifinfo
  1061. @ifnotinfo
  1062. (see the Emacs Calculator manual for more information about the Emacs
  1063. calculator).
  1064. @end ifnotinfo
  1065. @menu
  1066. * Built-in table editor:: Simple tables
  1067. * Narrow columns:: Stop wasting space in tables
  1068. * Column groups:: Grouping to trigger vertical lines
  1069. * orgtbl-mode:: The table editor as minor mode
  1070. * The spreadsheet:: The table editor has spreadsheet capabilities.
  1071. @end menu
  1072. @node Built-in table editor, Narrow columns, Tables, Tables
  1073. @section The built-in table editor
  1074. @cindex table editor, built-in
  1075. Org-mode makes it easy to format tables in plain ASCII. Any line with
  1076. @samp{|} as the first non-whitespace character is considered part of a
  1077. table. @samp{|} is also the column separator. A table might look like
  1078. this:
  1079. @example
  1080. | Name | Phone | Age |
  1081. |-------+-------+-----|
  1082. | Peter | 1234 | 17 |
  1083. | Anna | 4321 | 25 |
  1084. @end example
  1085. A table is re-aligned automatically each time you press @key{TAB} or
  1086. @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
  1087. the next field (@key{RET} to the next row) and creates new table rows
  1088. at the end of the table or before horizontal lines. The indentation
  1089. of the table is set by the first line. Any line starting with
  1090. @samp{|-} is considered as a horizontal separator line and will be
  1091. expanded on the next re-align to span the whole table width. So, to
  1092. create the above table, you would only type
  1093. @example
  1094. |Name|Phone|Age|
  1095. |-
  1096. @end example
  1097. @noindent and then press @key{TAB} to align the table and start filling in
  1098. fields.
  1099. When typing text into a field, Org-mode treats @key{DEL},
  1100. @key{Backspace}, and all character keys in a special way, so that
  1101. inserting and deleting avoids shifting other fields. Also, when
  1102. typing @emph{immediately after the cursor was moved into a new field
  1103. with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
  1104. field is automatically made blank. If this behavior is too
  1105. unpredictable for you, configure the variables
  1106. @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
  1107. @table @kbd
  1108. @tsubheading{Creation and conversion}
  1109. @kindex C-c |
  1110. @item C-c |
  1111. Convert the active region to table. If every line contains at least one
  1112. TAB character, the function assumes that the material is tab separated.
  1113. If every line contains a comma, comma-separated values (CSV) are assumed.
  1114. If not, lines are split at whitespace into fields. You can use a prefix
  1115. argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
  1116. C-u} forces TAB, and a numeric argument N indicates that at least N
  1117. consequtive spaces, or alternatively a TAB will be the separator.
  1118. @*
  1119. If there is no active region, this command creates an empty Org-mode
  1120. table. But it's easier just to start typing, like
  1121. @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
  1122. @tsubheading{Re-aligning and field motion}
  1123. @kindex C-c C-c
  1124. @item C-c C-c
  1125. Re-align the table without moving the cursor.
  1126. @c
  1127. @kindex @key{TAB}
  1128. @item @key{TAB}
  1129. Re-align the table, move to the next field. Creates a new row if
  1130. necessary.
  1131. @c
  1132. @kindex S-@key{TAB}
  1133. @item S-@key{TAB}
  1134. Re-align, move to previous field.
  1135. @c
  1136. @kindex @key{RET}
  1137. @item @key{RET}
  1138. Re-align the table and move down to next row. Creates a new row if
  1139. necessary. At the beginning or end of a line, @key{RET} still does
  1140. NEWLINE, so it can be used to split a table.
  1141. @tsubheading{Column and row editing}
  1142. @kindex M-@key{left}
  1143. @kindex M-@key{right}
  1144. @item M-@key{left}
  1145. @itemx M-@key{right}
  1146. Move the current column left/right.
  1147. @c
  1148. @kindex M-S-@key{left}
  1149. @item M-S-@key{left}
  1150. Kill the current column.
  1151. @c
  1152. @kindex M-S-@key{right}
  1153. @item M-S-@key{right}
  1154. Insert a new column to the left of the cursor position.
  1155. @c
  1156. @kindex M-@key{up}
  1157. @kindex M-@key{down}
  1158. @item M-@key{up}
  1159. @itemx M-@key{down}
  1160. Move the current row up/down.
  1161. @c
  1162. @kindex M-S-@key{up}
  1163. @item M-S-@key{up}
  1164. Kill the current row or horizontal line.
  1165. @c
  1166. @kindex M-S-@key{down}
  1167. @item M-S-@key{down}
  1168. Insert a new row above (with arg: below) the current row.
  1169. @c
  1170. @kindex C-c -
  1171. @item C-c -
  1172. Insert a horizontal line below current row. With prefix arg, the line
  1173. is created above the current line.
  1174. @c
  1175. @kindex C-c ^
  1176. @item C-c ^
  1177. Sort the table lines in the region. The position of point indicates the
  1178. column to be used for sorting, and the range of lines is the range
  1179. between the nearest horizontal separator lines, or the entire table. If
  1180. point is before the first column, you will be prompted for the sorting
  1181. column. If there is an active region, the mark specifies the first line
  1182. and the sorting column, while point should be in the last line to be
  1183. included into the sorting. The command prompts for the sorting type
  1184. (alphabetically, numerically, or by time). When called with a prefix
  1185. argument, alphabetic sorting will be case-sensitive.
  1186. @tsubheading{Regions}
  1187. @kindex C-c C-x M-w
  1188. @item C-c C-x M-w
  1189. Copy a rectangular region from a table to a special clipboard. Point
  1190. and mark determine edge fields of the rectangle. The process ignores
  1191. horizontal separator lines.
  1192. @c
  1193. @kindex C-c C-x C-w
  1194. @item C-c C-x C-w
  1195. Copy a rectangular region from a table to a special clipboard, and
  1196. blank all fields in the rectangle. So this is the ``cut'' operation.
  1197. @c
  1198. @kindex C-c C-x C-y
  1199. @item C-c C-x C-y
  1200. Paste a rectangular region into a table.
  1201. The upper right corner ends up in the current field. All involved fields
  1202. will be overwritten. If the rectangle does not fit into the present table,
  1203. the table is enlarged as needed. The process ignores horizontal separator
  1204. lines.
  1205. @c
  1206. @kindex C-c C-q
  1207. @item C-c C-q
  1208. Wrap several fields in a column like a paragraph. If there is an active
  1209. region, and both point and mark are in the same column, the text in the
  1210. column is wrapped to minimum width for the given number of lines. A
  1211. prefix ARG may be used to change the number of desired lines. If there
  1212. is no region, the current field is split at the cursor position and the
  1213. text fragment to the right of the cursor is prepended to the field one
  1214. line down. If there is no region, but you specify a prefix ARG, the
  1215. current field is made blank, and the content is appended to the field
  1216. above.
  1217. @tsubheading{Calculations}
  1218. @cindex formula, in tables
  1219. @cindex calculations, in tables
  1220. @cindex region, active
  1221. @cindex active region
  1222. @cindex transient-mark-mode
  1223. @kindex C-c +
  1224. @item C-c +
  1225. Sum the numbers in the current column, or in the rectangle defined by
  1226. the active region. The result is shown in the echo area and can
  1227. be inserted with @kbd{C-y}.
  1228. @c
  1229. @kindex S-@key{RET}
  1230. @item S-@key{RET}
  1231. When current field is empty, copy from first non-empty field above.
  1232. When not empty, copy current field down to next row and move cursor
  1233. along with it. Depending on the variable
  1234. @code{org-table-copy-increment}, integer field values will be
  1235. incremented during copy. This key is also used by CUA-mode
  1236. (@pxref{Cooperation}).
  1237. @tsubheading{Miscellaneous}
  1238. @kindex C-c `
  1239. @item C-c `
  1240. Edit the current field in a separate window. This is useful for fields
  1241. that are not fully visible (@pxref{Narrow columns}). When called with a
  1242. @kbd{C-u} prefix, just make the full field visible, so that it can be
  1243. edited in place.
  1244. @c
  1245. @item M-x org-table-import
  1246. Import a file as a table. The table should be TAB- or whitespace
  1247. separated. Useful, for example, to import a spreadsheet table or data
  1248. from a database, because these programs generally can write
  1249. TAB-separated text files. This command works by inserting the file into
  1250. the buffer and then converting the region to a table. Any prefix
  1251. argument is passed on to the converter, which uses it to determine the
  1252. separator.
  1253. @item C-c |
  1254. Tables can also be imported by pasting tabular text into the org-mode
  1255. buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
  1256. @kbd{C-c |} command (see above under @i{Creation and conversion}.
  1257. @c
  1258. @item M-x org-table-export
  1259. Export the table as a TAB-separated file. Useful for data exchange with,
  1260. for example, spreadsheet or database programs.
  1261. @end table
  1262. If you don't like the automatic table editor because it gets in your
  1263. way on lines which you would like to start with @samp{|}, you can turn
  1264. it off with
  1265. @lisp
  1266. (setq org-enable-table-editor nil)
  1267. @end lisp
  1268. @noindent Then the only table command that still works is
  1269. @kbd{C-c C-c} to do a manual re-align.
  1270. @node Narrow columns, Column groups, Built-in table editor, Tables
  1271. @section Narrow columns
  1272. @cindex narrow columns in tables
  1273. The width of columns is automatically determined by the table editor.
  1274. Sometimes a single field or a few fields need to carry more text,
  1275. leading to inconveniently wide columns. To limit@footnote{This feature
  1276. does not work on XEmacs.} the width of a column, one field anywhere in
  1277. the column may contain just the string @samp{<N>} where @samp{N} is an
  1278. integer specifying the width of the column in characters. The next
  1279. re-align will then set the width of this column to no more than this
  1280. value.
  1281. @example
  1282. @group
  1283. |---+------------------------------| |---+--------|
  1284. | | | | | <6> |
  1285. | 1 | one | | 1 | one |
  1286. | 2 | two | ----\ | 2 | two |
  1287. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  1288. | 4 | four | | 4 | four |
  1289. |---+------------------------------| |---+--------|
  1290. @end group
  1291. @end example
  1292. @noindent
  1293. Fields that are wider become clipped and end in the string @samp{=>}.
  1294. Note that the full text is still in the buffer, it is only invisible.
  1295. To see the full text, hold the mouse over the field - a tool-tip window
  1296. will show the full content. To edit such a field, use the command
  1297. @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
  1298. open a new window with the full field. Edit it and finish with @kbd{C-c
  1299. C-c}.
  1300. When visiting a file containing a table with narrowed columns, the
  1301. necessary character hiding has not yet happened, and the table needs to
  1302. be aligned before it looks nice. Setting the option
  1303. @code{org-startup-align-all-tables} will realign all tables in a file
  1304. upon visiting, but also slow down startup. You can also set this option
  1305. on a per-file basis with:
  1306. @example
  1307. #+STARTUP: align
  1308. #+STARTUP: noalign
  1309. @end example
  1310. @node Column groups, orgtbl-mode, Narrow columns, Tables
  1311. @section Column groups
  1312. @cindex grouping columns in tables
  1313. When Org-mode exports tables, it does so by default without vertical
  1314. lines because that is visually more satisfying in general. Occasionally
  1315. however, vertical lines can be useful to structure a table into groups
  1316. of columns, much like horizontal lines can do for groups of rows. In
  1317. order to specify column groups, you can use a special row where the
  1318. first field contains only @samp{/}. The further fields can either
  1319. contain @samp{<} to indicate that this column should start a group,
  1320. @samp{>} to indicate the end of a column, or @samp{<>} to make a column
  1321. a group of its own. Boundaries between colum groups will upon export be
  1322. marked with vertical lines. Here is an example:
  1323. @example
  1324. | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1325. |---+----+-----+-----+-----+---------+------------|
  1326. | / | <> | < | | > | < | > |
  1327. | # | 1 | 1 | 1 | 1 | 1 | 1 |
  1328. | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
  1329. | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
  1330. |---+----+-----+-----+-----+---------+------------|
  1331. #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))
  1332. @end example
  1333. It is also sufficient to just insert the colum group starters after
  1334. every vertical line you'd like to have:
  1335. @example
  1336. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1337. |----+-----+-----+-----+---------+------------|
  1338. | / | < | | | < | |
  1339. @end example
  1340. @node orgtbl-mode, The spreadsheet, Column groups, Tables
  1341. @section The Orgtbl minor mode
  1342. @cindex orgtbl-mode
  1343. @cindex minor mode for tables
  1344. If you like the intuitive way the Org-mode table editor works, you
  1345. might also want to use it in other modes like text-mode or mail-mode.
  1346. The minor mode Orgtbl-mode makes this possible. You can always toggle
  1347. the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
  1348. example in mail mode, use
  1349. @lisp
  1350. (add-hook 'mail-mode-hook 'turn-on-orgtbl)
  1351. @end lisp
  1352. Furthermore, with some special setup, it is possible to maintain tables
  1353. in arbitrary syntax with Orgtbl-mode. For example, it is possible to
  1354. construct La@TeX{} tables with the underlying ease and power of
  1355. Orgtbl-mode, including spreadsheet capabilities. For details, see
  1356. @ref{Tables in arbitrary syntax}.
  1357. @node The spreadsheet, , orgtbl-mode, Tables
  1358. @section The spreadsheet
  1359. @cindex calculations, in tables
  1360. @cindex spreadsheet capabilities
  1361. @cindex @file{calc} package
  1362. The table editor makes use of the Emacs @file{calc} package to implement
  1363. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  1364. derive fields from other fields. While fully featured, Org-mode's
  1365. implementation is not identical to other spreadsheets. For example,
  1366. Org-mode knows the concept of a @emph{column formula} that will be
  1367. applied to all non-header fields in a column without having to copy the
  1368. formula to each relevant field.
  1369. @menu
  1370. * References:: How to refer to another field or range
  1371. * Formula syntax for Calc:: Using Calc to compute stuff
  1372. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  1373. * Field formulas:: Formulas valid for a single field
  1374. * Column formulas:: Formulas valid for an entire column
  1375. * Editing and debugging formulas:: Fixing formulas
  1376. * Updating the table:: Recomputing all dependent fields
  1377. * Advanced features:: Field names, parameters and automatic recalc
  1378. @end menu
  1379. @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
  1380. @subsection References
  1381. @cindex references
  1382. To compute fields in the table from other fields, formulas must
  1383. reference other fields or ranges. In Org-mode, fields can be referenced
  1384. by name, by absolute coordinates, and by relative coordinates. To find
  1385. out what the coordinates of a field are, press @kbd{C-c ?} in that
  1386. field, or press @kbd{C-c @}} to toggle the display of a grid.
  1387. @subsubheading Field references
  1388. @cindex field references
  1389. @cindex references, to fields
  1390. Formulas can reference the value of another field in two ways. Like in
  1391. any other spreadsheet, you may reference fields with a letter/number
  1392. combination like @code{B3}, meaning the 2nd field in the 3rd row.
  1393. @c Such references are always fixed to that field, they don't change
  1394. @c when you copy and paste a formula to a different field. So
  1395. @c Org-mode's @code{B3} behaves like @code{$B$3} in other spreadsheets.
  1396. @noindent
  1397. Org-mode also uses another, more general operator that looks like this:
  1398. @example
  1399. @@row$column
  1400. @end example
  1401. @noindent
  1402. Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
  1403. or relative to the current column like @samp{+1} or @samp{-2}.
  1404. The row specification only counts data lines and ignores horizontal
  1405. separator lines (hlines). You can use absolute row numbers
  1406. @samp{1}...@samp{N}, and row numbers relative to the current row like
  1407. @samp{+3} or @samp{-1}. Or specify the row relative to one of the
  1408. hlines: @samp{I} refers to the first hline@footnote{Note that only
  1409. hlines are counted that @emph{separate} table lines. If the table
  1410. starts with a hline above the header, it does not count.}, @samp{II} to
  1411. the second etc. @samp{-I} refers to the first such line above the
  1412. current line, @samp{+I} to the first such line below the current line.
  1413. You can also write @samp{III+2} which is the second data line after the
  1414. third hline in the table. Relative row numbers like @samp{-3} will not
  1415. cross hlines if the current line is too close to the hline. Instead,
  1416. the value directly at the hline is used.
  1417. @samp{0} refers to the current row and column. Also, if you omit
  1418. either the column or the row part of the reference, the current
  1419. row/column is implied.
  1420. Org-mode's references with @emph{unsigned} numbers are fixed references
  1421. in the sense that if you use the same reference in the formula for two
  1422. different fields, the same field will be referenced each time.
  1423. Org-mode's references with @emph{signed} numbers are floating
  1424. references because the same reference operator can reference different
  1425. fields depending on the field being calculated by the formula.
  1426. Here are a few examples:
  1427. @example
  1428. @@2$3 @r{2nd row, 3rd column}
  1429. C2 @r{same as previous}
  1430. $5 @r{column 5 in the current row}
  1431. E& @r{same as previous}
  1432. @@2 @r{current column, row 2}
  1433. @@-1$-3 @r{the field one row up, three columns to the left}
  1434. @@-I$2 @r{field just under hline above current row, column 2}
  1435. @end example
  1436. @subsubheading Range references
  1437. @cindex range references
  1438. @cindex references, to ranges
  1439. You may reference a rectangular range of fields by specifying two field
  1440. references connected by two dots @samp{..}. If both fields are in the
  1441. current row, you may simply use @samp{$2..$7}, but if at least one field
  1442. is in a different row, you need to use the general @code{@@row$column}
  1443. format at least for the first field (i.e the reference must start with
  1444. @samp{@@} in order to be interpreted correctly). Examples:
  1445. @example
  1446. $1..$3 @r{First three fields in the current row.}
  1447. $P..$Q @r{Range, using column names (see under Advanced)}
  1448. @@2$1..@@4$3 @r{6 fields between these two fields.}
  1449. A2..C4 @r{Same as above.}
  1450. @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
  1451. @end example
  1452. @noindent Range references return a vector of values that can be fed
  1453. into Calc vector functions. Empty fields in ranges are normally
  1454. suppressed, so that the vector contains only the non-empty fields (but
  1455. see the @samp{E} mode switch below). If there are no non-empty fields,
  1456. @samp{[0]} is returned to avoid syntax errors in formulas.
  1457. @subsubheading Named references
  1458. @cindex named references
  1459. @cindex references, named
  1460. @cindex name, of column or field
  1461. @cindex constants, in calculations
  1462. @samp{$name} is interpreted as the name of a column, parameter or
  1463. constant. Constants are defined globally through the variable
  1464. @code{org-table-formula-constants}, and locally (for the file) through a
  1465. line like
  1466. @example
  1467. #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
  1468. @end example
  1469. @noindent
  1470. Also properties (@pxref{Properties and columns}) can be used as
  1471. constants in table formulas: For a property @samp{:Xyz:} use the name
  1472. @samp{$PROP_Xyz}, and the property will be searched in the current
  1473. outline entry and in the hierarchy above it. If you have the
  1474. @file{constants.el} package, it will also be used to resolve constants,
  1475. including natural constants like @samp{$h} for Planck's constant, and
  1476. units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
  1477. supply the values of constants in two different unit systems, @code{SI}
  1478. and @code{cgs}. Which one is used depends on the value of the variable
  1479. @code{constants-unit-system}. You can use the @code{#+STARTUP} options
  1480. @code{constSI} and @code{constcgs} to set this value for the current
  1481. buffer.}. Column names and parameters can be specified in special table
  1482. lines. These are described below, see @ref{Advanced features}. All
  1483. names must start with a letter, and further consist of letters and
  1484. numbers.
  1485. @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
  1486. @subsection Formula syntax for Calc
  1487. @cindex formula syntax, Calc
  1488. @cindex syntax, of formulas
  1489. A formula can be any algebraic expression understood by the Emacs
  1490. @file{Calc} package. @b{Note that @file{calc} has the
  1491. non-standard convention that @samp{/} has lower precedence than
  1492. @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
  1493. evaluation by @code{calc-eval} (@pxref{Calling Calc from
  1494. Your Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU
  1495. Emacs Calc Manual}),
  1496. @c FIXME: The link to the calc manual in HTML does not work.
  1497. variable substitution takes place according to the rules described above.
  1498. @cindex vectors, in table calculations
  1499. The range vectors can be directly fed into the calc vector functions
  1500. like @samp{vmean} and @samp{vsum}.
  1501. @cindex format specifier
  1502. @cindex mode, for @file{calc}
  1503. A formula can contain an optional mode string after a semicolon. This
  1504. string consists of flags to influence Calc and other modes during
  1505. execution. By default, Org-mode uses the standard calc modes (precision
  1506. 12, angular units degrees, fraction and symbolic modes off. The display
  1507. format, however, has been changed to @code{(float 5)} to keep tables
  1508. compact. The default settings can be configured using the variable
  1509. @code{org-calc-default-modes}.
  1510. @example
  1511. p20 @r{switch the internal precision to 20 digits}
  1512. n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
  1513. D R @r{angle modes: degrees, radians}
  1514. F S @r{fraction and symbolic modes}
  1515. N @r{interpret all fields as numbers, use 0 for non-numbers}
  1516. T @r{force text interpretation}
  1517. E @r{keep empty fields in ranges}
  1518. @end example
  1519. @noindent
  1520. In addition, you may provide a @code{printf} format specifier to
  1521. reformat the final result. A few examples:
  1522. @example
  1523. $1+$2 @r{Sum of first and second field}
  1524. $1+$2;%.2f @r{Same, format result to two decimals}
  1525. exp($2)+exp($1) @r{Math functions can be used}
  1526. $0;%.1f @r{Reformat current cell to 1 decimal}
  1527. ($3-32)*5/9 @r{Degrees F -> C conversion}
  1528. $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
  1529. tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
  1530. sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
  1531. vmean($2..$7) @r{Compute column range mean, using vector function}
  1532. vmean($2..$7);EN @r{Same, but treat empty fields as 0}
  1533. taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
  1534. @end example
  1535. Calc also contains a complete set of logical operations. For example
  1536. @example
  1537. if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
  1538. @end example
  1539. @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
  1540. @subsection Emacs Lisp forms as formulas
  1541. @cindex Lisp forms, as table formulas
  1542. It is also possible to write a formula in Emacs Lisp; this can be useful
  1543. for string manipulation and control structures, if the Calc's
  1544. functionality is not enough. If a formula starts with a single quote
  1545. followed by an opening parenthesis, then it is evaluated as a lisp form.
  1546. The evaluation should return either a string or a number. Just as with
  1547. @file{calc} formulas, you can specify modes and a printf format after a
  1548. semicolon. With Emacs Lisp forms, you need to be concious about the way
  1549. field references are interpolated into the form. By default, a
  1550. reference will be interpolated as a Lisp string (in double quotes)
  1551. containing the field. If you provide the @samp{N} mode switch, all
  1552. referenced elements will be numbers (non-number fields will be zero) and
  1553. interpolated as Lisp numbers, without quotes. If you provide the
  1554. @samp{L} flag, all fields will be interpolated literally, without quotes.
  1555. I.e., if you want a reference to be interpreted as a string by the Lisp
  1556. form, enclode the reference operator itself in double quotes, like
  1557. @code{"$3"}. Ranges are inserted as space-separated fields, so you can
  1558. embed them in list or vector syntax. A few examples, note how the
  1559. @samp{N} mode is used when we do computations in lisp.
  1560. @example
  1561. @r{Swap the first two characters of the content of column 1}
  1562. '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
  1563. @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}}
  1564. '(+ $1 $2);N
  1565. @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
  1566. '(apply '+ '($1..$4));N
  1567. @end example
  1568. @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
  1569. @subsection Field formulas
  1570. @cindex field formula
  1571. @cindex formula, for individual table field
  1572. To assign a formula to a particular field, type it directly into the
  1573. field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
  1574. press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
  1575. the field, the formula will be stored as the formula for this field,
  1576. evaluated, and the current field replaced with the result.
  1577. Formulas are stored in a special line starting with @samp{#+TBLFM:}
  1578. directly below the table. If you typed the equation in the 4th field of
  1579. the 3rd data line in the table, the formula will look like
  1580. @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
  1581. with the appropriate commands, @i{absolute references} (but not relative
  1582. ones) in stored formulas are modified in order to still reference the
  1583. same field. Of cause this is not true if you edit the table structure
  1584. with normal editing commands - then you must fix the equations yourself.
  1585. Instead of typing an equation into the field, you may also use the
  1586. following command
  1587. @table @kbd
  1588. @kindex C-u C-c =
  1589. @item C-u C-c =
  1590. Install a new formula for the current field. The command prompts for a
  1591. formula, with default taken from the @samp{#+TBLFM:} line, applies
  1592. it to the current field and stores it.
  1593. @end table
  1594. @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
  1595. @subsection Column formulas
  1596. @cindex column formula
  1597. @cindex formula, for table column
  1598. Often in a table, the same formula should be used for all fields in a
  1599. particular column. Instead of having to copy the formula to all fields
  1600. in that column, org-mode allows to assign a single formula to an entire
  1601. column. If the table contains horizontal separator hlines, everything
  1602. before the first such line is considered part of the table @emph{header}
  1603. and will not be modified by column formulas.
  1604. To assign a formula to a column, type it directly into any field in the
  1605. column, preceded by an equal sign, like @samp{=$1+$2}. When you press
  1606. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the
  1607. field, the formula will be stored as the formula for the current column,
  1608. evaluated and the current field replaced with the result. If the field
  1609. contains only @samp{=}, the previously stored formula for this column is
  1610. used. For each column, Org-mode will only remember the most recently
  1611. used formula. In the @samp{TBLFM:} line, column formulas will look like
  1612. @samp{$4=$1+$2}.
  1613. Instead of typing an equation into the field, you may also use the
  1614. following command:
  1615. @table @kbd
  1616. @kindex C-c =
  1617. @item C-c =
  1618. Install a new formula for the current column and replace current field
  1619. with the result of the formula. The command prompts for a formula, with
  1620. default taken from the @samp{#+TBLFM} line, applies it to the current
  1621. field and stores it. With a numerical prefix (e.g. @kbd{C-5 C-c =})
  1622. will apply it to that many consecutive fields in the current column.
  1623. @end table
  1624. @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
  1625. @subsection Editing and Debugging formulas
  1626. @cindex formula editing
  1627. @cindex editing, of table formulas
  1628. You can edit individual formulas in the minibuffer or directly in the
  1629. field. Org-mode can also prepare a special buffer with all active
  1630. formulas of a table. When offering a formula for editing, Org-mode
  1631. converts references to the standard format (like @code{B3} or @code{D&})
  1632. if possible. If you prefer to only work with the internal format (like
  1633. @code{@@3$2} or @code{$4}), configure the variable
  1634. @code{org-table-use-standard-references}.
  1635. @table @kbd
  1636. @kindex C-c =
  1637. @kindex C-u C-c =
  1638. @item C-c =
  1639. @itemx C-u C-c =
  1640. Edit the formula associated with the current column/field in the
  1641. minibuffer. See @ref{Column formulas} and @ref{Field formulas}.
  1642. @kindex C-u C-u C-c =
  1643. @item C-u C-u C-c =
  1644. Re-insert the active formula (either a
  1645. field formula, or a column formula) into the current field, so that you
  1646. can edit it directly in the field. The advantage over editing in the
  1647. minibuffer is that you can use the command @kbd{C-c ?}.
  1648. @kindex C-c ?
  1649. @item C-c ?
  1650. While editing a formula in a table field, highlight the field(s)
  1651. referenced by the reference at the cursor position in the formula.
  1652. @kindex C-c @}
  1653. @item C-c @}
  1654. Toggle the display of row and column numbers for a table, using
  1655. overlays. These are updated each time the table is aligned, you can
  1656. force it with @kbd{C-c C-c}.
  1657. @kindex C-c @{
  1658. @item C-c @{
  1659. Toggle the formula debugger on and off. See below.
  1660. @kindex C-c '
  1661. @item C-c '
  1662. Edit all formulas for the current table in a special buffer, where the
  1663. formulas will be displayed one per line. If the current field has an
  1664. active formula, the cursor in the formula editor will mark it.
  1665. While inside the special buffer, Org-mode will automatically highlight
  1666. any field or range reference at the cursor position. You may edit,
  1667. remove and add formulas, and use the following commands:
  1668. @table @kbd
  1669. @kindex C-c C-c
  1670. @kindex C-x C-s
  1671. @item C-c C-c
  1672. @itemx C-x C-s
  1673. Exit the formula editor and store the modified formulas. With @kbd{C-u}
  1674. prefix, also apply the new formulas to the entire table.
  1675. @kindex C-c C-q
  1676. @item C-c C-q
  1677. Exit the formula editor without installing changes.
  1678. @kindex C-c C-r
  1679. @item C-c C-r
  1680. Toggle all references in the formula editor between standard (like
  1681. @code{B3}) and internal (like @code{@@3$2}).
  1682. @kindex @key{TAB}
  1683. @item @key{TAB}
  1684. Pretty-print or indent lisp formula at point. When in a line containing
  1685. a lisp formula, format the formula according to Emacs Lisp rules.
  1686. Another @key{TAB} collapses the formula back again. In the open
  1687. formula, @key{TAB} re-indents just like in Emacs-lisp-mode.
  1688. @kindex M-@key{TAB}
  1689. @item M-@key{TAB}
  1690. Complete Lisp symbols, just like in Emacs-lisp-mode.
  1691. @kindex S-@key{up}
  1692. @kindex S-@key{down}
  1693. @kindex S-@key{left}
  1694. @kindex S-@key{right}
  1695. @item S-@key{up}/@key{down}/@key{left}/@key{right}
  1696. Shift the reference at point. For example, if the reference is
  1697. @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
  1698. This also works for relative references, and for hline references.
  1699. @kindex M-S-@key{up}
  1700. @kindex M-S-@key{down}
  1701. @item M-S-@key{up}/@key{down}
  1702. Move the test line for column formulas in the Org-mode buffer up and
  1703. down.
  1704. @kindex M-@key{up}
  1705. @kindex M-@key{down}
  1706. @item M-@key{up}/@key{down}
  1707. Scroll the window displaying the table.
  1708. @kindex C-c @}
  1709. @item C-c @}
  1710. Turn the coordinate grid in the table on and off.
  1711. @end table
  1712. @end table
  1713. Making a table field blank does not remove the formula associated with
  1714. the field, because that is stored in a different line (the @samp{TBLFM}
  1715. line) - during the next recalculation the field will be filled again.
  1716. To remove a formula from a field, you have to give an empty reply when
  1717. prompted for the formula, or to edit the @samp{#+TBLFM} line.
  1718. @kindex C-c C-c
  1719. You may edit the @samp{#+TBLFM} directly and re-apply the changed
  1720. equations with @kbd{C-c C-c} in that line, or with the normal
  1721. recalculation commands in the table.
  1722. @subsubheading Debugging formulas
  1723. @cindex formula debugging
  1724. @cindex debugging, of table formulas
  1725. When the evaluation of a formula leads to an error, the field content
  1726. becomes the string @samp{#ERROR}. If you would like see what is going
  1727. on during variable substitution and calculation in order to find a bug,
  1728. turn on formula debugging in the @code{Tbl} menu and repeat the
  1729. calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
  1730. field. Detailed information will be displayed.
  1731. @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
  1732. @subsection Updating the Table
  1733. @cindex recomputing table fields
  1734. @cindex updating, table
  1735. Recalculation of a table is normally not automatic, but needs to be
  1736. triggered by a command. See @ref{Advanced features} for a way to make
  1737. recalculation at least semi-automatically.
  1738. In order to recalculate a line of a table or the entire table, use the
  1739. following commands:
  1740. @table @kbd
  1741. @kindex C-c *
  1742. @item C-c *
  1743. Recalculate the current row by first applying the stored column formulas
  1744. from left to right, and all field formulas in the current row.
  1745. @c
  1746. @kindex C-u C-c *
  1747. @item C-u C-c *
  1748. @kindex C-u C-c C-c
  1749. @itemx C-u C-c C-c
  1750. Recompute the entire table, line by line. Any lines before the first
  1751. hline are left alone, assuming that these are part of the table header.
  1752. @c
  1753. @kindex C-u C-u C-c *
  1754. @kindex C-u C-u C-c C-c
  1755. @item C-u C-u C-c *
  1756. @itemx C-u C-u C-c C-c
  1757. Iterate the table by recomputing it until no further changes occur.
  1758. This may be necessary if some computed fields use the value of other
  1759. fields that are computed @i{later} in the calculation sequence.
  1760. @end table
  1761. @node Advanced features, , Updating the table, The spreadsheet
  1762. @subsection Advanced features
  1763. If you want the recalculation of fields to happen automatically, or if
  1764. you want to be able to assign @i{names} to fields and columns, you need
  1765. to reserve the first column of the table for special marking characters.
  1766. @table @kbd
  1767. @kindex C-#
  1768. @item C-#
  1769. Rotate the calculation mark in first column through the states @samp{},
  1770. @samp{#}, @samp{*}, @samp{!}, @samp{$}. The meaning of these characters
  1771. is discussed below. When there is an active region, change all marks in
  1772. the region.
  1773. @end table
  1774. Here is an example of a table that collects exam results of students and
  1775. makes use of these features:
  1776. @example
  1777. @group
  1778. |---+---------+--------+--------+--------+-------+------|
  1779. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  1780. |---+---------+--------+--------+--------+-------+------|
  1781. | ! | | P1 | P2 | P3 | Tot | |
  1782. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  1783. | ^ | | m1 | m2 | m3 | mt | |
  1784. |---+---------+--------+--------+--------+-------+------|
  1785. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  1786. | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
  1787. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  1788. |---+---------+--------+--------+--------+-------+------|
  1789. | | Average | | | | 29.7 | |
  1790. | ^ | | | | | at | |
  1791. | $ | max=50 | | | | | |
  1792. |---+---------+--------+--------+--------+-------+------|
  1793. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
  1794. @end group
  1795. @end example
  1796. @noindent @b{Important}: Please note that for these special tables,
  1797. recalculating the table with @kbd{C-u C-c *} will only affect rows that
  1798. are marked @samp{#} or @samp{*}, and fields that have a formula assigned
  1799. to the field itself. The column formulas are not applied in rows with
  1800. empty first field.
  1801. @cindex marking characters, tables
  1802. The marking characters have the following meaning:
  1803. @table @samp
  1804. @item !
  1805. The fields in this line define names for the columns, so that you may
  1806. refer to a column as @samp{$Tot} instead of @samp{$6}.
  1807. @item ^
  1808. This row defines names for the fields @emph{above} the row. With such
  1809. a definition, any formula in the table may use @samp{$m1} to refer to
  1810. the value @samp{10}. Also, if you assign a formula to a names field, it
  1811. will be stored as @samp{$name=...}.
  1812. @item _
  1813. Similar to @samp{^}, but defines names for the fields in the row
  1814. @emph{below}.
  1815. @item $
  1816. Fields in this row can define @emph{parameters} for formulas. For
  1817. example, if a field in a @samp{$} row contains @samp{max=50}, then
  1818. formulas in this table can refer to the value 50 using @samp{$max}.
  1819. Parameters work exactly like constants, only that they can be defined on
  1820. a per-table basis.
  1821. @item #
  1822. Fields in this row are automatically recalculated when pressing
  1823. @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
  1824. is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
  1825. lines will be left alone by this command.
  1826. @item *
  1827. Selects this line for global recalculation with @kbd{C-u C-c *}, but
  1828. not for automatic recalculation. Use this when automatic
  1829. recalculation slows down editing too much.
  1830. @item
  1831. Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
  1832. All lines that should be recalculated should be marked with @samp{#}
  1833. or @samp{*}.
  1834. @item /
  1835. Do not export this line. Useful for lines that contain the narrowing
  1836. @samp{<N>} markers.
  1837. @end table
  1838. Finally, just to whet your appetite on what can be done with the
  1839. fantastic @file{calc} package, here is a table that computes the Taylor
  1840. series of degree @code{n} at location @code{x} for a couple of functions
  1841. (homework: try that with Excel :-)
  1842. @example
  1843. @group
  1844. |---+-------------+---+-----+--------------------------------------|
  1845. | | Func | n | x | Result |
  1846. |---+-------------+---+-----+--------------------------------------|
  1847. | # | exp(x) | 1 | x | 1 + x |
  1848. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  1849. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  1850. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  1851. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  1852. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  1853. |---+-------------+---+-----+--------------------------------------|
  1854. #+TBLFM: $5=taylor($2,$4,$3);n3
  1855. @end group
  1856. @end example
  1857. @node Hyperlinks, TODO items, Tables, Top
  1858. @chapter Hyperlinks
  1859. @cindex hyperlinks
  1860. Like HTML, Org-mode provides links inside a file, external links to
  1861. other files, Usenet articles, emails, and much more.
  1862. @menu
  1863. * Link format:: How links in Org-mode are formatted
  1864. * Internal links:: Links to other places in the current file
  1865. * External links:: URL-like links to the world
  1866. * Handling links:: Creating, inserting and following
  1867. * Using links outside Org-mode:: Linking from my C source code?
  1868. * Link abbreviations:: Shortcuts for writing complex links
  1869. * Search options:: Linking to a specific location
  1870. * Custom searches:: When the default search is not enough
  1871. @end menu
  1872. @node Link format, Internal links, Hyperlinks, Hyperlinks
  1873. @section Link format
  1874. @cindex link format
  1875. @cindex format, of links
  1876. Org-mode will recognize plain URL-like links and activate them as
  1877. clickable links. The general link format, however, looks like this:
  1878. @example
  1879. [[link][description]] @r{or alternatively} [[link]]
  1880. @end example
  1881. Once a link in the buffer is complete (all brackets present), Org-mode
  1882. will change the display so that @samp{description} is displayed instead
  1883. of @samp{[[link][description]]} and @samp{link} is displayed instead of
  1884. @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
  1885. which by default is an underlined face. You can directly edit the
  1886. visible part of a link. Note that this can be either the @samp{link}
  1887. part (if there is no description) or the @samp{description} part. To
  1888. edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
  1889. cursor on the link.
  1890. If you place the cursor at the beginning or just behind the end of the
  1891. displayed text and press @key{BACKSPACE}, you will remove the
  1892. (invisible) bracket at that location. This makes the link incomplete
  1893. and the internals are again displayed as plain text. Inserting the
  1894. missing bracket hides the link internals again. To show the
  1895. internal structure of all links, use the menu entry
  1896. @code{Org->Hyperlinks->Literal links}.
  1897. @node Internal links, External links, Link format, Hyperlinks
  1898. @section Internal links
  1899. @cindex internal links
  1900. @cindex links, internal
  1901. @cindex targets, for links
  1902. If the link does not look like a URL, it is considered to be internal in
  1903. the current file. Links such as @samp{[[My Target]]} or @samp{[[My
  1904. Target][Find my target]]} lead to a text search in the current file.
  1905. The link can be followed with @kbd{C-c C-o} when the cursor is on the
  1906. link, or with a mouse click (@pxref{Handling links}). The preferred
  1907. match for such a link is a dedicated target: the same string in double
  1908. angular brackets. Targets may be located anywhere; sometimes it is
  1909. convenient to put them into a comment line. For example
  1910. @example
  1911. # <<My Target>>
  1912. @end example
  1913. @noindent In HTML export (@pxref{HTML export}), such targets will become
  1914. named anchors for direct access through @samp{http} links@footnote{Note
  1915. that text before the first headline is usually not exported, so the
  1916. first such target should be after the first headline.}.
  1917. If no dedicated target exists, Org-mode will search for the words in the
  1918. link. In the above example the search would be for @samp{my target}.
  1919. Links starting with a star like @samp{*My Target} restrict the search to
  1920. headlines. When searching, Org-mode will first try an exact match, but
  1921. then move on to more and more lenient searches. For example, the link
  1922. @samp{[[*My Targets]]} will find any of the following:
  1923. @example
  1924. ** My targets
  1925. ** TODO my targets are bright
  1926. ** my 20 targets are
  1927. @end example
  1928. To insert a link targeting a headline, in-buffer completion can be used.
  1929. Just type a star followed by a few optional letters into the buffer and
  1930. press @kbd{M-@key{TAB}}. All headlines in the current buffer will be
  1931. offered as completions. @xref{Handling links}, for more commands
  1932. creating links.
  1933. Following a link pushes a mark onto Org-mode's own mark ring. You can
  1934. return to the previous position with @kbd{C-c &}. Using this command
  1935. several times in direct succession goes back to positions recorded
  1936. earlier.
  1937. @menu
  1938. * Radio targets:: Make targets trigger links in plain text.
  1939. @end menu
  1940. @node Radio targets, , Internal links, Internal links
  1941. @subsection Radio targets
  1942. @cindex radio targets
  1943. @cindex targets, radio
  1944. @cindex links, radio targets
  1945. Org-mode can automatically turn any occurrences of certain target names
  1946. in normal text into a link. So without explicitly creating a link, the
  1947. text connects to the target radioing its position. Radio targets are
  1948. enclosed by triple angular brackets. For example, a target @samp{<<<My
  1949. Target>>>} causes each occurrence of @samp{my target} in normal text to
  1950. become activated as a link. The Org-mode file is scanned automatically
  1951. for radio targets only when the file is first loaded into Emacs. To
  1952. update the target list during editing, press @kbd{C-c C-c} with the
  1953. cursor on or at a target.
  1954. @node External links, Handling links, Internal links, Hyperlinks
  1955. @section External links
  1956. @cindex links, external
  1957. @cindex external links
  1958. @cindex links, external
  1959. @cindex GNUS links
  1960. @cindex BBDB links
  1961. @cindex URL links
  1962. @cindex file links
  1963. @cindex VM links
  1964. @cindex RMAIL links
  1965. @cindex WANDERLUST links
  1966. @cindex MH-E links
  1967. @cindex USENET links
  1968. @cindex SHELL links
  1969. @cindex Info links
  1970. @cindex elisp links
  1971. Org-mode supports links to files, websites, Usenet and email messages,
  1972. and BBDB database entries. External links are URL-like locators. They
  1973. start with a short identifying string followed by a colon. There can be
  1974. no space after the colon. The following list shows examples for each
  1975. link type.
  1976. @example
  1977. http://www.astro.uva.nl/~dominik @r{on the web}
  1978. file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
  1979. file:papers/last.pdf @r{file, relative path}
  1980. news:comp.emacs @r{Usenet link}
  1981. mailto:adent@@galaxy.net @r{Mail link}
  1982. vm:folder @r{VM folder link}
  1983. vm:folder#id @r{VM message link}
  1984. vm://myself@@some.where.org/folder#id @r{VM on remote machine}
  1985. wl:folder @r{WANDERLUST folder link}
  1986. wl:folder#id @r{WANDERLUST message link}
  1987. mhe:folder @r{MH-E folder link}
  1988. mhe:folder#id @r{MH-E message link}
  1989. rmail:folder @r{RMAIL folder link}
  1990. rmail:folder#id @r{RMAIL message link}
  1991. gnus:group @r{GNUS group link}
  1992. gnus:group#id @r{GNUS article link}
  1993. bbdb:Richard Stallman @r{BBDB link}
  1994. shell:ls *.org @r{A shell command}
  1995. elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate}
  1996. @end example
  1997. A link should be enclosed in double brackets and may contain a
  1998. descriptive text to be displayed instead of the url (@pxref{Link
  1999. format}), for example:
  2000. @example
  2001. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  2002. @end example
  2003. @noindent
  2004. If the description is a file name or URL that points to an image, HTML
  2005. export (@pxref{HTML export}) will inline the image as a clickable
  2006. button. If there is no description at all and the link points to an
  2007. image,
  2008. that image will be inlined into the exported HTML file.
  2009. @cindex angular brackets, around links
  2010. @cindex plain text external links
  2011. Org-mode also finds external links in the normal text and activates them
  2012. as links. If spaces must be part of the link (for example in
  2013. @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
  2014. about the end of the link, enclose them in angular brackets.
  2015. @node Handling links, Using links outside Org-mode, External links, Hyperlinks
  2016. @section Handling links
  2017. @cindex links, handling
  2018. Org-mode provides methods to create a link in the correct syntax, to
  2019. insert it into an org-mode file, and to follow the link.
  2020. @table @kbd
  2021. @kindex C-c l
  2022. @cindex storing links
  2023. @item C-c l
  2024. Store a link to the current location. This is a @emph{global} command
  2025. which can be used in any buffer to create a link. The link will be
  2026. stored for later insertion into an Org-mode buffer (see below). For
  2027. Org-mode files, if there is a @samp{<<target>>} at the cursor, the link
  2028. points to the target. Otherwise it points to the current headline. For
  2029. VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the link will
  2030. indicate the current article/entry. For W3 and W3M buffers, the link
  2031. goes to the current URL. For any other files, the link will point to
  2032. the file, with a search string (@pxref{Search options}) pointing to the
  2033. contents of the current line. If there is an active region, the
  2034. selected words will form the basis of the search string. If the
  2035. automatically created link is not working correctly or accurately
  2036. enough, you can write custom functions to select the search string and
  2037. to do the search for particular file types - see @ref{Custom searches}.
  2038. The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}.
  2039. @c
  2040. @kindex C-c C-l
  2041. @cindex link completion
  2042. @cindex completion, of links
  2043. @cindex inserting links
  2044. @item C-c C-l
  2045. Insert a link. This prompts for a link to be inserted into the buffer.
  2046. You can just type a link, using text for an internal link, or one of the
  2047. link type prefixes mentioned in the examples above. All links stored
  2048. during the current session are part of the history for this prompt, so
  2049. you can access them with @key{up} and @key{down} (or @kbd{M-p/n}).
  2050. Completion, on the other hand, will help you to insert valid link
  2051. prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
  2052. defined through link abbreviations (@pxref{Link abbreviations}). The
  2053. link will be inserted into the buffer@footnote{After insertion of a
  2054. stored link, the link will be removed from the list of stored links. To
  2055. keep it in the list later use, use a triple @kbd{C-u} prefix to @kbd{C-c
  2056. C-l}, or configure the option
  2057. @code{org-keep-stored-link-after-insertion}.}, along with a descriptive
  2058. text. If some text was selected when this command is called, the
  2059. selected text becomes the default description.@* Note that you don't
  2060. have to use this command to insert a link. Links in Org-mode are plain
  2061. text, and you can type or paste them straight into the buffer. By using
  2062. this command, the links are automatically enclosed in double brackets,
  2063. and you will be asked for the optional descriptive text.
  2064. @c
  2065. @c If the link is a @samp{file:} link and
  2066. @c the linked file is located in the same directory as the current file or
  2067. @c a subdirectory of it, the path of the file will be inserted relative to
  2068. @c the current directory.
  2069. @c
  2070. @kindex C-u C-c C-l
  2071. @cindex file name completion
  2072. @cindex completion, of file names
  2073. @item C-u C-c C-l
  2074. When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
  2075. a file will be inserted and you may use file name completion to select
  2076. the name of the file. The path to the file is inserted relative to the
  2077. directory of the current org file, if the linked file is in the current
  2078. directory or in a subdirectory of it, or if the path is written relative
  2079. to the current directory using @samp{../}. Otherwise an absolute path
  2080. is used, if possible with @samp{~/} for your home directory. You can
  2081. force an absolute path with two @kbd{C-u} prefixes.
  2082. @c
  2083. @item C-c C-l @r{(with cursor on existing link)}
  2084. When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
  2085. link and description parts of the link.
  2086. @c
  2087. @cindex following links
  2088. @kindex C-c C-o
  2089. @item C-c C-o
  2090. Open link at point. This will launch a web browser for URLs (using
  2091. @command{browse-url-at-point}), run vm/mh-e/wanderlust/rmail/gnus/bbdb
  2092. for the corresponding links, and execute the command in a shell link.
  2093. When the cursor is on an internal link, this commands runs the
  2094. corresponding search. When the cursor is on a TAG list in a headline,
  2095. it creates the corresponding TAGS view. If the cursor is on a time
  2096. stamp, it compiles the agenda for that date. Furthermore, it will visit
  2097. text and remote files in @samp{file:} links with Emacs and select a
  2098. suitable application for local non-text files. Classification of files
  2099. is based on file extension only. See option @code{org-file-apps}. If
  2100. you want to override the default application and visit the file with
  2101. Emacs, use a @kbd{C-u} prefix.
  2102. @c
  2103. @kindex mouse-2
  2104. @kindex mouse-1
  2105. @item mouse-2
  2106. @itemx mouse-1
  2107. On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
  2108. would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
  2109. @c
  2110. @kindex mouse-3
  2111. @item mouse-3
  2112. Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
  2113. internal links to be displayed in another window@footnote{See the
  2114. variable @code{org-display-internal-link-with-indirect-buffer}}.
  2115. @c
  2116. @cindex mark ring
  2117. @kindex C-c %
  2118. @item C-c %
  2119. Push the current position onto the mark ring, to be able to return
  2120. easily. Commands following an internal link do this automatically.
  2121. @c
  2122. @cindex links, returning to
  2123. @kindex C-c &
  2124. @item C-c &
  2125. Jump back to a recorded position. A position is recorded by the
  2126. commands following internal links, and by @kbd{C-c %}. Using this
  2127. command several times in direct succession moves through a ring of
  2128. previously recorded positions.
  2129. @c
  2130. @kindex C-c C-x C-n
  2131. @kindex C-c C-x C-p
  2132. @cindex links, finding next/previous
  2133. @item C-c C-x C-n
  2134. @itemx C-c C-x C-p
  2135. Move forward/backward to the next link in the buffer. At the limit of
  2136. the buffer, the search fails once, and then wraps around. The key
  2137. bindings for this are really too long, you might want to bind this also
  2138. to @kbd{C-n} and @kbd{C-p}
  2139. @lisp
  2140. (add-hook 'org-load-hook
  2141. (lambda ()
  2142. (define-key 'org-mode-map "\C-n" 'org-next-link)
  2143. (define-key 'org-mode-map "\C-p" 'org-previous-link)))
  2144. @end lisp
  2145. @end table
  2146. @node Using links outside Org-mode, Link abbreviations, Handling links, Hyperlinks
  2147. @section Using links outside Org-mode
  2148. You can insert and follow links that have Org-mode syntax not only in
  2149. Org-mode, but in any Emacs buffer. For this, you should create two
  2150. global commands, like this (please select suitable global keys
  2151. yourself):
  2152. @lisp
  2153. (global-set-key "\C-c L" 'org-insert-link-global)
  2154. (global-set-key "\C-c o" 'org-open-at-point-global)
  2155. @end lisp
  2156. @node Link abbreviations, Search options, Using links outside Org-mode, Hyperlinks
  2157. @section Link abbreviations
  2158. @cindex link abbreviations
  2159. @cindex abbreviation, links
  2160. Long URLs can be cumbersome to type, and often many similar links are
  2161. needed in a document. For this you can use link abbreviations. An
  2162. abbreviated link looks like this
  2163. @example
  2164. [[linkword:tag][description]]
  2165. @end example
  2166. @noindent
  2167. where the tag is optional. Such abbreviations are resolved according to
  2168. the information in the variable @code{org-link-abbrev-alist} that
  2169. relates the linkwords to replacement text. Here is an example:
  2170. @lisp
  2171. @group
  2172. (setq org-link-abbrev-alist
  2173. '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
  2174. ("google" . "http://www.google.com/search?q=")
  2175. ("ads" . "http://adsabs.harvard.edu/cgi-bin/
  2176. nph-abs_connect?author=%s&db_key=AST")))
  2177. @end group
  2178. @end lisp
  2179. If the replacement text contains the string @samp{%s}, it will be
  2180. replaced with the tag. Otherwise the tag will be appended to the string
  2181. in order to create the link. You may also specify a function that will
  2182. be called with the tag as the only argument to create the link.
  2183. With the above setting, you could link to a specific bug with
  2184. @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
  2185. @code{[[google:OrgMode]]} and find out what the Org-mode author is
  2186. doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
  2187. If you need special abbreviations just for a single Org-mode buffer, you
  2188. can define them in the file with
  2189. @example
  2190. #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
  2191. #+LINK: google http://www.google.com/search?q=%s
  2192. @end example
  2193. @noindent
  2194. In-buffer completion @pxref{Completion} can be used after @samp{[} to
  2195. complete link abbreviations.
  2196. @node Search options, Custom searches, Link abbreviations, Hyperlinks
  2197. @section Search options in file links
  2198. @cindex search option in file links
  2199. @cindex file links, searching
  2200. File links can contain additional information to make Emacs jump to a
  2201. particular location in the file when following a link. This can be a
  2202. line number or a search option after a double@footnote{For backward
  2203. compatibility, line numbers can also follow a single colon.} colon. For
  2204. example, when the command @kbd{C-c l} creates a link (@pxref{Handling
  2205. links}) to a file, it encodes the words in the current line as a search
  2206. string that can be used to find this line back later when following the
  2207. link with @kbd{C-c C-o}.
  2208. Here is the syntax of the different ways to attach a search to a file
  2209. link, together with an explanation:
  2210. @example
  2211. [[file:~/code/main.c::255]]
  2212. [[file:~/xx.org::My Target]]
  2213. [[file:~/xx.org::*My Target]]
  2214. [[file:~/xx.org::/regexp/]]
  2215. @end example
  2216. @table @code
  2217. @item 255
  2218. Jump to line 255.
  2219. @item My Target
  2220. Search for a link target @samp{<<My Target>>}, or do a text search for
  2221. @samp{my target}, similar to the search in internal links, see
  2222. @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
  2223. link will become an HTML reference to the corresponding named anchor in
  2224. the linked file.
  2225. @item *My Target
  2226. In an Org-mode file, restrict search to headlines.
  2227. @item /regexp/
  2228. Do a regular expression search for @code{regexp}. This uses the Emacs
  2229. command @code{occur} to list all matches in a separate window. If the
  2230. target file is in Org-mode, @code{org-occur} is used to create a
  2231. sparse tree with the matches.
  2232. @c If the target file is a directory,
  2233. @c @code{grep} will be used to search all files in the directory.
  2234. @end table
  2235. As a degenerate case, a file link with an empty file name can be used
  2236. to search the current file. For example, @code{[[file:::find me]]} does
  2237. a search for @samp{find me} in the current file, just as
  2238. @samp{[[find me]]} would.
  2239. @node Custom searches, , Search options, Hyperlinks
  2240. @section Custom Searches
  2241. @cindex custom search strings
  2242. @cindex search strings, custom
  2243. The default mechanism for creating search strings and for doing the
  2244. actual search related to a file link may not work correctly in all
  2245. cases. For example, BibTeX database files have many entries like
  2246. @samp{year="1993"} which would not result in good search strings,
  2247. because the only unique identification for a BibTeX entry is the
  2248. citation key.
  2249. If you come across such a problem, you can write custom functions to set
  2250. the right search string for a particular file type, and to do the search
  2251. for the string in the file. Using @code{add-hook}, these functions need
  2252. to be added to the hook variables
  2253. @code{org-create-file-search-functions} and
  2254. @code{org-execute-file-search-functions}. See the docstring for these
  2255. variables for more information. Org-mode actually uses this mechanism
  2256. for Bib@TeX{} database files, and you can use the corresponding code as
  2257. an implementation example. Search for @samp{BibTeX links} in the source
  2258. file.
  2259. @node TODO items, Tags, Hyperlinks, Top
  2260. @chapter TODO items
  2261. @cindex TODO items
  2262. Org-mode does not maintain TODO lists as separate documents. Instead,
  2263. TODO items are an integral part of the notes file, because TODO items
  2264. usually come up while taking notes! With Org-mode, simply mark any
  2265. entry in a tree as being a TODO item. In this way, information is not
  2266. duplicated, and the entire context from which the TODO item emerged is
  2267. always present.
  2268. Of course, this technique for managing TODO items scatters them
  2269. throughout your notes file. Org-mode compensates for this by providing
  2270. methods to give you an overview of all the things that you have to do.
  2271. @menu
  2272. * TODO basics:: Marking and displaying TODO entries
  2273. * TODO extensions:: Workflow and assignments
  2274. * Progress logging:: Dates and notes for progress
  2275. * Priorities:: Some things are more important than others
  2276. * Breaking down tasks:: Splitting a task into manageable pieces
  2277. * Checkboxes:: Tick-off lists
  2278. @end menu
  2279. @node TODO basics, TODO extensions, TODO items, TODO items
  2280. @section Basic TODO functionality
  2281. Any headline becomes a TODO item when it starts with the word
  2282. @samp{TODO}, for example:
  2283. @example
  2284. *** TODO Write letter to Sam Fortune
  2285. @end example
  2286. @noindent
  2287. The most important commands to work with TODO entries are:
  2288. @table @kbd
  2289. @kindex C-c C-t
  2290. @cindex cycling, of TODO states
  2291. @item C-c C-t
  2292. Rotate the TODO state of the current item among
  2293. @example
  2294. ,-> (unmarked) -> TODO -> DONE --.
  2295. '--------------------------------'
  2296. @end example
  2297. The same rotation can also be done ``remotely'' from the timeline and
  2298. agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
  2299. @kindex C-u C-c C-t
  2300. @item C-u C-c C-t
  2301. Select a specific keyword using completion or (if it has been set up)
  2302. the fast selection interface.
  2303. @kindex S-@key{right}
  2304. @kindex S-@key{left}
  2305. @item S-@key{right}
  2306. @itemx S-@key{left}
  2307. Select the following/preceding TODO state, similar to cycling. Useful
  2308. mostly if more than two TODO states are possible (@pxref{TODO
  2309. extensions}).
  2310. @kindex C-c C-c
  2311. @item C-c C-c
  2312. Use the fast tag interface to directly select a specific TODO state.
  2313. For this you need to assign keys to TODO states, like this:
  2314. @example
  2315. #+SEQ_TODO: TODO(t) STARTED(s) WAITING(w) | DONE(d)
  2316. @end example
  2317. @noindent See @ref{Per-file keywords} and @ref{Setting tags} for more
  2318. information.
  2319. @kindex C-c C-v
  2320. @kindex C-c / t
  2321. @cindex sparse tree, for TODO
  2322. @item C-c C-v
  2323. @itemx C-c / t
  2324. View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
  2325. the entire buffer, but shows all TODO items and the headings hierarchy
  2326. above them. With prefix arg, search for a specific TODO. You will be
  2327. prompted for the keyword, and you can also give a list of keywords like
  2328. @code{KWD1|KWD2|...}. With numerical prefix N, show the tree for the
  2329. Nth keyword in the variable @code{org-todo-keywords}. With two prefix
  2330. args, find all TODO and DONE entries.
  2331. @kindex C-c a t
  2332. @item C-c a t
  2333. Show the global TODO list. Collects the TODO items from all agenda
  2334. files (@pxref{Agenda views}) into a single buffer. The new buffer will
  2335. be in @code{agenda-mode}, which provides commands to examine and
  2336. manipulate the TODO entries from the new buffer (@pxref{Agenda
  2337. commands}). @xref{Global TODO list}, for more information.
  2338. @kindex S-M-@key{RET}
  2339. @item S-M-@key{RET}
  2340. Insert a new TODO entry below the current one.
  2341. @end table
  2342. @node TODO extensions, Progress logging, TODO basics, TODO items
  2343. @section Extended use of TODO keywords
  2344. @cindex extended TODO keywords
  2345. By default, marked TODO entries have one of only two states: TODO and
  2346. DONE. Org-mode allows you to classify TODO items in more complex ways
  2347. with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
  2348. special setup, the TODO keyword system can work differently in different
  2349. files.
  2350. Note that @i{tags} are another way to classify headlines in general and
  2351. TODO items in particular (@pxref{Tags}).
  2352. @menu
  2353. * Workflow states:: From TODO to DONE in steps
  2354. * TODO types:: I do this, Fred does the rest
  2355. * Multiple sets in one file:: Mixing it all, and still finding your way
  2356. * Fast access to TODO states:: Single letter selection of a state
  2357. * Per-file keywords:: Different files, different requirements
  2358. * Faces for TODO keywords:: Highlighting states
  2359. @end menu
  2360. @node Workflow states, TODO types, TODO extensions, TODO extensions
  2361. @subsection TODO keywords as workflow states
  2362. @cindex TODO workflow
  2363. @cindex workflow states as TODO keywords
  2364. You can use TODO keywords to indicate different @emph{sequential} states
  2365. in the process of working on an item, for example@footnote{Changing
  2366. this variable only becomes effective after restarting Org-mode in a
  2367. buffer.}:
  2368. @lisp
  2369. (setq org-todo-keywords
  2370. '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
  2371. @end lisp
  2372. The vertical bar separates the TODO keywords (states that @emph{need
  2373. action}) from the DONE states (which need @emph{no further action}. If
  2374. you don't provide the separator bar, the last state is used as the DONE
  2375. state.
  2376. @cindex completion, of TODO keywords
  2377. With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
  2378. to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
  2379. also use a prefix argument to quickly select a specific state. For
  2380. example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
  2381. If you define many keywords, you can use in-buffer completion (see
  2382. @ref{Completion}) to insert these words into the buffer. Changing a
  2383. todo state can be logged with a timestamp, see @ref{Tracking TODO state
  2384. changes} for more information.
  2385. @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
  2386. @subsection TODO keywords as types
  2387. @cindex TODO types
  2388. @cindex names as TODO keywords
  2389. @cindex types as TODO keywords
  2390. The second possibility is to use TODO keywords to indicate different
  2391. @emph{types} of action items. For example, you might want to indicate
  2392. that items are for ``work'' or ``home''. Or, when you work with several
  2393. people on a single project, you might want to assign action items
  2394. directly to persons, by using their names as TODO keywords. This would
  2395. be set up like this:
  2396. @lisp
  2397. (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
  2398. @end lisp
  2399. In this case, different keywords do not indicate a sequence, but rather
  2400. different types. So the normal work flow would be to assign a task to a
  2401. person, and later to mark it DONE. Org-mode supports this style by
  2402. adapting the workings of the command @kbd{C-c C-t}@footnote{This is also
  2403. true for the @kbd{t} command in the timeline and agenda buffers.}. When
  2404. used several times in succession, it will still cycle through all names,
  2405. in order to first select the right type for a task. But when you return
  2406. to the item after some time and execute @kbd{C-c C-t} again, it will
  2407. switch from any name directly to DONE. Use prefix arguments or
  2408. completion to quickly select a specific name. You can also review the
  2409. items of a specific TODO type in a sparse tree by using a numeric prefix
  2410. to @kbd{C-c C-v}. For example, to see all things Lucy has to do, you
  2411. would use @kbd{C-3 C-c C-v}. To collect Lucy's items from all agenda
  2412. files into a single buffer, you would use the prefix arg as well when
  2413. creating the global todo list: @kbd{C-3 C-c t}.
  2414. @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
  2415. @subsection Multiple keyword sets in one file
  2416. @cindex todo keyword sets
  2417. Sometimes you may want to use different sets of TODO keywords in
  2418. parallel. For example, you may want to have the basic
  2419. @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
  2420. separate state indicating that an item has been canceled (so it is not
  2421. DONE, but also does not require action). Your setup would then look
  2422. like this:
  2423. @lisp
  2424. (setq org-todo-keywords
  2425. '((sequence "TODO" "|" "DONE")
  2426. (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
  2427. (sequence "|" "CANCELED")))
  2428. @end lisp
  2429. The keywords should all be different, this helps Org-mode to keep track
  2430. of which subsequence should be used for a given entry. In this setup,
  2431. @kbd{C-c C-t} only operates within a subsequence, so it switches from
  2432. @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
  2433. (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
  2434. select the correct sequence. Besides the obvious ways like typing a
  2435. keyword or using completion, you may also apply the following commands:
  2436. @table @kbd
  2437. @kindex C-S-@key{right}
  2438. @kindex C-S-@key{left}
  2439. @item C-S-@key{right}
  2440. @itemx C-S-@key{left}
  2441. These keys jump from one TODO subset to the next. In the above example,
  2442. @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to
  2443. @code{REPORT}, and any of the words in the second row to @code{CANCELED}.
  2444. @kindex S-@key{right}
  2445. @kindex S-@key{left}
  2446. @item S-@key{right}
  2447. @itemx S-@key{left}
  2448. @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through
  2449. @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}}
  2450. would switch from @code{DONE} to @code{REPORT} in the example above.
  2451. @end table
  2452. @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
  2453. @subsection Fast access to TODO states
  2454. If you would like to quickly change an entry to an arbitrary TODO state
  2455. instead of cycling through the states, you can set up keys for
  2456. single-letter access to the states. This is done by adding the section
  2457. key after each keyword, in parenthesis. For example:
  2458. @lisp
  2459. (setq org-todo-keywords
  2460. '((sequence "TODO(t)" "|" "DONE(d)")
  2461. (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
  2462. (sequence "|" "CANCELED(c)")))
  2463. @end lisp
  2464. If you then press @code{C-u C-c C-t} followed by the selection key, the
  2465. entry will be switched to this state. @key{SPC} can be used to remove
  2466. any TODO keyword from an entry. Should you like this way of selecting
  2467. TODO states a lot, you might want to set the variable
  2468. @code{org-use-fast-todo-selection} to @code{t} and make this behavior
  2469. the default. Check also the variable
  2470. @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
  2471. state through the tags interface (@pxref{Setting tags}).
  2472. @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
  2473. @subsection Setting up keywords for individual files
  2474. @cindex keyword options
  2475. @cindex per-file keywords
  2476. It can be very useful to use different aspects of the TODO mechanism in
  2477. different files. For file-local settings, you need to add special lines
  2478. to the file which set the keywords and interpretation for that file
  2479. only. For example, to set one of the two examples discussed above, you
  2480. need one of the following lines, starting in column zero anywhere in the
  2481. file:
  2482. @example
  2483. #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
  2484. @end example
  2485. or
  2486. @example
  2487. #+TYP_TODO: Fred Sara Lucy Mike | DONE
  2488. @end example
  2489. A setup for using several sets in parallel would be:
  2490. @example
  2491. #+SEQ_TODO: TODO | DONE
  2492. #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
  2493. #+SEQ_TODO: | CANCELED
  2494. @end example
  2495. @cindex completion, of option keywords
  2496. @kindex M-@key{TAB}
  2497. @noindent To make sure you are using the correct keyword, type
  2498. @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
  2499. @cindex DONE, final TODO keyword
  2500. Remember that the keywords after the vertical bar (or the last keyword
  2501. if no bar is there) must always mean that the item is DONE (although you
  2502. may use a different word). After changing one of these lines, use
  2503. @kbd{C-c C-c} with the cursor still in the line to make the changes
  2504. known to Org-mode@footnote{Org-mode parses these lines only when
  2505. Org-mode is activated after visiting a file. @kbd{C-c C-c} with the
  2506. cursor in a line starting with @samp{#+} is simply restarting Org-mode
  2507. for the current buffer.}.
  2508. @node Faces for TODO keywords, , Per-file keywords, TODO extensions
  2509. @subsection Faces for TODO keywords
  2510. @cindex faces, for TODO keywords
  2511. Org-mode highlights TODO keywords with special faces: @code{org-todo}
  2512. for keywords indicating that an item still has to be acted upon, and
  2513. @code{org-done} for keywords indicating that an item is finished. If
  2514. you are using more than 2 different states, you might want to use
  2515. special faces for some of them. This can be done using the variable
  2516. @code{org-todo-keyword-faces}. For example:
  2517. @lisp
  2518. (setq org-todo-keyword-faces
  2519. '(("TODO" . org-warning)
  2520. ("DEFERRED" . shadow)
  2521. ("CANCELED" . (:foreground "blue" :weight bold))))
  2522. @end lisp
  2523. @page
  2524. @node Progress logging, Priorities, TODO extensions, TODO items
  2525. @section Progress Logging
  2526. @cindex progress logging
  2527. @cindex logging, of progress
  2528. Org-mode can automatically record a time stamp and even a note when you
  2529. mark a TODO item as DONE, or even each time you change the state of
  2530. a TODO item.
  2531. @menu
  2532. * Closing items:: When was this entry marked DONE?
  2533. * Tracking TODO state changes:: When did the status change?
  2534. @end menu
  2535. @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
  2536. @subsection Closing items
  2537. If you want to keep track of @emph{when} a certain TODO item was
  2538. finished, turn on logging with@footnote{The corresponding in-buffer
  2539. setting is: @code{#+STARTUP: logdone}. You may also set this for the
  2540. scope of a subtree by adding a @code{:LOGGING:} property with one or more
  2541. of the logging keywords in the value.}
  2542. @lisp
  2543. (setq org-log-done t)
  2544. @end lisp
  2545. @noindent
  2546. Then each time you turn a TODO entry into DONE using either @kbd{C-c
  2547. C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line
  2548. @samp{CLOSED: [timestamp]} will be inserted just after the headline. If
  2549. you turn the entry back into a TODO item through further state cycling,
  2550. that line will be removed again. In the timeline (@pxref{Timeline}) and
  2551. in the agenda (@pxref{Weekly/Daily agenda}), you can then use the
  2552. @kbd{l} key to display the TODO items closed on each day, giving you an
  2553. overview of what has been done on a day. If you want to record a note
  2554. along with the timestamp, use@footnote{The corresponding in-buffer
  2555. setting is: @code{#+STARTUP: lognotedone}}
  2556. @lisp
  2557. (setq org-log-done '(done))
  2558. @end lisp
  2559. @node Tracking TODO state changes, , Closing items, Progress logging
  2560. @subsection Tracking TODO state changes
  2561. When TODO keywords are used as workflow states (@pxref{Workflow
  2562. states}), you might want to keep track of when a state change occurred
  2563. and record a note about this change. With the setting@footnote{The
  2564. corresponding in-buffer setting is: @code{#+STARTUP: lognotestate}.}
  2565. @lisp
  2566. (setq org-log-done '(state))
  2567. @end lisp
  2568. @noindent
  2569. each state change will prompt you for a note that will be attached to
  2570. the current headline. If you press @kbd{C-c C-c} without typing
  2571. anything into the note buffer, only the time of the state change will be
  2572. noted. Very likely you do not want this verbose tracking all the time,
  2573. so it is probably better to configure this behavior with in-buffer
  2574. options. For example, if you are tracking purchases, put these into a
  2575. separate file that contains:
  2576. @example
  2577. #+SEQ_TODO: TODO(t) ORDERED(o) INVOICE(i) PAYED(p) | RECEIVED(r)
  2578. #+STARTUP: lognotestate
  2579. @end example
  2580. If you only need to take a note for some of the states, mark those
  2581. states with an additional @samp{@@}, like this:
  2582. @example
  2583. #+SEQ_TODO: TODO(t) ORDERED(o@@) INVOICE(i@@) PAYED(p) | RECEIVED(r)
  2584. #+STARTUP: lognotestate
  2585. @end example
  2586. @node Priorities, Breaking down tasks, Progress logging, TODO items
  2587. @section Priorities
  2588. @cindex priorities
  2589. If you use Org-mode extensively, you may end up enough TODO items that
  2590. it starts to make sense to prioritize them. Prioritizing can be done by
  2591. placing a @emph{priority cookie} into the headline of a TODO item, like
  2592. this
  2593. @example
  2594. *** TODO [#A] Write letter to Sam Fortune
  2595. @end example
  2596. @noindent
  2597. By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
  2598. @samp{C}. @samp{A} is the highest priority. An entry without a cookie
  2599. is treated as priority @samp{B}. Priorities make a difference only in
  2600. the agenda (@pxref{Weekly/Daily agenda}); outside the agenda, they have
  2601. no inherent meaning to Org-mode.
  2602. Priorities can be attached to any outline tree entries; they do not need
  2603. to be TODO items.
  2604. @table @kbd
  2605. @kindex @kbd{C-c ,}
  2606. @item @kbd{C-c ,}
  2607. Set the priority of the current headline. The command prompts for a
  2608. priority character @samp{A}, @samp{B} or @samp{C}. When you press
  2609. @key{SPC} instead, the priority cookie is removed from the headline.
  2610. The priorities can also be changed ``remotely'' from the timeline and
  2611. agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
  2612. @c
  2613. @kindex S-@key{up}
  2614. @kindex S-@key{down}
  2615. @item S-@key{up}
  2616. @itemx S-@key{down}
  2617. Increase/decrease priority of current headline@footnote{See also the
  2618. option @code{org-priority-start-cycle-with-default'}.}. Note that these
  2619. keys are also used to modify time stamps (@pxref{Creating timestamps}).
  2620. Furthermore, these keys are also used by CUA-mode (@pxref{Conflicts}).
  2621. @end table
  2622. You can change the range of allowed priorities by setting the variables
  2623. @code{org-highest-priority}, @code{org-lowest-priority}, and
  2624. @code{org-default-priority}. For an individual buffer, you may set
  2625. these values (highest, lowest, default) like this (please make sure that
  2626. the highest priority is earlier in the alphabet than the lowest
  2627. priority):
  2628. @example
  2629. #+PRIORITIES: A C B
  2630. @end example
  2631. @node Breaking down tasks, Checkboxes, Priorities, TODO items
  2632. @section Breaking tasks down into subtasks
  2633. @cindex tasks, breaking down
  2634. It is often advisable to break down large tasks into smaller, manageable
  2635. subtasks. You can do this by creating an outline tree below a TODO
  2636. item, with detailed subtasks on the tree@footnote{To keep subtasks out
  2637. of the global TODO list, see the
  2638. @code{org-agenda-todo-list-sublevels}.}. Another possibility is the use
  2639. of checkboxes to identify (a hierarchy of) a large number of subtasks
  2640. (@pxref{Checkboxes}).
  2641. @node Checkboxes, , Breaking down tasks, TODO items
  2642. @section Checkboxes
  2643. @cindex checkboxes
  2644. Every item in a plain list (@pxref{Plain lists}) can be made into a
  2645. checkbox by starting it with the string @samp{[ ]}. This feature is
  2646. similar to TODO items (@pxref{TODO items}), but is more lightweight.
  2647. Checkboxes are not included into the global TODO list, so they are often
  2648. great to split a task into a number of simple steps. Or you can use
  2649. them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
  2650. use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
  2651. Here is an example of a checkbox list.
  2652. @example
  2653. * TODO Organize party [3/6]
  2654. - call people [1/3]
  2655. - [ ] Peter
  2656. - [X] Sarah
  2657. - [ ] Sam
  2658. - [X] order food
  2659. - [ ] think about what music to play
  2660. - [X] talk to the neighbors
  2661. @end example
  2662. @cindex statistics, for checkboxes
  2663. @cindex checkbox statistics
  2664. The @samp{[3/6]} and @samp{[1/3]} in the first and second line are
  2665. cookies indicating how many checkboxes present in this entry have been
  2666. checked off, and the total number of checkboxes are present. This can
  2667. give you an idea on how many checkboxes remain, even without opening a
  2668. folded entry. The cookies can be placed into a headline or into (the
  2669. first line of) a plain list item. Each cookie covers all checkboxes
  2670. structurally below the headline/item on which the cookie appear. You
  2671. have to insert the cookie yourself by typing either @samp{[/]} or
  2672. @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as in
  2673. the examples above. With @samp{[%]} you get information about the
  2674. percentage of checkboxes checked (in the above example, this would be
  2675. @samp{[50%]} and @samp{[33%]}, respectively).
  2676. @noindent The following commands work with checkboxes:
  2677. @table @kbd
  2678. @kindex C-c C-c
  2679. @item C-c C-c
  2680. Toggle checkbox at point. With prefix argument, set it to @samp{[-]},
  2681. which is considered to be an intermediate state.
  2682. @kindex C-c C-x C-b
  2683. @item C-c C-x C-b
  2684. Toggle checkbox at point.
  2685. @itemize @minus
  2686. @item
  2687. If there is an active region, toggle the first checkbox in the region
  2688. and set all remaining boxes to the same status as the first. If you
  2689. want to toggle all boxes in the region independently, use a prefix
  2690. argument.
  2691. @item
  2692. If the cursor is in a headline, toggle checkboxes in the region between
  2693. this headline and the next (so @emph{not} the entire subtree).
  2694. @item
  2695. If there is no active region, just toggle the checkbox at point.
  2696. @end itemize
  2697. @kindex M-S-@key{RET}
  2698. @item M-S-@key{RET}
  2699. Insert a new item with a checkbox.
  2700. This works only if the cursor is already in a plain list item
  2701. (@pxref{Plain lists}).
  2702. @kindex C-c #
  2703. @item C-c #
  2704. Update the checkbox statistics in the current outline entry. When
  2705. called with a @kbd{C-u} prefix, update the entire file. Checkbox
  2706. statistic cookies are updated automatically if you toggle checkboxes
  2707. with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you
  2708. delete boxes or add/change them by hand, use this command to get things
  2709. back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
  2710. @end table
  2711. @node Tags, Properties and columns, TODO items, Top
  2712. @chapter Tags
  2713. @cindex tags
  2714. @cindex headline tagging
  2715. @cindex matching, tags
  2716. @cindex sparse tree, tag based
  2717. An excellent way to implement labels and contexts for cross-correlating
  2718. information is to assign @i{tags} to headlines. Org-mode has extensive
  2719. support for tags.
  2720. Every headline can contain a list of tags; they occur at the end of the
  2721. headline. Tags are normal words containing letters, numbers, @samp{_},
  2722. and @samp{@@}. Tags must be preceded and followed by a single colon,
  2723. e.g., @samp{:WORK:}. Several tags can be specified, as in
  2724. @samp{:work:URGENT:}.
  2725. @menu
  2726. * Tag inheritance:: Tags use the tree structure of the outline
  2727. * Setting tags:: How to assign tags to a headline
  2728. * Tag searches:: Searching for combinations of tags
  2729. @end menu
  2730. @node Tag inheritance, Setting tags, Tags, Tags
  2731. @section Tag inheritance
  2732. @cindex tag inheritance
  2733. @cindex inheritance, of tags
  2734. @cindex sublevels, inclusion into tags match
  2735. @i{Tags} make use of the hierarchical structure of outline trees. If a
  2736. heading has a certain tag, all subheadings will inherit the tag as
  2737. well. For example, in the list
  2738. @example
  2739. * Meeting with the French group :work:
  2740. ** Summary by Frank :boss:notes:
  2741. *** TODO Prepare slides for him :action:
  2742. @end example
  2743. @noindent
  2744. the final heading will have the tags @samp{:work:}, @samp{:boss:},
  2745. @samp{:notes:}, and @samp{:action:} even though the final heading is not
  2746. explicitly marked with those tags. When executing tag searches and
  2747. Org-mode finds that a certain headline matches the search criterion, it
  2748. will not check any sublevel headline, assuming that these also match and
  2749. that the list of matches could become very long because of that. If you
  2750. do want the subevels be tested and listed as well, you may set the
  2751. variable @code{org-tags-match-list-sublevels}. To turn off tag
  2752. inheritance entirely, use the variable @code{org-use-tag-inheritance}.
  2753. @node Setting tags, Tag searches, Tag inheritance, Tags
  2754. @section Setting tags
  2755. @cindex setting tags
  2756. @cindex tags, setting
  2757. @kindex M-@key{TAB}
  2758. Tags can simply be typed into the buffer at the end of a headline.
  2759. After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
  2760. also a special command for inserting tags:
  2761. @table @kbd
  2762. @kindex C-c C-c
  2763. @item C-c C-c
  2764. @cindex completion, of tags
  2765. Enter new tags for the current headline. Org-mode will either offer
  2766. completion or a special single-key interface for setting tags, see
  2767. below. After pressing @key{RET}, the tags will be inserted and aligned
  2768. to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
  2769. tags in the current buffer will be aligned to that column, just to make
  2770. things look nice. TAGS are automatically realigned after promotion,
  2771. demotion, and TODO state changes (@pxref{TODO basics}).
  2772. @end table
  2773. Org will support tag insertion based on a @emph{list of tags}. By
  2774. default this list is constructed dynamically, containing all tags
  2775. currently used in the buffer. You may also globally specify a hard list
  2776. of tags with the variable @code{org-tag-alist}. Finally you can set
  2777. the default tags for a given file with lines like
  2778. @example
  2779. #+TAGS: @@work @@home @@tennisclub
  2780. #+TAGS: laptop car pc sailboat
  2781. @end example
  2782. If you have globally defined your preferred set of tags using the
  2783. variable @code{org-tag-alist}, but would like to use a dynamic tag list
  2784. in a specific file, add an empty TAGS option line to that file:
  2785. @example
  2786. #+TAGS:
  2787. @end example
  2788. The default support method for entering tags is minibuffer completion.
  2789. However, Org-mode also implements a much better method: @emph{fast tag
  2790. selection}. This method allows to select and deselect tags with a
  2791. single key per tag. To function efficiently, you should assign unique
  2792. keys to most tags. This can be done globally with
  2793. @lisp
  2794. (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
  2795. @end lisp
  2796. @noindent or on a per-file basis with
  2797. @example
  2798. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
  2799. @end example
  2800. @noindent
  2801. You can also group together tags that are mutually exclusive. With
  2802. curly braces@footnote{In @code{org-mode-alist} use
  2803. @code{'(:startgroup)} and @code{'(:endgroup)}, respectively. Several
  2804. groups are allowed.}
  2805. @example
  2806. #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
  2807. @end example
  2808. @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
  2809. and @samp{@@tennisclub} should be selected.
  2810. @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
  2811. these lines to activate any changes.
  2812. If at least one tag has a selection key, pressing @kbd{C-c C-c} will
  2813. automatically present you with a special interface, listing inherited
  2814. tags, the tags of the current headline, and a list of all legal tags
  2815. with corresponding keys@footnote{Keys will automatically be assigned to
  2816. tags which have no configured keys.}. In this interface, you can use
  2817. the following keys:
  2818. @table @kbd
  2819. @item a-z...
  2820. Pressing keys assigned to tags will add or remove them from the list of
  2821. tags in the current line. Selecting a tag in a group of mutually
  2822. exclusive tags will turn off any other tags from that group.
  2823. @kindex @key{TAB}
  2824. @item @key{TAB}
  2825. Enter a tag in the minibuffer, even if the tag is not in the predefined
  2826. list. You will be able to complete on all tags present in the buffer.
  2827. @kindex @key{SPC}
  2828. @item @key{SPC}
  2829. Clear all tags for this line.
  2830. @kindex @key{RET}
  2831. @item @key{RET}
  2832. Accept the modified set.
  2833. @item C-g
  2834. Abort without installing changes.
  2835. @item q
  2836. If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
  2837. @item !
  2838. Turn off groups of mutually exclusive tags. Use this to (as an
  2839. exception) assign several tags from such a group.
  2840. @item C-c
  2841. Toggle auto-exit after the next change (see below).
  2842. If you are using expert mode, the first @kbd{C-c} will display the
  2843. selection window.
  2844. @end table
  2845. @noindent
  2846. This method lets you assign tags to a headline with very few keys. With
  2847. the above setup, you could clear the current tags and set @samp{@@home},
  2848. @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
  2849. C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
  2850. @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
  2851. alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
  2852. @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
  2853. @key{RET} @key{RET}}.
  2854. If you find that most of the time, you need only a single keypress to
  2855. modify your list of tags, set the variable
  2856. @code{org-fast-tag-selection-single-key}. Then you no longer have to
  2857. press @key{RET} to exit fast tag selection - it will immediately exit
  2858. after the first change. If you then occasionally need more keys, press
  2859. @kbd{C-c} to turn off auto-exit for the current tag selection process
  2860. (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
  2861. C-c}). If you set the variable to the value @code{expert}, the special
  2862. window is not even shown for single-key tag selection, it comes up only
  2863. when you press an extra @kbd{C-c}.
  2864. @node Tag searches, , Setting tags, Tags
  2865. @section Tag searches
  2866. @cindex tag searches
  2867. @cindex searching for tags
  2868. Once a system of tags has been set up, it can be used to collect related
  2869. information into special lists.
  2870. @table @kbd
  2871. @kindex C-c \
  2872. @kindex C-c / T
  2873. @item C-c \
  2874. @itemx C-c / T
  2875. Create a sparse tree with all headlines matching a tags search. With a
  2876. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  2877. @kindex C-c a m
  2878. @item C-c a m
  2879. Create a global list of tag matches from all agenda files.
  2880. @xref{Matching tags and properties}.
  2881. @kindex C-c a M
  2882. @item C-c a M
  2883. Create a global list of tag matches from all agenda files, but check
  2884. only TODO items and force checking subitems (see variable
  2885. @code{org-tags-match-list-sublevels}).
  2886. @end table
  2887. @cindex Boolean logic, for tag searches
  2888. A @i{tags} search string can use Boolean operators @samp{&} for AND and
  2889. @samp{|} for OR. @samp{&} binds more strongly than @samp{|}.
  2890. Parenthesis are currently not implemented. A tag may also be preceded
  2891. by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
  2892. positive selection. The AND operator @samp{&} is optional when @samp{+}
  2893. or @samp{-} is present. Examples:
  2894. @table @samp
  2895. @item +work-boss
  2896. Select headlines tagged @samp{:work:}, but discard those also tagged
  2897. @samp{:boss:}.
  2898. @item work|laptop
  2899. Selects lines tagged @samp{:work:} or @samp{:laptop:}.
  2900. @item work|laptop&night
  2901. Like before, but require the @samp{:laptop:} lines to be tagged also
  2902. @samp{:night:}.
  2903. @end table
  2904. @cindex TODO keyword matching, with tags search
  2905. If you are using multi-state TODO keywords (@pxref{TODO extensions}), it
  2906. can be useful to also match on the TODO keyword. This can be done by
  2907. adding a condition after a slash to a tags match. The syntax is similar
  2908. to the tag matches, but should be applied with consideration: For
  2909. example, a positive selection on several TODO keywords can not
  2910. meaningfully be combined with boolean AND. However, @emph{negative
  2911. selection} combined with AND can be meaningful. To make sure that only
  2912. lines are checked that actually have any TODO keyword, use @kbd{C-c a
  2913. M}, or equivalently start the todo part after the slash with @samp{!}.
  2914. Examples:
  2915. @table @samp
  2916. @item work/WAITING
  2917. Select @samp{:work:}-tagged TODO lines with the specific TODO
  2918. keyword @samp{WAITING}.
  2919. @item work/!-WAITING-NEXT
  2920. Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
  2921. nor @samp{NEXT}
  2922. @item work/+WAITING|+NEXT
  2923. Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
  2924. @samp{NEXT}.
  2925. @end table
  2926. @cindex regular expressions, with tags search
  2927. Any element of the tag/todo match can be a regular expression - in this
  2928. case it must be enclosed in curly braces. For example,
  2929. @samp{work+@{^boss.*@}} matches headlines that contain the tag
  2930. @samp{:work:} and any tag @i{starting} with @samp{boss}.
  2931. @cindex level, require for tags/property match
  2932. @cindex category, require for tags/property match
  2933. You can also require a headline to be of a certain level or category, by
  2934. writing instead of any TAG an expression like @samp{LEVEL=3} or
  2935. @samp{CATEGORY="work"}, respectively. For example, a search
  2936. @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the
  2937. tag @samp{boss} and are @emph{not} marked with the todo keyword DONE.
  2938. @node Properties and columns, Dates and times, Tags, Top
  2939. @chapter Properties and Columns
  2940. @cindex properties
  2941. Properties are a set of key-value pairs associated with an entry. There
  2942. are two main applications for properties in Org-mode. First, properties
  2943. are like tags, but with a value. Second, you can use properties to
  2944. implement (very basic) database capabilities in an Org-mode buffer. For
  2945. an example of the first application, imagine maintaining a file where
  2946. you document bugs and plan releases of a piece of software. Instead of
  2947. using tags like @code{:release_1:}, @code{:release_2:}, one can use a
  2948. property, say @code{:Release:}, that in different subtrees has different
  2949. values, such as @code{1.0} or @code{2.0}. For an example of the second
  2950. application of properties, imagine keeping track of one's music CD's,
  2951. where properties could be things such as the album artist, date of
  2952. release, number of tracks, and so on.
  2953. Properties can be conveiently edited and viewed in column view
  2954. (@pxref{Column view}).
  2955. Properties are like tags, but with a value. For example, in a file
  2956. where you document bugs and plan releases of a piece of software,
  2957. instead of using tags like @code{:release_1:}, @code{:release_2:}, it
  2958. can be more efficient to use a property @code{:Release:} with a value
  2959. @code{1.0} or @code{2.0}. Second, you can use properties to implement
  2960. (very basic) database capabilities in an Org-mode buffer, for example to
  2961. create a list of Music CD's you own. You can edit and view properties
  2962. conveniently in column view (@pxref{Column view}).
  2963. @menu
  2964. * Property syntax:: How properties are spelled out
  2965. * Special properties:: Access to other Org-mode features
  2966. * Property searches:: Matching property values
  2967. * Property inheritance:: Passing values down the tree
  2968. * Column view:: Tabular viewing and editing
  2969. * Property API:: Properties for Lisp programmers
  2970. @end menu
  2971. @node Property syntax, Special properties, Properties and columns, Properties and columns
  2972. @section Property Syntax
  2973. @cindex property syntax
  2974. @cindex drawer, for properties
  2975. Properties are key-value pairs. They need to be inserted into a special
  2976. drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
  2977. is specified on a single line, with the key (surrounded by colons)
  2978. first, and the value after it. Here is an example:
  2979. @example
  2980. * CD collection
  2981. ** Classic
  2982. *** Goldberg Variations
  2983. :PROPERTIES:
  2984. :Title: Goldberg Variations
  2985. :Composer: J.S. Bach
  2986. :Artist: Glen Gould
  2987. :Publisher: Deutsche Grammphon
  2988. :NDisks: 1
  2989. :END:
  2990. @end example
  2991. You may define the allowed values for a particular property @samp{:Xyz:}
  2992. by setting a property @samp{:Xyz_ALL:}. This special property is
  2993. @emph{inherited}, so if you set it in a level 1 entry, it will apply to
  2994. the entire tree. When allowed values are defined, setting the
  2995. corresponding property becomes easier and is less prone to typing
  2996. errors. For the example with the CD collection, we can predefine
  2997. publishers and the number of disks in a box like this:
  2998. @example
  2999. * CD collection
  3000. :PROPERTIES:
  3001. :NDisks_ALL: 1 2 3 4
  3002. :Publisher_ALL: "Deutsche Grammophon" Phillips EMI
  3003. :END:
  3004. @end example
  3005. If you want to set properties that can be inherited by any entry in a
  3006. file, use a line like
  3007. @example
  3008. #+PROPERTY: NDisks_ALL 1 2 3 4
  3009. @end example
  3010. Property values set with the global variable
  3011. @code{org-global-properties} can be inherited by all entries in all
  3012. Org-mode files.
  3013. @noindent
  3014. The following commands help to work with properties:
  3015. @table @kbd
  3016. @kindex M-@key{TAB}
  3017. @item M-@key{TAB}
  3018. After an initial colon in a line, complete property keys. All keys used
  3019. in the current file will be offered as possible completions.
  3020. @kindex C-c C-x p
  3021. @item C-c C-x p
  3022. Set a property. This prompts for a property name and a value. If
  3023. necessary, the property drawer is created as well.
  3024. @item M-x org-insert-property-drawer
  3025. Insert a property drawer into the current entry. The drawer will be
  3026. inserted early in the entry, but after the lines with planning
  3027. information like deadlines.
  3028. @kindex C-c C-c
  3029. @item C-c C-c
  3030. With the cursor in a property drawer, this executes property commands.
  3031. @item C-c C-c s
  3032. Set a property in the current entry. Both the property and the value
  3033. can be inserted using completion.
  3034. @kindex S-@key{right}
  3035. @kindex S-@key{left}
  3036. @item S-@key{left}/@key{right}
  3037. Switch property at point to the next/previous allowed value.
  3038. @item C-c C-c d
  3039. Remove a property from the current entry.
  3040. @item C-c C-c D
  3041. Globally remove a property, from all entries in the current file.
  3042. @item C-c C-c c
  3043. Compute the property at point, using the operator and scope from the
  3044. nearest column format definition.
  3045. @end table
  3046. @node Special properties, Property searches, Property syntax, Properties and columns
  3047. @section Special Properties
  3048. @cindex properties, special
  3049. Special properties provide alternative access method to Org-mode
  3050. features discussed in the previous chapters, like the TODO state or the
  3051. priority of an entry. This interface exists so that you can include
  3052. these states into columns view (@pxref{Column view}), or to use them in
  3053. queries. The following property names are special and should not be
  3054. used as keys in the properties drawer:
  3055. @example
  3056. TODO @r{The TODO keyword of the entry.}
  3057. TAGS @r{The tags defined directly in the headline.}
  3058. ALLTAGS @r{All tags, including inherited ones.}
  3059. PRIORITY @r{The priority of the entry, a string with a single letter.}
  3060. DEADLINE @r{The deadline time string, without the angular brackets.}
  3061. SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
  3062. TIMESTAMP @r{The first keyword-less time stamp in the entry.}
  3063. TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
  3064. CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
  3065. @r{must be run first to compute the values.}
  3066. @end example
  3067. @node Property searches, Property inheritance, Special properties, Properties and columns
  3068. @section Property searches
  3069. @cindex properties, searching
  3070. @cindex properties, inheritance
  3071. @cindex searching, of properties
  3072. @cindex inheritance, of properties
  3073. To create sparse trees and special lists with selection based on
  3074. properties, the same commands are used as for tag searches (@pxref{Tag
  3075. searches}), and the same logic applies. For example, a search string
  3076. @example
  3077. +work-boss+PRIORITY="A"+Coffee="unlimited"+With=@{Sarah\|Denny@}
  3078. @end example
  3079. @noindent
  3080. finds entries tagged @samp{:work:} but not @samp{:boss:}, which
  3081. also have a priority value @samp{A}, a @samp{:Coffee:} property with the
  3082. value @samp{unlimited}, and a @samp{:With:} property that is matched by
  3083. the regular expression @samp{Sarah\|Denny}.
  3084. You can configure Org-mode to use property inheritance during a search,
  3085. see @ref{Property inheritance} for details.
  3086. There is also a special command for creating sparse trees based on a
  3087. single property:
  3088. @table @kbd
  3089. @kindex C-c / p
  3090. @item C-c / p
  3091. Create a sparse tree based on the value of a property. This first
  3092. prompts for the name of a property, and then for a value. A sparse tree
  3093. is created with all entries that define this property with the given
  3094. value. If you enclose the value into curly braces, it is interpreted as
  3095. a regular expression and matched against the property values.
  3096. @end table
  3097. @node Property inheritance, Column view, Property searches, Properties and columns
  3098. @section Property Inheritance
  3099. The outline structure of Org-mode documents lends itself for an
  3100. inheritance model of properties: If the parent in a tree has a certain
  3101. property, the children can inherit this property. Org-mode does not
  3102. turn this on by default, because it can slow down property searches
  3103. significantly and is often not needed. However, if you find inheritance
  3104. useful, you can turn it on by setting the variable
  3105. @code{org-use-property-inheritance}. It may be set to @code{t}, to make
  3106. all properties inherited from the parent, or to a list of properties
  3107. that should be inherited.
  3108. Org-mode has a few properties for which inheritance is hard-coded, at
  3109. least for the special applications for which they are used:
  3110. @table @code
  3111. @item COLUMNS
  3112. The @code{:COLUMNS:} property defines the format of column view
  3113. (@pxref{Column view}). It is inherited in the sense that the level
  3114. where a @code{:COLUMNS:} property is defined is used as the starting
  3115. point for a column view table, independently of the location in the
  3116. subtree from where columns view is turned on.
  3117. @item CATEGORY
  3118. For agenda view, a category set through a @code{:CATEGORY:} property
  3119. applies to the entire subtree.
  3120. @item ARCHIVE
  3121. For archiving, the @code{:ARCHIVE:} property may define the archive
  3122. location for the entire subtree (@pxref{Moving subtrees}).
  3123. @end table
  3124. @node Column view, Property API, Property inheritance, Properties and columns
  3125. @section Column View
  3126. A great way to view and edit properties in an outline tree is
  3127. @emph{column view}. In column view, each outline item is turned into a
  3128. table row. Columns in this table provide access to properties of the
  3129. entries. Org-mode implements columns by overlaying a tabular structure
  3130. over the headline of each item. While the headlines have been turned
  3131. into a table row, you can still change the visibility of the outline
  3132. tree. For example, you get a compact table by switching to CONTENTS
  3133. view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
  3134. is active), but you can still open, read, and edit the entry below each
  3135. headline. Or, you can switch to column view after executing a sparse
  3136. tree command and in this way get a table only for the selected items.
  3137. Column view also works in agenda buffers (@pxref{Agenda views}) where
  3138. queries have collected selected items, possibly from a number of files.
  3139. @menu
  3140. * Defining columns:: The COLUMNS format property
  3141. * Using column view:: How to create and use column view
  3142. * Capturing Column View:: A dynamic block for column view
  3143. @end menu
  3144. @node Defining columns, Using column view, Column view, Column view
  3145. @subsection Defining Columns
  3146. @cindex column view, for properties
  3147. @cindex properties, column view
  3148. Setting up a column view first requires defining the columns. This is
  3149. done by defining a column format line.
  3150. @menu
  3151. * Scope of column definitions:: Where defined, where valid?
  3152. * Column attributes:: Appearance and content of a column
  3153. @end menu
  3154. @node Scope of column definitions, Column attributes, Defining columns, Defining columns
  3155. @subsubsection Scope of column definitions
  3156. To define a column format for an entire file, use a line like
  3157. @example
  3158. #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  3159. @end example
  3160. To specify a format that only applies to a specific tree, add a
  3161. @code{:COLUMNS:} property to the top node of that tree, for example:
  3162. @example
  3163. ** Top node for columns view
  3164. :PROPERTIES:
  3165. :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  3166. :END:
  3167. @end example
  3168. If a @code{:COLUMNS:} property is present in an entry, it defines columns
  3169. for the entry itself, and for the entire subtree below it. Since the
  3170. column definition is part of the hierarchical structure of the document,
  3171. you can define columns on level 1 that are general enough for all
  3172. sublevels, and more specific columns further down, when you edit a
  3173. deeper part of the tree.
  3174. @node Column attributes, , Scope of column definitions, Defining columns
  3175. @subsubsection Column attributes
  3176. A column definition sets the attributes of a column. The general
  3177. definition looks like this:
  3178. @example
  3179. %[width]property[(title)][@{summary-type@}]
  3180. @end example
  3181. @noindent
  3182. Except for the percent sign and the property name, all items are
  3183. optional. The individual parts have the following meaning:
  3184. @example
  3185. width @r{An integer specifying the width of the column in characters.}
  3186. @r{If omitted, the width will be determined automatically.}
  3187. property @r{The property that should be edited in this column.}
  3188. (title) @r{The header text for the column. If omitted, the}
  3189. @r{property name is used.}
  3190. @{summary-type@} @r{The summary type. If specified, the column values for}
  3191. @r{parent nodes are computed from the children.}
  3192. @r{Supported summary types are:}
  3193. @{+@} @r{Sum numbers in this column.}
  3194. @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
  3195. @{$@} @r{Currency, short for @samp{+;%.2f}.}
  3196. @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
  3197. @{X@} @r{Checkbox status, [X] if all children are [X].}
  3198. @end example
  3199. @noindent
  3200. Here is an example for a complete columns definition, along with allowed
  3201. values.
  3202. @example
  3203. :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.}
  3204. %10Time_Estimate@{:@} %CLOCKSUM
  3205. :Owner_ALL: Tammy Mark Karl Lisa Don
  3206. :Status_ALL: "In progress" "Not started yet" "Finished" ""
  3207. :Approved_ALL: "[ ]" "[X]"
  3208. @end example
  3209. The first column, @samp{%25ITEM}, means the first 25 characters of the
  3210. item itself, i.e. of the headline. You probably always should start the
  3211. column definition with the ITEM specifier. The other specifiers create
  3212. columns @samp{Owner} with a list of names as allowed values, for
  3213. @samp{Status} with four different possible values, and for a checkbox
  3214. field @samp{Approved}. When no width is given after the @samp{%}
  3215. character, the column will be exactly as wide as it needs to be in order
  3216. to fully display all values. The @samp{Approved} column does have a
  3217. modified title (@samp{Approved?}, with a question mark). Summaries will
  3218. be created for the @samp{Time_Estimate} column by adding time duration
  3219. expressions like HH:MM, and for the @samp{Approved} column, by providing
  3220. an @samp{[X]} status if all children have been checked. The
  3221. @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
  3222. in the subtree.
  3223. @node Using column view, Capturing Column View, Defining columns, Column view
  3224. @subsection Using Column View
  3225. @table @kbd
  3226. @tsubheading{Turning column view on and off}
  3227. @kindex C-c C-x C-c
  3228. @item C-c C-x C-c
  3229. Create the column view for the local environment. This command searches
  3230. the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
  3231. a format. When one is found, the column view table is established for
  3232. the entire tree, starting from the entry that contains the @code{:COLUMNS:}
  3233. property. If none is found, the format is taken from the @code{#+COLUMNS}
  3234. line or from the variable @code{org-columns-default-format}, and column
  3235. view is established for the current entry and its subtree.
  3236. @kindex q
  3237. @item q
  3238. Exit column view.
  3239. @tsubheading{Editing values}
  3240. @item @key{left} @key{right} @key{up} @key{down}
  3241. Move through the column view from field to field.
  3242. @kindex S-@key{left}
  3243. @kindex S-@key{right}
  3244. @item S-@key{left}/@key{right}
  3245. Switch to the next/previous allowed value of the field. For this, you
  3246. have to have specified allowed values for a property.
  3247. @kindex n
  3248. @kindex p
  3249. @itemx n / p
  3250. Same as @kbd{S-@key{left}/@key{right}}
  3251. @kindex e
  3252. @item e
  3253. Edit the property at point. For the special properties, this will
  3254. invoke the same interface that you normally use to change that
  3255. property. For example, when editing a TAGS property, the tag completion
  3256. or fast selection interface will pop up.
  3257. @kindex C-c C-c
  3258. @item C-c C-c
  3259. When there is a checkbox at point, toggle it.
  3260. @kindex v
  3261. @item v
  3262. View the full value of this property. This is useful if the width of
  3263. the column is smaller than that of the value.
  3264. @kindex a
  3265. @item a
  3266. Edit the list of allowed values for this property. If the list is found
  3267. in the hierarchy, the modified values is stored there. If no list is
  3268. found, the new value is stored in the first entry that is part of the
  3269. current column view.
  3270. @tsubheading{Modifying the table structure}
  3271. @kindex <
  3272. @kindex >
  3273. @item < / >
  3274. Make the column narrower/wider by one character.
  3275. @kindex S-M-@key{right}
  3276. @item S-M-@key{right}
  3277. Insert a new column, to the right of the current column.
  3278. @kindex S-M-@key{left}
  3279. @item S-M-@key{left}
  3280. Delete the current column.
  3281. @end table
  3282. @node Capturing Column View, , Using column view, Column view
  3283. @subsection Capturing Column View
  3284. Since column view is just an overlay over a buffer, it cannot be
  3285. exported or printed directly. If you want to capture a column view, use
  3286. the dynamic block (@pxref{Dynamic blocks}). The frame of this block
  3287. looks like this:
  3288. @example
  3289. * The column view
  3290. #+BEGIN: columnview :hlines 1 :id "label"
  3291. #+END:
  3292. @end example
  3293. @noindent This dynamic block has the following parameters:
  3294. @table @code
  3295. @item :id
  3296. This is most important parameter. Column view is a feature that is
  3297. often localized to a certain (sub)tree, and the capture block might be
  3298. in a different location in the file. To identify the tree whose view to
  3299. capture, you can use 3 values:
  3300. @example
  3301. local @r{use the tree in which the capture block is located}
  3302. global @r{make a global view, including all headings in the file}
  3303. "label" @r{call column view in the tree that has and @code{:ID:}}
  3304. @r{property with the value @i{label}}
  3305. @end example
  3306. @item :hlines
  3307. When @code{t}, insert a hline after every line. When a number N, insert
  3308. a hline before each headline with level @code{<= N}.
  3309. @item :vlines
  3310. When set to @code{t}, enforce column groups to get vertical lines.
  3311. @end table
  3312. @noindent
  3313. The following commands insert or update the dynamic block:
  3314. @table @kbd
  3315. @kindex C-c C-x r
  3316. @item C-c C-x r
  3317. Insert a dynamic block capturing a column view. You will be prompted
  3318. for the scope or id of the view.
  3319. @kindex C-c C-c
  3320. @item C-c C-c
  3321. @kindex C-c C-x C-u
  3322. @itemx C-c C-x C-u
  3323. Update dynamical block at point. The cursor needs to be in the
  3324. @code{#+BEGIN} line of the dynamic block.
  3325. @kindex C-u C-c C-x C-u
  3326. @item C-u C-c C-x C-u
  3327. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  3328. you have several clocktable blocks in a buffer.
  3329. @end table
  3330. @node Property API, , Column view, Properties and columns
  3331. @section The Property API
  3332. @cindex properties, API
  3333. @cindex API, for properties
  3334. There is a full API for accessing and changing properties. This API can
  3335. be used by Emacs Lisp programs to work with properties and to implement
  3336. features based on them. For more information see @ref{Using the
  3337. property API}.
  3338. @node Dates and times, Remember, Properties and columns, Top
  3339. @chapter Dates and Times
  3340. @cindex dates
  3341. @cindex times
  3342. @cindex time stamps
  3343. @cindex date stamps
  3344. To assist project planning, TODO items can be labeled with a date and/or
  3345. a time. The specially formatted string carrying the date and time
  3346. information is called a @emph{timestamp} in Org-mode. This may be a
  3347. little confusing because timestamp is often used as indicating when
  3348. something was created or last changed. However, in Org-mode this term
  3349. is used in a much wider sense.
  3350. @menu
  3351. * Time stamps:: Assigning a time to a tree entry
  3352. * Creating timestamps:: Commands which insert timestamps
  3353. * Deadlines and scheduling:: Planning your work
  3354. * Clocking work time::
  3355. @end menu
  3356. @node Time stamps, Creating timestamps, Dates and times, Dates and times
  3357. @section Time stamps, deadlines and scheduling
  3358. @cindex time stamps
  3359. @cindex ranges, time
  3360. @cindex date stamps
  3361. @cindex deadlines
  3362. @cindex scheduling
  3363. A time stamp is a specification of a date (possibly with time or a range
  3364. of times) in a special format, either @samp{<2003-09-16 Tue>} or
  3365. @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
  3366. 12:00-12:30>}@footnote{This is the standard ISO date/time format. To
  3367. use an alternative format, see @ref{Custom time format}.}. A time stamp
  3368. can appear anywhere in the headline or body of an org-tree entry. Its
  3369. presence causes entries to be shown on specific dates in the agenda
  3370. (@pxref{Weekly/Daily agenda}). We distinguish:
  3371. @table @var
  3372. @item Plain time stamp; Event; Appointment
  3373. @cindex timestamp
  3374. A simple time stamp just assigns a date/time to an item. This is just
  3375. like writing down an appointment or event in a paper agenda. In the
  3376. timeline and agenda displays, the headline of an entry associated with a
  3377. plain time stamp will be shown exactly on that date.
  3378. @example
  3379. * Meet Peter at the movies <2006-11-01 Wed 19:15>
  3380. * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
  3381. @end example
  3382. @item Time stamp with repeater interval
  3383. @cindex timestamp, with repeater interval
  3384. A time stamp may contain a @emph{repeater interval}, indicating that it
  3385. applies not only on the given date, but again and again after a certain
  3386. interval of N days (d), weeks (w), months(m), or years(y). The
  3387. following will show up in the agenda every Wednesday:
  3388. @example
  3389. * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
  3390. @end example
  3391. @item Diary-style sexp entries
  3392. For more complex date specifications, Org-mode supports using the
  3393. special sexp diary entries implemented in the Emacs calendar/diary
  3394. package. For example
  3395. @example
  3396. * The nerd meeting on every 2nd Thursday of the month
  3397. <%%(diary-float t 4 2)>
  3398. @end example
  3399. @item Time/Date range
  3400. @cindex timerange
  3401. @cindex date range
  3402. Two time stamps connected by @samp{--} denote a range. The headline
  3403. will be shown on the first and last day of the range, and on any dates
  3404. that are displayed and fall in the range. Here is an example:
  3405. @example
  3406. ** Meeting in Amsterdam
  3407. <2004-08-23 Mon>--<2004-08-26 Thu>
  3408. @end example
  3409. @item Inactive time stamp
  3410. @cindex timestamp, inactive
  3411. @cindex inactive timestamp
  3412. Just like a plain time stamp, but with square brackets instead of
  3413. angular ones. These time stamps are inactive in the sense that they do
  3414. @emph{not} trigger an entry to show up in the agenda.
  3415. @example
  3416. * Gillian comes late for the fifth time [2006-11-01 Wed]
  3417. @end example
  3418. @end table
  3419. @node Creating timestamps, Deadlines and scheduling, Time stamps, Dates and times
  3420. @section Creating timestamps
  3421. @cindex creating timestamps
  3422. @cindex timestamps, creating
  3423. For Org-mode to recognize time stamps, they need to be in the specific
  3424. format. All commands listed below produce time stamps in the correct
  3425. format.
  3426. @table @kbd
  3427. @kindex C-c .
  3428. @item C-c .
  3429. Prompt for a date and insert a corresponding time stamp. When the
  3430. cursor is at a previously used time stamp, it is updated to NOW. When
  3431. this command is used twice in succession, a time range is inserted.
  3432. @c
  3433. @kindex C-u C-c .
  3434. @item C-u C-c .
  3435. Like @kbd{C-c .}, but use the alternative format which contains date
  3436. and time. The default time can be rounded to multiples of 5 minutes,
  3437. see the option @code{org-time-stamp-rounding-minutes}.
  3438. @c
  3439. @kindex C-c !
  3440. @item C-c !
  3441. Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
  3442. an agenda entry.
  3443. @c
  3444. @kindex C-c <
  3445. @item C-c <
  3446. Insert a time stamp corresponding to the cursor date in the Calendar.
  3447. @c
  3448. @kindex C-c >
  3449. @item C-c >
  3450. Access the Emacs calendar for the current date. If there is a
  3451. timestamp in the current line, goto the corresponding date
  3452. instead.
  3453. @c
  3454. @kindex C-c C-o
  3455. @item C-c C-o
  3456. Access the agenda for the date given by the time stamp or -range at
  3457. point (@pxref{Weekly/Daily agenda}).
  3458. @c
  3459. @kindex S-@key{left}
  3460. @kindex S-@key{right}
  3461. @item S-@key{left}
  3462. @itemx S-@key{right}
  3463. Change date at cursor by one day. These key bindings conflict with
  3464. CUA-mode (@pxref{Conflicts}).
  3465. @c
  3466. @kindex S-@key{up}
  3467. @kindex S-@key{down}
  3468. @item S-@key{up}
  3469. @itemx S-@key{down}
  3470. Change the item under the cursor in a timestamp. The cursor can be on a
  3471. year, month, day, hour or minute. Note that if the cursor is in a
  3472. headline and not at a time stamp, these same keys modify the priority of
  3473. an item. (@pxref{Priorities}). The key bindings also conflict with
  3474. CUA-mode (@pxref{Conflicts}).
  3475. @c
  3476. @kindex C-c C-y
  3477. @cindex evaluate time range
  3478. @item C-c C-y
  3479. Evaluate a time range by computing the difference between start and
  3480. end. With prefix arg, insert result after the time range (in a table:
  3481. into the following column).
  3482. @end table
  3483. @menu
  3484. * The date/time prompt:: How org-mode helps you entering date and time
  3485. * Custom time format:: Making dates look differently
  3486. @end menu
  3487. @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
  3488. @subsection The date/time prompt
  3489. @cindex date, reading in minibuffer
  3490. @cindex time, reading in minibuffer
  3491. When Org-mode prompts for a date/time, the default is shown as an ISO
  3492. date, and the prompt therefore seems to ask for an ISO date. But it
  3493. will in fact accept any string containing some date and/or time
  3494. information, and it is really smart about interpreting your input. You
  3495. can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
  3496. copied from an email message. Org-mode will find whatever information
  3497. is in there and derive anything you have not specified from the
  3498. @emph{default date and time}. The default is usually the current date
  3499. and time, but when modifying an existing time stamp, or when entering
  3500. the second stamp of a range, it is taken from the stamp in the buffer.
  3501. When filling in information, Org-mode assumes that most of the time you
  3502. will want to enter a date in the future: If you omit the month/year and
  3503. the given day/month is @i{before} today, it will assume that you mean a
  3504. future date@footnote{See the variable
  3505. @code{org-read-date-prefer-future}.}.
  3506. For example, lets assume that today is @b{June 13, 2006}. Here is how
  3507. various inputs will be interpreted, the items filled in by Org-mode are
  3508. in @b{bold}.
  3509. @example
  3510. 3-2-5 --> 2003-02-05
  3511. 14 --> @b{2006}-@b{06}-14
  3512. 12 --> @b{2006}-@b{07}-12
  3513. Fri --> nearest Friday (defaultdate or later)
  3514. sep 15 --> @b{2006}-11-15
  3515. feb 15 --> @b{2007}-02-15
  3516. sep 12 9 --> 2009-09-12
  3517. 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
  3518. 22 sept 0:34 --> @b{2006}-09-22 0:34
  3519. @end example
  3520. Furthermore you can specify a relative date by giving, as the
  3521. @emph{first} thing in the input: a plus/minus sign, a number and a
  3522. letter [dwmy] to indicate change in days weeks, months, years. With a
  3523. single plus or minus, the date is always relative to today. With a
  3524. double plus or minus, it is relative to the default date. If instead of
  3525. a single letter, you use the abbreviation of day name, the date will be
  3526. the nth such day. E.g.
  3527. @example
  3528. +4d --> four days from today
  3529. +4 --> same as above
  3530. +2w --> two weeks from today
  3531. ++5 --> five days from default date
  3532. +2tue --> second tuesday from now.
  3533. @end example
  3534. The function understands English month and weekday abbreviations. If
  3535. you want to use unabbreviated names and/or other languages, configure
  3536. the variables @code{parse-time-months} and @code{parse-time-weekdays}.
  3537. @cindex calendar, for selecting date
  3538. Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
  3539. you don't need/want the calendar, configure the variable
  3540. @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
  3541. prompt, either by clicking on a date in the calendar, or by pressing
  3542. @key{RET}, the date selected in the calendar will be combined with the
  3543. information entered at the prompt. You can control the calendar fully
  3544. from the minibuffer:
  3545. @kindex <
  3546. @kindex >
  3547. @kindex mouse-1
  3548. @kindex S-@key{right}
  3549. @kindex S-@key{left}
  3550. @kindex S-@key{down}
  3551. @kindex S-@key{up}
  3552. @kindex M-S-@key{right}
  3553. @kindex M-S-@key{left}
  3554. @kindex @key{RET}
  3555. @example
  3556. > / < @r{Scroll calendar forward/backward by one month.}
  3557. mouse-1 @r{Select date by clicking on it.}
  3558. S-@key{right}/@key{left} @r{One day forward/backward.}
  3559. S-@key{down}/@key{up} @r{One week forward/backward.}
  3560. M-S-@key{right}/@key{left} @r{One month forward/backward.}
  3561. @key{RET} @r{Choose date in calendar.}
  3562. @end example
  3563. The actions of the date/time prompt may seem complex, but I asure you
  3564. they will grow on you. To help you understand what is going on, the
  3565. current interpretation of your input will be displayed live in the
  3566. minibuffer@footnote{If you find this distracting, turn the display of
  3567. with @code{org-read-date-display-live}.}.
  3568. @node Custom time format, , The date/time prompt, Creating timestamps
  3569. @subsection Custom time format
  3570. @cindex custom date/time format
  3571. @cindex time format, custom
  3572. @cindex date format, custom
  3573. Org-mode uses the standard ISO notation for dates and times as it is
  3574. defined in ISO 8601. If you cannot get used to this and require another
  3575. representation of date and time to keep you happy, you can get it by
  3576. customizing the variables @code{org-display-custom-times} and
  3577. @code{org-time-stamp-custom-formats}.
  3578. @table @kbd
  3579. @kindex C-c C-x C-t
  3580. @item C-c C-x C-t
  3581. Toggle the display of custom formats for dates and times.
  3582. @end table
  3583. @noindent
  3584. Org-mode needs the default format for scanning, so the custom date/time
  3585. format does not @emph{replace} the default format - instead it is put
  3586. @emph{over} the default format using text properties. This has the
  3587. following consequences:
  3588. @itemize @bullet
  3589. @item
  3590. You cannot place the cursor onto a time stamp anymore, only before or
  3591. after.
  3592. @item
  3593. The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
  3594. each component of a time stamp. If the cursor is at the beginning of
  3595. the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
  3596. just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
  3597. time will be changed by one minute.
  3598. @item
  3599. If the time stamp contains a range of clock times or a repeater, these
  3600. will not be overlayed, but remain in the buffer as they were.
  3601. @item
  3602. When you delete a time stamp character-by-character, it will only
  3603. disappear from the buffer after @emph{all} (invisible) characters
  3604. belonging to the ISO timestamp have been removed.
  3605. @item
  3606. If the custom time stamp format is longer than the default and you are
  3607. using dates in tables, table alignment will be messed up. If the custom
  3608. format is shorter, things do work as expected.
  3609. @end itemize
  3610. @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and times
  3611. @section Deadlines and Scheduling
  3612. A time stamp may be preceded by special keywords to facilitate planning:
  3613. @table @var
  3614. @item DEADLINE
  3615. @cindex DEADLINE keyword
  3616. Meaning: the task (most likely a TODO item, though not necessarily) is supposed
  3617. to be finished on that date.
  3618. On the deadline date, the task will be listed in the agenda. In
  3619. addition, the agenda for @emph{today} will carry a warning about the
  3620. approaching or missed deadline, starting
  3621. @code{org-deadline-warning-days} before the due date, and continuing
  3622. until the entry is marked DONE. An example:
  3623. @example
  3624. *** TODO write article about the Earth for the Guide
  3625. The editor in charge is [[bbdb:Ford Prefect]]
  3626. DEADLINE: <2004-02-29 Sun>
  3627. @end example
  3628. You can specify a different lead time for warnings for a specific
  3629. deadlines using the following syntax. Here is an example with a warning
  3630. period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
  3631. @item SCHEDULED
  3632. @cindex SCHEDULED keyword
  3633. Meaning: you are planning to start working on that task on the given
  3634. date.
  3635. The headline will be listed under the given date@footnote{It will still
  3636. be listed on that date after it has been marked DONE. If you don't like
  3637. this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
  3638. addition, a reminder that the scheduled date has passed will be present
  3639. in the compilation for @emph{today}, until the entry is marked DONE.
  3640. I.e., the task will automatically be forwarded until completed.
  3641. @example
  3642. *** TODO Call Trillian for a date on New Years Eve.
  3643. SCHEDULED: <2004-12-25 Sat>
  3644. @end example
  3645. @noindent
  3646. @b{Important:} Scheduling an item in Org-mode should @i{not} be
  3647. understood in the same way that we understand @i{scheduling a meeting}.
  3648. Setting a date for a meeting is just a simple appointment, you should
  3649. mark this entry with a simple plain time stamp, to get this item shown
  3650. on the date where it applies. This is a frequent mis-understanding from
  3651. Org-users. In Org-mode, @i{scheduling} means setting a date when you
  3652. want to start working on an action item.
  3653. @end table
  3654. You may use time stamps with repeaters in scheduling and deadline
  3655. entries. Org-mode will issue early and late warnings based on the
  3656. assumption that the time stamp represents the @i{nearest instance} of
  3657. the repeater. However, the use of diary sexp entries like
  3658. @c
  3659. @code{<%%(diary-float t 42)>}
  3660. @c
  3661. in scheduling and deadline timestamps is limited. Org-mode does not
  3662. know enough about the internals of each sexp function to issue early and
  3663. late warnings. However, it will show the item on each day where the
  3664. sexp entry matches.
  3665. @menu
  3666. * Inserting deadline/schedule:: Planning items
  3667. * Repeated tasks:: Items that show up again and again
  3668. @end menu
  3669. @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
  3670. @subsection Inserting deadline/schedule
  3671. The following commands allow to quickly insert a deadline or to schedule
  3672. an item:
  3673. @table @kbd
  3674. @c
  3675. @kindex C-c C-d
  3676. @item C-c C-d
  3677. Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
  3678. happen in the line directly following the headline. When called with a
  3679. prefix arg, an existing deadline will be removed from the entry.
  3680. @c FIXME Any CLOSED timestamp will be removed.????????
  3681. @c
  3682. @kindex C-c / d
  3683. @cindex sparse tree, for deadlines
  3684. @item C-c / d
  3685. Create a sparse tree with all deadlines that are either past-due, or
  3686. which will become due within @code{org-deadline-warning-days}.
  3687. With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
  3688. prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
  3689. all deadlines due tomorrow.
  3690. @c
  3691. @kindex C-c C-s
  3692. @item C-c C-s
  3693. Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
  3694. happen in the line directly following the headline. Any CLOSED
  3695. timestamp will be removed. When called with a prefix argument, remove
  3696. the scheduling date from the entry.
  3697. @end table
  3698. @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
  3699. @subsection Repeated Tasks
  3700. Some tasks need to be repeated again and again. Org-mode helps to
  3701. organize such tasks using a so-called repeater in a DEADLINE or
  3702. SCHEDULED time stamp. In the following example
  3703. @example
  3704. ** TODO Pay the rent
  3705. DEADLINE: <2005-10-01 Sat +1m>
  3706. @end example
  3707. the @code{+1m} is a repeater; the intended interpretation is that the
  3708. task has a deadline on <2005-10-01> and repeats itself every (one) month
  3709. starting from that time.
  3710. Deadlines and scheduled items produce entries in the agenda when they
  3711. are over-due, so it is important to be able to mark such an entry as
  3712. completed once you have done so. When you mark a DEADLINE or a SCHEDULE
  3713. with the todo keyword DONE, it will no longer produce entries in the
  3714. agenda. The problem with this is, however, that then also the
  3715. @emph{next} instance of the repeated entry will not be active. Org-mode
  3716. deals with this in the following way: When you try to mark such an entry
  3717. DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
  3718. time stamp by the repeater interval, and immediately set the entry state
  3719. back to TODO. In the example above, setting the state to DONE would
  3720. actually switch the date like this:
  3721. @example
  3722. ** TODO Pay the rent
  3723. DEADLINE: <2005-11-01 Tue +1m>
  3724. @end example
  3725. You will also be prompted for a note@footnote{You can change this using
  3726. the option @code{org-log-repeat}, or the @code{#+STARTUP} options
  3727. @code{logrepeat} and @code{nologrepeat}.} that will be put under the
  3728. DEADLINE line to keep a record that you actually acted on the previous
  3729. instance of this deadline.
  3730. As a consequence of shifting the base date, this entry will no longer be
  3731. visible in the agenda when checking past dates, but all future instances
  3732. will be visible.
  3733. You may have both scheduling and deadline information for a specific
  3734. task - just make sure that the repeater intervals on both are the same.
  3735. @node Clocking work time, , Deadlines and scheduling, Dates and times
  3736. @section Clocking work time
  3737. Org-mode allows you to clock the time you spent on specific tasks in a
  3738. project. When you start working on an item, you can start the clock.
  3739. When you stop working on that task, or when you mark the task done, the
  3740. clock is stopped and the corresponding time interval is recorded. It
  3741. also computes the total time spent on each subtree of a project.
  3742. @table @kbd
  3743. @kindex C-c C-x C-i
  3744. @item C-c C-x C-i
  3745. Start the clock on the current item (clock-in). This inserts the CLOCK
  3746. keyword together with a timestamp. If this is not the first clocking of
  3747. this item, the multiple CLOCK lines will be wrapped into a
  3748. @code{:CLOCK:} drawer (see also the variable
  3749. @code{org-clock-into-drawer}.
  3750. @kindex C-c C-x C-o
  3751. @item C-c C-x C-o
  3752. Stop the clock (clock-out). The inserts another timestamp at the same
  3753. location where the clock was last started. It also directly computes
  3754. the resulting time in inserts it after the time range as @samp{=>
  3755. HH:MM}. See the variable @code{org-log-done} for the possibility to
  3756. record an additional note together with the clock-out time
  3757. stamp@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
  3758. lognoteclock-out}}.
  3759. @kindex C-c C-y
  3760. @item C-c C-y
  3761. Recompute the time interval after changing one of the time stamps. This
  3762. is only necessary if you edit the time stamps directly. If you change
  3763. them with @kbd{S-@key{cursor}} keys, the update is automatic.
  3764. @kindex C-c C-t
  3765. @item C-c C-t
  3766. Changing the TODO state of an item to DONE automatically stops the clock
  3767. if it is running in this same item.
  3768. @kindex C-c C-x C-x
  3769. @item C-c C-x C-x
  3770. Cancel the current clock. This is useful if a clock was started by
  3771. mistake, or if you ended up working on something else.
  3772. @kindex C-c C-x C-j
  3773. @item C-c C-x C-j
  3774. Jump to the entry that contains the currently running clock, an another
  3775. window.
  3776. @kindex C-c C-x C-d
  3777. @item C-c C-x C-d
  3778. Display time summaries for each subtree in the current buffer. This
  3779. puts overlays at the end of each headline, showing the total time
  3780. recorded under that heading, including the time of any subheadings. You
  3781. can use visibility cycling to study the tree, but the overlays disappear
  3782. when you change the buffer (see variable
  3783. @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
  3784. @kindex C-c C-x C-r
  3785. @item C-c C-x C-r
  3786. Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
  3787. report as an org-mode table into the current file. When the cursor is
  3788. at an existing clock table, just update it. When called with a prefix
  3789. argument, jump to the first clock report in the current document and
  3790. update it.
  3791. @example
  3792. #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
  3793. #+END: clocktable
  3794. @end example
  3795. @noindent
  3796. If such a block already exists at point, its content is replaced by the
  3797. new table. The @samp{BEGIN} line can specify options:
  3798. @example
  3799. :maxlevel @r{Maximum level depth to which times are listed in the table.}
  3800. :emphasize @r{When @code{t}, emphasize level one and level two items}
  3801. :scope @r{The scope to consider. This can be any of the following:}
  3802. nil @r{the current buffer or narrowed region}
  3803. file @r{the full current buffer}
  3804. subtree @r{the subtree where the clocktable is located}
  3805. treeN @r{the surrounding level N tree, for example @code{tree3}}
  3806. tree @r{the surrounding level 1 tree}
  3807. agenda @r{all agenda files}
  3808. ("file"..) @r{scan these files}
  3809. :block @r{The time block to consider. This block is specified relative}
  3810. @r{to the current time and may be any of these keywords:}
  3811. @r{@code{today}, @code{yesterday}, @code{thisweek}, @code{lastweek},}
  3812. @r{@code{thismonth}, @code{lastmonth}, @code{thisyear}, or @code{lastyear}}.
  3813. :tstart @r{A time string specifying when to start considering times}
  3814. :tend @r{A time string specifying when to stop considering times}
  3815. @end example
  3816. So to get a clock summary of the current level 1 tree, for the current
  3817. day, you could write
  3818. @example
  3819. #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1
  3820. #+END: clocktable
  3821. @end example
  3822. and to use a specific time range you could write@footnote{Note that all
  3823. parameters must be specified in a single line - the line is broken here
  3824. only to fit it onto the manual.}
  3825. @example
  3826. #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
  3827. :tend "<2006-08-10 Thu 12:00>"
  3828. #+END: clocktable
  3829. @end example
  3830. @kindex C-c C-c
  3831. @item C-c C-c
  3832. @kindex C-c C-x C-u
  3833. @itemx C-c C-x C-u
  3834. Update dynamical block at point. The cursor needs to be in the
  3835. @code{#+BEGIN} line of the dynamic block.
  3836. @kindex C-u C-c C-x C-u
  3837. @item C-u C-c C-x C-u
  3838. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  3839. you have several clocktable blocks in a buffer.
  3840. @end table
  3841. The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
  3842. the agenda (@pxref{Weekly/Daily agenda}) to show which tasks have been
  3843. worked on or closed during a day.
  3844. @node Remember, Agenda views, Dates and times, Top
  3845. @chapter Remember
  3846. @cindex @file{remember.el}
  3847. The @i{Remember} package by John Wiegley lets you store quick notes with
  3848. little interruption of your work flow. See
  3849. @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
  3850. information. It is an excellent way to add new notes and tasks to
  3851. Org-mode files. Org-mode significantly expands the possibilities of
  3852. @i{remember}: You may define templates for different note types, and
  3853. associate target files and headlines with specific templates. It also
  3854. allows you to select the location where a note should be stored
  3855. interactively, on the fly.
  3856. @menu
  3857. * Setting up remember:: Some code for .emacs to get things going
  3858. * Remember templates:: Define the outline of different note types
  3859. * Storing notes:: Directly get the note to where it belongs
  3860. * Refiling notes:: Moving a note or task to a project
  3861. @end menu
  3862. @node Setting up remember, Remember templates, Remember, Remember
  3863. @section Setting up remember
  3864. The following customization will tell @i{remember} to use org files as
  3865. target, and to create annotations compatible with Org-mode links.
  3866. @example
  3867. (org-remember-insinuate)
  3868. (setq org-directory "~/path/to/my/orgfiles/")
  3869. (setq org-default-notes-file (concat org-directory "/notes.org"))
  3870. (define-key global-map "\C-cr" 'org-remember)
  3871. @end example
  3872. The last line binds the command @code{org-remember} to a global
  3873. key@footnote{Please select your own key, @kbd{C-c r} is only a
  3874. suggestion.}. @code{org-remember} basically just calls @code{remember},
  3875. but it makes a few things easier: If there is an active region, it will
  3876. automatically copy the region into the remember buffer. It also allows
  3877. to jump to the buffer and location where remember notes are being
  3878. stored: Just call @code{org-remember} with a prefix argument.
  3879. @node Remember templates, Storing notes, Setting up remember, Remember
  3880. @section Remember templates
  3881. @cindex templates, for remember
  3882. In combination with Org-mode, you can use templates to generate
  3883. different types of @i{remember} notes. For example, if you would like
  3884. to use one template to create general TODO entries, another one for
  3885. journal entries, and a third one for collecting random ideas, you could
  3886. use:
  3887. @example
  3888. (setq org-remember-templates
  3889. '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
  3890. ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
  3891. ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
  3892. @end example
  3893. @noindent In these entries, the first string is just a name, and the
  3894. character specifies how to select the template. It is useful if the
  3895. character is also the first letter of the name. The next string
  3896. specifies the template. Two more (optional) strings give the file in
  3897. which, and the headline under which the new note should be stored. The
  3898. file (if not present or @code{nil}) defaults to
  3899. @code{org-default-notes-file}, the heading to
  3900. @code{org-remember-default-headline}.
  3901. When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remember
  3902. something, org will prompt for a key to select the template (if you have
  3903. more than one template) and then prepare the buffer like
  3904. @example
  3905. * TODO
  3906. [[file:link to where you called remember]]
  3907. @end example
  3908. @noindent
  3909. During expansion of the template, special @kbd{%}-escapes allow dynamic
  3910. insertion of content:
  3911. @example
  3912. %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.}
  3913. @r{You may specify a default value and a completion table with}
  3914. @r{%^@{prompt|default|completion2|completion3...@}}
  3915. @r{The arrow keys access a prompt-specific history.}
  3916. %t @r{time stamp, date only}
  3917. %T @r{time stamp with date and time}
  3918. %u, %U @r{like the above, but inactive time stamps}
  3919. %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
  3920. @r{You may define a prompt like @code{%^@{Birthday@}t}}
  3921. %n @r{user name (taken from @code{user-full-name})}
  3922. %a @r{annotation, normally the link created with @code{org-store-link}}
  3923. %A @r{like @code{%a}, but prompt for the description part}
  3924. %i @r{initial content, the region when remember is called with C-u.}
  3925. @r{The entire text will be indented like @code{%i} itself.}
  3926. %c @r{Content of the clipboard, or current kill ring head.}
  3927. %^g @r{prompt for tags, with completion on tags in target file.}
  3928. %^G @r{prompt for tags, with completion all tags in all agenda files.}
  3929. %:keyword @r{specific information for certain link types, see below}
  3930. %[pathname] @r{insert the contents of the file given by @code{pathname}}
  3931. %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result}
  3932. %! @r{immediately store note after completing the template}
  3933. @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
  3934. @end example
  3935. @noindent
  3936. For specific link types, the following keywords will be
  3937. defined@footnote{If you define your own link types (@pxref{Adding
  3938. hyperlink types}), any property you store with
  3939. @code{org-store-link-props} can be accessed in remember templates in a
  3940. similar way.}:
  3941. @example
  3942. Link type | Available keywords
  3943. -------------------+----------------------------------------------
  3944. bbdb | %:name %:company
  3945. vm, wl, mh, rmail | %:type %:subject %:message-id
  3946. | %:from %:fromname %:fromaddress
  3947. | %:to %:toname %:toaddress
  3948. | %: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}.}}
  3949. gnus | %:group, @r{for messages also all email fields}
  3950. w3, w3m | %:url
  3951. info | %:file %:node
  3952. calendar | %:date"
  3953. @end example
  3954. @noindent
  3955. To place the cursor after template expansion use:
  3956. @example
  3957. %? @r{After completing the template, position cursor here.}
  3958. @end example
  3959. @noindent
  3960. If you change you mind about which template to use, call
  3961. @code{org-remember} in the remember buffer. You may then select a new
  3962. template that will be filled with the previous context information.
  3963. @node Storing notes, Refiling notes, Remember templates, Remember
  3964. @section Storing notes
  3965. When you are finished preparing a note with @i{remember}, you have to
  3966. press @kbd{C-c C-c} to file the note away. The handler will store the
  3967. note in the file and under the headline specified in the template, or it
  3968. will use the default file and headlines. The window configuration will
  3969. be restored, sending you back to the working context before the call to
  3970. @code{remember}. To re-use the location found during the last call to
  3971. @code{remember}, exit the remember buffer with @kbd{C-u C-u C-c C-c},
  3972. i.e. specify a double prefix argument to @kbd{C-c C-c}.
  3973. If you want to store the note directly to a different place, use
  3974. @kbd{C-u C-c C-c} instead to exit remember@footnote{Configure the
  3975. variable @code{org-remember-store-without-prompt} to make this behavior
  3976. the default.}. The handler will then first prompt for a target file -
  3977. if you press @key{RET}, the value specified for the template is used.
  3978. Then the command offers the headings tree of the selected file, with the
  3979. cursor position at the default headline (if you had specified one in the
  3980. template). You can either immediately press @key{RET} to get the note
  3981. placed there. Or you can use the following keys to find a different
  3982. location:
  3983. @example
  3984. @key{TAB} @r{Cycle visibility.}
  3985. @key{down} / @key{up} @r{Next/previous visible headline.}
  3986. n / p @r{Next/previous visible headline.}
  3987. f / b @r{Next/previous headline same level.}
  3988. u @r{One level up.}
  3989. @c 0-9 @r{Digit argument.}
  3990. @end example
  3991. @noindent
  3992. Pressing @key{RET} or @key{left} or @key{right}
  3993. then leads to the following result.
  3994. @multitable @columnfractions 0.2 0.15 0.65
  3995. @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
  3996. @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
  3997. @item @tab @tab depending on @code{org-reverse-note-order}.
  3998. @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
  3999. @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
  4000. @item @tab @tab depending on @code{org-reverse-note-order}.
  4001. @item not on headline @tab @key{RET}
  4002. @tab at cursor position, level taken from context.
  4003. @end multitable
  4004. Before inserting the text into a tree, the function ensures that the
  4005. text has a headline, i.e. a first line that starts with a @samp{*}. If
  4006. not, a headline is constructed from the current date and some additional
  4007. data. If you have indented the text of the note below the headline, the
  4008. indentation will be adapted if inserting the note into the tree requires
  4009. demotion from level 1.
  4010. @node Refiling notes, , Storing notes, Remember
  4011. @section Refiling notes
  4012. @cindex refiling notes
  4013. Remember is usually used to quickly capture notes and tasks into one or
  4014. a few capture lists. When reviewing the captured data, you may want to
  4015. refile some of the entries into a different list, for example into a
  4016. project. Cutting, finding the right location and then pasting the note
  4017. is cumbersome. To simplify this process, you can use the following
  4018. special command:
  4019. @table @kbd
  4020. @kindex C-c C-w
  4021. @item C-c C-w
  4022. Refile the entry at point. This command offers possible locations for
  4023. refiling the entry and lets you select one with completion. The item is
  4024. filed below the target heading as a subitem. Depending on
  4025. @code{org-reverse-note-order}, it will be either the first of last
  4026. subitem, and you can toggle the value of this variable for the duration
  4027. of the command by using a @kbd{C-u} prefix.@* By default, all level 1
  4028. headlines in the current buffer are considered to be targets, but you
  4029. can have more complex definitions across a number of files. See the
  4030. variable @code{org-refile-targets} for details. The list of targets is
  4031. compiled upon first use, you can update it by using a double prefix
  4032. argument (@kbd{C-u C-u}) to this command.
  4033. @end table
  4034. @node Agenda views, Embedded LaTeX, Remember, Top
  4035. @chapter Agenda Views
  4036. @cindex agenda views
  4037. Due to the way Org-mode works, TODO items, time-stamped items, and
  4038. tagged headlines can be scattered throughout a file or even a number of
  4039. files. To get an overview of open action items, or of events that are
  4040. important for a particular date, this information must be collected,
  4041. sorted and displayed in an organized way.
  4042. Org-mode can select items based on various criteria, and display them
  4043. in a separate buffer. Six different view types are provided:
  4044. @itemize @bullet
  4045. @item
  4046. an @emph{agenda} that is like a calendar and shows information
  4047. for specific dates,
  4048. @item
  4049. a @emph{TODO list} that covers all unfinished
  4050. action items,
  4051. @item
  4052. a @emph{tags view}, showings headlines based on
  4053. the tags associated with them,
  4054. @item
  4055. a @emph{timeline view} that shows all events in a single Org-mode file,
  4056. in time-sorted view,
  4057. @item
  4058. a @emph{stuck projects view} showing projects that currently don't move
  4059. along, and
  4060. @item
  4061. @emph{custom views} that are special tag/keyword searches and
  4062. combinations of different views.
  4063. @end itemize
  4064. @noindent
  4065. The extracted information is displayed in a special @emph{agenda
  4066. buffer}. This buffer is read-only, but provides commands to visit the
  4067. corresponding locations in the original Org-mode files, and even to
  4068. edit these files remotely.
  4069. Two variables control how the agenda buffer is displayed and whether the
  4070. window configuration is restored when the agenda exits:
  4071. @code{org-agenda-window-setup} and
  4072. @code{org-agenda-restore-windows-after-quit}.
  4073. @menu
  4074. * Agenda files:: Files being searched for agenda information
  4075. * Agenda dispatcher:: Keyboard access to agenda views
  4076. * Built-in agenda views:: What is available out of the box?
  4077. * Presentation and sorting:: How agenda items are prepared for display
  4078. * Agenda commands:: Remote editing of org trees
  4079. * Custom agenda views:: Defining special searches and views
  4080. @end menu
  4081. @node Agenda files, Agenda dispatcher, Agenda views, Agenda views
  4082. @section Agenda files
  4083. @cindex agenda files
  4084. @cindex files for agenda
  4085. The information to be shown is normally collected from all @emph{agenda
  4086. files}, the files listed in the variable
  4087. @code{org-agenda-files}@footnote{If the value of that variable is not a
  4088. list, but a single file name, then the list of agenda files will be
  4089. maintained in that external file.}. If a directory is part of this list,
  4090. all files with the extension @file{.org} in this directory will be part
  4091. of the list.
  4092. Thus even if you only work with a single Org-mode file, this file should
  4093. be put into that list@footnote{When using the dispatcher, pressing
  4094. @kbd{<} before selecting a command will actually limit the command to
  4095. the current file, and ignore @code{org-agenda-files} until the next
  4096. dispatcher command.}. You can customize @code{org-agenda-files}, but
  4097. the easiest way to maintain it is through the following commands
  4098. @cindex files, adding to agenda list
  4099. @table @kbd
  4100. @kindex C-c [
  4101. @item C-c [
  4102. Add current file to the list of agenda files. The file is added to
  4103. the front of the list. If it was already in the list, it is moved to
  4104. the front. With prefix arg, file is added/moved to the end.
  4105. @kindex C-c ]
  4106. @item C-c ]
  4107. Remove current file from the list of agenda files.
  4108. @kindex C-,
  4109. @kindex C-'
  4110. @item C-,
  4111. @itemx C-'
  4112. Cycle through agenda file list, visiting one file after the other.
  4113. @end table
  4114. @noindent
  4115. The Org menu contains the current list of files and can be used
  4116. to visit any of them.
  4117. If you would like to focus the agenda temporarily onto a file not in
  4118. this list, or onto just one file in the list or even only a subtree in a
  4119. file, this can be done in different ways. For a single agenda command,
  4120. you may press @kbd{<} once or several times in the dispatcher
  4121. (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
  4122. extended period, use the following commands:
  4123. @table @kbd
  4124. @kindex C-c C-x <
  4125. @item C-c C-x <
  4126. Permanently restrict the agenda to the current subtree. When with a
  4127. prefix argument, or with the cursor before the first headline in a file,
  4128. the agenda scope is set to the entire file. This restriction remains in
  4129. effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
  4130. or @kbd{>} in the agenda dispatcher. If there is a window displaying an
  4131. agenda view, the new restriction takes effect immediately.
  4132. @kindex C-c C-x <
  4133. @item C-c C-x <
  4134. Remove the permanent restriction created by @kbd{C-c C-x <}.
  4135. @end table
  4136. @noindent
  4137. When working with @file{Speedbar}, you can use the following commands in
  4138. the speedbar frame:
  4139. @table @kbd
  4140. @kindex <
  4141. @item < @r{in the speedbar frame}
  4142. Permanently restrict the agenda to the item at the cursor in the
  4143. speedbar frame, either an Org-mode file or a subtree in such a file.
  4144. If there is a window displaying an agenda view, the new restriction takes
  4145. effect immediately.
  4146. @kindex <
  4147. @item > @r{in the speedbar frame}
  4148. Lift the restriction again.
  4149. @end table
  4150. @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda views
  4151. @section The agenda dispatcher
  4152. @cindex agenda dispatcher
  4153. @cindex dispatching agenda commands
  4154. The views are created through a dispatcher that should be bound to a
  4155. global key, for example @kbd{C-c a} (@pxref{Installation}). In the
  4156. following we will assume that @kbd{C-c a} is indeed how the dispatcher
  4157. is accessed and list keyboard access to commands accordingly. After
  4158. pressing @kbd{C-c a}, an additional letter is required to execute a
  4159. command. The dispatcher offers the following default commands:
  4160. @table @kbd
  4161. @item a
  4162. Create the calendar-like agenda (@pxref{Weekly/Daily agenda}).
  4163. @item t @r{/} T
  4164. Create a list of all TODO items (@pxref{Global TODO list}).
  4165. @item m @r{/} M
  4166. Create a list of headlines matching a TAGS expression (@pxref{Matching
  4167. tags and properties}).
  4168. @item L
  4169. Create the timeline view for the current buffer (@pxref{Timeline}).
  4170. @item # @r{/} !
  4171. Create a list of stuck projects (@pxref{Stuck projects}).
  4172. @item /
  4173. Search for a regular expression in all agenda files and additionally in
  4174. the files listed in @code{org-agenda-multi-occur-extra-files}. This
  4175. uses the Emacs command @code{multi-occur}. A prefix argument can be
  4176. used to specify the number of context lines for each match, default is
  4177. 1.
  4178. @item <
  4179. Restrict an agenda command to the current buffer@footnote{For backward
  4180. compatibility, you can also press @kbd{1} to restrict to the current
  4181. buffer.}. After pressing @kbd{<}, you still need to press the character
  4182. selecting the command.
  4183. @item < <
  4184. If there is an active region, restrict the following agenda command to
  4185. the region. Otherwise, restrict it to the current subtree@footnote{For
  4186. backward compatibility, you can also press @kbd{0} to restrict to the
  4187. current buffer.}. After pressing @kbd{< <}, you still need to press the
  4188. character selecting the command.
  4189. @end table
  4190. You can also define custom commands that will be accessible through the
  4191. dispatcher, just like the default commands. This includes the
  4192. possibility to create extended agenda buffers that contain several
  4193. blocks together, for example the weekly agenda, the global TODO list and
  4194. a number of special tags matches. @xref{Custom agenda views}.
  4195. @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda views
  4196. @section The built-in agenda views
  4197. In this section we describe the built-in views.
  4198. @menu
  4199. * Weekly/Daily agenda:: The calendar page with current tasks
  4200. * Global TODO list:: All unfinished action items
  4201. * Matching tags and properties:: Structured information with fine-tuned search
  4202. * Timeline:: Time-sorted view for single file
  4203. * Stuck projects:: Find projects you need to review
  4204. @end menu
  4205. @node Weekly/Daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
  4206. @subsection The weekly/daily agenda
  4207. @cindex agenda
  4208. @cindex weekly agenda
  4209. @cindex daily agenda
  4210. The purpose of the weekly/daily @emph{agenda} is to act like a page of a
  4211. paper agenda, showing all the tasks for the current week or day.
  4212. @table @kbd
  4213. @cindex org-agenda, command
  4214. @kindex C-c a a
  4215. @item C-c a a
  4216. Compile an agenda for the current week from a list of org files. The
  4217. agenda shows the entries for each day. With a numeric
  4218. prefix@footnote{For backward compatibility, the universal prefix
  4219. @kbd{C-u} causes all TODO entries to be listed before the agenda. This
  4220. feature is deprecated, use the dedicated TODO list, or a block agenda
  4221. instead.} (like @kbd{C-u 2 1 C-c a a}) you may set the number of days
  4222. to be displayed (see also the variable @code{org-agenda-ndays})
  4223. @end table
  4224. Remote editing from the agenda buffer means, for example, that you can
  4225. change the dates of deadlines and appointments from the agenda buffer.
  4226. The commands available in the Agenda buffer are listed in @ref{Agenda
  4227. commands}.
  4228. @subsubheading Calendar/Diary integration
  4229. @cindex calendar integration
  4230. @cindex diary integration
  4231. Emacs contains the calendar and diary by Edward M. Reingold. The
  4232. calendar displays a three-month calendar with holidays from different
  4233. countries and cultures. The diary allows you to keep track of
  4234. anniversaries, lunar phases, sunrise/set, recurrent appointments
  4235. (weekly, monthly) and more. In this way, it is quite complementary to
  4236. Org-mode. It can be very useful to combine output from Org-mode with
  4237. the diary.
  4238. In order to include entries from the Emacs diary into Org-mode's
  4239. agenda, you only need to customize the variable
  4240. @lisp
  4241. (setq org-agenda-include-diary t)
  4242. @end lisp
  4243. @noindent After that, everything will happen automatically. All diary
  4244. entries including holidays, anniversaries etc will be included in the
  4245. agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
  4246. @key{RET} can be used from the agenda buffer to jump to the diary
  4247. file in order to edit existing diary entries. The @kbd{i} command to
  4248. insert new entries for the current date works in the agenda buffer, as
  4249. well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
  4250. Sunrise/Sunset times, show lunar phases and to convert to other
  4251. calendars, respectively. @kbd{c} can be used to switch back and forth
  4252. between calendar and agenda.
  4253. If you are using the diary only for sexp entries and holidays, it is
  4254. faster to not use the above setting, but instead to copy or even move
  4255. the entries into an Org-mode file. Org-mode evaluates diary-style sexp
  4256. entries, and does it faster because there is no overhead for first
  4257. creating the diary display. Note that the sexp entries must start at
  4258. the left margin, no white space is allowed before them. For example,
  4259. the following segment of an Org-mode file will be processed and entries
  4260. will be made in the agenda:
  4261. @example
  4262. * Birthdays and similar stuff
  4263. #+CATEGORY: Holiday
  4264. %%(org-calendar-holiday) ; special function for holiday names
  4265. #+CATEGORY: Ann
  4266. %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
  4267. %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
  4268. @end example
  4269. @subsubheading Appointment reminders
  4270. @cindex @file{appt.el}
  4271. @cindex appointment reminders
  4272. Org can interact with Emacs appointments notification facility.
  4273. To add all the appointments of your agenda files, use the command
  4274. @code{org-agenda-to-appt}. This commands also lets you filter through
  4275. the list of your appointments and add only those belonging to a specific
  4276. category or matching a regular expression. See the docstring for
  4277. details.
  4278. @node Global TODO list, Matching tags and properties, Weekly/Daily agenda, Built-in agenda views
  4279. @subsection The global TODO list
  4280. @cindex global TODO list
  4281. @cindex TODO list, global
  4282. The global TODO list contains all unfinished TODO items, formatted and
  4283. collected into a single place.
  4284. @table @kbd
  4285. @kindex C-c a t
  4286. @item C-c a t
  4287. Show the global TODO list. This collects the TODO items from all
  4288. agenda files (@pxref{Agenda views}) into a single buffer. The buffer is in
  4289. @code{agenda-mode}, so there are commands to examine and manipulate
  4290. the TODO entries directly from that buffer (@pxref{Agenda commands}).
  4291. @kindex C-c a T
  4292. @item C-c a T
  4293. @cindex TODO keyword matching
  4294. Like the above, but allows selection of a specific TODO keyword. You
  4295. can also do this by specifying a prefix argument to @kbd{C-c a t}. With
  4296. a @kbd{C-u} prefix you are prompted for a keyword, and you may also
  4297. specify several keywords by separating them with @samp{|} as boolean OR
  4298. operator. With a numeric prefix, the Nth keyword in
  4299. @code{org-todo-keywords} is selected.
  4300. @kindex r
  4301. The @kbd{r} key in the agenda buffer regenerates it, and you can give
  4302. a prefix argument to this command to change the selected TODO keyword,
  4303. for example @kbd{3 r}. If you often need a search for a specific
  4304. keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
  4305. Matching specific TODO keywords can also be done as part of a tags
  4306. search (@pxref{Tag searches}).
  4307. @end table
  4308. Remote editing of TODO items means that you can change the state of a
  4309. TODO entry with a single key press. The commands available in the
  4310. TODO list are described in @ref{Agenda commands}.
  4311. @cindex sublevels, inclusion into todo list
  4312. Normally the global todo list simply shows all headlines with TODO
  4313. keywords. This list can become very long. There are two ways to keep
  4314. it more compact:
  4315. @itemize @minus
  4316. @item
  4317. Some people view a TODO item that has been @emph{scheduled} for
  4318. execution (@pxref{Time stamps}) as no longer @emph{open}. Configure the
  4319. variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled
  4320. items from the global TODO list.
  4321. @item
  4322. TODO items may have sublevels to break up the task into subtasks. In
  4323. such cases it may be enough to list only the highest level TODO headline
  4324. and omit the sublevels from the global list. Configure the variable
  4325. @code{org-agenda-todo-list-sublevels} to get this behavior.
  4326. @end itemize
  4327. @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
  4328. @subsection Matching Tags and Properties
  4329. @cindex matching, of tags
  4330. @cindex matching, of properties
  4331. @cindex tags view
  4332. If headlines in the agenda files are marked with @emph{tags}
  4333. (@pxref{Tags}), you can select headlines based on the tags that apply
  4334. to them and collect them into an agenda buffer.
  4335. @table @kbd
  4336. @kindex C-c a m
  4337. @item C-c a m
  4338. Produce a list of all headlines that match a given set of tags. The
  4339. command prompts for a selection criterion, which is a boolean logic
  4340. expression with tags, like @samp{+work+urgent-withboss} or
  4341. @samp{work|home} (@pxref{Tags}). If you often need a specific search,
  4342. define a custom command for it (@pxref{Agenda dispatcher}).
  4343. @kindex C-c a M
  4344. @item C-c a M
  4345. Like @kbd{C-c a m}, but only select headlines that are also TODO items
  4346. and force checking subitems (see variable
  4347. @code{org-tags-match-list-sublevels}). Matching specific todo keywords
  4348. together with a tags match is also possible, see @ref{Tag searches}.
  4349. @end table
  4350. The commands available in the tags list are described in @ref{Agenda
  4351. commands}.
  4352. @node Timeline, Stuck projects, Matching tags and properties, Built-in agenda views
  4353. @subsection Timeline for a single file
  4354. @cindex timeline, single file
  4355. @cindex time-sorted view
  4356. The timeline summarizes all time-stamped items from a single Org-mode
  4357. file in a @emph{time-sorted view}. The main purpose of this command is
  4358. to give an overview over events in a project.
  4359. @table @kbd
  4360. @kindex C-c a L
  4361. @item C-c a L
  4362. Show a time-sorted view of the org file, with all time-stamped items.
  4363. When called with a @kbd{C-u} prefix, all unfinished TODO entries
  4364. (scheduled or not) are also listed under the current date.
  4365. @end table
  4366. @noindent
  4367. The commands available in the timeline buffer are listed in
  4368. @ref{Agenda commands}.
  4369. @node Stuck projects, , Timeline, Built-in agenda views
  4370. @subsection Stuck projects
  4371. If you are following a system like David Allen's GTD to organize your
  4372. work, one of the ``duties'' you have is a regular review to make sure
  4373. that all projects move along. A @emph{stuck} project is a project that
  4374. has no defined next actions, so it will never show up in the TODO lists
  4375. Org-mode produces. During the review, you need to identify such
  4376. projects and define next actions for them.
  4377. @table @kbd
  4378. @kindex C-c a #
  4379. @item C-c a #
  4380. List projects that are stuck.
  4381. @kindex C-c a !
  4382. @item C-c a !
  4383. Customize the variable @code{org-stuck-projects} to define what a stuck
  4384. project is and how to find it.
  4385. @end table
  4386. You almost certainly will have to configure this view before it will
  4387. work for you. The built-in default assumes that all your projects are
  4388. level-2 headlines, and that a project is not stuck if it has at least
  4389. one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
  4390. Lets assume that you, in your own way of using Org-mode, identify
  4391. projects with a tag PROJECT, and that you use a todo keyword MAYBE to
  4392. indicate a project that should not be considered yet. Lets further
  4393. assume that the todo keyword DONE marks finished projects, and that NEXT
  4394. and TODO indicate next actions. The tag @@SHOP indicates shopping and
  4395. is a next action even without the NEXT tag. Finally, if the project
  4396. contains the special word IGNORE anywhere, it should not be listed
  4397. either. In this case you would start by identifying eligible projects
  4398. with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
  4399. TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
  4400. are not stuck. The correct customization for this is
  4401. @lisp
  4402. (setq org-stuck-projects
  4403. '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
  4404. "\\<IGNORE\\>"))
  4405. @end lisp
  4406. @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda views
  4407. @section Presentation and sorting
  4408. @cindex presentation, of agenda items
  4409. Before displaying items in an agenda view, Org-mode visually prepares
  4410. the items and sorts them. Each item occupies a single line. The line
  4411. starts with a @emph{prefix} that contains the @emph{category}
  4412. (@pxref{Categories}) of the item and other important information. You can
  4413. customize the prefix using the option @code{org-agenda-prefix-format}.
  4414. The prefix is followed by a cleaned-up version of the outline headline
  4415. associated with the item.
  4416. @menu
  4417. * Categories:: Not all tasks are equal
  4418. * Time-of-day specifications:: How the agenda knows the time
  4419. * Sorting of agenda items:: The order of things
  4420. @end menu
  4421. @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
  4422. @subsection Categories
  4423. @cindex category
  4424. The category is a broad label assigned to each agenda item. By default,
  4425. the category is simply derived from the file name, but you can also
  4426. specify it with a special line in the buffer, like this@footnote{For
  4427. backward compatibility, the following also works: If there are several
  4428. such lines in a file, each specifies the category for the text below it.
  4429. The first category also applies to any text before the first CATEGORY
  4430. line. However, using this method is @emph{strongly} deprecated as it is
  4431. incompatible with the outline structure of the document. The correct
  4432. method for setting multiple categories in a buffer is using a
  4433. property.}:
  4434. @example
  4435. #+CATEGORY: Thesis
  4436. @end example
  4437. @noindent
  4438. If you would like to have a special CATEGORY for a single entry or a
  4439. (sub)tree, give the entry a @code{:CATEGORY:} property with the location
  4440. as the value (@pxref{Properties and columns}).
  4441. @noindent
  4442. The display in the agenda buffer looks best if the category is not
  4443. longer than 10 characters.
  4444. @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
  4445. @subsection Time-of-Day Specifications
  4446. @cindex time-of-day specification
  4447. Org-mode checks each agenda item for a time-of-day specification. The
  4448. time can be part of the time stamp that triggered inclusion into the
  4449. agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
  4450. ranges can be specified with two time stamps, like
  4451. @c
  4452. @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
  4453. In the headline of the entry itself, a time(range) may also appear as
  4454. plain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agenda
  4455. integrates the Emacs diary (@pxref{Weekly/Daily agenda}), time
  4456. specifications in diary entries are recognized as well.
  4457. For agenda display, Org-mode extracts the time and displays it in a
  4458. standard 24 hour format as part of the prefix. The example times in
  4459. the previous paragraphs would end up in the agenda like this:
  4460. @example
  4461. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  4462. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  4463. 19:00...... The Vogon reads his poem
  4464. 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
  4465. @end example
  4466. @cindex time grid
  4467. If the agenda is in single-day mode, or for the display of today, the
  4468. timed entries are embedded in a time grid, like
  4469. @example
  4470. 8:00...... ------------------
  4471. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  4472. 10:00...... ------------------
  4473. 12:00...... ------------------
  4474. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  4475. 14:00...... ------------------
  4476. 16:00...... ------------------
  4477. 18:00...... ------------------
  4478. 19:00...... The Vogon reads his poem
  4479. 20:00...... ------------------
  4480. 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
  4481. @end example
  4482. The time grid can be turned on and off with the variable
  4483. @code{org-agenda-use-time-grid}, and can be configured with
  4484. @code{org-agenda-time-grid}.
  4485. @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
  4486. @subsection Sorting of agenda items
  4487. @cindex sorting, of agenda items
  4488. @cindex priorities, of agenda items
  4489. Before being inserted into a view, the items are sorted. How this is
  4490. done depends on the type of view.
  4491. @itemize @bullet
  4492. @item
  4493. For the daily/weekly agenda, the items for each day are sorted. The
  4494. default order is to first collect all items containing an explicit
  4495. time-of-day specification. These entries will be shown at the beginning
  4496. of the list, as a @emph{schedule} for the day. After that, items remain
  4497. grouped in categories, in the sequence given by @code{org-agenda-files}.
  4498. Within each category, items are sorted by priority (@pxref{Priorities}),
  4499. which is composed of the base priority (2000 for priority @samp{A}, 1000
  4500. for @samp{B}, and 0 for @samp{C}), plus additional increments for
  4501. overdue scheduled or deadline items.
  4502. @item
  4503. For the TODO list, items remain in the order of categories, but within
  4504. each category, sorting takes place according to priority
  4505. (@pxref{Priorities}).
  4506. @item
  4507. For tags matches, items are not sorted at all, but just appear in the
  4508. sequence in which they are found in the agenda files.
  4509. @end itemize
  4510. Sorting can be customized using the variable
  4511. @code{org-agenda-sorting-strategy}.
  4512. @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda views
  4513. @section Commands in the agenda buffer
  4514. @cindex commands, in agenda buffer
  4515. Entries in the agenda buffer are linked back to the org file or diary
  4516. file where they originate. You are not allowed to edit the agenda
  4517. buffer itself, but commands are provided to show and jump to the
  4518. original entry location, and to edit the org-files ``remotely'' from
  4519. the agenda buffer. In this way, all information is stored only once,
  4520. removing the risk that your agenda and note files may diverge.
  4521. Some commands can be executed with mouse clicks on agenda lines. For
  4522. the other commands, the cursor needs to be in the desired line.
  4523. @table @kbd
  4524. @tsubheading{Motion}
  4525. @cindex motion commands in agenda
  4526. @kindex n
  4527. @item n
  4528. Next line (same as @key{up} and @kbd{C-p}).
  4529. @kindex p
  4530. @item p
  4531. Previous line (same as @key{down} and @kbd{C-n}).
  4532. @tsubheading{View/GoTo org file}
  4533. @kindex mouse-3
  4534. @kindex @key{SPC}
  4535. @item mouse-3
  4536. @itemx @key{SPC}
  4537. Display the original location of the item in another window.
  4538. @c
  4539. @kindex L
  4540. @item L
  4541. Display original location and recenter that window.
  4542. @c
  4543. @kindex mouse-2
  4544. @kindex mouse-1
  4545. @kindex @key{TAB}
  4546. @item mouse-2
  4547. @itemx mouse-1
  4548. @itemx @key{TAB}
  4549. Go to the original location of the item in another window. Under Emacs
  4550. 22, @kbd{mouse-1} will also works for this.
  4551. @c
  4552. @kindex @key{RET}
  4553. @itemx @key{RET}
  4554. Go to the original location of the item and delete other windows.
  4555. @c
  4556. @kindex f
  4557. @item f
  4558. Toggle Follow mode. In Follow mode, as you move the cursor through
  4559. the agenda buffer, the other window always shows the corresponding
  4560. location in the org file. The initial setting for this mode in new
  4561. agenda buffers can be set with the variable
  4562. @code{org-agenda-start-with-follow-mode}.
  4563. @c
  4564. @kindex b
  4565. @item b
  4566. Display the entire subtree of the current item in an indirect buffer.
  4567. With numerical prefix ARG, go up to this level and then take that tree.
  4568. If ARG is negative, go up that many levels. With @kbd{C-u} prefix, do
  4569. not remove the previously used indirect buffer.
  4570. @c
  4571. @kindex l
  4572. @item l
  4573. Toggle Logbook mode. In Logbook mode, entries that where marked DONE while
  4574. logging was on (variable @code{org-log-done}) are shown in the agenda,
  4575. as are entries that have been clocked on that day.
  4576. @tsubheading{Change display}
  4577. @cindex display changing, in agenda
  4578. @kindex o
  4579. @item o
  4580. Delete other windows.
  4581. @c
  4582. @kindex d
  4583. @kindex w
  4584. @kindex m
  4585. @kindex y
  4586. @item d w m y
  4587. Switch to day/week/month/year view. When switching to day or week view,
  4588. this setting becomes the default for subseqent agenda commands. Since
  4589. month and year views are slow to create, the do not become the default.
  4590. @c
  4591. @kindex D
  4592. @item D
  4593. Toggle the inclusion of diary entries. See @ref{Weekly/Daily agenda}.
  4594. @c
  4595. @kindex g
  4596. @item g
  4597. Toggle the time grid on and off. See also the variables
  4598. @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
  4599. @c
  4600. @kindex r
  4601. @item r
  4602. Recreate the agenda buffer, for example to reflect the changes
  4603. after modification of the time stamps of items with S-@key{left} and
  4604. S-@key{right}. When the buffer is the global todo list, a prefix
  4605. argument is interpreted to create a selective list for a specific TODO
  4606. keyword.
  4607. @c
  4608. @kindex s
  4609. @kindex C-x C-s
  4610. @item s
  4611. @itemx C-x C-s
  4612. Save all Org-mode buffers in the current Emacs session.
  4613. @c
  4614. @kindex @key{right}
  4615. @item @key{right}
  4616. Display the following @code{org-agenda-ndays} days. For example, if
  4617. the display covers a week, switch to the following week. With prefix
  4618. arg, go forward that many times @code{org-agenda-ndays} days.
  4619. @c
  4620. @kindex @key{left}
  4621. @item @key{left}
  4622. Display the previous dates.
  4623. @c
  4624. @kindex .
  4625. @item .
  4626. Goto today.
  4627. @tsubheading{Remote editing}
  4628. @cindex remote editing, from agenda
  4629. @item 0-9
  4630. Digit argument.
  4631. @c
  4632. @cindex undoing remote-editing events
  4633. @cindex remote editing, undo
  4634. @kindex C-_
  4635. @item C-_
  4636. Undo a change due to a remote editing command. The change is undone
  4637. both in the agenda buffer and in the remote buffer.
  4638. @c
  4639. @kindex t
  4640. @item t
  4641. Change the TODO state of the item, both in the agenda and in the
  4642. original org file.
  4643. @c
  4644. @kindex C-k
  4645. @item C-k
  4646. Delete the current agenda item along with the entire subtree belonging
  4647. to it in the original Org-mode file. If the text to be deleted remotely
  4648. is longer than one line, the kill needs to be confirmed by the user. See
  4649. variable @code{org-agenda-confirm-kill}.
  4650. @c
  4651. @kindex $
  4652. @item $
  4653. Archive the subtree corresponding to the current headline.
  4654. @c
  4655. @kindex T
  4656. @item T
  4657. Show all tags associated with the current item. Because of
  4658. inheritance, this may be more than the tags listed in the line itself.
  4659. @c
  4660. @kindex :
  4661. @item :
  4662. Set tags for the current headline. If there is an active region in the
  4663. agenda, change a tag for all headings in the region.
  4664. @c
  4665. @kindex a
  4666. @item a
  4667. Toggle the ARCHIVE tag for the current headline.
  4668. @c
  4669. @kindex ,
  4670. @item ,
  4671. Set the priority for the current item. Org-mode prompts for the
  4672. priority character. If you reply with @key{SPC}, the priority cookie
  4673. is removed from the entry.
  4674. @c
  4675. @kindex P
  4676. @item P
  4677. Display weighted priority of current item.
  4678. @c
  4679. @kindex +
  4680. @kindex S-@key{up}
  4681. @item +
  4682. @itemx S-@key{up}
  4683. Increase the priority of the current item. The priority is changed in
  4684. the original buffer, but the agenda is not resorted. Use the @kbd{r}
  4685. key for this.
  4686. @c
  4687. @kindex -
  4688. @kindex S-@key{down}
  4689. @item -
  4690. @itemx S-@key{down}
  4691. Decrease the priority of the current item.
  4692. @c
  4693. @kindex C-c C-s
  4694. @item C-c C-s
  4695. Schedule this item
  4696. @c
  4697. @kindex C-c C-d
  4698. @item C-c C-d
  4699. Set a deadline for this item.
  4700. @c
  4701. @kindex S-@key{right}
  4702. @item S-@key{right}
  4703. Change the time stamp associated with the current line by one day into
  4704. the future. With prefix argument, change it by that many days. For
  4705. example, @kbd{3 6 5 S-@key{right}} will change it by a year. The
  4706. stamp is changed in the original org file, but the change is not
  4707. directly reflected in the agenda buffer. Use the
  4708. @kbd{r} key to update the buffer.
  4709. @c
  4710. @kindex S-@key{left}
  4711. @item S-@key{left}
  4712. Change the time stamp associated with the current line by one day
  4713. into the past.
  4714. @c
  4715. @kindex >
  4716. @item >
  4717. Change the time stamp associated with the current line to today.
  4718. The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
  4719. on my keyboard.
  4720. @c
  4721. @kindex I
  4722. @item I
  4723. Start the clock on the current item. If a clock is running already, it
  4724. is stopped first.
  4725. @c
  4726. @kindex O
  4727. @item O
  4728. Stop the previously started clock.
  4729. @c
  4730. @kindex X
  4731. @item X
  4732. Cancel the currently running clock.
  4733. @kindex J
  4734. @item J
  4735. Jump to the running clock in another window.
  4736. @tsubheading{Calendar commands}
  4737. @cindex calendar commands, from agenda
  4738. @kindex c
  4739. @item c
  4740. Open the Emacs calendar and move to the date at the agenda cursor.
  4741. @c
  4742. @item c
  4743. When in the calendar, compute and show the Org-mode agenda for the
  4744. date at the cursor.
  4745. @c
  4746. @cindex diary entries, creating from agenda
  4747. @kindex i
  4748. @item i
  4749. Insert a new entry into the diary. Prompts for the type of entry
  4750. (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
  4751. entry in the diary, just as @kbd{i d} etc. would do in the calendar.
  4752. The date is taken from the cursor position.
  4753. @c
  4754. @kindex M
  4755. @item M
  4756. Show the phases of the moon for the three months around current date.
  4757. @c
  4758. @kindex S
  4759. @item S
  4760. Show sunrise and sunset times. The geographical location must be set
  4761. with calendar variables, see documentation of the Emacs calendar.
  4762. @c
  4763. @kindex C
  4764. @item C
  4765. Convert the date at cursor into many other cultural and historic
  4766. calendars.
  4767. @c
  4768. @kindex H
  4769. @item H
  4770. Show holidays for three month around the cursor date.
  4771. @c
  4772. @c FIXME: This should be a different key.
  4773. @kindex C-c C-x C-c
  4774. @item C-c C-x C-c
  4775. Export a single iCalendar file containing entries from all agenda files.
  4776. @tsubheading{Exporting to a file}
  4777. @kindex C-x C-w
  4778. @item C-x C-w
  4779. @cindex exporting agenda views
  4780. @cindex agenda views, exporting
  4781. Write the agenda view to a file. Depending on the extension of the
  4782. selected file name, the view will be exported as HTML (extension
  4783. @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
  4784. plain text (any other extension). Use the variable
  4785. @code{org-agenda-exporter-settings} to set options for @file{ps-print}
  4786. and for @file{htmlize} to be used during export.
  4787. @tsubheading{Quit and Exit}
  4788. @kindex q
  4789. @item q
  4790. Quit agenda, remove the agenda buffer.
  4791. @c
  4792. @kindex x
  4793. @cindex agenda files, removing buffers
  4794. @item x
  4795. Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
  4796. for the compilation of the agenda. Buffers created by the user to
  4797. visit org files will not be removed.
  4798. @end table
  4799. @node Custom agenda views, , Agenda commands, Agenda views
  4800. @section Custom agenda views
  4801. @cindex custom agenda views
  4802. @cindex agenda views, custom
  4803. Custom agenda commands serve two purposes: to store and quickly access
  4804. frequently used TODO and tags searches, and to create special composite
  4805. agenda buffers. Custom agenda commands will be accessible through the
  4806. dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
  4807. @menu
  4808. * Storing searches:: Type once, use often
  4809. * Block agenda:: All the stuff you need in a single buffer
  4810. * Setting Options:: Changing the rules
  4811. * Exporting Agenda Views:: Writing agendas to files.
  4812. * Extracting Agenda Information for other programs::
  4813. @end menu
  4814. @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
  4815. @subsection Storing searches
  4816. The first application of custom searches is the definition of keyboard
  4817. shortcuts for frequently used searches, either creating an agenda
  4818. buffer, or a sparse tree (the latter covering of course only the current
  4819. buffer).
  4820. @kindex C-c a C
  4821. Custom commands are configured in the variable
  4822. @code{org-agenda-custom-commands}. You can customize this variable, for
  4823. example by pressing @kbd{C-c a C}. You can also directly set it with
  4824. Emacs Lisp in @file{.emacs}. The following example contains all valid
  4825. search types:
  4826. @lisp
  4827. @group
  4828. (setq org-agenda-custom-commands
  4829. '(("w" todo "WAITING")
  4830. ("W" todo-tree "WAITING")
  4831. ("u" tags "+boss-urgent")
  4832. ("v" tags-todo "+boss-urgent")
  4833. ("U" tags-tree "+boss-urgent")
  4834. ("f" occur-tree "\\<FIXME\\>")
  4835. ("h" . "HOME+Name tags searches") ; description for "h" prefix
  4836. ("hl" tags "+home+Lisa")
  4837. ("hp" tags "+home+Peter")
  4838. ("hk" tags "+home+Kim")))
  4839. @end group
  4840. @end lisp
  4841. @noindent
  4842. The initial string in each entry defines the keys you have to press
  4843. after the dispatcher command @kbd{C-c a} in order to access the command.
  4844. Usually this will be just a single character, but if you have many
  4845. similar commands, you can also define two-letter combinations where the
  4846. first character is the same in several combinations and serves as a
  4847. prefix key@footnote{You can provide a description for a prefix key by
  4848. inserting a cons cell with the prefix and the description.}. The second
  4849. parameter is the search type, followed by the string or regular
  4850. expression to be used for the matching. The example above will
  4851. therefore define:
  4852. @table @kbd
  4853. @item C-c a w
  4854. as a global search for TODO entries with @samp{WAITING} as the TODO
  4855. keyword
  4856. @item C-c a W
  4857. as the same search, but only in the current buffer and displaying the
  4858. results as a sparse tree
  4859. @item C-c a u
  4860. as a global tags search for headlines marked @samp{:boss:} but not
  4861. @samp{:urgent:}
  4862. @item C-c a v
  4863. as the same search as @kbd{C-c a u}, but limiting the search to
  4864. headlines that are also TODO items
  4865. @item C-c a U
  4866. as the same search as @kbd{C-c a u}, but only in the current buffer and
  4867. displaying the result as a sparse tree
  4868. @item C-c a f
  4869. to create a sparse tree (again: current buffer only) with all entries
  4870. containing the word @samp{FIXME}
  4871. @item C-c a h
  4872. as a prefix command for a HOME tags search where you have to press an
  4873. additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
  4874. Peter, or Kim) as additional tag to match.
  4875. @end table
  4876. @node Block agenda, Setting Options, Storing searches, Custom agenda views
  4877. @subsection Block agenda
  4878. @cindex block agenda
  4879. @cindex agenda, with block views
  4880. Another possibility is the construction of agenda views that comprise
  4881. the results of @emph{several} commands, each of which creates a block in
  4882. the agenda buffer. The available commands include @code{agenda} for the
  4883. daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
  4884. for the global todo list (as constructed with @kbd{C-c a t}), and the
  4885. matching commands discussed above: @code{todo}, @code{tags}, and
  4886. @code{tags-todo}. Here are two examples:
  4887. @lisp
  4888. @group
  4889. (setq org-agenda-custom-commands
  4890. '(("h" "Agenda and Home-related tasks"
  4891. ((agenda)
  4892. (tags-todo "home")
  4893. (tags "garden")))
  4894. ("o" "Agenda and Office-related tasks"
  4895. ((agenda)
  4896. (tags-todo "work")
  4897. (tags "office")))))
  4898. @end group
  4899. @end lisp
  4900. @noindent
  4901. This will define @kbd{C-c a h} to create a multi-block view for stuff
  4902. you need to attend to at home. The resulting agenda buffer will contain
  4903. your agenda for the current week, all TODO items that carry the tag
  4904. @samp{home}, and also all lines tagged with @samp{garden}. Finally the
  4905. command @kbd{C-c a o} provides a similar view for office tasks.
  4906. @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
  4907. @subsection Setting Options for custom commands
  4908. @cindex options, for custom agenda views
  4909. Org-mode contains a number of variables regulating agenda construction
  4910. and display. The global variables define the behavior for all agenda
  4911. commands, including the custom commands. However, if you want to change
  4912. some settings just for a single custom view, you can do so. Setting
  4913. options requires inserting a list of variable names and values at the
  4914. right spot in @code{org-agenda-custom-commands}. For example:
  4915. @lisp
  4916. @group
  4917. (setq org-agenda-custom-commands
  4918. '(("w" todo "WAITING"
  4919. ((org-agenda-sorting-strategy '(priority-down))
  4920. (org-agenda-prefix-format " Mixed: ")))
  4921. ("U" tags-tree "+boss-urgent"
  4922. ((org-show-following-heading nil)
  4923. (org-show-hierarchy-above nil)))))
  4924. @end group
  4925. @end lisp
  4926. @noindent
  4927. Now the @kbd{C-c a w} command will sort the collected entries only by
  4928. priority, and the prefix format is modified to just say @samp{ Mixed: }
  4929. instead of giving the category of the entry. The sparse tags tree of
  4930. @kbd{C-c a U} will now turn out ultra-compact, because neither the
  4931. headline hierarchy above the match, nor the headline following the match
  4932. will be shown.
  4933. For command sets creating a block agenda,
  4934. @code{org-agenda-custom-commands} has two separate spots for setting
  4935. options. You can add options that should be valid for just a single
  4936. command in the set, and options that should be valid for all commands in
  4937. the set. The former are just added to the command entry, the latter
  4938. must come after the list of command entries. Going back to the block
  4939. agenda example (@pxref{Block agenda}), let's change the sorting strategy
  4940. for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
  4941. the results for GARDEN tags query in the opposite order,
  4942. @code{priority-up}. This would look like this:
  4943. @lisp
  4944. @group
  4945. (setq org-agenda-custom-commands
  4946. '(("h" "Agenda and Home-related tasks"
  4947. ((agenda)
  4948. (tags-todo "home")
  4949. (tags "garden"
  4950. ((org-agenda-sorting-strategy '(priority-up)))))
  4951. ((org-agenda-sorting-strategy '(priority-down))))
  4952. ("o" "Agenda and Office-related tasks"
  4953. ((agenda)
  4954. (tags-todo "work")
  4955. (tags "office")))))
  4956. @end group
  4957. @end lisp
  4958. As you see, the values and parenthesis setting is a little complex.
  4959. When in doubt, use the customize interface to set this variable - it
  4960. fully supports its structure. Just one caveat: When setting options in
  4961. this interface, the @emph{values} are just lisp expressions. So if the
  4962. value is a string, you need to add the double quotes around the value
  4963. yourself.
  4964. @node Exporting Agenda Views, Extracting Agenda Information for other programs, Setting Options, Custom agenda views
  4965. @subsection Exporting Agenda Views
  4966. @cindex agenda views, exporting
  4967. If you are away from your computer, it can be very useful to have a
  4968. printed version of some agenda views to carry around. Org-mode can
  4969. export custom agenda views as plain text, HTML@footnote{You need to
  4970. install Hrvoje Niksic' @file{htmlize.el}.} and postscript. If you want
  4971. to do this only occasionally, use the command
  4972. @table @kbd
  4973. @kindex C-x C-w
  4974. @item C-x C-w
  4975. @cindex exporting agenda views
  4976. @cindex agenda views, exporting
  4977. Write the agenda view to a file. Depending on the extension of the
  4978. selected file name, the view will be exported as HTML (extension
  4979. @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
  4980. plain text (any other extension). Use the variable
  4981. @code{org-agenda-exporter-settings} to set options for @file{ps-print}
  4982. and for @file{htmlize} to be used during export, for example
  4983. @lisp
  4984. (setq org-agenda-exporter-settings
  4985. '((ps-number-of-columns 2)
  4986. (ps-landscape-mode t)
  4987. (htmlize-output-type 'css)))
  4988. @end lisp
  4989. @end table
  4990. If you need to export certain agenda views frequently, you can associate
  4991. any custom agenda command with a list of output file names
  4992. @footnote{If you want to store standard views like the weekly agenda
  4993. or the global TODO list as well, you need to define custom commands for
  4994. them in order to be able to specify filenames.}. Here is an example
  4995. that first does define custom commands for the agenda and the global
  4996. todo list, together with a number of files to which to export them.
  4997. Then we define two block agenda commands and specify filenames for them
  4998. as well. File names can be relative to the current working directory,
  4999. or absolute.
  5000. @lisp
  5001. @group
  5002. (setq org-agenda-custom-commands
  5003. '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
  5004. ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
  5005. ("h" "Agenda and Home-related tasks"
  5006. ((agenda)
  5007. (tags-todo "home")
  5008. (tags "garden"))
  5009. nil
  5010. ("~/views/home.html"))
  5011. ("o" "Agenda and Office-related tasks"
  5012. ((agenda)
  5013. (tags-todo "work")
  5014. (tags "office"))
  5015. nil
  5016. ("~/views/office.ps"))))
  5017. @end group
  5018. @end lisp
  5019. The extension of the file name determines the type of export. If it is
  5020. @file{.html}, Org-mode will use the @file{htmlize.el} package to convert
  5021. the buffer to HTML and save it to this file name. If the extension is
  5022. @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
  5023. postscript output. Any other extension produces a plain ASCII file.
  5024. The export files are @emph{not} created when you use one of those
  5025. commands interactively. Instead, there is a special command to produce
  5026. @emph{all} specified files in one step:
  5027. @table @kbd
  5028. @kindex C-c a e
  5029. @item C-c a e
  5030. Export all agenda views that have export filenames associated with
  5031. them.
  5032. @end table
  5033. You can use the options section of the custom agenda commands to also
  5034. set options for the export commands. For example:
  5035. @lisp
  5036. (setq org-agenda-custom-commands
  5037. '(("X" agenda ""
  5038. ((ps-number-of-columns 2)
  5039. (ps-landscape-mode t)
  5040. (org-agenda-prefix-format " [ ] ")
  5041. (org-agenda-with-colors nil)
  5042. (org-agenda-remove-tags t))
  5043. ("theagenda.ps"))))
  5044. @end lisp
  5045. @noindent
  5046. This command sets two options for the postscript exporter, to make it
  5047. print in two columns in landscape format - the resulting page can be cut
  5048. in two and then used in a paper agenda. The remaining settings modify
  5049. the agenda prefix to omit category and scheduling information, and
  5050. instead include a checkbox to check off items. We also remove the tags
  5051. to make the lines compact, and we don't want to use colors for the
  5052. black-and-white printer. Settings specified in
  5053. @code{org-agenda-exporter-settings} will also apply, but the settings
  5054. in @code{org-agenda-custom-commands} take precedence.
  5055. @noindent
  5056. From the command line you may also use
  5057. @example
  5058. emacs -f org-batch-store-agenda-views -kill
  5059. @end example
  5060. @noindent
  5061. or, if you need to modify some parameters
  5062. @example
  5063. emacs -eval '(org-batch-store-agenda-views \
  5064. org-agenda-ndays 30 \
  5065. org-agenda-start-day "2007-11-01" \
  5066. org-agenda-include-diary nil \
  5067. org-agenda-files (quote ("~/org/project.org")))' \
  5068. -kill
  5069. @end example
  5070. @noindent
  5071. which will create the agenda views restricted to the file
  5072. @file{~/org/project.org}, without diary entries and with 30 days
  5073. extent.
  5074. @node Extracting Agenda Information for other programs, , Exporting Agenda Views, Custom agenda views
  5075. @subsection Extracting Agenda Information for other programs
  5076. @cindex agenda, pipe
  5077. @cindex Scripts, for agenda processing
  5078. Org-mode provides commands to access agenda information for the command
  5079. line in emacs batch mode. This extracted information can be sent
  5080. directly to a printer, or it can be read by a program that does further
  5081. processing of the data. The first of these commands is the function
  5082. @code{org-batch-agenda}, that produces an agenda view and sends it as
  5083. ASCII text to STDOUT. The command takes a single string as parameter.
  5084. If the string has length 1, it is used as a key to one of the commands
  5085. you have configured in @code{org-agenda-custom-commands}, basically any
  5086. key you can use after @kbd{C-c a}. For example, to directly print the
  5087. current TODO list, you could use
  5088. @example
  5089. emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
  5090. @end example
  5091. If the parameter is a string with 2 or more characters, it is used as a
  5092. tags/todo match string. For example, to print your local shopping list
  5093. (all items with the tag @samp{shop}, but excluding the tag
  5094. @samp{NewYork}), you could use
  5095. @example
  5096. emacs -batch -l ~/.emacs \
  5097. -eval '(org-batch-agenda "+shop-NewYork")' | lpr
  5098. @end example
  5099. @noindent
  5100. You may also modify parameters on the fly like this:
  5101. @example
  5102. emacs -batch -l ~/.emacs \
  5103. -eval '(org-batch-agenda "a" \
  5104. org-agenda-ndays 30 \
  5105. org-agenda-include-diary nil \
  5106. org-agenda-files (quote ("~/org/project.org")))' \
  5107. | lpr
  5108. @end example
  5109. @noindent
  5110. which will produce a 30 day agenda, fully restricted to the Org file
  5111. @file{~/org/projects.org}, not even including the diary.
  5112. If you want to process the agenda data in more sophisticated ways, you
  5113. can use the command @code{org-batch-agenda-csv} to get a comma-separated
  5114. list of values for each agenda item. Each line in the output will
  5115. contain a number of fields separated by commas. The fields in a line
  5116. are:
  5117. @example
  5118. category @r{The category of the item}
  5119. head @r{The headline, without TODO kwd, TAGS and PRIORITY}
  5120. type @r{The type of the agenda entry, can be}
  5121. todo @r{selected in TODO match}
  5122. tagsmatch @r{selected in tags match}
  5123. diary @r{imported from diary}
  5124. deadline @r{a deadline}
  5125. scheduled @r{scheduled}
  5126. timestamp @r{appointment, selected by timestamp}
  5127. closed @r{entry was closed on date}
  5128. upcoming-deadline @r{warning about nearing deadline}
  5129. past-scheduled @r{forwarded scheduled item}
  5130. block @r{entry has date block including date}
  5131. todo @r{The todo keyword, if any}
  5132. tags @r{All tags including inherited ones, separated by colons}
  5133. date @r{The relevant date, like 2007-2-14}
  5134. time @r{The time, like 15:00-16:50}
  5135. extra @r{String with extra planning info}
  5136. priority-l @r{The priority letter if any was given}
  5137. priority-n @r{The computed numerical priority}
  5138. @end example
  5139. @noindent
  5140. Time and date will only be given if a timestamp (or deadline/scheduled)
  5141. lead to the selection of the item.
  5142. A CSV list like this is very easy to use in a post processing script.
  5143. For example, here is a Perl program that gets the TODO list from
  5144. Emacs/org-mode and prints all the items, preceded by a checkbox:
  5145. @example
  5146. @group
  5147. #!/usr/bin/perl
  5148. # define the Emacs command to run
  5149. $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
  5150. # run it and capture the output
  5151. $agenda = qx@{$cmd 2>/dev/null@};
  5152. # loop over all lines
  5153. foreach $line (split(/\n/,$agenda)) @{
  5154. # get the individual values
  5155. ($category,$head,$type,$todo,$tags,$date,$time,$extra,
  5156. $priority_l,$priority_n) = split(/,/,$line);
  5157. # proccess and print
  5158. print "[ ] $head\n";
  5159. @}
  5160. @end group
  5161. @end example
  5162. @node Embedded LaTeX, Exporting, Agenda views, Top
  5163. @chapter Embedded LaTeX
  5164. @cindex @TeX{} interpretation
  5165. @cindex La@TeX{} interpretation
  5166. Plain ASCII is normally sufficient for almost all note taking. One
  5167. exception, however, are scientific notes which need to be able to
  5168. contain mathematical symbols and the occasional formula.
  5169. La@TeX{}@footnote{La@TeX{} is a macro system based on Donald E. Knuth's
  5170. @TeX{} system. Many of the features described here as ``La@TeX{}'' are
  5171. really from @TeX{}, but for simplicity I am blurring this distinction.}
  5172. is widely used to typeset scientific documents. Org-mode supports
  5173. embedding La@TeX{} code into its files, because many academics are used
  5174. to read La@TeX{} source code, and because it can be readily processed
  5175. into images for HTML production.
  5176. It is not necessary to mark La@TeX{} macros and code in any special way.
  5177. If you observe a few conventions, Org-mode knows how to find it and what
  5178. to do with it.
  5179. @menu
  5180. * Math symbols:: TeX macros for symbols and Greek letters
  5181. * Subscripts and Superscripts:: Simple syntax for raising/lowering text
  5182. * LaTeX fragments:: Complex formulas made easy
  5183. * Processing LaTeX fragments:: Previewing LaTeX processing
  5184. * CDLaTeX mode:: Speed up entering of formulas
  5185. @end menu
  5186. @node Math symbols, Subscripts and Superscripts, Embedded LaTeX, Embedded LaTeX
  5187. @section Math symbols
  5188. @cindex math symbols
  5189. @cindex TeX macros
  5190. You can use La@TeX{} macros to insert special symbols like @samp{\alpha}
  5191. to indicate the Greek letter, or @samp{\to} to indicate an arrow.
  5192. Completion for these macros is available, just type @samp{\} and maybe a
  5193. few letters, and press @kbd{M-@key{TAB}} to see possible completions.
  5194. Unlike La@TeX{} code, Org-mode allows these macros to be present
  5195. without surrounding math delimiters, for example:
  5196. @example
  5197. Angles are written as Greek letters \alpha, \beta and \gamma.
  5198. @end example
  5199. During HTML export (@pxref{HTML export}), these symbols are translated
  5200. into the proper syntax for HTML, for the above examples this is
  5201. @samp{&alpha;} and @samp{&rarr;}, respectively.
  5202. @node Subscripts and Superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
  5203. @section Subscripts and Superscripts
  5204. @cindex subscript
  5205. @cindex superscript
  5206. Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
  5207. and subscripts. Again, these can be used without embedding them in
  5208. math-mode delimiters. To increase the readability of ASCII text, it is
  5209. not necessary (but OK) to surround multi-character sub- and superscripts
  5210. with curly braces. For example
  5211. @example
  5212. The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
  5213. the sun is R_@{sun@} = 6.96 x 10^8 m.
  5214. @end example
  5215. To avoid interpretation as raised or lowered text, you can quote
  5216. @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
  5217. During HTML export (@pxref{HTML export}), subscript and superscripts
  5218. are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
  5219. @node LaTeX fragments, Processing LaTeX fragments, Subscripts and Superscripts, Embedded LaTeX
  5220. @section LaTeX fragments
  5221. @cindex LaTeX fragments
  5222. With symbols, sub- and superscripts, HTML is pretty much at its end when
  5223. it comes to representing mathematical formulas@footnote{Yes, there is
  5224. MathML, but that is not yet fully supported by many browsers, and there
  5225. is no decent converter for turning La@TeX{} or ASCII representations of
  5226. formulas into MathML. So for the time being, converting formulas into
  5227. images seems the way to go.}. More complex expressions need a dedicated
  5228. formula processor. To this end, Org-mode can contain arbitrary La@TeX{}
  5229. fragments. It provides commands to preview the typeset result of these
  5230. fragments, and upon export to HTML, all fragments will be converted to
  5231. images and inlined into the HTML document@footnote{The La@TeX{} export
  5232. will not use images for displaying La@TeX{} fragments but include these
  5233. fragments directly into the La@TeX{} code.}. For this to work you
  5234. need to be on a system with a working La@TeX{} installation. You also
  5235. need the @file{dvipng} program, available at
  5236. @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
  5237. will be used when processing a fragment can be configured with the
  5238. variable @code{org-format-latex-header}.
  5239. La@TeX{} fragments don't need any special marking at all. The following
  5240. snippets will be identified as La@TeX{} source code:
  5241. @itemize @bullet
  5242. @item
  5243. Environments of any kind. The only requirement is that the
  5244. @code{\begin} statement appears on a new line, preceded by only
  5245. whitespace.
  5246. @item
  5247. Text within the usual La@TeX{} math delimiters. To avoid conflicts with
  5248. currency specifications, single @samp{$} characters are only recognized
  5249. as math delimiters if the enclosed text contains at most two line breaks,
  5250. is directly attached to the @samp{$} characters with no whitespace in
  5251. between, and if the closing @samp{$} is followed by whitespace or
  5252. punctuation. For the other delimiters, there is no such restriction, so
  5253. when in doubt, use @samp{\(...\)} as inline math delimiters.
  5254. @end itemize
  5255. @noindent For example:
  5256. @example
  5257. \begin@{equation@} % arbitrary environments,
  5258. x=\sqrt@{b@} % even tables, figures
  5259. \end@{equation@} % etc
  5260. If $a^2=b$ and \( b=2 \), then the solution must be
  5261. either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
  5262. @end example
  5263. @noindent
  5264. If you need any of the delimiter ASCII sequences for other purposes, you
  5265. can configure the option @code{org-format-latex-options} to deselect the
  5266. ones you do not wish to have interpreted by the La@TeX{} converter.
  5267. @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
  5268. @section Processing LaTeX fragments
  5269. @cindex LaTeX fragments, preview
  5270. La@TeX{} fragments can be processed to produce a preview images of the
  5271. typeset expressions:
  5272. @table @kbd
  5273. @kindex C-c C-x C-l
  5274. @item C-c C-x C-l
  5275. Produce a preview image of the La@TeX{} fragment at point and overlay it
  5276. over the source code. If there is no fragment at point, process all
  5277. fragments in the current entry (between two headlines). When called
  5278. with a prefix argument, process the entire subtree. When called with
  5279. two prefix arguments, or when the cursor is before the first headline,
  5280. process the entire buffer.
  5281. @kindex C-c C-c
  5282. @item C-c C-c
  5283. Remove the overlay preview images.
  5284. @end table
  5285. During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
  5286. converted into images and inlined into the document if the following
  5287. setting is active:
  5288. @lisp
  5289. (setq org-export-with-LaTeX-fragments t)
  5290. @end lisp
  5291. @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
  5292. @section Using CDLaTeX to enter math
  5293. @cindex CDLaTeX
  5294. CDLaTeX-mode is a minor mode that is normally used in combination with a
  5295. major La@TeX{} mode like AUCTeX in order to speed-up insertion of
  5296. environments and math templates. Inside Org-mode, you can make use of
  5297. some of the features of cdlatex-mode. You need to install
  5298. @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
  5299. AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
  5300. Don't turn cdlatex-mode itself under Org-mode, but use the light
  5301. version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it
  5302. on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
  5303. Org-mode files with
  5304. @lisp
  5305. (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
  5306. @end lisp
  5307. When this mode is enabled, the following features are present (for more
  5308. details see the documentation of cdlatex-mode):
  5309. @itemize @bullet
  5310. @kindex C-c @{
  5311. @item
  5312. Environment templates can be inserted with @kbd{C-c @{}.
  5313. @item
  5314. @kindex @key{TAB}
  5315. The @key{TAB} key will do template expansion if the cursor is inside a
  5316. La@TeX{} fragment@footnote{Org-mode has a method to test if the cursor is
  5317. inside such a fragment, see the documentation of the function
  5318. @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
  5319. expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
  5320. correctly inside the first brace. Another @key{TAB} will get you into
  5321. the second brace. Even outside fragments, @key{TAB} will expand
  5322. environment abbreviations at the beginning of a line. For example, if
  5323. you write @samp{equ} at the beginning of a line and press @key{TAB},
  5324. this abbreviation will be expanded to an @code{equation} environment.
  5325. To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
  5326. @item
  5327. @kindex _
  5328. @kindex ^
  5329. Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
  5330. characters together with a pair of braces. If you use @key{TAB} to move
  5331. out of the braces, and if the braces surround only a single character or
  5332. macro, they are removed again (depending on the variable
  5333. @code{cdlatex-simplify-sub-super-scripts}).
  5334. @item
  5335. @kindex `
  5336. Pressing the backquote @kbd{`} followed by a character inserts math
  5337. macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
  5338. after the backquote, a help window will pop up.
  5339. @item
  5340. @kindex '
  5341. Pressing the normal quote @kbd{'} followed by another character modifies
  5342. the symbol before point with an accent or a font. If you wait more than
  5343. 1.5 seconds after the backquote, a help window will pop up. Character
  5344. modification will work only inside La@TeX{} fragments, outside the quote
  5345. is normal.
  5346. @end itemize
  5347. @node Exporting, Publishing, Embedded LaTeX, Top
  5348. @chapter Exporting
  5349. @cindex exporting
  5350. Org-mode documents can be exported into a variety of other formats. For
  5351. printing and sharing of notes, ASCII export produces a readable and
  5352. simple version of an Org-mode file. HTML export allows you to publish a
  5353. notes file on the web, while the XOXO format provides a solid base for
  5354. exchange with a broad range of other applications. La@TeX{} export lets
  5355. you use Org-mode and its structured editing functions to easily create
  5356. La@TeX{} files. To incorporate entries with associated times like
  5357. deadlines or appointments into a desktop calendar program like iCal,
  5358. Org-mode can also produce extracts in the iCalendar format. Currently
  5359. Org-mode only supports export, not import of these different formats.
  5360. When exporting, Org-mode uses special conventions to enrich the output
  5361. produced. @xref{Text interpretation}, for more details.
  5362. @table @kbd
  5363. @kindex C-c C-e
  5364. @item C-c C-e
  5365. Dispatcher for export and publishing commands. Displays a help-window
  5366. listing the additional key(s) needed to launch an export or publishing
  5367. command.
  5368. @end table
  5369. @menu
  5370. * ASCII export:: Exporting to plain ASCII
  5371. * HTML export:: Exporting to HTML
  5372. * LaTeX export:: Exporting to LaTeX
  5373. * XOXO export:: Exporting to XOXO
  5374. * iCalendar export:: Exporting in iCalendar format
  5375. * Text interpretation:: How the exporter looks at the file
  5376. @end menu
  5377. @node ASCII export, HTML export, Exporting, Exporting
  5378. @section ASCII export
  5379. @cindex ASCII export
  5380. ASCII export produces a simple and very readable version of an Org-mode
  5381. file.
  5382. @cindex region, active
  5383. @cindex active region
  5384. @cindex transient-mark-mode
  5385. @table @kbd
  5386. @kindex C-c C-e a
  5387. @item C-c C-e a
  5388. Export as ASCII file. For an org file @file{myfile.org}, the ASCII file
  5389. will be @file{myfile.txt}. The file will be overwritten without
  5390. warning. If there is an active region, only the region will be
  5391. exported. If the selected region is a single tree, the tree head will
  5392. become the document title. If the tree head entry has or inherits an
  5393. @code{:EXPORT_FILE_NAME:} property, that name will be used for the
  5394. export.
  5395. @kindex C-c C-e v a
  5396. @item C-c C-e v a
  5397. Export only the visible part of the document.
  5398. @end table
  5399. @cindex headline levels, for exporting
  5400. In the exported version, the first 3 outline levels will become
  5401. headlines, defining a general document structure. Additional levels
  5402. will be exported as itemized lists. If you want that transition to occur
  5403. at a different level, specify it with a prefix argument. For example,
  5404. @example
  5405. @kbd{C-1 C-c C-e a}
  5406. @end example
  5407. @noindent
  5408. creates only top level headlines and does the rest as items. When
  5409. headlines are converted to items, the indentation of the text following
  5410. the headline is changed to fit nicely under the item. This is done with
  5411. the assumption that the first bodyline indicates the base indentation of
  5412. the body text. Any indentation larger than this is adjusted to preserve
  5413. the layout relative to the first line. Should there be lines with less
  5414. indentation than the first, these are left alone.
  5415. @node HTML export, LaTeX export, ASCII export, Exporting
  5416. @section HTML export
  5417. @cindex HTML export
  5418. Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
  5419. HTML formatting, in ways similar to John Grubers @emph{markdown}
  5420. language, but with additional support for tables.
  5421. @menu
  5422. * HTML Export commands:: How to invoke LaTeX export
  5423. * Quoting HTML tags:: Using direct HTML in Org-mode
  5424. * Links:: Transformation of links for HTML
  5425. * Images:: How to include images
  5426. * CSS support:: Changing the appearence of the output
  5427. @end menu
  5428. @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
  5429. @subsection HTML export commands
  5430. @cindex region, active
  5431. @cindex active region
  5432. @cindex transient-mark-mode
  5433. @table @kbd
  5434. @kindex C-c C-e h
  5435. @item C-c C-e h
  5436. Export as HTML file @file{myfile.html}. For an org file
  5437. @file{myfile.org}, the ASCII file will be @file{myfile.html}. The file
  5438. will be overwritten without warning. If there is an active region, only
  5439. the region will be exported. If the selected region is a single tree,
  5440. the tree head will become the document title. If the tree head entry
  5441. has or inherits an @code{:EXPORT_FILE_NAME:} property, that name will be
  5442. used for the export.
  5443. @kindex C-c C-e b
  5444. @item C-c C-e b
  5445. Export as HTML file and immediately open it with a browser.
  5446. @kindex C-c C-e H
  5447. @item C-c C-e H
  5448. Export to a temporary buffer, do not create a file.
  5449. @kindex C-c C-e R
  5450. @item C-c C-e R
  5451. Export the active region to a temporary buffer. With prefix arg, do not
  5452. produce file header and foot, but just the plain HTML section for the
  5453. region. This is good for cut-and-paste operations.
  5454. @kindex C-c C-e v h
  5455. @kindex C-c C-e v b
  5456. @kindex C-c C-e v H
  5457. @kindex C-c C-e v R
  5458. @item C-c C-e v h
  5459. @item C-c C-e v b
  5460. @item C-c C-e v H
  5461. @item C-c C-e v R
  5462. Export only the visible part of the document.
  5463. @item M-x org-export-region-as-html
  5464. Convert the region to HTML under the assumption that it was org-mode
  5465. syntax before. This is a global command that can be invoked in any
  5466. buffer.
  5467. @item M-x org-replace-region-by-HTML
  5468. Replace the active region (assumed to be in Org-mode syntax) by HTML
  5469. code.
  5470. @end table
  5471. @cindex headline levels, for exporting
  5472. In the exported version, the first 3 outline levels will become
  5473. headlines, defining a general document structure. Additional levels
  5474. will be exported as itemized lists. If you want that transition to occur
  5475. at a different level, specify it with a prefix argument. For example,
  5476. @example
  5477. @kbd{C-2 C-c C-e b}
  5478. @end example
  5479. @noindent
  5480. creates two levels of headings and does the rest as items.
  5481. @node Quoting HTML tags, Links, HTML Export commands, HTML export
  5482. @subsection Quoting HTML tags
  5483. Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
  5484. @samp{&gt;} in HTML export. If you want to include simple HTML tags
  5485. which should be interpreted as such, mark them with @samp{@@} as in
  5486. @samp{@@<b>bold text@@</b>}. Note that this really works only for
  5487. simple tags. For more extensive HTML that should be copied verbatim to
  5488. the exported file use either
  5489. @example
  5490. #+HTML: Literal HTML code for export
  5491. @end example
  5492. @noindent or
  5493. @example
  5494. #+BEGIN_HTML
  5495. All lines between these markers are exported literally
  5496. #+END_HTML
  5497. @end example
  5498. @node Links, Images, Quoting HTML tags, HTML export
  5499. @subsection Links
  5500. @cindex links, in HTML export
  5501. @cindex internal links, in HTML export
  5502. @cindex external links, in HTML export
  5503. Internal links (@pxref{Internal links}) will continue to work in HTML
  5504. files only if they match a dedicated @samp{<<target>>}. Automatic links
  5505. created by radio targets (@pxref{Radio targets}) will also work in the
  5506. HTML file. Links to external files will still work if the HTML file is
  5507. in the same directory as the Org-mode file. Links to other @file{.org}
  5508. files will be translated into HTML links under the assumption that an
  5509. HTML version also exists of the linked file. For information related to
  5510. linking files while publishing them to a publishing directory see
  5511. @ref{Publishing links}.
  5512. @node Images, CSS support, Links, HTML export
  5513. @subsection Images
  5514. @cindex images, inline in HTML
  5515. @cindex inlining images in HTML
  5516. HTML export can inline images given as links in the Org-mode file, and
  5517. it can make an image the clickable part of a link. By
  5518. default@footnote{but see the variable
  5519. @code{org-export-html-inline-images}}, images are inlined if a link does
  5520. not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
  5521. while @samp{[[file:myimg.jpg][the image]]} will just produce a link
  5522. @samp{the image} that points to the image. If the description part
  5523. itself is a @code{file:} link or a @code{http:} URL pointing to an
  5524. image, this image will be inlined and activated so that clicking on the
  5525. image will activate the link. For example, to include a thumbnail that
  5526. will link to a high resolution version of the image, you could use:
  5527. @example
  5528. [[file:highres.jpg][file:thumb.jpg]]
  5529. @end example
  5530. @noindent
  5531. and you could use @code{http} addresses just as well.
  5532. @node CSS support, , Images, HTML export
  5533. @subsection CSS support
  5534. You can also give style information for the exported file. The HTML
  5535. exporter assigns the following CSS classes to appropriate parts of the
  5536. document - your style specifications may change these:
  5537. @example
  5538. .todo @r{TODO keywords}
  5539. .done @r{the DONE keyword}
  5540. .timestamp @r{time stamp}
  5541. .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
  5542. .tag @r{tag in a headline}
  5543. .target @r{target for links}
  5544. @end example
  5545. The default style specification can be configured through the option
  5546. @code{org-export-html-style}. If you want to use a file-local style,
  5547. you may use file variables, best wrapped into a COMMENT section at the
  5548. end of the outline tree. For example@footnote{Under Emacs 21, the
  5549. continuation lines for a variable value should have no @samp{#} at the
  5550. start of the line.}:
  5551. @example
  5552. * COMMENT html style specifications
  5553. # Local Variables:
  5554. # org-export-html-style: " <style type=\"text/css\">
  5555. # p @{font-weight: normal; color: gray; @}
  5556. # h1 @{color: black; @}
  5557. # </style>"
  5558. # End:
  5559. @end example
  5560. Remember to execute @kbd{M-x normal-mode} after changing this to make
  5561. the new style visible to Emacs. This command restarts org-mode for the
  5562. current buffer and forces Emacs to re-evaluate the local variables
  5563. section in the buffer.
  5564. @c FIXME: More about header and footer styles
  5565. @c FIXME: Talk about links and targets.
  5566. @node LaTeX export, XOXO export, HTML export, Exporting
  5567. @section LaTeX export
  5568. @cindex LaTeX export
  5569. Org-mode contains a La@TeX{} exporter written by Bastien Guerry.
  5570. @menu
  5571. * LaTeX export commands:: How to invoke LaTeX export
  5572. * Quoting LaTeX code:: Incorporating literal LaTeX code
  5573. * Sectioning structure::
  5574. @end menu
  5575. @node LaTeX export commands, Quoting LaTeX code, LaTeX export, LaTeX export
  5576. @subsection LaTeX export commands
  5577. @table @kbd
  5578. @kindex C-c C-e l
  5579. @item C-c C-e l
  5580. Export as La@TeX{} file @file{myfile.tex}.
  5581. @kindex C-c C-e L
  5582. @item C-c C-e L
  5583. Export to a temporary buffer, do not create a file.
  5584. @kindex C-c C-e v l
  5585. @kindex C-c C-e v L
  5586. @item C-c C-e v l
  5587. @item C-c C-e v L
  5588. Export only the visible part of the document.
  5589. @item M-x org-export-region-as-latex
  5590. Convert the region to La@TeX{} under the assumption that it was org-mode
  5591. syntax before. This is a global command that can be invoked in any
  5592. buffer.
  5593. @item M-x org-replace-region-by-latex
  5594. Replace the active region (assumed to be in Org-mode syntax) by La@TeX{}
  5595. code.
  5596. @end table
  5597. @cindex headline levels, for exporting
  5598. In the exported version, the first 3 outline levels will become
  5599. headlines, defining a general document structure. Additional levels
  5600. will be exported as description lists. The exporter can ignore them or
  5601. convert them to a custom string depending on
  5602. @code{org-latex-low-levels}.
  5603. If you want that transition to occur at a different level, specify it
  5604. with a prefix argument. For example,
  5605. @example
  5606. @kbd{C-2 C-c C-e l}
  5607. @end example
  5608. @noindent
  5609. creates two levels of headings and does the rest as items.
  5610. @node Quoting LaTeX code, Sectioning structure, LaTeX export commands, LaTeX export
  5611. @subsection Quoting LaTeX code
  5612. Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
  5613. inserted into the La@TeX{} file. Forthermore, you can add special code
  5614. that should only be present in La@TeX{} export with the following
  5615. constructs:
  5616. @example
  5617. #+LaTeX: Literal LaTeX code for export
  5618. @end example
  5619. @noindent or
  5620. @example
  5621. #+BEGIN_LaTeX
  5622. All lines between these markers are exported literally
  5623. #+END_LaTeX
  5624. @end example
  5625. @node Sectioning structure, , Quoting LaTeX code, LaTeX export
  5626. @subsection Sectioning structure
  5627. @cindex LaTeX class
  5628. @cindex LaTeX sectioning structure
  5629. By default, the La@TeX{} output uses the class @code{article}.
  5630. You can change this globally by setting a different value for
  5631. @code{org-export-latex-default-class} or locally by adding an option
  5632. like @code{#+LaTeX_CLASS: myclass} in your file. The class should be
  5633. listed in @code{org-export-latex-classes}, where you can also define the
  5634. sectioning structure for each class.
  5635. @node XOXO export, iCalendar export, LaTeX export, Exporting
  5636. @section XOXO export
  5637. @cindex XOXO export
  5638. Org-mode contains an exporter that produces XOXO-style output.
  5639. Currently, this exporter only handles the general outline structure and
  5640. does not interpret any additional Org-mode features.
  5641. @table @kbd
  5642. @kindex C-c C-e x
  5643. @item C-c C-e x
  5644. Export as XOXO file @file{myfile.html}.
  5645. @kindex C-c C-e v
  5646. @item C-c C-e v x
  5647. Export only the visible part of the document.
  5648. @end table
  5649. @node iCalendar export, Text interpretation, XOXO export, Exporting
  5650. @section iCalendar export
  5651. @cindex iCalendar export
  5652. Some people like to use Org-mode for keeping track of projects, but
  5653. still prefer a standard calendar application for anniversaries and
  5654. appointments. In this case it can be useful to have deadlines and
  5655. other time-stamped items in Org-mode files show up in the calendar
  5656. application. Org-mode can export calendar information in the standard
  5657. iCalendar format. If you also want to have TODO entries included in the
  5658. export, configure the variable @code{org-icalendar-include-todo}.
  5659. @table @kbd
  5660. @kindex C-c C-e i
  5661. @item C-c C-e i
  5662. Create iCalendar entries for the current file and store them in the same
  5663. directory, using a file extension @file{.ics}.
  5664. @kindex C-c C-e I
  5665. @item C-c C-e I
  5666. Like @kbd{C-c C-e i}, but do this for all files in
  5667. @code{org-agenda-files}. For each of these files, a separate iCalendar
  5668. file will be written.
  5669. @kindex C-c C-e c
  5670. @item C-c C-e c
  5671. Create a single large iCalendar file from all files in
  5672. @code{org-agenda-files} and write it to the file given by
  5673. @code{org-combined-agenda-icalendar-file}.
  5674. @end table
  5675. The export will honor SUMMARY, DESCRIPTION and LOCATION properties if
  5676. the selected entries have them. If not, the summary will be derived
  5677. from the headline, and the description from the body (limited to
  5678. @code{org-icalendar-include-body} characters).
  5679. How this calendar is best read and updated, depends on the application
  5680. you are using. The FAQ covers this issue.
  5681. @node Text interpretation, , iCalendar export, Exporting
  5682. @section Text interpretation by the exporter
  5683. The exporter backends interpret additional structure in the Org-mode file
  5684. in order to produce better output.
  5685. @menu
  5686. * Comment lines:: Some lines will not be exported
  5687. * Initial text:: Text before the first headline
  5688. * Footnotes:: Numbers like [1]
  5689. * Quoted examples:: Inserting quoted chnuks of text
  5690. * Enhancing text:: Subscripts, symbols and more
  5691. * Export options:: How to influence the export settings
  5692. @end menu
  5693. @node Comment lines, Initial text, Text interpretation, Text interpretation
  5694. @subsection Comment lines
  5695. @cindex comment lines
  5696. @cindex exporting, not
  5697. Lines starting with @samp{#} in column zero are treated as comments
  5698. and will never be exported. Also entire subtrees starting with the
  5699. word @samp{COMMENT} will never be exported.
  5700. @table @kbd
  5701. @kindex C-c ;
  5702. @item C-c ;
  5703. Toggle the COMMENT keyword at the beginning of an entry.
  5704. @end table
  5705. @node Initial text, Footnotes, Comment lines, Text interpretation
  5706. @subsection Text before the first headline
  5707. Org-mode normally ignores any text before the first headline when
  5708. exporting, leaving this region for internal links to speed up navigation
  5709. etc. However, in publishing-oriented files, you might want to have some
  5710. text before the first headline, like a small introduction, special HTML
  5711. code with a navigation bar, etc. You can ask to have this part of the
  5712. file exported as well by setting the variable
  5713. @code{org-export-skip-text-before-1st-heading} to @code{nil}. On a
  5714. per-file basis, you can get the same effect with
  5715. @example
  5716. #+OPTIONS: skip:nil
  5717. @end example
  5718. The text before the first headline will be fully processed
  5719. (@pxref{Enhancing text}), and the first non-comment line becomes the
  5720. title of the exported document. If you need to include literal HTML,
  5721. use the special constructs described in @ref{Quoting HTML tags}. The
  5722. table of contents is normally inserted directly before the first
  5723. headline of the file. If you would like to get it to a different
  5724. location, insert the string @code{[TABLE-OF-CONTENTS]} on a line by
  5725. itself at the desired location.
  5726. Finally, if you want to use the space before the first headline for
  5727. internal purposes, but @emph{still} want to place something before the
  5728. first headline when exporting the file, you can use the @code{#+TEXT}
  5729. construct:
  5730. @example
  5731. #+OPTIONS: skip:t
  5732. #+TEXT: This text will go before the *first* headline.
  5733. #+TEXT: We place the table of contents here:
  5734. #+TEXT: [TABLE-OF-CONTENTS]
  5735. #+TEXT: This goes between the table of contents and the first headline
  5736. @end example
  5737. @node Footnotes, Quoted examples, Initial text, Text interpretation
  5738. @subsection Footnotes
  5739. @cindex footnotes
  5740. @cindex @file{footnote.el}
  5741. Numbers in square brackets are treated as footnotes, so that you can use
  5742. the Emacs package @file{footnote.el} to create footnotes. For example:
  5743. @example
  5744. The org-mode homepage[1] clearly needs help from
  5745. a good web designer.
  5746. [1] The link is: http://orgmode.org
  5747. @end example
  5748. @noindent
  5749. @kindex C-c !
  5750. Note that the @file{footnote} package uses @kbd{C-c !} to invoke its
  5751. commands. This binding conflicts with the org-mode command for
  5752. inserting inactive time stamps. You could use the variable
  5753. @code{footnote-prefix} to switch footnotes commands to another key. Or,
  5754. if you are too used to this binding, you could use
  5755. @code{org-replace-disputed-keys} and @code{org-disputed-keys} to change
  5756. the settings in Org-mode.
  5757. @node Quoted examples, Enhancing text, Footnotes, Text interpretation
  5758. @subsection Quoted examples
  5759. @cindex quoted examples
  5760. @cindex examples, quoted
  5761. @cindex text, fixed width
  5762. @cindex fixed width text
  5763. When writing technical documents, you often need to insert examples that
  5764. are not further interpreted by Org-mode. For historical reasons, there
  5765. are several ways to do this:
  5766. @itemize @bullet
  5767. @item
  5768. If a headline starts with the word @samp{QUOTE}, the text below the
  5769. headline will be typeset as fixed-width, to allow quoting of computer
  5770. codes etc.
  5771. @item
  5772. Lines starting with @samp{:} are also typeset in fixed-width font.
  5773. @table @kbd
  5774. @kindex C-c :
  5775. @item C-c :
  5776. Toggle fixed-width for entry (QUOTE) or region, see below.
  5777. @end table
  5778. @item
  5779. Finally, text between
  5780. @example
  5781. #+BEGIN_EXAMPLE
  5782. quoted text
  5783. #+END_EXAMPLE
  5784. @end example
  5785. will also be exported in this way.
  5786. @end itemize
  5787. @node Enhancing text, Export options, Quoted examples, Text interpretation
  5788. @subsection Enhancing text for export
  5789. @cindex enhancing text
  5790. @cindex richer text
  5791. Some of the export backends of Org-mode allow for sophisticated text
  5792. formatting, this is true in particular for the HTML and La@TeX{}
  5793. backends. Org-mode has a number of typing conventions that allow to
  5794. produce a richly formatted output.
  5795. @itemize @bullet
  5796. @cindex hand-formatted lists
  5797. @cindex lists, hand-formatted
  5798. @item
  5799. Plain lists @samp{-}, @samp{*} or @samp{+} as bullet, or with @samp{1.}
  5800. or @samp{2)} as enumerator will be recognized and transformed if the
  5801. backend supports lists. See @xref{Plain lists}.
  5802. @cindex underlined text
  5803. @cindex bold text
  5804. @cindex italic text
  5805. @cindex verbatim text
  5806. @item
  5807. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
  5808. and @code{~verbatim~}, and, if you must, @samp{+strikethrough+}. Text
  5809. in the code and verbatim string is not processed for org-mode specific
  5810. syntax, it is exported verbatim.
  5811. @cindex horizontal rules, in exported files
  5812. @item
  5813. A line consisting of only dashes, and at least 5 of them, will be
  5814. exported as a horizontal line (@samp{<hr/>} in HTML).
  5815. @cindex LaTeX fragments, export
  5816. @cindex TeX macros, export
  5817. @item
  5818. Many @TeX{} macros and entire La@TeX{} fragments are converted into HTML
  5819. entities or images (@pxref{Embedded LaTeX}).
  5820. @cindex tables, export
  5821. @item
  5822. Tables are transformed into native tables under the exporter, if the
  5823. export backend supports this. Data fields before the first horizontal
  5824. separator line will be formatted as table header fields.
  5825. @cindex fixed width
  5826. @item
  5827. If a headline starts with the word @samp{QUOTE}, the text below the
  5828. headline will be typeset as fixed-width, to allow quoting of computer
  5829. codes etc. Lines starting with @samp{:} are also typeset in fixed-width
  5830. font.
  5831. @table @kbd
  5832. @kindex C-c :
  5833. @item C-c :
  5834. Toggle fixed-width for entry (QUOTE) or region, see below.
  5835. @end table
  5836. Finally, text between
  5837. @example
  5838. #+BEGIN_EXAMPLE
  5839. quoted text
  5840. #+END_EXAMPLE
  5841. @end example
  5842. will also be exported in this way.
  5843. @cindex linebreak, forced
  5844. @item
  5845. A double backslash @emph{at the end of a line} enforces a line break at
  5846. this position.
  5847. @cindex HTML entities, LaTeX entities
  5848. @item
  5849. Strings like @code{\alpha} will be exported as @code{&alpha;}, in the
  5850. HTML output. These strings are exported as @code{$\alpha$} in the
  5851. La@TeX{} output. Similarly, @code{\nbsp} will become @code{&nbsp;} in
  5852. HTML and in La@TeX{}. This applies for a long list of entities, see
  5853. the variable @code{org-html-entities} for the complete list.
  5854. @c FIXME
  5855. @end itemize
  5856. If these conversions conflict with your habits of typing ASCII text,
  5857. they can all be turned off with corresponding variables. See the
  5858. customization group @code{org-export-general}, and the following section
  5859. which explains how to set export options with special lines in a
  5860. buffer.
  5861. @node Export options, , Enhancing text, Text interpretation
  5862. @subsection Export options
  5863. @cindex options, for export
  5864. @cindex completion, of option keywords
  5865. The exporter recognizes special lines in the buffer which provide
  5866. additional information. These lines may be put anywhere in the file.
  5867. The whole set of lines can be inserted into the buffer with @kbd{C-c
  5868. C-e t}. For individual lines, a good way to make sure the keyword is
  5869. correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
  5870. (@pxref{Completion}).
  5871. @table @kbd
  5872. @kindex C-c C-e t
  5873. @item C-c C-e t
  5874. Insert template with export options, see example below.
  5875. @end table
  5876. @example
  5877. #+TITLE: the title to be shown (default is the buffer name)
  5878. #+AUTHOR: the author (default taken from @code{user-full-name})
  5879. #+DATE: A date, fixed, of a format string for @code{format-time-string}
  5880. #+EMAIL: his/her email address (default from @code{user-mail-address})
  5881. #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
  5882. #+TEXT: Some descriptive text to be inserted at the beginning.
  5883. #+TEXT: Several lines may be given.
  5884. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
  5885. @end example
  5886. @noindent
  5887. The OPTIONS line is a compact form to specify export settings. Here
  5888. you can:
  5889. @cindex headline levels
  5890. @cindex section-numbers
  5891. @cindex table of contents
  5892. @cindex linebreak preservation
  5893. @cindex quoted HTML tags
  5894. @cindex fixed-width sections
  5895. @cindex tables
  5896. @cindex @TeX{}-like syntax for sub- and superscripts
  5897. @cindex footnotes
  5898. @cindex special strings
  5899. @cindex emphasized text
  5900. @cindex @TeX{} macros
  5901. @cindex La@TeX{} fragments
  5902. @cindex author info, in export
  5903. @cindex time info, in export
  5904. @example
  5905. H: @r{set the number of headline levels for export}
  5906. num: @r{turn on/off section-numbers}
  5907. toc: @r{turn on/off table of contents, or set level limit (integer)}
  5908. \n: @r{turn on/off linebreak-preservation}
  5909. @@: @r{turn on/off quoted HTML tags}
  5910. :: @r{turn on/off fixed-width sections}
  5911. |: @r{turn on/off tables}
  5912. ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
  5913. @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
  5914. @r{the simple @code{a_b} will be left as it is.}
  5915. -: @r{turn on/off conversion of special strings.}
  5916. f: @r{turn on/off foototes like this[1].}
  5917. *: @r{turn on/off emphasized text (bold, italic, underlined)}
  5918. TeX: @r{turn on/off simple @TeX{} macros in plain text}
  5919. LaTeX: @r{turn on/off La@TeX{} fragments}
  5920. skip: @r{turn on/off skipping the text before the first heading}
  5921. author: @r{turn on/off inclusion of author name/email into exported file}
  5922. timestamp: @r{turn on/off inclusion creation time into exported file}
  5923. d: @r{turn on/off inclusion of drawers}
  5924. @end example
  5925. These options take effect in both the HTML and La@TeX{} export, except
  5926. for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
  5927. @code{nil} for the La@TeX{} export.
  5928. @node Publishing, Miscellaneous, Exporting, Top
  5929. @chapter Publishing
  5930. @cindex publishing
  5931. Org-mode includes@footnote{@file{org-publish.el} is not distributed with
  5932. Emacs 21, if you are still using Emacs 21, you need you need to download
  5933. this file separately.} a publishing management system that allows you to
  5934. configure automatic HTML conversion of @emph{projects} composed of
  5935. interlinked org files. This system is called @emph{org-publish}. You can
  5936. also configure org-publish to automatically upload your exported HTML
  5937. pages and related attachments, such as images and source code files, to
  5938. a web server. Org-publish turns org-mode into a web-site authoring tool.
  5939. You can also use Org-publish to convert files into La@TeX{}, or even
  5940. combine HTML and La@TeX{} conversion so that files are available in both
  5941. formats on the server@footnote{Since La@TeX{} files on a server are not
  5942. that helpful, you surely want to perform further conversion on them --
  5943. e.g. convert them to @code{PDF} format.}.
  5944. Org-publish has been contributed to Org-mode by David O'Toole.
  5945. @menu
  5946. * Configuration:: Defining projects
  5947. * Sample configuration:: Example projects
  5948. * Triggering publication:: Publication commands
  5949. @end menu
  5950. @node Configuration, Sample configuration, Publishing, Publishing
  5951. @section Configuration
  5952. Publishing needs significant configuration to specify files, destination
  5953. and many other properties of a project.
  5954. @menu
  5955. * Project alist:: The central configuration variable
  5956. * Sources and destinations:: From here to there
  5957. * Selecting files:: What files are part of the project?
  5958. * Publishing action:: Setting the function doing the publishing
  5959. * Publishing options:: Tweaking HTML export
  5960. * Publishing links:: Which links keep working after publishing?
  5961. * Project page index:: Publishing a list of project files
  5962. @end menu
  5963. @node Project alist, Sources and destinations, Configuration, Configuration
  5964. @subsection The variable @code{org-publish-project-alist}
  5965. @cindex org-publish-project-alist
  5966. @cindex projects, for publishing
  5967. Org-publish is configured almost entirely through setting the value of
  5968. one variable, called @code{org-publish-project-alist}.
  5969. Each element of the list configures one project, and may be in one of
  5970. the two following forms:
  5971. @lisp
  5972. ("project-name" :property value :property value ...)
  5973. @r{or}
  5974. ("project-name" :components ("project-name" "project-name" ...))
  5975. @end lisp
  5976. In both cases, projects are configured by specifying property values.
  5977. A project defines the set of files that will be published, as well as
  5978. the publishing configuration to use when publishing those files. When
  5979. a project takes the second form listed above, the individual members
  5980. of the ``components'' property are taken to be components of the
  5981. project, which group together files requiring different publishing
  5982. options. When you publish such a ``meta-project'' all the components
  5983. will also publish.
  5984. @node Sources and destinations, Selecting files, Project alist, Configuration
  5985. @subsection Sources and destinations for files
  5986. @cindex directories, for publishing
  5987. Most properties are optional, but some should always be set. In
  5988. particular, org-publish needs to know where to look for source files,
  5989. and where to put published files.
  5990. @multitable @columnfractions 0.3 0.7
  5991. @item @code{:base-directory}
  5992. @tab Directory containing publishing source files
  5993. @item @code{:publishing-directory}
  5994. @tab Directory (possibly remote) where output files will be published.
  5995. @item @code{:preparation-function}
  5996. @tab Function called before starting publishing process, for example to
  5997. run @code{make} for updating files to be published.
  5998. @end multitable
  5999. @noindent
  6000. @node Selecting files, Publishing action, Sources and destinations, Configuration
  6001. @subsection Selecting files
  6002. @cindex files, selecting for publishing
  6003. By default, all files with extension @file{.org} in the base directory
  6004. are considered part of the project. This can be modified by setting the
  6005. properties
  6006. @multitable @columnfractions 0.25 0.75
  6007. @item @code{:base-extension}
  6008. @tab Extension (without the dot!) of source files. This actually is a
  6009. regular expression.
  6010. @item @code{:exclude}
  6011. @tab Regular expression to match file names that should not be
  6012. published, even though they have been selected on the basis of their
  6013. extension.
  6014. @item @code{:include}
  6015. @tab List of files to be included regardless of @code{:base-extension}
  6016. and @code{:exclude}.
  6017. @end multitable
  6018. @node Publishing action, Publishing options, Selecting files, Configuration
  6019. @subsection Publishing Action
  6020. @cindex action, for publishing
  6021. Publishing means that a file is copied to the destination directory and
  6022. possibly transformed in the process. The default transformation is to
  6023. export Org-mode files as HTML files, and this is done by the function
  6024. @code{org-publish-org-to-html} which calls the HTML exporter
  6025. (@pxref{HTML export}). But you also can publish your files in La@TeX{} by
  6026. using the function @code{org-publish-org-to-latex} instead. Other files
  6027. like images only need to be copied to the publishing destination. For
  6028. non-Org-mode files, you need to specify the publishing function.
  6029. @multitable @columnfractions 0.3 0.7
  6030. @item @code{:publishing-function}
  6031. @tab Function executing the publication of a file. This may also be a
  6032. list of functions, which will all be called in turn.
  6033. @end multitable
  6034. The function must accept two arguments: a property list containing at
  6035. least a @code{:publishing-directory} property, and the name of the file
  6036. to be published. It should take the specified file, make the necessary
  6037. transformation (if any) and place the result into the destination folder.
  6038. You can write your own publishing function, but @code{org-publish}
  6039. provides one for attachments (files that only need to be copied):
  6040. @code{org-publish-attachment}.
  6041. @node Publishing options, Publishing links, Publishing action, Configuration
  6042. @subsection Options for the HTML/LaTeX exporters
  6043. @cindex options, for publishing
  6044. The property list can be used to set many export options for the HTML
  6045. and La@TeX{} exporters. In most cases, these properties correspond to user
  6046. variables in Org-mode. The table below lists these properties along
  6047. with the variable they belong to. See the documentation string for the
  6048. respective variable for details.
  6049. @multitable @columnfractions 0.3 0.7
  6050. @item @code{:language} @tab @code{org-export-default-language}
  6051. @item @code{:headline-levels} @tab @code{org-export-headline-levels}
  6052. @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
  6053. @item @code{:table-of-contents} @tab @code{org-export-with-toc}
  6054. @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
  6055. @item @code{:emphasize} @tab @code{org-export-with-emphasize}
  6056. @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
  6057. @item @code{:special-strings} @tab @code{org-export-with-special-strings}
  6058. @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
  6059. @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
  6060. @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
  6061. @item @code{:timestamps} .@tab @code{org-export-with-timestamps}
  6062. @item @code{:tags} .@tab @code{org-export-with-tags}
  6063. @item @code{:tables} @tab @code{org-export-with-tables}
  6064. @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
  6065. @item @code{:style} @tab @code{org-export-html-style}
  6066. @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
  6067. @item @code{:inline-images} @tab @code{org-export-html-inline-images}
  6068. @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
  6069. @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
  6070. @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
  6071. @item @code{:preamble} @tab @code{org-export-html-preamble}
  6072. @item @code{:postamble} @tab @code{org-export-html-postamble}
  6073. @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
  6074. @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
  6075. @item @code{:author} @tab @code{user-full-name}
  6076. @item @code{:email} @tab @code{user-mail-address}
  6077. @end multitable
  6078. If you use several email addresses, separate them by a semi-column.
  6079. Most of the @code{org-export-with-*} variables have the same effect in
  6080. both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
  6081. @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
  6082. La@TeX{} export.
  6083. When a property is given a value in @code{org-publish-project-alist},
  6084. its setting overrides the value of the corresponding user variable (if
  6085. any) during publishing. Options set within a file (@pxref{Export
  6086. options}), however, override everything.
  6087. @node Publishing links, Project page index, Publishing options, Configuration
  6088. @subsection Links between published files
  6089. @cindex links, publishing
  6090. To create a link from one Org-mode file to another, you would use
  6091. something like @samp{[[file:foo.org][The foo]]} or simply
  6092. @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link
  6093. becomes a link to @file{foo.html}. In this way, you can interlink the
  6094. pages of your "org web" project and the links will work as expected when
  6095. you publish them to HTML.
  6096. You may also link to related files, such as images. Provided you are
  6097. careful with relative pathnames, and provided you have also configured
  6098. @code{org-publish} to upload the related files, these links will work
  6099. too. @ref{Complex example} for an example of this usage.
  6100. Sometime an Org-mode file to be published may contain links that are
  6101. only valid in your production environment, but not in the publishing
  6102. location. In this case, use the property
  6103. @multitable @columnfractions 0.4 0.6
  6104. @item @code{:link-validation-function}
  6105. @tab Function to validate links
  6106. @end multitable
  6107. @noindent
  6108. to define a function for checking link validity. This function must
  6109. accept two arguments, the file name and a directory relative to which
  6110. the file name is interpreted in the production environment. If this
  6111. function returns @code{nil}, then the HTML generator will only insert a
  6112. description into the HTML file, but no link. One option for this
  6113. function is @code{org-publish-validate-link} which checks if the given
  6114. file is part of any project in @code{org-publish-project-alist}.
  6115. @node Project page index, , Publishing links, Configuration
  6116. @subsection Project page index
  6117. @cindex index, of published pages
  6118. The following properties may be used to control publishing of an
  6119. index of files or summary page for a given project.
  6120. @multitable @columnfractions 0.25 0.75
  6121. @item @code{:auto-index}
  6122. @tab When non-nil, publish an index during org-publish-current-project or
  6123. org-publish-all.
  6124. @item @code{:index-filename}
  6125. @tab Filename for output of index. Defaults to @file{index.org} (which
  6126. becomes @file{index.html}).
  6127. @item @code{:index-title}
  6128. @tab Title of index page. Defaults to name of file.
  6129. @item @code{:index-function}
  6130. @tab Plugin function to use for generation of index.
  6131. Defaults to @code{org-publish-org-index}, which generates a plain list
  6132. of links to all files in the project.
  6133. @end multitable
  6134. @node Sample configuration, Triggering publication, Configuration, Publishing
  6135. @section Sample configuration
  6136. Below we provide two example configurations. The first one is a simple
  6137. project publishing only a set of Org-mode files. The second example is
  6138. more complex, with a multi-component project.
  6139. @menu
  6140. * Simple example:: One-component publishing
  6141. * Complex example:: A multi-component publishing example
  6142. @end menu
  6143. @node Simple example, Complex example, Sample configuration, Sample configuration
  6144. @subsection Example: simple publishing configuration
  6145. This example publishes a set of Org-mode files to the @file{public_html}
  6146. directory on the local machine.
  6147. @lisp
  6148. (setq org-publish-project-alist
  6149. '(("org"
  6150. :base-directory "~/org/"
  6151. :publishing-directory "~/public_html"
  6152. :section-numbers nil
  6153. :table-of-contents nil
  6154. :style "<link rel=stylesheet
  6155. href=\"../other/mystyle.css\"
  6156. type=\"text/css\">")))
  6157. @end lisp
  6158. @node Complex example, , Simple example, Sample configuration
  6159. @subsection Example: complex publishing configuration
  6160. This more complicated example publishes an entire website, including
  6161. org files converted to HTML, image files, emacs lisp source code, and
  6162. stylesheets. The publishing-directory is remote and private files are
  6163. excluded.
  6164. To ensure that links are preserved, care should be taken to replicate
  6165. your directory structure on the web server, and to use relative file
  6166. paths. For example, if your org files are kept in @file{~/org} and your
  6167. publishable images in @file{~/images}, you'd link to an image with
  6168. @c
  6169. @example
  6170. file:../images/myimage.png
  6171. @end example
  6172. @c
  6173. On the web server, the relative path to the image should be the
  6174. same. You can accomplish this by setting up an "images" folder in the
  6175. right place on the webserver, and publishing images to it.
  6176. @lisp
  6177. (setq org-publish-project-alist
  6178. '(("orgfiles"
  6179. :base-directory "~/org/"
  6180. :base-extension "org"
  6181. :publishing-directory "/ssh:user@@host:~/html/notebook/"
  6182. :publishing-function org-publish-org-to-html
  6183. :exclude "PrivatePage.org" ;; regexp
  6184. :headline-levels 3
  6185. :section-numbers nil
  6186. :table-of-contents nil
  6187. :style "<link rel=stylesheet
  6188. href=\"../other/mystyle.css\" type=\"text/css\">"
  6189. :auto-preamble t
  6190. :auto-postamble nil)
  6191. ("images"
  6192. :base-directory "~/images/"
  6193. :base-extension "jpg\\|gif\\|png"
  6194. :publishing-directory "/ssh:user@@host:~/html/images/"
  6195. :publishing-function org-publish-attachment)
  6196. ("other"
  6197. :base-directory "~/other/"
  6198. :base-extension "css\\|el"
  6199. :publishing-directory "/ssh:user@@host:~/html/other/"
  6200. :publishing-function org-publish-attachment)
  6201. ("website" :components ("orgfiles" "images" "other"))))
  6202. @end lisp
  6203. @node Triggering publication, , Sample configuration, Publishing
  6204. @section Triggering publication
  6205. Once org-publish is properly configured, you can publish with the
  6206. following functions:
  6207. @table @kbd
  6208. @item C-c C-e C
  6209. Prompt for a specific project and publish all files that belong to it.
  6210. @item C-c C-e P
  6211. Publish the project containing the current file.
  6212. @item C-c C-e F
  6213. Publish only the current file.
  6214. @item C-c C-e A
  6215. Publish all projects.
  6216. @end table
  6217. Org uses timestamps to track when a file has changed. The above
  6218. functions normally only publish changed files. You can override this and
  6219. force publishing of all files by giving a prefix argument.
  6220. @node Miscellaneous, Extensions and Hacking, Publishing, Top
  6221. @chapter Miscellaneous
  6222. @menu
  6223. * Completion:: M-TAB knows what you need
  6224. * Customization:: Adapting Org-mode to your taste
  6225. * In-buffer settings:: Overview of the #+KEYWORDS
  6226. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  6227. * Clean view:: Getting rid of leading stars in the outline
  6228. * TTY keys:: Using Org-mode on a tty
  6229. * Interaction:: Other Emacs packages
  6230. * Bugs:: Things which do not work perfectly
  6231. @end menu
  6232. @node Completion, Customization, Miscellaneous, Miscellaneous
  6233. @section Completion
  6234. @cindex completion, of @TeX{} symbols
  6235. @cindex completion, of TODO keywords
  6236. @cindex completion, of dictionary words
  6237. @cindex completion, of option keywords
  6238. @cindex completion, of tags
  6239. @cindex completion, of property keys
  6240. @cindex completion, of link abbreviations
  6241. @cindex @TeX{} symbol completion
  6242. @cindex TODO keywords completion
  6243. @cindex dictionary word completion
  6244. @cindex option keyword completion
  6245. @cindex tag completion
  6246. @cindex link abbreviations, completion of
  6247. Org-mode supports in-buffer completion. This type of completion does
  6248. not make use of the minibuffer. You simply type a few letters into
  6249. the buffer and use the key to complete text right there.
  6250. @table @kbd
  6251. @kindex M-@key{TAB}
  6252. @item M-@key{TAB}
  6253. Complete word at point
  6254. @itemize @bullet
  6255. @item
  6256. At the beginning of a headline, complete TODO keywords.
  6257. @item
  6258. After @samp{\}, complete @TeX{} symbols supported by the exporter.
  6259. @item
  6260. After @samp{*}, complete headlines in the current buffer so that they
  6261. can be used in search links like @samp{[[*find this headline]]}.
  6262. @item
  6263. After @samp{:} in a headline, complete tags. The list of tags is taken
  6264. from the variable @code{org-tag-alist} (possibly set through the
  6265. @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
  6266. dynamically from all tags used in the current buffer.
  6267. @item
  6268. After @samp{:} and not in a headline, complete property keys. The list
  6269. of keys is constructed dynamically from all keys used in the current
  6270. buffer.
  6271. @item
  6272. After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
  6273. @item
  6274. After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
  6275. @samp{OPTIONS} which set file-specific options for Org-mode. When the
  6276. option keyword is already complete, pressing @kbd{M-@key{TAB}} again
  6277. will insert example settings for this keyword.
  6278. @item
  6279. In the line after @samp{#+STARTUP: }, complete startup keywords,
  6280. i.e. valid keys for this line.
  6281. @item
  6282. Elsewhere, complete dictionary words using ispell.
  6283. @end itemize
  6284. @end table
  6285. @node Customization, In-buffer settings, Completion, Miscellaneous
  6286. @section Customization
  6287. @cindex customization
  6288. @cindex options, for customization
  6289. @cindex variables, for customization
  6290. There are more than 180 variables that can be used to customize
  6291. Org-mode. For the sake of compactness of the manual, I am not
  6292. describing the variables here. A structured overview of customization
  6293. variables is available with @kbd{M-x org-customize}. Or select
  6294. @code{Browse Org Group} from the @code{Org->Customization} menu. Many
  6295. settings can also be activated on a per-file basis, by putting special
  6296. lines into the buffer (@pxref{In-buffer settings}).
  6297. @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
  6298. @section Summary of in-buffer settings
  6299. @cindex in-buffer settings
  6300. @cindex special keywords
  6301. Org-mode uses special lines in the buffer to define settings on a
  6302. per-file basis. These lines start with a @samp{#+} followed by a
  6303. keyword, a colon, and then individual words defining a setting. Several
  6304. setting words can be in the same line, but you can also have multiple
  6305. lines for the keyword. While these settings are described throughout
  6306. the manual, here is a summary. After changing any of those lines in the
  6307. buffer, press @kbd{C-c C-c} with the cursor still in the line to
  6308. activate the changes immediately. Otherwise they become effective only
  6309. when the file is visited again in a new Emacs session.
  6310. @table @kbd
  6311. @item #+ARCHIVE: %s_done::
  6312. This line sets the archive location for the agenda file. It applies for
  6313. all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
  6314. of the file. The first such line also applies to any entries before it.
  6315. The corresponding variable is @code{org-archive-location}.
  6316. @item #+CATEGORY:
  6317. This line sets the category for the agenda file. The category applies
  6318. for all subsequent lines until the next @samp{#+CATEGORY} line, or the
  6319. end of the file. The first such line also applies to any entries before it.
  6320. @item #+COLUMNS: %25ITEM .....
  6321. Set the default format for columns view. This format applies when
  6322. columns view is invoked in location where no @code{COLUMNS} property
  6323. applies.
  6324. @item #+CONSTANTS: name1=value1 ...
  6325. Set file-local values for constants to be used in table formulas. This
  6326. line set the local variable @code{org-table-formula-constants-local}.
  6327. The global version of this variable is
  6328. @code{org-table-formula-constants}.
  6329. @item #+DRAWERS: NAME1 .....
  6330. Set the file-local set of drawers. The corresponding global variable is
  6331. @code{org-drawers}.
  6332. @item #+LINK: linkword replace
  6333. These lines (several are allowed) specify link abbreviations.
  6334. @xref{Link abbreviations}. The corresponding variable is
  6335. @code{org-link-abbrev-alist}.
  6336. @item #+PRIORITIES: highest lowest default
  6337. This line sets the limits and the default for the priorities. All three
  6338. must be either letters A-Z or numbers 0-9. The highest priority must
  6339. have a lower ASCII number that the lowest priority.
  6340. @item #+PROPERTY: Property_Name Value
  6341. This line sets a default inheritance value for entries in the current
  6342. buffer, most useful for specifying the allowed values of a property.
  6343. @item #+STARTUP:
  6344. This line sets options to be used at startup of Org-mode, when an
  6345. Org-mode file is being visited. The first set of options deals with the
  6346. initial visibility of the outline tree. The corresponding variable for
  6347. global default settings is @code{org-startup-folded}, with a default
  6348. value @code{t}, which means @code{overview}.
  6349. @cindex @code{overview}, STARTUP keyword
  6350. @cindex @code{content}, STARTUP keyword
  6351. @cindex @code{showall}, STARTUP keyword
  6352. @example
  6353. overview @r{top-level headlines only}
  6354. content @r{all headlines}
  6355. showall @r{no folding at all, show everything}
  6356. @end example
  6357. Then there are options for aligning tables upon visiting a file. This
  6358. is useful in files containing narrowed table columns. The corresponding
  6359. variable is @code{org-startup-align-all-tables}, with a default value
  6360. @code{nil}.
  6361. @cindex @code{align}, STARTUP keyword
  6362. @cindex @code{noalign}, STARTUP keyword
  6363. @example
  6364. align @r{align all tables}
  6365. noalign @r{don't align tables on startup}
  6366. @end example
  6367. Logging TODO state changes and clock intervals (variables
  6368. @code{org-log-done} and @code{org-log-repeat}) can be configured using
  6369. these options.
  6370. @cindex @code{logdone}, STARTUP keyword
  6371. @cindex @code{nologging}, STARTUP keyword
  6372. @cindex @code{lognotedone}, STARTUP keyword
  6373. @cindex @code{lognoteclock-out}, STARTUP keyword
  6374. @cindex @code{lognotestate}, STARTUP keyword
  6375. @cindex @code{logrepeat}, STARTUP keyword
  6376. @cindex @code{nologrepeat}, STARTUP keyword
  6377. @example
  6378. logging @r{record a timestamp when an item is marked DONE}
  6379. nologging @r{don't record when items are marked DONE}
  6380. lognotedone @r{record timestamp and a note when DONE}
  6381. lognotestate @r{record timestamp and a note when TODO state changes}
  6382. logrepeat @r{record a note when re-instating a repeating item}
  6383. nologrepeat @r{do not record when re-instating repeating item}
  6384. lognoteclock-out @r{record timestamp and a note when clocking out}
  6385. @end example
  6386. Here are the options for hiding leading stars in outline headings. The
  6387. corresponding variables are @code{org-hide-leading-stars} and
  6388. @code{org-odd-levels-only}, both with a default setting @code{nil}
  6389. (meaning @code{showstars} and @code{oddeven}).
  6390. @cindex @code{hidestars}, STARTUP keyword
  6391. @cindex @code{showstars}, STARTUP keyword
  6392. @cindex @code{odd}, STARTUP keyword
  6393. @cindex @code{even}, STARTUP keyword
  6394. @example
  6395. hidestars @r{make all but one of the stars starting a headline invisible.}
  6396. showstars @r{show all stars starting a headline}
  6397. odd @r{allow only odd outline levels (1,3,...)}
  6398. oddeven @r{allow all outline levels}
  6399. @end example
  6400. To turn on custom format overlays over time stamps (variables
  6401. @code{org-put-time-stamp-overlays} and
  6402. @code{org-time-stamp-overlay-formats}), use
  6403. @cindex @code{customtime}, STARTUP keyword
  6404. @example
  6405. customtime @r{overlay custom time format}
  6406. @end example
  6407. The following options influence the table spreadsheet (variable
  6408. @code{constants-unit-system}).
  6409. @cindex @code{constcgs}, STARTUP keyword
  6410. @cindex @code{constSI}, STARTUP keyword
  6411. @example
  6412. constcgs @r{@file{constants.el} should use the c-g-s unit system}
  6413. constSI @r{@file{constants.el} should use the SI unit system}
  6414. @end example
  6415. @item #+TAGS: TAG1(c1) TAG2(c2)
  6416. These lines (several such lines are allowed) specify the legal tags in
  6417. this file, and (potentially) the corresponding @emph{fast tag selection}
  6418. keys. The corresponding variable is @code{org-tag-alist}.
  6419. @item #+TBLFM:
  6420. This line contains the formulas for the table directly above the line.
  6421. @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:
  6422. These lines provide settings for exporting files. For more details see
  6423. @ref{Export options}.
  6424. @item #+SEQ_TODO: #+TYP_TODO:
  6425. These lines set the TODO keywords and their interpretation in the
  6426. current file. The corresponding variables are @code{org-todo-keywords}
  6427. and @code{org-todo-interpretation}.
  6428. @end table
  6429. @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
  6430. @section The very busy C-c C-c key
  6431. @kindex C-c C-c
  6432. @cindex C-c C-c, overview
  6433. The key @kbd{C-c C-c} has many purposes in org-mode, which are all
  6434. mentioned scattered throughout this manual. One specific function of
  6435. this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
  6436. other circumstances it means something like @emph{Hey Org-mode, look
  6437. here and update according to what you see here}. Here is a summary of
  6438. what this means in different contexts.
  6439. @itemize @minus
  6440. @item
  6441. If there are highlights in the buffer from the creation of a sparse
  6442. tree, or from clock display, remove these highlights.
  6443. @item
  6444. If the cursor is in one of the special @code{#+KEYWORD} lines, this
  6445. triggers scanning the buffer for these lines and updating the
  6446. information.
  6447. @item
  6448. If the cursor is inside a table, realign the table. This command
  6449. works even if the automatic table editor has been turned off.
  6450. @item
  6451. If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
  6452. the entire table.
  6453. @item
  6454. If the cursor is inside a table created by the @file{table.el} package,
  6455. activate that table.
  6456. @item
  6457. If the current buffer is a remember buffer, close the note and file it.
  6458. With a prefix argument, file it, without further interaction, to the
  6459. default location.
  6460. @item
  6461. If the cursor is on a @code{<<<target>>>}, update radio targets and
  6462. corresponding links in this buffer.
  6463. @item
  6464. If the cursor is in a property line or at the start or end of a property
  6465. drawer, offer property commands.
  6466. @item
  6467. If the cursor is in a plain list item with a checkbox, toggle the status
  6468. of the checkbox.
  6469. @item
  6470. If the cursor is on a numbered item in a plain list, renumber the
  6471. ordered list.
  6472. @item
  6473. If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
  6474. block is updated.
  6475. @end itemize
  6476. @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
  6477. @section A cleaner outline view
  6478. @cindex hiding leading stars
  6479. @cindex clean outline view
  6480. Some people find it noisy and distracting that the Org-mode headlines
  6481. are starting with a potentially large number of stars. For example
  6482. the tree from @ref{Headlines}:
  6483. @example
  6484. * Top level headline
  6485. ** Second level
  6486. *** 3rd level
  6487. some text
  6488. *** 3rd level
  6489. more text
  6490. * Another top level headline
  6491. @end example
  6492. @noindent
  6493. Unfortunately this is deeply ingrained into the code of Org-mode and
  6494. cannot be easily changed. You can, however, modify the display in such
  6495. a way that all leading stars become invisible and the outline more easy
  6496. to read. To do this, customize the variable
  6497. @code{org-hide-leading-stars} like this:
  6498. @lisp
  6499. (setq org-hide-leading-stars t)
  6500. @end lisp
  6501. @noindent
  6502. or change this on a per-file basis with one of the lines (anywhere in
  6503. the buffer)
  6504. @example
  6505. #+STARTUP: showstars
  6506. #+STARTUP: hidestars
  6507. @end example
  6508. @noindent
  6509. Press @kbd{C-c C-c} with the cursor in a @samp{STARTUP} line to activate
  6510. the modifications.
  6511. With stars hidden, the tree becomes:
  6512. @example
  6513. * Top level headline
  6514. * Second level
  6515. * 3rd level
  6516. some text
  6517. * 3rd level
  6518. more text
  6519. * Another top level headline
  6520. @end example
  6521. @noindent
  6522. Note that the leading stars are not truly replaced by whitespace, they
  6523. are only fontified with the face @code{org-hide} that uses the
  6524. background color as font color. If you are not using either white or
  6525. black background, you may have to customize this face to get the wanted
  6526. effect. Another possibility is to set this font such that the extra
  6527. stars are @i{almost} invisible, for example using the color
  6528. @code{grey90} on a white background.
  6529. Things become cleaner still if you skip all the even levels and use only
  6530. odd levels 1, 3, 5..., effectively adding two stars to go from one
  6531. outline level to the next:
  6532. @example
  6533. * Top level headline
  6534. * Second level
  6535. * 3rd level
  6536. some text
  6537. * 3rd level
  6538. more text
  6539. * Another top level headline
  6540. @end example
  6541. @noindent
  6542. In order to make the structure editing and export commands handle this
  6543. convention correctly, use
  6544. @lisp
  6545. (setq org-odd-levels-only t)
  6546. @end lisp
  6547. @noindent
  6548. or set this on a per-file basis with one of the following lines (don't
  6549. forget to press @kbd{C-c C-c} with the cursor in the startup line to
  6550. activate changes immediately).
  6551. @example
  6552. #+STARTUP: odd
  6553. #+STARTUP: oddeven
  6554. @end example
  6555. You can convert an Org-mode file from single-star-per-level to the
  6556. double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
  6557. RET} in that file. The reverse operation is @kbd{M-x
  6558. org-convert-to-oddeven-levels}.
  6559. @node TTY keys, Interaction, Clean view, Miscellaneous
  6560. @section Using org-mode on a tty
  6561. @cindex tty keybindings
  6562. Because Org-mode contains a large number of commands, by default much of
  6563. Org-mode's core commands are bound to keys that are generally not
  6564. accessible on a tty, such as the cursor keys (@key{left}, @key{right},
  6565. @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
  6566. together with modifiers like @key{Meta} and/or @key{Shift}. To access
  6567. these commands on a tty when special keys are unavailable, the following
  6568. alternative bindings can be used. The tty bindings below will likely be
  6569. more cumbersome; you may find for some of the bindings below that a
  6570. customized work-around suits you better. For example, changing a time
  6571. stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
  6572. tty you would rather use @kbd{C-c .} to re-insert the timestamp.
  6573. @multitable @columnfractions 0.15 0.2 0.2
  6574. @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
  6575. @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
  6576. @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
  6577. @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
  6578. @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
  6579. @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
  6580. @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
  6581. @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
  6582. @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
  6583. @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
  6584. @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
  6585. @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
  6586. @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
  6587. @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
  6588. @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
  6589. @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
  6590. @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
  6591. @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
  6592. @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
  6593. @end multitable
  6594. @node Interaction, Bugs, TTY keys, Miscellaneous
  6595. @section Interaction with other packages
  6596. @cindex packages, interaction with other
  6597. Org-mode lives in the world of GNU Emacs and interacts in various ways
  6598. with other code out there.
  6599. @menu
  6600. * Cooperation:: Packages Org-mode cooperates with
  6601. * Conflicts:: Packages that lead to conflicts
  6602. @end menu
  6603. @node Cooperation, Conflicts, Interaction, Interaction
  6604. @subsection Packages that Org-mode cooperates with
  6605. @table @asis
  6606. @cindex @file{calc.el}
  6607. @item @file{calc.el} by Dave Gillespie
  6608. Org-mode uses the calc package for implementing spreadsheet
  6609. functionality in its tables (@pxref{The spreadsheet}). Org-mode
  6610. checks for the availability of calc by looking for the function
  6611. @code{calc-eval} which should be autoloaded in your setup if calc has
  6612. been installed properly. As of Emacs 22, calc is part of the Emacs
  6613. distribution. Another possibility for interaction between the two
  6614. packages is using calc for embedded calculations. @xref{Embedded Mode,
  6615. , Embedded Mode, calc, GNU Emacs Calc Manual}.
  6616. @cindex @file{constants.el}
  6617. @item @file{constants.el} by Carsten Dominik
  6618. In a table formula (@pxref{The spreadsheet}), it is possible to use
  6619. names for natural constants or units. Instead of defining your own
  6620. constants in the variable @code{org-table-formula-constants}, install
  6621. the @file{constants} package which defines a large number of constants
  6622. and units, and lets you use unit prefixes like @samp{M} for
  6623. @samp{Mega} etc. You will need version 2.0 of this package, available
  6624. at @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks for
  6625. the function @code{constants-get}, which has to be autoloaded in your
  6626. setup. See the installation instructions in the file
  6627. @file{constants.el}.
  6628. @item @file{cdlatex.el} by Carsten Dominik
  6629. @cindex @file{cdlatex.el}
  6630. Org-mode can make use of the cdlatex package to efficiently enter
  6631. La@TeX{} fragments into Org-mode files. See @ref{CDLaTeX mode}.
  6632. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
  6633. @cindex @file{imenu.el}
  6634. Imenu allows menu access to an index of items in a file. Org-mode
  6635. supports imenu - all you need to do to get the index is the following:
  6636. @lisp
  6637. (add-hook 'org-mode-hook
  6638. (lambda () 'imenu-add-to-menubar "Imenu"))
  6639. @end lisp
  6640. By default the index is two levels deep - you can modify the depth using
  6641. the option @code{org-imenu-depth}.
  6642. @item @file{remember.el} by John Wiegley
  6643. @cindex @file{remember.el}
  6644. Org mode cooperates with remember, see @ref{Remember}.
  6645. @file{Remember.el} is not part of Emacs, find it on the web.
  6646. @item @file{speedbar.el} by Eric M. Ludlam
  6647. @cindex @file{speedbar.el}
  6648. Speedbar is a package that creates a special frame displaying files and
  6649. index items in files. Org-mode supports speedbar and allows you to
  6650. drill into Org-mode files directly from the speedbar. It also allows to
  6651. restrict the scope of agenda commands to a file or a subtree by using
  6652. the command @kbd{<} in the speedbar frame.
  6653. @cindex @file{table.el}
  6654. @item @file{table.el} by Takaaki Ota
  6655. @kindex C-c C-c
  6656. @cindex table editor, @file{table.el}
  6657. @cindex @file{table.el}
  6658. Complex ASCII tables with automatic line wrapping, column- and
  6659. row-spanning, and alignment can be created using the Emacs table
  6660. package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
  6661. and also part of Emacs 22).
  6662. When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode
  6663. will call @command{table-recognize-table} and move the cursor into the
  6664. table. Inside a table, the keymap of Org-mode is inactive. In order
  6665. to execute Org-mode-related commands, leave the table.
  6666. @table @kbd
  6667. @kindex C-c C-c
  6668. @item C-c C-c
  6669. Recognize @file{table.el} table. Works when the cursor is in a
  6670. table.el table.
  6671. @c
  6672. @kindex C-c ~
  6673. @item C-c ~
  6674. Insert a table.el table. If there is already a table at point, this
  6675. command converts it between the table.el format and the Org-mode
  6676. format. See the documentation string of the command
  6677. @code{org-convert-table} for the restrictions under which this is
  6678. possible.
  6679. @end table
  6680. @file{table.el} is part of Emacs 22.
  6681. @cindex @file{footnote.el}
  6682. @item @file{footnote.el} by Steven L. Baur
  6683. Org-mode recognizes numerical footnotes as provided by this package
  6684. (@pxref{Footnotes}).
  6685. @end table
  6686. @node Conflicts, , Cooperation, Interaction
  6687. @subsection Packages that lead to conflicts with Org-mode
  6688. @table @asis
  6689. @cindex @file{allout.el}
  6690. @item @file{allout.el} by Ken Manheimer
  6691. Startup of Org-mode may fail with the error message
  6692. @code{(wrong-type-argument keymapp nil)} when there is an outdated
  6693. version @file{allout.el} on the load path, for example the version
  6694. distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will
  6695. disappear. If for some reason you cannot do this, make sure that org.el
  6696. is loaded @emph{before} @file{allout.el}, for example by putting
  6697. @code{(require 'org)} early enough into your @file{.emacs} file.
  6698. @cindex @file{CUA.el}
  6699. @item @file{CUA.el} by Kim. F. Storm
  6700. Keybindings in Org-mode conflict with the @kbd{S-<cursor>} keys used by
  6701. CUA-mode (as well as pc-select-mode and s-region-mode) to select and
  6702. extend the region. If you want to use one of these packages along with
  6703. Org-mode, configure the variable @code{org-replace-disputed-keys}. When
  6704. set, Org-mode will move the following keybindings in Org-mode files, and
  6705. in the agenda buffer (but not during date selection).
  6706. @example
  6707. S-UP -> M-p S-DOWN -> M-n
  6708. S-LEFT -> M-- S-RIGHT -> M-+
  6709. @end example
  6710. Yes, these are unfortunately more difficult to remember. If you want
  6711. to have other replacement keys, look at the variable
  6712. @code{org-disputed-keys}.
  6713. @item @file{windmove.el} by Hovav Shacham
  6714. @cindex @file{windmove.el}
  6715. Also this package uses the @kbd{S-<cursor>} keys, so everything written
  6716. in the paragraph above about CUA mode also applies here.
  6717. @cindex @file{footnote.el}
  6718. @item @file{footnote.el} by Steven L. Baur
  6719. Org-mode supports the syntax of the footnote package, but only the
  6720. numerical footnote markers. Also, the default key for footnote
  6721. commands, @kbd{C-c !} is already used by Org-mode. You could use the
  6722. variable @code{footnote-prefix} to switch footnotes commands to another
  6723. key. Or, you could use @code{org-replace-disputed-keys} and
  6724. @code{org-disputed-keys} to change the settings in Org-mode.
  6725. @end table
  6726. @node Bugs, , Interaction, Miscellaneous
  6727. @section Bugs
  6728. @cindex bugs
  6729. Here is a list of things that should work differently, but which I
  6730. have found too hard to fix.
  6731. @itemize @bullet
  6732. @item
  6733. If a table field starts with a link, and if the corresponding table
  6734. column is narrowed (@pxref{Narrow columns}) to a width too small to
  6735. display the link, the field would look entirely empty even though it is
  6736. not. To prevent this, Org-mode throws an error. The work-around is to
  6737. make the column wide enough to fit the link, or to add some text (at
  6738. least 2 characters) before the link in the same field.
  6739. @item
  6740. Narrowing table columns does not work on XEmacs, because the
  6741. @code{format} function does not transport text properties.
  6742. @item
  6743. Text in an entry protected with the @samp{QUOTE} keyword should not
  6744. autowrap.
  6745. @item
  6746. When the application called by @kbd{C-c C-o} to open a file link fails
  6747. (for example because the application does not exist or refuses to open
  6748. the file), it does so silently. No error message is displayed.
  6749. @item
  6750. Recalculating a table line applies the formulas from left to right.
  6751. If a formula uses @emph{calculated} fields further down the row,
  6752. multiple recalculation may be needed to get all fields consistent. You
  6753. may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to
  6754. recalculate until convergence.
  6755. @item
  6756. A single letter cannot be made bold, for example @samp{*a*}.
  6757. @item
  6758. The exporters work well, but could be made more efficient.
  6759. @end itemize
  6760. @node Extensions and Hacking, History and Acknowledgments, Miscellaneous, Top
  6761. @appendix Extensions, Hooks and Hacking
  6762. This appendix lists extensions for Org-mode written by other authors.
  6763. It also covers some aspects where users can extend the functionality of
  6764. Org-mode.
  6765. @menu
  6766. * Extensions:: Existing 3rd-part extensions
  6767. * Adding hyperlink types:: New custom link types
  6768. * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
  6769. * Dynamic blocks:: Automatically filled blocks
  6770. * Special agenda views:: Customized views
  6771. * Using the property API:: Writing programs that use entry properties
  6772. @end menu
  6773. @node Extensions, Adding hyperlink types, Extensions and Hacking, Extensions and Hacking
  6774. @section Third-party extensions for Org-mode
  6775. @cindex extension, third-party
  6776. The following extensions for Org-mode have been written by other people:
  6777. @table @asis
  6778. @cindex @file{org-publish.el}
  6779. @item @file{org-publish.el} by David O'Toole
  6780. This package provides facilities for publishing related sets of Org-mode
  6781. files together with linked files like images as webpages. It is
  6782. highly configurable and can be used for other publishing purposes as
  6783. well. As of Org-mode version 4.30, @file{org-publish.el} is part of the
  6784. Org-mode distribution. It is not yet part of Emacs, however, a delay
  6785. caused by the preparations for the 22.1 release. In the mean time,
  6786. @file{org-publish.el} can be downloaded from David's site:
  6787. @url{http://dto.freeshell.org/e/org-publish.el}.
  6788. @cindex @file{org-mouse.el}
  6789. @item @file{org-mouse.el} by Piotr Zielinski
  6790. This package implements extended mouse functionality for Org-mode. It
  6791. allows you to cycle visibility and to edit the document structure with
  6792. the mouse. Best of all, it provides a context-sensitive menu on
  6793. @key{mouse-3} that changes depending on the context of a mouse-click.
  6794. As of Org-mode version 4.53, @file{org-mouse.el} is part of the
  6795. Org-mode distribution. It is not yet part of Emacs, however, a delay
  6796. caused by the preparations for the 22.1 release. In the mean time,
  6797. @file{org-mouse.el} can be downloaded from Piotr's site:
  6798. @url{http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el}.
  6799. @cindex @file{org-blog.el}
  6800. @item @file{org-blog.el} by David O'Toole
  6801. A blogging plug-in for @file{org-publish.el}.@*
  6802. @url{http://dto.freeshell.org/notebook/OrgMode.html}.
  6803. @cindex @file{blorg.el}
  6804. @item @file{blorg.el} by Bastien Guerry
  6805. Publish Org-mode files as
  6806. blogs. @url{http://www.cognition.ens.fr/~guerry/blorg.html}.
  6807. @cindex @file{org2rem.el}
  6808. @item @file{org2rem.el} by Bastien Guerry
  6809. Translates Org-mode files into something readable by
  6810. Remind. @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}.
  6811. @item @file{org-toc.el} by Bastien Guerry
  6812. Produces a simple table of contents of an Org-mode file, for easy
  6813. navigation. @url{http://www.cognition.ens.fr/~guerry/u/org-registry.el}.
  6814. @item @file{org-registry.el} by Bastien Guerry
  6815. Find which Org-file link to a certain document.
  6816. @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}.
  6817. @end table
  6818. @page
  6819. @node Adding hyperlink types, Tables in arbitrary syntax, Extensions, Extensions and Hacking
  6820. @section Adding hyperlink types
  6821. @cindex hyperlinks, adding new types
  6822. Org-mode has a large number of hyperlink types built-in
  6823. (@pxref{Hyperlinks}). If you would like to add new link types, it
  6824. provides an interface for doing so. Lets look at an example file
  6825. @file{org-man.el} that will add support for creating links like
  6826. @samp{[[man:printf][The printf manpage]]} to show unix manual pages inside
  6827. emacs:
  6828. @lisp
  6829. ;;; org-man.el - Support for links to manpages in Org-mode
  6830. (require 'org)
  6831. (org-add-link-type "man" 'org-man-open)
  6832. (add-hook 'org-store-link-functions 'org-man-store-link)
  6833. (defcustom org-man-command 'man
  6834. "The Emacs command to be used to display a man page."
  6835. :group 'org-link
  6836. :type '(choice (const man) (const woman)))
  6837. (defun org-man-open (path)
  6838. "Visit the manpage on PATH.
  6839. PATH should be a topic that can be thrown at the man command."
  6840. (funcall org-man-command path))
  6841. (defun org-man-store-link ()
  6842. "Store a link to a manpage."
  6843. (when (memq major-mode '(Man-mode woman-mode))
  6844. ;; This is a man page, we do make this link
  6845. (let* ((page (org-man-get-page-name))
  6846. (link (concat "man:" page))
  6847. (description (format "Manpage for %s" page)))
  6848. (org-store-link-props
  6849. :type "man"
  6850. :link link
  6851. :description description))))
  6852. (defun org-man-get-page-name ()
  6853. "Extract the page name from the buffer name."
  6854. ;; This works for both `Man-mode' and `woman-mode'.
  6855. (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
  6856. (match-string 1 (buffer-name))
  6857. (error "Cannot create link to this man page")))
  6858. (provide 'org-man)
  6859. ;;; org-man.el ends here
  6860. @end lisp
  6861. @noindent
  6862. You would activate this new link type in @file{.emacs} with
  6863. @lisp
  6864. (require 'org-man)
  6865. @end lisp
  6866. @noindent
  6867. Lets go through the file and see what it does.
  6868. @enumerate
  6869. @item
  6870. It does @code{(require 'org)} to make sure that @file{org.el} has been
  6871. loaded.
  6872. @item
  6873. The next line calls @code{org-add-link-type} to define a new link type
  6874. with prefix @samp{man}. The call also contains the name of a function
  6875. that will be called to follow such a link.
  6876. @item
  6877. The next line adds a function to @code{org-store-link-functions}, in
  6878. order to allow the command @kbd{C-c l} to record a useful link in a
  6879. buffer displaying a man page.
  6880. @end enumerate
  6881. The rest of the file defines the necessary variables and functions.
  6882. First there is a customization variable that determines which emacs
  6883. command should be used to display manpages. There are two options,
  6884. @code{man} and @code{woman}. Then the function to follow a link is
  6885. defined. It gets the link path as an argument - in this case the link
  6886. path is just a topic for the manual command. The function calls the
  6887. value of @code{org-man-command} to display the man page.
  6888. Finally the function @code{org-man-store-link} is defined. When you try
  6889. to store a link with @kbd{C-c l}, also this function will be called to
  6890. try to make a link. The function must first decide if it is supposed to
  6891. create the link for this buffer type, we do this by checking the value
  6892. of the variable @code{major-mode}. If not, the function must exit and
  6893. retunr the value @code{nil}. If yes, the link is created by getting the
  6894. manual tpoic from the buffer name and prefixing it with the string
  6895. @samp{man:}. Then it must call the command @code{org-store-link-props}
  6896. and set the @code{:type} and @code{:link} properties. Optionally you
  6897. can also set the @code{:description} property to provide a default for
  6898. the link description when the link is later inserted into tan Org-mode
  6899. buffer with @kbd{C-c C-l}.
  6900. @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Extensions and Hacking
  6901. @section Tables and Lists in arbitrary syntax
  6902. @cindex tables, in other modes
  6903. @cindex lists, in other modes
  6904. @cindex orgtbl-mode
  6905. Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
  6906. frequent feature request has been to make it work with native tables in
  6907. specific languages, for example La@TeX{}. However, this is extremely
  6908. hard to do in a general way, would lead to a customization nightmare,
  6909. and would take away much of the simplicity of the Orgtbl-mode table
  6910. editor.
  6911. This appendix describes a different approach. We keep the Orgtbl-mode
  6912. table in its native format (the @i{source table}), and use a custom
  6913. function to @i{translate} the table to the correct syntax, and to
  6914. @i{install} it in the right location (the @i{target table}). This puts
  6915. the burden of writing conversion functions on the user, but it allows
  6916. for a very flexible system.
  6917. Bastien added the ability to do the same with lists. You can use Org's
  6918. facilities to edit and structure lists by turning @code{orgstruct-mode}
  6919. on, then locally exporting such lists in another format (HTML, La@TeX{}
  6920. or TeXInfo.)
  6921. @menu
  6922. * Radio tables:: Sending and receiving
  6923. * A LaTeX example:: Step by step, almost a tutorial
  6924. * Translator functions:: Copy and modify
  6925. * Radio lists:: Doing the same for lists.
  6926. @end menu
  6927. @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
  6928. @subsection Radio tables
  6929. @cindex radio tables
  6930. To define the location of the target table, you first need to create two
  6931. lines that are comments in the current mode, but contain magic words for
  6932. Orgtbl-mode to find. Orgtbl-mode will insert the translated table
  6933. between these lines, replacing whatever was there before. For example:
  6934. @example
  6935. /* BEGIN RECEIVE ORGTBL table_name */
  6936. /* END RECEIVE ORGTBL table_name */
  6937. @end example
  6938. @noindent
  6939. Just above the source table, we put a special line that tells
  6940. Orgtbl-mode how to translate this table and where to install it. For
  6941. example:
  6942. @example
  6943. #+ORGTBL: SEND table_name translation_function arguments....
  6944. @end example
  6945. @noindent
  6946. @code{table_name} is the reference name for the table that is also used
  6947. in the receiver lines. @code{translation_function} is the Lisp function
  6948. that does the translation. Furthermore, the line can contain a list of
  6949. arguments (alternating key and value) at the end. The arguments will be
  6950. passed as a property list to the translation function for
  6951. interpretation. A few standard parameters are already recognized and
  6952. acted upon before the translation function is called:
  6953. @table @code
  6954. @item :skip N
  6955. Skip the first N lines of the table. Hlines do count!
  6956. @item :skipcols (n1 n2 ...)
  6957. List of columns that should be skipped. If the table has a column with
  6958. calculation marks, that column is automatically discarded as well.
  6959. Please note that the translator function sees the table @emph{after} the
  6960. removal of these columns, the function never knows that there have been
  6961. additional columns.
  6962. @end table
  6963. @noindent
  6964. The one problem remaining is how to keep the source table in the buffer
  6965. without disturbing the normal workings of the file, for example during
  6966. compilation of a C file or processing of a La@TeX{} file. There are a
  6967. number of different solutions:
  6968. @itemize @bullet
  6969. @item
  6970. The table could be placed in a block comment if that is supported by the
  6971. language. For example, in C-mode you could wrap the table between
  6972. @samp{/*} and @samp{*/} lines.
  6973. @item
  6974. Sometimes it is possible to put the table after some kind of @i{END}
  6975. statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
  6976. in La@TeX{}.
  6977. @item
  6978. You can just comment the table line by line whenever you want to process
  6979. the file, and uncomment it whenever you need to edit the table. This
  6980. only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
  6981. make this comment-toggling very easy, in particular if you bind it to a
  6982. key.
  6983. @end itemize
  6984. @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
  6985. @subsection A LaTeX example of radio tables
  6986. @cindex LaTeX, and orgtbl-mode
  6987. The best way to wrap the source table in La@TeX{} is to use the
  6988. @code{comment} environment provided by @file{comment.sty}. It has to be
  6989. activated by placing @code{\usepackage@{comment@}} into the document
  6990. header. Orgtbl-mode can insert a radio table skeleton@footnote{By
  6991. default this works only for La@TeX{}, HTML, and TeXInfo. Configure the
  6992. variable @code{orgtbl-radio-tables} to install templates for other
  6993. modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
  6994. be prompted for a table name, lets say we use @samp{salesfigures}. You
  6995. will then get the following template:
  6996. @example
  6997. % BEGIN RECEIVE ORGTBL salesfigures
  6998. % END RECEIVE ORGTBL salesfigures
  6999. \begin@{comment@}
  7000. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  7001. | | |
  7002. \end@{comment@}
  7003. @end example
  7004. @noindent
  7005. The @code{#+ORGTBL: SEND} line tells orgtbl-mode to use the function
  7006. @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
  7007. into the receiver location with name @code{salesfigures}. You may now
  7008. fill in the table, feel free to use the spreadsheet features@footnote{If
  7009. the @samp{#+TBLFM} line contains an odd number of dollar characters,
  7010. this may cause problems with font-lock in latex-mode. As shown in the
  7011. example you can fix this by adding an extra line inside the
  7012. @code{comment} environment that is used to balance the dollar
  7013. expressions. If you are using AUCTeX with the font-latex library, a
  7014. much better solution is to add the @code{comment} environment to the
  7015. variable @code{LaTeX-verbatim-environments}.}:
  7016. @example
  7017. % BEGIN RECEIVE ORGTBL salesfigures
  7018. % END RECEIVE ORGTBL salesfigures
  7019. \begin@{comment@}
  7020. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  7021. | Month | Days | Nr sold | per day |
  7022. |-------+------+---------+---------|
  7023. | Jan | 23 | 55 | 2.4 |
  7024. | Feb | 21 | 16 | 0.8 |
  7025. | March | 22 | 278 | 12.6 |
  7026. #+TBLFM: $4=$3/$2;%.1f
  7027. % $ (optional extra dollar to keep font-lock happy, see footnote)
  7028. \end@{comment@}
  7029. @end example
  7030. @noindent
  7031. When you are done, press @kbd{C-c C-c} in the table to get the converted
  7032. table inserted between the two marker lines.
  7033. Now lets assume you want to make the table header by hand, because you
  7034. want to control how columns are aligned etc. In this case we make sure
  7035. that the table translator does skip the first 2 lines of the source
  7036. table, and tell the command to work as a @i{splice}, i.e. to not produce
  7037. header and footer commands of the target table:
  7038. @example
  7039. \begin@{tabular@}@{lrrr@}
  7040. Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
  7041. % BEGIN RECEIVE ORGTBL salesfigures
  7042. % END RECEIVE ORGTBL salesfigures
  7043. \end@{tabular@}
  7044. %
  7045. \begin@{comment@}
  7046. #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
  7047. | Month | Days | Nr sold | per day |
  7048. |-------+------+---------+---------|
  7049. | Jan | 23 | 55 | 2.4 |
  7050. | Feb | 21 | 16 | 0.8 |
  7051. | March | 22 | 278 | 12.6 |
  7052. #+TBLFM: $4=$3/$2;%.1f
  7053. \end@{comment@}
  7054. @end example
  7055. The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
  7056. Orgtbl-mode. It uses a @code{tabular} environment to typeset the table
  7057. and marks horizontal lines with @code{\hline}. Furthermore, it
  7058. interprets the following parameters:
  7059. @table @code
  7060. @item :splice nil/t
  7061. When set to t, return only table body lines, don't wrap them into a
  7062. tabular environment. Default is nil.
  7063. @item :fmt fmt
  7064. A format to be used to wrap each field, should contain @code{%s} for the
  7065. original field value. For example, to wrap each field value in dollars,
  7066. you could use @code{:fmt "$%s$"}. This may also be a property list with
  7067. column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
  7068. @item :efmt efmt
  7069. Use this format to print numbers with exponentials. The format should
  7070. have @code{%s} twice for inserting mantissa and exponent, for example
  7071. @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
  7072. may also be a property list with column numbers and formats, for example
  7073. @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
  7074. @code{efmt} has been applied to a value, @code{fmt} will also be
  7075. applied.
  7076. @end table
  7077. @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
  7078. @subsection Translator functions
  7079. @cindex HTML, and orgtbl-mode
  7080. @cindex translator function
  7081. Orgtbl-mode has several translator functions built-in:
  7082. @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and
  7083. @code{orgtbl-to-texinfo}. Except for @code{orgtbl-to-html}@footnote{The
  7084. HTML translator uses the same code that produces tables during HTML
  7085. export.}, these all use a generic translator, @code{orgtbl-to-generic}.
  7086. For example, @code{orgtbl-to-latex} itself is a very short function that
  7087. computes the column definitions for the @code{tabular} environment,
  7088. defines a few field and line separators and then hands over to the
  7089. generic translator. Here is the entire code:
  7090. @lisp
  7091. @group
  7092. (defun orgtbl-to-latex (table params)
  7093. "Convert the orgtbl-mode TABLE to LaTeX."
  7094. (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
  7095. org-table-last-alignment ""))
  7096. (params2
  7097. (list
  7098. :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
  7099. :tend "\\end@{tabular@}"
  7100. :lstart "" :lend " \\\\" :sep " & "
  7101. :efmt "%s\\,(%s)" :hline "\\hline")))
  7102. (orgtbl-to-generic table (org-combine-plists params2 params))))
  7103. @end group
  7104. @end lisp
  7105. As you can see, the properties passed into the function (variable
  7106. @var{PARAMS}) are combined with the ones newly defined in the function
  7107. (variable @var{PARAMS2}). The ones passed into the function (i.e. the
  7108. ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
  7109. would like to use the La@TeX{} translator, but wanted the line endings to
  7110. be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
  7111. overrule the default with
  7112. @example
  7113. #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
  7114. @end example
  7115. For a new language, you can either write your own converter function in
  7116. analogy with the La@TeX{} translator, or you can use the generic function
  7117. directly. For example, if you have a language where a table is started
  7118. with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
  7119. started with @samp{!BL!}, ended with @samp{!EL!} and where the field
  7120. separator is a TAB, you could call the generic translator like this (on
  7121. a single line!):
  7122. @example
  7123. #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
  7124. :lstart "!BL! " :lend " !EL!" :sep "\t"
  7125. @end example
  7126. @noindent
  7127. Please check the documentation string of the function
  7128. @code{orgtbl-to-generic} for a full list of parameters understood by
  7129. that function and remember that you can pass each of them into
  7130. @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
  7131. using the generic function.
  7132. Of course you can also write a completely new function doing complicated
  7133. things the generic translator cannot do. A translator function takes
  7134. two arguments. The first argument is the table, a list of lines, each
  7135. line either the symbol @code{hline} or a list of fields. The second
  7136. argument is the property list containing all parameters specified in the
  7137. @samp{#+ORGTBL: SEND} line. The function must return a single string
  7138. containing the formatted table. If you write a generally useful
  7139. translator, please post it on @code{emacs-orgmode@@gnu.org} so that
  7140. others can benefit from your work.
  7141. @node Radio lists, , Translator functions, Tables in arbitrary syntax
  7142. @subsection Radio lists
  7143. @cindex radio lists
  7144. @cindex org-list-insert-radio-list
  7145. Sending and receiving radio lists works exactly the same way than
  7146. sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
  7147. need to load the @code{org-export-latex.el} package to use radio lists
  7148. since the relevant code is there for now.}. As for radio tables, you
  7149. can insert radio lists templates in HTML, La@TeX{} and TeXInfo modes by
  7150. calling @code{org-list-insert-radio-list}.
  7151. Here are the differences with radio tables:
  7152. @itemize @minus
  7153. @item
  7154. Use @code{ORGLST} instead of @code{ORGTBL}.
  7155. @item
  7156. The available translation functions for radio lists don't take
  7157. parameters.
  7158. @item
  7159. `C-c C-c' will work when pressed on the first item of the list.
  7160. @end itemize
  7161. Here is a La@TeX{} example. Let's say that you have this in your
  7162. La@TeX{} file:
  7163. @example
  7164. % BEGIN RECEIVE ORGLST to-buy
  7165. % END RECEIVE ORGLST to-buy
  7166. \begin@{comment@}
  7167. #+ORGLIST: SEND to-buy orgtbl-to-latex
  7168. - a new house
  7169. - a new computer
  7170. + a new keyboard
  7171. + a new mouse
  7172. - a new life
  7173. \end@{comment@}
  7174. @end example
  7175. Pressing `C-c C-c' on @code{a new house} and will insert the converted
  7176. La@TeX{} list between the two marker lines.
  7177. @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Extensions and Hacking
  7178. @section Dynamic blocks
  7179. @cindex dynamic blocks
  7180. Org-mode documents can contain @emph{dynamic blocks}. These are
  7181. specially marked regions that are updated by some user-written function.
  7182. A good example for such a block is the clock table inserted by the
  7183. command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
  7184. Dynamic block are enclosed by a BEGIN-END structure that assigns a name
  7185. to the block and can also specify parameters for the function producing
  7186. the content of the block.
  7187. @example
  7188. #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
  7189. #+END:
  7190. @end example
  7191. Dynamic blocks are updated with the following commands
  7192. @table @kbd
  7193. @kindex C-c C-x C-u
  7194. @item C-c C-x C-u
  7195. Update dynamic block at point.
  7196. @kindex C-u C-c C-x C-u
  7197. @item C-u C-c C-x C-u
  7198. Update all dynamic blocks in the current file.
  7199. @end table
  7200. Updating a dynamic block means to remove all the text between BEGIN and
  7201. END, parse the BEGIN line for parameters and then call the specific
  7202. writer function for this block to insert the new content. For a block
  7203. with name @code{myblock}, the writer function is
  7204. @code{org-dblock-write:myblock} with as only parameter a property list
  7205. with the parameters given in the begin line. Here is a trivial example
  7206. of a block that keeps track of when the block update function was last
  7207. run:
  7208. @example
  7209. #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
  7210. #+END:
  7211. @end example
  7212. @noindent
  7213. The corresponding block writer function could look like this:
  7214. @lisp
  7215. (defun org-dblock-write:block-update-time (params)
  7216. (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
  7217. (insert "Last block update at: "
  7218. (format-time-string fmt (current-time)))))
  7219. @end lisp
  7220. If you want to make sure that all dynamic blocks are always up-to-date,
  7221. you could add the function @code{org-update-all-dblocks} to a hook, for
  7222. example @code{before-save-hook}. @code{org-update-all-dblocks} is
  7223. written in a way that is does nothing in buffers that are not in Org-mode.
  7224. @node Special agenda views, Using the property API, Dynamic blocks, Extensions and Hacking
  7225. @section Special Agenda Views
  7226. @cindex agenda views, user-defined
  7227. Org-mode provides a special hook that can be used to narrow down the
  7228. selection made by any of the agenda views. You may specify a function
  7229. that is used at each match to verify if the match should indeed be part
  7230. of the agenda view, and if not, how much should be skipped.
  7231. Let's say you want to produce a list of projects that contain a WAITING
  7232. tag anywhere in the project tree. Let's further assume that you have
  7233. marked all tree headings that define a project with the todo keyword
  7234. PROJECT. In this case you would run a todo search for the keyword
  7235. PROJECT, but skip the match unless there is a WAITING tag anywhere in
  7236. the subtree belonging to the project line.
  7237. To achieve this, you must write a function that searches the subtree for
  7238. the tag. If the tag is found, the function must return @code{nil} to
  7239. indicate that this match should not be skipped. If there is no such
  7240. tag, return the location of the end of the subtree, to indicate that
  7241. search should continue from there.
  7242. @lisp
  7243. (defun my-skip-unless-waiting ()
  7244. "Skip trees that are not waiting"
  7245. (let ((subtree-end (save-excursion (org-end-of-subtree t))))
  7246. (if (re-search-forward ":waiting:" subtree-end t)
  7247. nil ; tag found, do not skip
  7248. subtree-end))) ; tag not found, continue after end of subtree
  7249. @end lisp
  7250. Now you may use this function in an agenda custom command, for example
  7251. like this:
  7252. @lisp
  7253. (org-add-agenda-custom-command
  7254. '("b" todo "PROJECT"
  7255. ((org-agenda-skip-function 'my-org-waiting-projects)
  7256. (org-agenda-overriding-header "Projects waiting for something: "))))
  7257. @end lisp
  7258. Note that this also binds @code{org-agenda-overriding-header} to get a
  7259. meaningful header in the agenda view.
  7260. You may also put a Lisp form into @code{org-agenda-skip-function}. In
  7261. particular, you may use the functions @code{org-agenda-skip-entry-if}
  7262. and @code{org-agenda-skip-subtree-if} in this form, for example:
  7263. @table @code
  7264. @item '(org-agenda-skip-entry-if 'scheduled)
  7265. Skip current entry if it has been scheduled.
  7266. @item '(org-agenda-skip-entry-if 'notscheduled)
  7267. Skip current entry if it has not been scheduled.
  7268. @item '(org-agenda-skip-entry-if 'deadline)
  7269. Skip current entry if it has a deadline.
  7270. @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
  7271. Skip current entry if it has a deadline, or if it is scheduled.
  7272. @item '(org-agenda-skip-entry 'regexp "regular expression")
  7273. Skip current entry if the regular expression matches in the entry.
  7274. @item '(org-agenda-skip-entry 'notregexp "regular expression")
  7275. Skip current entry unless the regular expression matches.
  7276. @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
  7277. Same as above, but check and skip the entire subtree.
  7278. @end table
  7279. Therefore we could also have written the search for WAITING projects
  7280. like this, even without defining a special function:
  7281. @lisp
  7282. (org-add-agenda-custom-command
  7283. '("b" todo "PROJECT"
  7284. ((org-agenda-skip-function '(org-agenda-skip-subtree-if
  7285. 'regexp ":waiting:"))
  7286. (org-agenda-overriding-header "Projects waiting for something: "))))
  7287. @end lisp
  7288. @node Using the property API, , Special agenda views, Extensions and Hacking
  7289. @section Using the property API
  7290. @cindex API, for properties
  7291. @cindex properties, API
  7292. Here is a description of the functions that can be used to work with
  7293. properties.
  7294. @defun org-entry-properties &optional pom which
  7295. Get all properties of the entry at point-or-marker POM.
  7296. This includes the TODO keyword, the tags, time strings for deadline,
  7297. scheduled, and clocking, and any additional properties defined in the
  7298. entry. The return value is an alist, keys may occur multiple times
  7299. if the property key was used several times.
  7300. POM may also be nil, in which case the current entry is used.
  7301. If WHICH is nil or `all', get all properties. If WHICH is
  7302. `special' or `standard', only get that subclass.
  7303. @end defun
  7304. @defun org-entry-get pom property &optional inherit
  7305. Get value of PROPERTY for entry at point-or-marker POM.
  7306. If INHERIT is non-nil and the entry does not have the property,
  7307. then also check higher levels of the hierarchy. This function ignores
  7308. the value of @code{org-use-property-inheritance} and requires the
  7309. explicit INHERIT flag.
  7310. @end defun
  7311. @defun org-entry-delete pom property
  7312. Delete the property PROPERTY from entry at point-or-marker POM.
  7313. @end defun
  7314. @defun org-entry-put pom property value
  7315. Set PROPERTY to VALUE for entry at point-or-marker POM.
  7316. @end defun
  7317. @defun org-buffer-property-keys &optional include-specials
  7318. Get all property keys in the current buffer.
  7319. @end defun
  7320. @defun org-insert-property-drawer
  7321. Insert a property drawer at point.
  7322. @end defun
  7323. @node History and Acknowledgments, Main Index, Extensions and Hacking, Top
  7324. @appendix History and Acknowledgments
  7325. @cindex acknowledgments
  7326. @cindex history
  7327. @cindex thanks
  7328. Org-mode was borne in 2003, out of frustration over the user interface
  7329. of the Emacs outline-mode. I was trying to organize my notes and
  7330. projects, and using Emacs seemed to be the natural way to go. However,
  7331. having to remember eleven different commands with two or three keys per
  7332. command, only to hide and unhide parts of the outline tree, that seemed
  7333. entirely unacceptable to me. Also, when using outlines to take notes, I
  7334. constantly want to restructure the tree, organizing it parallel to my
  7335. thoughts and plans. @emph{Visibility cycling} and @emph{structure
  7336. editing} were originally implemented in the package
  7337. @file{outline-magic.el}, but quickly moved to the more general
  7338. @file{org.el}. As this environment became comfortable for project
  7339. planning, the next step was adding @emph{TODO entries}, basic @emph{time
  7340. stamps}, and @emph{table support}. These areas highlight the two main
  7341. goals that Org-mode still has today: To create a new, outline-based,
  7342. plain text mode with innovative and intuitive editing features, and to
  7343. incorporate project planning functionality directly into a notes file.
  7344. Since the first release, literally thousands of emails to me or on
  7345. @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
  7346. reports, feedback, new ideas, and sometimes patches and add-on code.
  7347. Many thanks to everyone who has helped to improve this package. I am
  7348. trying to keep here a list of the people who had significant influence
  7349. in shaping one or more aspects of Org-mode. The list may not be
  7350. complete, if I have forgotten someone, please accept my apologies and
  7351. let me know.
  7352. @itemize @bullet
  7353. @item
  7354. @i{Russel Adams} came up with the idea for drawers.
  7355. @item
  7356. @i{Thomas Baumann} contributed the code for links to the MH-E email
  7357. system.
  7358. @item
  7359. @i{Alex Bochannek} provided a patch for rounding time stamps.
  7360. @item
  7361. @i{Charles Cave}'s suggestion sparked the implementation of templates
  7362. for Remember.
  7363. @item
  7364. @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
  7365. specified time.
  7366. @item
  7367. @i{Gregory Chernov} patched support for lisp forms into table
  7368. calculations and improved XEmacs compatibility, in particular by porting
  7369. @file{nouline.el} to XEmacs.
  7370. @item
  7371. @i{Sacha Chua} suggested to copy some linking code from Planner.
  7372. @item
  7373. @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
  7374. came up with the idea of properties, and that there should be an API for
  7375. them.
  7376. @item
  7377. @i{Kees Dullemond} used to edit projects lists directly in HTML and so
  7378. inspired some of the early development, including HTML export. He also
  7379. asked for a way to narrow wide table columns.
  7380. @item
  7381. @i{Christian Egli} converted the documentation into TeXInfo format,
  7382. patched CSS formatting into the HTML exporter, and inspired the agenda.
  7383. @item
  7384. @i{David Emery} provided a patch for custom CSS support in exported
  7385. HTML agendas.
  7386. @item
  7387. @i{Nic Ferrier} contributed mailcap and XOXO support.
  7388. @item
  7389. @i{John Foerch} figured out how to make incremental search show context
  7390. around a match in a hidden outline tree.
  7391. @item
  7392. @i{Niels Giesen} had the idea to automatically archive DONE trees.
  7393. @item
  7394. @i{Bastien Guerry} wrote the La@TeX{} exporter and has been prolific
  7395. with patches, ideas, and bug reports.
  7396. @item
  7397. @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
  7398. @item
  7399. @i{Scott Jaderholm} proposed footnotes, control over whitespace between
  7400. folded entries, and column view for properties.
  7401. @item
  7402. @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
  7403. provided frequent feedback and some patches.
  7404. @item
  7405. @i{Jason F. McBrayer} suggested agenda export to CSV format.
  7406. @item
  7407. @i{Max Mikhanosha} came up with the idea of refiling.
  7408. @item
  7409. @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
  7410. basis.
  7411. @item
  7412. @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
  7413. happy.
  7414. @item
  7415. @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
  7416. and to be able to quickly restrict the agenda to a subtree.
  7417. @item
  7418. @i{Todd Neal} provided patches for links to Info files and elisp forms.
  7419. @item
  7420. @i{Tim O'Callaghan} suggested in-file links, search options for general
  7421. file links, and TAGS.
  7422. @item
  7423. @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
  7424. into Japanese.
  7425. @item
  7426. @i{Oliver Oppitz} suggested multi-state TODO items.
  7427. @item
  7428. @i{Scott Otterson} sparked the introduction of descriptive text for
  7429. links, among other things.
  7430. @item
  7431. @i{Pete Phillips} helped during the development of the TAGS feature, and
  7432. provided frequent feedback.
  7433. @item
  7434. @i{T.V. Raman} reported bugs and suggested improvements.
  7435. @item
  7436. @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
  7437. control.
  7438. @item
  7439. @i{Kevin Rogers} contributed code to access VM files on remote hosts.
  7440. @item
  7441. @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
  7442. conflict with @file{allout.el}.
  7443. @item
  7444. @i{Jason Riedy} sent a patch to fix a bug with export of TODO keywords.
  7445. @item
  7446. @i{Philip Rooke} created the Org-mode reference card and provided lots
  7447. of feedback.
  7448. @item
  7449. @i{Christian Schlauer} proposed angular brackets around links, among
  7450. other things.
  7451. @item
  7452. Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s
  7453. @file{organizer-mode.el}.
  7454. @item
  7455. @i{Daniel Sinder} came up with the idea of internal archiving by locking
  7456. subtrees.
  7457. @item
  7458. @i{Dale Smith} proposed link abbreviations.
  7459. @item
  7460. @i{Adam Spiers} asked for global linking commands and inspired the link
  7461. extension system. support mairix.
  7462. @item
  7463. @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
  7464. chapter about publishing.
  7465. @item
  7466. @i{J@"urgen Vollmer} contributed code generating the table of contents
  7467. in HTML output.
  7468. @item
  7469. @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
  7470. keyword.
  7471. @item
  7472. @i{David Wainberg} suggested archiving, and improvements to the linking
  7473. system.
  7474. @item
  7475. @i{John Wiegley} wrote @file{emacs-wiki.el} and @file{planner.el}. The
  7476. development of Org-mode was fully independent, and both systems are
  7477. really different beasts in their basic ideas and implementation details.
  7478. I later looked at John's code, however, and learned from his
  7479. implementation of (i) links where the link itself is hidden and only a
  7480. description is shown, and (ii) popping up a calendar to select a date.
  7481. John has also contributed a number of great ideas directly to Org-mode.
  7482. @item
  7483. @i{Carsten Wimmer} suggested some changes and helped fix a bug in
  7484. linking to GNUS.
  7485. @item
  7486. @i{Roland Winkler} requested additional keybindings to make Org-mode
  7487. work on a tty.
  7488. @item
  7489. @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
  7490. and contributed various ideas and code snippets.
  7491. @end itemize
  7492. @node Main Index, Key Index, History and Acknowledgments, Top
  7493. @unnumbered The Main Index
  7494. @printindex cp
  7495. @node Key Index, , Main Index, Top
  7496. @unnumbered Key Index
  7497. @printindex ky
  7498. @bye
  7499. @ignore
  7500. arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac
  7501. @end ignore