org.texi 471 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779
  1. \input texinfo
  2. @c %**start of header
  3. @setfilename ../../info/org
  4. @settitle The Org Manual
  5. @set VERSION 6.28trans
  6. @set DATE June 2009
  7. @c Version and Contact Info
  8. @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
  9. @set AUTHOR Carsten Dominik
  10. @set MAINTAINER Carsten Dominik
  11. @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
  12. @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
  13. @c %**end of header
  14. @finalout
  15. @c Macro definitions
  16. @iftex
  17. @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
  18. @end iftex
  19. @macro Ie {}
  20. I.e.,
  21. @end macro
  22. @macro ie {}
  23. i.e.,
  24. @end macro
  25. @macro Eg {}
  26. E.g.,
  27. @end macro
  28. @macro eg {}
  29. e.g.,
  30. @end macro
  31. @c Subheadings inside a table.
  32. @macro tsubheading{text}
  33. @ifinfo
  34. @subsubheading \text\
  35. @end ifinfo
  36. @ifnotinfo
  37. @item @b{\text\}
  38. @end ifnotinfo
  39. @end macro
  40. @copying
  41. This manual is for Org version @value{VERSION}.
  42. Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
  43. @quotation
  44. Permission is granted to copy, distribute and/or modify this document
  45. under the terms of the GNU Free Documentation License, Version 1.3 or
  46. any later version published by the Free Software Foundation; with no
  47. Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
  48. and with the Back-Cover Texts as in (a) below. A copy of the license
  49. is included in the section entitled ``GNU Free Documentation License.''
  50. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
  51. modify this GNU manual. Buying copies from the FSF supports it in
  52. developing GNU and promoting software freedom.''
  53. This document is part of a collection distributed under the GNU Free
  54. Documentation License. If you want to distribute this document
  55. separately from the collection, you can do so by adding a copy of the
  56. license to the document, as described in section 6 of the license.
  57. @end quotation
  58. @end copying
  59. @dircategory Emacs
  60. @direntry
  61. * Org Mode: (org). Outline-based notes management and organizer
  62. @end direntry
  63. @titlepage
  64. @title The Org Manual
  65. @subtitle Release @value{VERSION}
  66. @author by Carsten Dominik
  67. @c The following two commands start the copyright page.
  68. @page
  69. @vskip 0pt plus 1filll
  70. @insertcopying
  71. @end titlepage
  72. @c Output the table of contents at the beginning.
  73. @contents
  74. @ifnottex
  75. @node Top, Introduction, (dir), (dir)
  76. @top Org Mode Manual
  77. @insertcopying
  78. @end ifnottex
  79. @menu
  80. * Introduction:: Getting started
  81. * Document Structure:: A tree works like your brain
  82. * Tables:: Pure magic for quick formatting
  83. * Hyperlinks:: Notes in context
  84. * TODO Items:: Every tree branch can be a TODO item
  85. * Tags:: Tagging headlines and matching sets of tags
  86. * Properties and Columns:: Storing information about an entry
  87. * Dates and Times:: Making items useful for planning
  88. * Capture:: Creating tasks and attaching files
  89. * Agenda Views:: Collecting information into views
  90. * Embedded LaTeX:: LaTeX fragments and formulas
  91. * Exporting:: Sharing and publishing of notes
  92. * Publishing:: Create a web site of linked Org files
  93. * Miscellaneous:: All the rest which did not fit elsewhere
  94. * Hacking:: How to hack your way around
  95. * History and Acknowledgments:: How Org came into being
  96. * Main Index:: An index of Org's concepts and features
  97. * Key Index:: Key bindings and where they are described
  98. * Variable Index:: Variables mentiond in the manual
  99. @detailmenu
  100. --- The Detailed Node Listing ---
  101. Introduction
  102. * Summary:: Brief summary of what Org does
  103. * Installation:: How to install a downloaded version of Org
  104. * Activation:: How to activate Org for certain buffers
  105. * Feedback:: Bug reports, ideas, patches etc.
  106. * Conventions:: Type-setting conventions in the manual
  107. Document Structure
  108. * Outlines:: Org is based on Outline mode
  109. * Headlines:: How to typeset Org tree headlines
  110. * Visibility cycling:: Show and hide, much simplified
  111. * Motion:: Jumping to other headlines
  112. * Structure editing:: Changing sequence and level of headlines
  113. * Archiving:: Move done task trees to a different place
  114. * Sparse trees:: Matches embedded in context
  115. * Plain lists:: Additional structure within an entry
  116. * Drawers:: Tucking stuff away
  117. * Blocks:: Folding blocks
  118. * Footnotes:: How footnotes are defined in Org's syntax
  119. * Orgstruct mode:: Structure editing outside Org
  120. Archiving
  121. * ARCHIVE tag:: Marking a tree as inactive
  122. * Moving subtrees:: Moving a tree to an archive file
  123. Tables
  124. * Built-in table editor:: Simple tables
  125. * Column width and alignment:: Overrule the automatic settings
  126. * Column groups:: Grouping to trigger vertical lines
  127. * Orgtbl mode:: The table editor as minor mode
  128. * The spreadsheet:: The table editor has spreadsheet capabilities
  129. * Org-Plot:: Plotting from org tables
  130. The spreadsheet
  131. * References:: How to refer to another field or range
  132. * Formula syntax for Calc:: Using Calc to compute stuff
  133. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  134. * Field formulas:: Formulas valid for a single field
  135. * Column formulas:: Formulas valid for an entire column
  136. * Editing and debugging formulas:: Fixing formulas
  137. * Updating the table:: Recomputing all dependent fields
  138. * Advanced features:: Field names, parameters and automatic recalc
  139. Hyperlinks
  140. * Link format:: How links in Org are formatted
  141. * Internal links:: Links to other places in the current file
  142. * External links:: URL-like links to the world
  143. * Handling links:: Creating, inserting and following
  144. * Using links outside Org:: Linking from my C source code?
  145. * Link abbreviations:: Shortcuts for writing complex links
  146. * Search options:: Linking to a specific location
  147. * Custom searches:: When the default search is not enough
  148. Internal links
  149. * Radio targets:: Make targets trigger links in plain text
  150. TODO Items
  151. * TODO basics:: Marking and displaying TODO entries
  152. * TODO extensions:: Workflow and assignments
  153. * Progress logging:: Dates and notes for progress
  154. * Priorities:: Some things are more important than others
  155. * Breaking down tasks:: Splitting a task into manageable pieces
  156. * Checkboxes:: Tick-off lists
  157. Extended use of TODO keywords
  158. * Workflow states:: From TODO to DONE in steps
  159. * TODO types:: I do this, Fred does the rest
  160. * Multiple sets in one file:: Mixing it all, and still finding your way
  161. * Fast access to TODO states:: Single letter selection of a state
  162. * Per-file keywords:: Different files, different requirements
  163. * Faces for TODO keywords:: Highlighting states
  164. * TODO dependencies:: When one task needs to wait for others
  165. Progress logging
  166. * Closing items:: When was this entry marked DONE?
  167. * Tracking TODO state changes:: When did the status change?
  168. Tags
  169. * Tag inheritance:: Tags use the tree structure of the outline
  170. * Setting tags:: How to assign tags to a headline
  171. * Tag searches:: Searching for combinations of tags
  172. Properties and Columns
  173. * Property syntax:: How properties are spelled out
  174. * Special properties:: Access to other Org mode features
  175. * Property searches:: Matching property values
  176. * Property inheritance:: Passing values down the tree
  177. * Column view:: Tabular viewing and editing
  178. * Property API:: Properties for Lisp programmers
  179. Column view
  180. * Defining columns:: The COLUMNS format property
  181. * Using column view:: How to create and use column view
  182. * Capturing column view:: A dynamic block for column view
  183. Defining columns
  184. * Scope of column definitions:: Where defined, where valid?
  185. * Column attributes:: Appearance and content of a column
  186. Dates and Times
  187. * Timestamps:: Assigning a time to a tree entry
  188. * Creating timestamps:: Commands which insert timestamps
  189. * Deadlines and scheduling:: Planning your work
  190. * Clocking work time:: Tracking how long you spend on a task
  191. * Effort estimates:: Planning work effort in advance
  192. * Relative timer:: Notes with a running timer
  193. Creating timestamps
  194. * The date/time prompt:: How Org mode helps you entering date and time
  195. * Custom time format:: Making dates look different
  196. Deadlines and scheduling
  197. * Inserting deadline/schedule:: Planning items
  198. * Repeated tasks:: Items that show up again and again
  199. Capture
  200. * Remember:: Capture new tasks/ideas with little interruption
  201. * Attachments:: Add files to tasks.
  202. * RSS Feeds:: Getting input from RSS feeds
  203. * Protocols:: External (@eg Browser) access to Emacs and Org
  204. Remember
  205. * Setting up Remember:: Some code for .emacs to get things going
  206. * Remember templates:: Define the outline of different note types
  207. * Storing notes:: Directly get the note to where it belongs
  208. * Refiling notes:: Moving a note or task to a project
  209. Agenda Views
  210. * Agenda files:: Files being searched for agenda information
  211. * Agenda dispatcher:: Keyboard access to agenda views
  212. * Built-in agenda views:: What is available out of the box?
  213. * Presentation and sorting:: How agenda items are prepared for display
  214. * Agenda commands:: Remote editing of Org trees
  215. * Custom agenda views:: Defining special searches and views
  216. * Exporting Agenda Views::
  217. * Agenda column view:: Using column view for collected entries
  218. The built-in agenda views
  219. * Weekly/daily agenda:: The calendar page with current tasks
  220. * Global TODO list:: All unfinished action items
  221. * Matching tags and properties:: Structured information with fine-tuned search
  222. * Timeline:: Time-sorted view for single file
  223. * Keyword search:: Finding entries by keyword
  224. * Stuck projects:: Find projects you need to review
  225. Presentation and sorting
  226. * Categories:: Not all tasks are equal
  227. * Time-of-day specifications:: How the agenda knows the time
  228. * Sorting of agenda items:: The order of things
  229. Custom agenda views
  230. * Storing searches:: Type once, use often
  231. * Block agenda:: All the stuff you need in a single buffer
  232. * Setting Options:: Changing the rules
  233. Embedded La@TeX{}
  234. * Math symbols:: @TeX{} macros for symbols and Greek letters
  235. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  236. * LaTeX fragments:: Complex formulas made easy
  237. * Processing LaTeX fragments:: Previewing La@TeX{} processing
  238. * CDLaTeX mode:: Speed up entering of formulas
  239. Exporting
  240. * Markup rules:: Which structures are recognized?
  241. * Selective export:: Using tags to select and exclude trees
  242. * Export options:: Per-file export settings
  243. * The export dispatcher:: How to access exporter commands
  244. * ASCII export:: Exporting to plain ASCII
  245. * HTML export:: Exporting to HTML
  246. * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
  247. * DocBook export:: Exporting to DocBook
  248. * XOXO export:: Exporting to XOXO
  249. * iCalendar export:: Exporting in iCalendar format
  250. Markup rules
  251. * Document title:: How the document title is determined
  252. * Headings and sections:: The main structure of the exported document
  253. * Table of contents:: If, where, how to create a table of contents
  254. * Initial text:: Text before the first headline
  255. * Lists:: Plain lists are exported
  256. * Paragraphs:: What determines beginning and ending
  257. * Literal examples:: Source code and other examples
  258. * Include files:: Include the contents of a file during export
  259. * Tables exported:: Tables are exported richly
  260. * Inlined images:: How to inline images during export
  261. * Footnote markup:: ASCII representation of footnotes
  262. * Emphasis and monospace:: To bold or not to bold
  263. * TeX macros and LaTeX fragments:: Create special, rich export.
  264. * Horizontal rules:: A line across the page
  265. * Comment lines:: Some lines will not be exported
  266. * Macro replacement:: Global replacement of place holdes
  267. HTML export
  268. * HTML Export commands:: How to invoke HTML export
  269. * Quoting HTML tags:: Using direct HTML in Org mode
  270. * Links:: Transformation of links for HTML
  271. * Tables in HTML export:: How to modify the formatting of tables
  272. * Images in HTML export:: How to insert figures into HTML output
  273. * Text areas in HTML export:: An alternative way to show an example
  274. * CSS support:: Changing the appearance of the output
  275. * Javascript support:: Info and Folding in a web browser
  276. La@TeX{} and PDF export
  277. * LaTeX/PDF export commands:: Which key invokes which commands
  278. * Quoting LaTeX code:: Incorporating literal La@TeX{} code
  279. * Sectioning structure:: Changing sectioning in La@TeX{} output
  280. * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
  281. * Images in LaTeX export:: How to insert figures into La@TeX{} output
  282. DocBook export
  283. * DocBook export commands:: How to invoke DocBook export
  284. * Quoting DocBook code:: Incorporating DocBook code in Org files
  285. * Recursive sections:: Recursive sections in DocBook
  286. * Tables in DocBook export:: Tables are exported as HTML tables
  287. * Images in DocBook export:: How to insert figures into DocBook output
  288. * Special characters:: How to handle special characters
  289. Publishing
  290. * Configuration:: Defining projects
  291. * Uploading files:: How to get files up on the server
  292. * Sample configuration:: Example projects
  293. * Triggering publication:: Publication commands
  294. Configuration
  295. * Project alist:: The central configuration variable
  296. * Sources and destinations:: From here to there
  297. * Selecting files:: What files are part of the project?
  298. * Publishing action:: Setting the function doing the publishing
  299. * Publishing options:: Tweaking HTML export
  300. * Publishing links:: Which links keep working after publishing?
  301. * Project page index:: Publishing a list of project files
  302. Sample configuration
  303. * Simple example:: One-component publishing
  304. * Complex example:: A multi-component publishing example
  305. Miscellaneous
  306. * Completion:: M-TAB knows what you need
  307. * Customization:: Adapting Org to your taste
  308. * In-buffer settings:: Overview of the #+KEYWORDS
  309. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  310. * Clean view:: Getting rid of leading stars in the outline
  311. * TTY keys:: Using Org on a tty
  312. * Interaction:: Other Emacs packages
  313. Interaction with other packages
  314. * Cooperation:: Packages Org cooperates with
  315. * Conflicts:: Packages that lead to conflicts
  316. Hacking
  317. * Hooks:: Who to reach into Org's internals
  318. * Add-on packages:: Available extensions
  319. * Adding hyperlink types:: New custom link types
  320. * Context-sensitive commands:: How to add functioality to such commands
  321. * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
  322. * Dynamic blocks:: Automatically filled blocks
  323. * Special agenda views:: Customized views
  324. * Extracting agenda information:: Postprocessing of agenda information
  325. * Using the property API:: Writing programs that use entry properties
  326. * Using the mapping API:: Mapping over all or selected entries
  327. Tables and lists in arbitrary syntax
  328. * Radio tables:: Sending and receiving
  329. * A LaTeX example:: Step by step, almost a tutorial
  330. * Translator functions:: Copy and modify
  331. * Radio lists:: Doing the same for lists
  332. @end detailmenu
  333. @end menu
  334. @node Introduction, Document Structure, Top, Top
  335. @chapter Introduction
  336. @cindex introduction
  337. @menu
  338. * Summary:: Brief summary of what Org does
  339. * Installation:: How to install a downloaded version of Org
  340. * Activation:: How to activate Org for certain buffers
  341. * Feedback:: Bug reports, ideas, patches etc.
  342. * Conventions:: Type-setting conventions in the manual
  343. @end menu
  344. @node Summary, Installation, Introduction, Introduction
  345. @section Summary
  346. @cindex summary
  347. Org is a mode for keeping notes, maintaining TODO lists, and doing
  348. project planning with a fast and effective plain-text system.
  349. Org develops organizational tasks around NOTES files that contain
  350. lists or information about projects as plain text. Org is
  351. implemented on top of Outline mode, which makes it possible to keep the
  352. content of large files well structured. Visibility cycling and
  353. structure editing help to work with the tree. Tables are easily created
  354. with a built-in table editor. Org supports TODO items, deadlines,
  355. timestamps, and scheduling. It dynamically compiles entries into an
  356. agenda that utilizes and smoothly integrates much of the Emacs calendar
  357. and diary. Plain text URL-like links connect to websites, emails,
  358. Usenet messages, BBDB entries, and any files related to the projects.
  359. For printing and sharing of notes, an Org file can be exported as a
  360. structured ASCII file, as HTML, or (TODO and agenda items only) as an
  361. iCalendar file. It can also serve as a publishing tool for a set of
  362. linked web pages.
  363. An important design aspect that distinguishes Org from, for example,
  364. Planner/Muse is that it encourages you to store every piece of information
  365. only once. In Planner, you have project pages, day pages and possibly
  366. other files, duplicating some information such as tasks. In Org,
  367. you only have notes files. In your notes you mark entries as tasks, and
  368. label them with tags and timestamps. All necessary lists, like a
  369. schedule for the day, the agenda for a meeting, tasks lists selected by
  370. tags, etc., are created dynamically when you need them.
  371. Org keeps simple things simple. When first fired up, it should
  372. feel like a straightforward, easy to use outliner. Complexity is not
  373. imposed, but a large amount of functionality is available when you need
  374. it. Org is a toolbox and can be used in different ways, for
  375. example as:
  376. @example
  377. @r{@bullet{} an outline extension with visibility cycling and structure editing}
  378. @r{@bullet{} an ASCII system and table editor for taking structured notes}
  379. @r{@bullet{} an ASCII table editor with spreadsheet-like capabilities}
  380. @r{@bullet{} a TODO list editor}
  381. @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
  382. @pindex GTD, Getting Things Done
  383. @r{@bullet{} an environment to implement David Allen's GTD system}
  384. @r{@bullet{} a basic database application}
  385. @r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export}
  386. @r{@bullet{} a publishing tool to create a set of interlinked webpages}
  387. @end example
  388. Org's automatic, context-sensitive table editor with spreadsheet
  389. capabilities can be integrated into any major mode by activating the
  390. minor Orgtbl mode. Using a translation step, it can be used to maintain
  391. tables in arbitrary file types, for example in La@TeX{}. The structure
  392. editing and list creation capabilities can be used outside Org with
  393. the minor Orgstruct mode.
  394. @cindex FAQ
  395. There is a website for Org which provides links to the newest
  396. version of Org, as well as additional information, frequently asked
  397. questions (FAQ), links to tutorials, etc@. This page is located at
  398. @uref{http://orgmode.org}.
  399. @page
  400. @node Installation, Activation, Summary, Introduction
  401. @section Installation
  402. @cindex installation
  403. @cindex XEmacs
  404. @b{Important:} @i{If Org is part of the Emacs distribution or an
  405. XEmacs package, please skip this section and go directly to
  406. @ref{Activation}.}
  407. If you have downloaded Org from the Web, either as a distribution @file{.zip}
  408. or @file{.tar} file, or as a Git archive, you must take the following steps
  409. to install it: Go into the unpacked Org distribution directory and edit the
  410. top section of the file @file{Makefile}. You must set the name of the Emacs
  411. binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
  412. directories where local Lisp and Info files are kept. If you don't have
  413. access to the system-wide directories, you can simply run Org directly from
  414. the distribution directory by adding the @file{lisp} subdirectory to the
  415. Emacs load path. To do this, add the following line to @file{.emacs}:
  416. @example
  417. (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
  418. @end example
  419. @noindent
  420. If you plan to use code from the @file{contrib} subdirectory, do a similar
  421. step for this directory:
  422. @example
  423. (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
  424. @end example
  425. @b{XEmacs users now need to install the file @file{noutline.el} from
  426. the @file{xemacs} sub-directory of the Org distribution. Use the
  427. command:}
  428. @example
  429. @b{make install-noutline}
  430. @end example
  431. @noindent Now byte-compile the Lisp files with the shell command:
  432. @example
  433. make
  434. @end example
  435. @noindent If you are running Org from the distribution directory, this is
  436. all. If you want to install into the system directories, use (as
  437. administrator)
  438. @example
  439. make install
  440. @end example
  441. Installing Info files is system dependent, because of differences in the
  442. @file{install-info} program. In Debian it copies the info files into the
  443. correct directory and modifies the info directory file. In many other
  444. systems, the files need to be copied to the correct directory separately, and
  445. @file{install-info} then only modifies the directory file. Check your system
  446. documentation to find out which of the following commands you need:
  447. @example
  448. make install-info
  449. make install-info-debian
  450. @end example
  451. @noindent Then add to @file{.emacs}:
  452. @lisp
  453. ;; This line only if Org is not part of the X/Emacs distribution.
  454. (require 'org-install)
  455. @end lisp
  456. Do not forget to activate Org as described in the following section.
  457. @node Activation, Feedback, Installation, Introduction
  458. @section Activation
  459. @cindex activation
  460. @cindex autoload
  461. @cindex global key bindings
  462. @cindex key bindings, global
  463. @iftex
  464. @b{Important:} @i{If you use copy-and-paste to copy Lisp code from the
  465. PDF documentation as viewed by some PDF viewers to your @file{.emacs} file, the
  466. single-quote character comes out incorrectly and the code will not work.
  467. You need to fix the single-quotes by hand, or copy from Info
  468. documentation.}
  469. @end iftex
  470. Add the following lines to your @file{.emacs} file. The last three lines
  471. define @emph{global} keys for the commands @command{org-store-link},
  472. @command{org-agenda}, and @command{org-iswitchb}---please choose suitable
  473. keys yourself.
  474. @lisp
  475. ;; The following lines are always needed. Choose your own keys.
  476. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
  477. (global-set-key "\C-cl" 'org-store-link)
  478. (global-set-key "\C-ca" 'org-agenda)
  479. (global-set-key "\C-cb" 'org-iswitchb)
  480. @end lisp
  481. Furthermore, you must activate @code{font-lock-mode} in Org
  482. buffers, because significant functionality depends on font-locking being
  483. active. You can do this with either one of the following two lines
  484. (XEmacs users must use the second option):
  485. @lisp
  486. (global-font-lock-mode 1) ; for all buffers
  487. (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
  488. @end lisp
  489. @cindex Org mode, turning on
  490. With this setup, all files with extension @samp{.org} will be put
  491. into Org mode. As an alternative, make the first line of a file look
  492. like this:
  493. @example
  494. MY PROJECTS -*- mode: org; -*-
  495. @end example
  496. @vindex org-insert-mode-line-in-empty-file
  497. @noindent which will select Org mode for this buffer no matter what
  498. the file's name is. See also the variable
  499. @code{org-insert-mode-line-in-empty-file}.
  500. Many commands in Org work on the region if the region is @i{active}. To make
  501. use of this, you need to have @code{transient-mark-mode}
  502. (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
  503. in Emacs 22 you need to do this yourself with
  504. @lisp
  505. (transient-mark-mode 1)
  506. @end lisp
  507. @noindent If you do not like @code{transient-make-mode}, you can create an
  508. active region by using the mouse to select a region, or pressing
  509. @kbd{C-@key{SPC}} twice before moving the cursor.
  510. @node Feedback, Conventions, Activation, Introduction
  511. @section Feedback
  512. @cindex feedback
  513. @cindex bug reports
  514. @cindex maintainer
  515. @cindex author
  516. If you find problems with Org, or if you have questions, remarks, or ideas
  517. about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
  518. If you are not a member of the mailing list, your mail will be reviewed by a
  519. moderator and then passed through to the list.
  520. For bug reports, please provide as much information as possible,
  521. including the version information of Emacs (@kbd{C-h v emacs-version
  522. @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
  523. the Org related setup in @file{.emacs}. If an error occurs, a
  524. backtrace can be very useful (see below on how to create one). Often a
  525. small example file helps, along with clear information about:
  526. @enumerate
  527. @item What exactly did you do?
  528. @item What did you expect to happen?
  529. @item What happened instead?
  530. @end enumerate
  531. @noindent Thank you for helping to improve this mode.
  532. @subsubheading How to create a useful backtrace
  533. @cindex backtrace of an error
  534. If working with Org produces an error with a message you don't
  535. understand, you may have hit a bug. The best way to report this is by
  536. providing, in addition to what was mentioned above, a @emph{backtrace}.
  537. This is information from the built-in debugger about where and how the
  538. error occurred. Here is how to produce a useful backtrace:
  539. @enumerate
  540. @item
  541. Reload uncompiled versions of all Org-mode Lisp files. The backtrace
  542. contains much more information if it is produced with uncompiled code.
  543. To do this, use
  544. @example
  545. C-u M-x org-reload RET
  546. @end example
  547. @noindent
  548. or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
  549. menu.
  550. @item
  551. Go to the @code{Options} menu and select @code{Enter Debugger on Error}
  552. (XEmacs has this option in the @code{Troubleshooting} sub-menu).
  553. @item
  554. Do whatever you have to do to hit the error. Don't forget to
  555. document the steps you take.
  556. @item
  557. When you hit the error, a @file{*Backtrace*} buffer will appear on the
  558. screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
  559. attach it to your bug report.
  560. @end enumerate
  561. @node Conventions, , Feedback, Introduction
  562. @section Typesetting conventions used in this manual
  563. Org uses three types of keywords: TODO keywords, tags, and property
  564. names. In this manual we use the following conventions:
  565. @table @code
  566. @item TODO
  567. @itemx WAITING
  568. TODO keywords are written with all capitals, even if they are
  569. user-defined.
  570. @item boss
  571. @itemx ARCHIVE
  572. User-defined tags are written in lowercase; built-in tags with special
  573. meaning are written with all capitals.
  574. @item Release
  575. @itemx PRIORITY
  576. User-defined properties are capitalized; built-in properties with
  577. special meaning are written with all capitals.
  578. @end table
  579. @node Document Structure, Tables, Introduction, Top
  580. @chapter Document Structure
  581. @cindex document structure
  582. @cindex structure of document
  583. Org is based on Outline mode and provides flexible commands to
  584. edit the structure of the document.
  585. @menu
  586. * Outlines:: Org is based on Outline mode
  587. * Headlines:: How to typeset Org tree headlines
  588. * Visibility cycling:: Show and hide, much simplified
  589. * Motion:: Jumping to other headlines
  590. * Structure editing:: Changing sequence and level of headlines
  591. * Archiving:: Move done task trees to a different place
  592. * Sparse trees:: Matches embedded in context
  593. * Plain lists:: Additional structure within an entry
  594. * Drawers:: Tucking stuff away
  595. * Blocks:: Folding blocks
  596. * Footnotes:: How footnotes are defined in Org's syntax
  597. * Orgstruct mode:: Structure editing outside Org
  598. @end menu
  599. @node Outlines, Headlines, Document Structure, Document Structure
  600. @section Outlines
  601. @cindex outlines
  602. @cindex Outline mode
  603. Org is implemented on top of Outline mode. Outlines allow a
  604. document to be organized in a hierarchical structure, which (at least
  605. for me) is the best representation of notes and thoughts. An overview
  606. of this structure is achieved by folding (hiding) large parts of the
  607. document to show only the general document structure and the parts
  608. currently being worked on. Org greatly simplifies the use of
  609. outlines by compressing the entire show/hide functionality into a single
  610. command, @command{org-cycle}, which is bound to the @key{TAB} key.
  611. @node Headlines, Visibility cycling, Outlines, Document Structure
  612. @section Headlines
  613. @cindex headlines
  614. @cindex outline tree
  615. @vindex org-special-ctrl-a/e
  616. Headlines define the structure of an outline tree. The headlines in
  617. Org start with one or more stars, on the left margin@footnote{See
  618. the variable @code{org-special-ctrl-a/e} to configure special behavior
  619. of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
  620. @example
  621. * Top level headline
  622. ** Second level
  623. *** 3rd level
  624. some text
  625. *** 3rd level
  626. more text
  627. * Another top level headline
  628. @end example
  629. @noindent Some people find the many stars too noisy and would prefer an
  630. outline that has whitespace followed by a single star as headline
  631. starters. @ref{Clean view}, describes a setup to realize this.
  632. @vindex org-cycle-separator-lines
  633. An empty line after the end of a subtree is considered part of it and
  634. will be hidden when the subtree is folded. However, if you leave at
  635. least two empty lines, one empty line will remain visible after folding
  636. the subtree, in order to structure the collapsed view. See the
  637. variable @code{org-cycle-separator-lines} to modify this behavior.
  638. @node Visibility cycling, Motion, Headlines, Document Structure
  639. @section Visibility cycling
  640. @cindex cycling, visibility
  641. @cindex visibility cycling
  642. @cindex trees, visibility
  643. @cindex show hidden text
  644. @cindex hide text
  645. Outlines make it possible to hide parts of the text in the buffer.
  646. Org uses just two commands, bound to @key{TAB} and
  647. @kbd{S-@key{TAB}} to change the visibility in the buffer.
  648. @cindex subtree visibility states
  649. @cindex subtree cycling
  650. @cindex folded, subtree visibility state
  651. @cindex children, subtree visibility state
  652. @cindex subtree, subtree visibility state
  653. @table @kbd
  654. @kindex @key{TAB}
  655. @item @key{TAB}
  656. @emph{Subtree cycling}: Rotate current subtree among the states
  657. @example
  658. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  659. '-----------------------------------'
  660. @end example
  661. @vindex org-cycle-emulate-tab
  662. @vindex org-cycle-global-at-bob
  663. The cursor must be on a headline for this to work@footnote{see, however,
  664. the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
  665. beginning of the buffer and the first line is not a headline, then
  666. @key{TAB} actually runs global cycling (see below)@footnote{see the
  667. option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
  668. argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
  669. @cindex global visibility states
  670. @cindex global cycling
  671. @cindex overview, global visibility state
  672. @cindex contents, global visibility state
  673. @cindex show all, global visibility state
  674. @kindex S-@key{TAB}
  675. @item S-@key{TAB}
  676. @itemx C-u @key{TAB}
  677. @emph{Global cycling}: Rotate the entire buffer among the states
  678. @example
  679. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  680. '--------------------------------------'
  681. @end example
  682. When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
  683. CONTENTS view up to headlines of level N will be shown. Note that inside
  684. tables, @kbd{S-@key{TAB}} jumps to the previous field.
  685. @cindex show all, command
  686. @kindex C-u C-u C-u @key{TAB}
  687. @item C-u C-u C-u @key{TAB}
  688. Show all, including drawers.
  689. @kindex C-c C-r
  690. @item C-c C-r
  691. Reveal context around point, showing the current entry, the following heading
  692. and the hierarchy above. Useful for working near a location that has been
  693. exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
  694. (@pxref{Agenda commands}). With a prefix argument show, on each
  695. level, all sibling headings.
  696. @kindex C-c C-x b
  697. @item C-c C-x b
  698. Show the current subtree in an indirect buffer@footnote{The indirect
  699. buffer
  700. @ifinfo
  701. (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
  702. @end ifinfo
  703. @ifnotinfo
  704. (see the Emacs manual for more information about indirect buffers)
  705. @end ifnotinfo
  706. will contain the entire buffer, but will be narrowed to the current
  707. tree. Editing the indirect buffer will also change the original buffer,
  708. but without affecting visibility in that buffer.}. With a numeric
  709. prefix argument N, go up to level N and then take that tree. If N is
  710. negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
  711. the previously used indirect buffer.
  712. @end table
  713. @vindex org-startup-folded
  714. When Emacs first visits an Org file, the global state is set to
  715. OVERVIEW, @ie only the top level headlines are visible. This can be
  716. configured through the variable @code{org-startup-folded}, or on a
  717. per-file basis by adding one of the following lines anywhere in the
  718. buffer:
  719. @example
  720. #+STARTUP: overview
  721. #+STARTUP: content
  722. #+STARTUP: showall
  723. @end example
  724. @cindex property, VISIBILITY
  725. @noindent
  726. Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
  727. and Columns}) will get their visibility adapted accordingly. Allowed values
  728. for this property are @code{folded}, @code{children}, @code{content}, and
  729. @code{all}.
  730. @table @kbd
  731. @kindex C-u C-u @key{TAB}
  732. @item C-u C-u @key{TAB}
  733. Switch back to the startup visibility of the buffer, @ie whatever is
  734. requested by startup options and @samp{VISIBILITY} properties in individual
  735. entries.
  736. @end table
  737. @node Motion, Structure editing, Visibility cycling, Document Structure
  738. @section Motion
  739. @cindex motion, between headlines
  740. @cindex jumping, to headlines
  741. @cindex headline navigation
  742. The following commands jump to other headlines in the buffer.
  743. @table @kbd
  744. @kindex C-c C-n
  745. @item C-c C-n
  746. Next heading.
  747. @kindex C-c C-p
  748. @item C-c C-p
  749. Previous heading.
  750. @kindex C-c C-f
  751. @item C-c C-f
  752. Next heading same level.
  753. @kindex C-c C-b
  754. @item C-c C-b
  755. Previous heading same level.
  756. @kindex C-c C-u
  757. @item C-c C-u
  758. Backward to higher level heading.
  759. @kindex C-c C-j
  760. @item C-c C-j
  761. Jump to a different place without changing the current outline
  762. visibility. Shows the document structure in a temporary buffer, where
  763. you can use the following keys to find your destination:
  764. @vindex org-goto-auto-isearch
  765. @example
  766. @key{TAB} @r{Cycle visibility.}
  767. @key{down} / @key{up} @r{Next/previous visible headline.}
  768. @key{RET} @r{Select this location.}
  769. @kbd{/} @r{Do a Sparse-tree search}
  770. @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
  771. n / p @r{Next/previous visible headline.}
  772. f / b @r{Next/previous headline same level.}
  773. u @r{One level up.}
  774. 0-9 @r{Digit argument.}
  775. q @r{Quit}
  776. @end example
  777. @vindex org-goto-interface
  778. @noindent
  779. See also the variable @code{org-goto-interface}.
  780. @end table
  781. @node Structure editing, Archiving, Motion, Document Structure
  782. @section Structure editing
  783. @cindex structure editing
  784. @cindex headline, promotion and demotion
  785. @cindex promotion, of subtrees
  786. @cindex demotion, of subtrees
  787. @cindex subtree, cut and paste
  788. @cindex pasting, of subtrees
  789. @cindex cutting, of subtrees
  790. @cindex copying, of subtrees
  791. @cindex subtrees, cut and paste
  792. @table @kbd
  793. @kindex M-@key{RET}
  794. @item M-@key{RET}
  795. @vindex org-M-RET-may-split-line
  796. Insert new heading with same level as current. If the cursor is in a
  797. plain list item, a new item is created (@pxref{Plain lists}). To force
  798. creation of a new headline, use a prefix argument, or first press @key{RET}
  799. to get to the beginning of the next line. When this command is used in
  800. the middle of a line, the line is split and the rest of the line becomes
  801. the new headline@footnote{If you do not want the line to be split,
  802. customize the variable @code{org-M-RET-may-split-line}.}. If the
  803. command is used at the beginning of a headline, the new headline is
  804. created before the current line. If at the beginning of any other line,
  805. the content of that line is made the new heading. If the command is
  806. used at the end of a folded subtree (@ie behind the ellipses at the end
  807. of a headline), then a headline like the current one will be inserted
  808. after the end of the subtree.
  809. @kindex C-@key{RET}
  810. @item C-@key{RET}
  811. Just like @kbd{M-@key{RET}}, except when adding a new heading below the
  812. current heading, the new heading is placed after the body instead of before
  813. it. This command works from anywhere in the entry.
  814. @kindex M-S-@key{RET}
  815. @item M-S-@key{RET}
  816. @vindex org-treat-insert-todo-heading-as-state-change
  817. Insert new TODO entry with same level as current heading. See also the
  818. variable @code{org-treat-insert-todo-heading-as-state-change}.
  819. @kindex C-S-@key{RET}
  820. @item C-S-@key{RET}
  821. Insert new TODO entry with same level as current heading. Like
  822. @kbd{C-@key{RET}}, the new headline will be inserted after the current
  823. subtree.
  824. @kindex M-@key{left}
  825. @item M-@key{left}
  826. Promote current heading by one level.
  827. @kindex M-@key{right}
  828. @item M-@key{right}
  829. Demote current heading by one level.
  830. @kindex M-S-@key{left}
  831. @item M-S-@key{left}
  832. Promote the current subtree by one level.
  833. @kindex M-S-@key{right}
  834. @item M-S-@key{right}
  835. Demote the current subtree by one level.
  836. @kindex M-S-@key{up}
  837. @item M-S-@key{up}
  838. Move subtree up (swap with previous subtree of same
  839. level).
  840. @kindex M-S-@key{down}
  841. @item M-S-@key{down}
  842. Move subtree down (swap with next subtree of same level).
  843. @kindex C-c C-x C-w
  844. @item C-c C-x C-w
  845. Kill subtree, @ie remove it from buffer but save in kill ring.
  846. With a numeric prefix argument N, kill N sequential subtrees.
  847. @kindex C-c C-x M-w
  848. @item C-c C-x M-w
  849. Copy subtree to kill ring. With a numeric prefix argument N, copy the N
  850. sequential subtrees.
  851. @kindex C-c C-x C-y
  852. @item C-c C-x C-y
  853. Yank subtree from kill ring. This does modify the level of the subtree to
  854. make sure the tree fits in nicely at the yank position. The yank level can
  855. also be specified with a numeric prefix argument, or by yanking after a
  856. headline marker like @samp{****}.
  857. @kindex C-y
  858. @item C-y
  859. @vindex org-yank-adjusted-subtrees
  860. @vindex org-yank-folded-subtrees
  861. Depending on the variables @code{org-yank-adjusted-subtrees} and
  862. @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
  863. paste subtrees folded and in a clever way, using the same command as @kbd{C-c
  864. C-x C-y}. With the default settings, no level adjustment will take place,
  865. but the yanked tree will be folded unless doing so would swallow text
  866. previously visible. Any prefix argument to this command will force a normal
  867. @code{yank} to be executed, with the prefix passed along. A good way to
  868. force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
  869. yank, it will yank previous kill items plainly, without adjustment and
  870. folding.
  871. @kindex C-c C-x c
  872. @item C-c C-x c
  873. Clone a subtree by making a number of sibling copies of it. You will be
  874. prompted for the number of copies to make, and you can also specify if any
  875. timestamps in the entry should be shifted. This can be useful, for example,
  876. to create a number of tasks related to a series of lectures to prepare. For
  877. more details, see the docstring of the command
  878. @code{org-clone-subtree-with-time-shift}.
  879. @kindex C-c C-w
  880. @item C-c C-w
  881. Refile entry or region to a different location. @xref{Refiling notes}.
  882. @kindex C-c ^
  883. @item C-c ^
  884. Sort same-level entries. When there is an active region, all entries in the
  885. region will be sorted. Otherwise the children of the current headline are
  886. sorted. The command prompts for the sorting method, which can be
  887. alphabetically, numerically, by time (first timestamp with active preferred,
  888. creation time, scheduled time, deadline time), by priority, by TODO keyword
  889. (in the sequence the keywords have been defined in the setup) or by the value
  890. of a property. Reverse sorting is possible as well. You can also supply
  891. your own function to extract the sorting key. With a @kbd{C-u} prefix,
  892. sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
  893. entries will also be removed.
  894. @kindex C-x n s
  895. @item C-x n s
  896. Narrow buffer to current subtree.
  897. @kindex C-x n w
  898. @item C-x n w
  899. Widen buffer to remove narrowing.
  900. @kindex C-c *
  901. @item C-c *
  902. Turn a normal line or plain list item into a headline (so that it becomes a
  903. subheading at its location). Also turn a headline into a normal line by
  904. removing the stars. If there is an active region, turn all lines in the
  905. region into headlines. If the first line in the region was an item, turn
  906. only the item lines into headlines. Finally, if the first line is a
  907. headline, remove the stars from all headlines in the region.
  908. @end table
  909. @cindex region, active
  910. @cindex active region
  911. @cindex transient mark mode
  912. When there is an active region (Transient Mark mode), promotion and
  913. demotion work on all headlines in the region. To select a region of
  914. headlines, it is best to place both point and mark at the beginning of a
  915. line, mark at the beginning of the first headline, and point at the line
  916. just after the last headline to change. Note that when the cursor is
  917. inside a table (@pxref{Tables}), the Meta-Cursor keys have different
  918. functionality.
  919. @node Archiving, Sparse trees, Structure editing, Document Structure
  920. @section Archiving
  921. @cindex archiving
  922. When a project represented by a (sub)tree is finished, you may want
  923. to move the tree out of the way and to stop it from contributing to the
  924. agenda. Org mode knows two ways of archiving. You can mark a tree with
  925. the ARCHIVE tag, or you can move an entire (sub)tree to a different
  926. location.
  927. @menu
  928. * ARCHIVE tag:: Marking a tree as inactive
  929. * Moving subtrees:: Moving a tree to an archive file
  930. @end menu
  931. @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
  932. @subsection The ARCHIVE tag
  933. @cindex internal archiving
  934. A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
  935. its location in the outline tree, but behaves in the following way:
  936. @itemize @minus
  937. @item
  938. @vindex org-cycle-open-archived-trees
  939. It does not open when you attempt to do so with a visibility cycling
  940. command (@pxref{Visibility cycling}). You can force cycling archived
  941. subtrees with @kbd{C-@key{TAB}}, or by setting the option
  942. @code{org-cycle-open-archived-trees}. Also normal outline commands like
  943. @code{show-all} will open archived subtrees.
  944. @item
  945. @vindex org-sparse-tree-open-archived-trees
  946. During sparse tree construction (@pxref{Sparse trees}), matches in
  947. archived subtrees are not exposed, unless you configure the option
  948. @code{org-sparse-tree-open-archived-trees}.
  949. @item
  950. @vindex org-agenda-skip-archived-trees
  951. During agenda view construction (@pxref{Agenda Views}), the content of
  952. archived trees is ignored unless you configure the option
  953. @code{org-agenda-skip-archived-trees}, in which case these trees will always
  954. be included. In the agenda you can press the @kbd{v} key to get archives
  955. temporarily included.
  956. @item
  957. @vindex org-export-with-archived-trees
  958. Archived trees are not exported (@pxref{Exporting}), only the headline
  959. is. Configure the details using the variable
  960. @code{org-export-with-archived-trees}.
  961. @item
  962. @vindex org-columns-skip-arrchived-trees
  963. Archived trees are excluded from column view unless the variable
  964. @code{org-columns-skip-arrchived-trees} is configured to @code{nil}.
  965. @end itemize
  966. The following commands help managing the ARCHIVE tag:
  967. @table @kbd
  968. @kindex C-c C-x a
  969. @item C-c C-x a
  970. Toggle the ARCHIVE tag for the current headline. When the tag is set,
  971. the headline changes to a shadowed face, and the subtree below it is
  972. hidden.
  973. @kindex C-u C-c C-x a
  974. @item C-u C-c C-x a
  975. Check if any direct children of the current headline should be archived.
  976. To do this, each subtree is checked for open TODO entries. If none are
  977. found, the command offers to set the ARCHIVE tag for the child. If the
  978. cursor is @emph{not} on a headline when this command is invoked, the
  979. level 1 trees will be checked.
  980. @kindex C-@kbd{TAB}
  981. @item C-@kbd{TAB}
  982. Cycle a tree even if it is tagged with ARCHIVE.
  983. @end table
  984. @node Moving subtrees, , ARCHIVE tag, Archiving
  985. @subsection Moving subtrees
  986. @cindex external archiving
  987. Once an entire project is finished, you may want to move it to a different
  988. location. Org can move it to an @emph{Archive Sibling} in the same tree, to a
  989. different tree in the current file, or to a different file, the archive file.
  990. @table @kbd
  991. @kindex C-c C-x A
  992. @item C-c C-x A
  993. Move the current entry to the @emph{Archive Sibling}. This is a sibling of
  994. the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
  995. (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
  996. way retains a lot of its original context, including inherited tags and
  997. approximate position in the outline.
  998. @kindex C-c $
  999. @kindex C-c C-x C-s
  1000. @itemx C-c $
  1001. @item C-c C-x C-s
  1002. @vindex org-archive-location
  1003. Archive the subtree starting at the cursor position to the location
  1004. given by @code{org-archive-location}. Context information that could be
  1005. lost, like the file name, the category, inherited tags, and the TODO
  1006. state will be stored as properties in the entry.
  1007. @kindex C-u C-c C-x C-s
  1008. @item C-u C-c C-x C-s
  1009. Check if any direct children of the current headline could be moved to
  1010. the archive. To do this, each subtree is checked for open TODO entries.
  1011. If none are found, the command offers to move it to the archive
  1012. location. If the cursor is @emph{not} on a headline when this command
  1013. is invoked, the level 1 trees will be checked.
  1014. @end table
  1015. @cindex archive locations
  1016. The default archive location is a file in the same directory as the
  1017. current file, with the name derived by appending @file{_archive} to the
  1018. current file name. For information and examples on how to change this,
  1019. see the documentation string of the variable
  1020. @code{org-archive-location}. There is also an in-buffer option for
  1021. setting this variable, for example@footnote{For backward compatibility,
  1022. the following also works: If there are several such lines in a file,
  1023. each specifies the archive location for the text below it. The first
  1024. such line also applies to any text before its definition. However,
  1025. using this method is @emph{strongly} deprecated as it is incompatible
  1026. with the outline structure of the document. The correct method for
  1027. setting multiple archive locations in a buffer is using properties.}:
  1028. @cindex #+ARCHIVE
  1029. @example
  1030. #+ARCHIVE: %s_done::
  1031. @end example
  1032. @cindex property, ARCHIVE
  1033. @noindent
  1034. If you would like to have a special ARCHIVE location for a single entry
  1035. or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
  1036. location as the value (@pxref{Properties and Columns}).
  1037. @vindex org-archive-save-context-info
  1038. When a subtree is moved, it receives a number of special properties that
  1039. record context information like the file from where the entry came, its
  1040. outline path the archiving time etc. Configure the variable
  1041. @code{org-archive-save-context-info} to adjust the amount of information
  1042. added.
  1043. @node Sparse trees, Plain lists, Archiving, Document Structure
  1044. @section Sparse trees
  1045. @cindex sparse trees
  1046. @cindex trees, sparse
  1047. @cindex folding, sparse trees
  1048. @cindex occur, command
  1049. @vindex org-show-hierarchy-above
  1050. @vindex org-show-following-heading
  1051. @vindex org-show-siblings
  1052. @vindex org-show-entry-below
  1053. An important feature of Org mode is the ability to construct @emph{sparse
  1054. trees} for selected information in an outline tree, so that the entire
  1055. document is folded as much as possible, but the selected information is made
  1056. visible along with the headline structure above it@footnote{See also the
  1057. variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
  1058. @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
  1059. control on how much context is shown around each match.}. Just try it out
  1060. and you will see immediately how it works.
  1061. Org mode contains several commands creating such trees, all these
  1062. commands can be accessed through a dispatcher:
  1063. @table @kbd
  1064. @kindex C-c /
  1065. @item C-c /
  1066. This prompts for an extra key to select a sparse-tree creating command.
  1067. @kindex C-c / r
  1068. @item C-c / r
  1069. @vindex org-remove-highlights-with-change
  1070. Occur. Prompts for a regexp and shows a sparse tree with all matches. If
  1071. the match is in a headline, the headline is made visible. If the match is in
  1072. the body of an entry, headline and body are made visible. In order to
  1073. provide minimal context, also the full hierarchy of headlines above the match
  1074. is shown, as well as the headline following the match. Each match is also
  1075. highlighted; the highlights disappear when the buffer is changed by an
  1076. editing command@footnote{This depends on the option
  1077. @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
  1078. When called with a @kbd{C-u} prefix argument, previous highlights are kept,
  1079. so several calls to this command can be stacked.
  1080. @end table
  1081. @noindent
  1082. @vindex org-agenda-custom-commands
  1083. For frequently used sparse trees of specific search strings, you can
  1084. use the variable @code{org-agenda-custom-commands} to define fast
  1085. keyboard access to specific sparse trees. These commands will then be
  1086. accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
  1087. For example:
  1088. @lisp
  1089. (setq org-agenda-custom-commands
  1090. '(("f" occur-tree "FIXME")))
  1091. @end lisp
  1092. @noindent will define the key @kbd{C-c a f} as a shortcut for creating
  1093. a sparse tree matching the string @samp{FIXME}.
  1094. The other sparse tree commands select headings based on TODO keywords,
  1095. tags, or properties and will be discussed later in this manual.
  1096. @kindex C-c C-e v
  1097. @cindex printing sparse trees
  1098. @cindex visible text, printing
  1099. To print a sparse tree, you can use the Emacs command
  1100. @code{ps-print-buffer-with-faces} which does not print invisible parts
  1101. of the document @footnote{This does not work under XEmacs, because
  1102. XEmacs uses selective display for outlining, not text properties.}.
  1103. Or you can use the command @kbd{C-c C-e v} to export only the visible
  1104. part of the document and print the resulting file.
  1105. @node Plain lists, Drawers, Sparse trees, Document Structure
  1106. @section Plain lists
  1107. @cindex plain lists
  1108. @cindex lists, plain
  1109. @cindex lists, ordered
  1110. @cindex ordered lists
  1111. Within an entry of the outline tree, hand-formatted lists can provide
  1112. additional structure. They also provide a way to create lists of
  1113. checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
  1114. and the HTML exporter (@pxref{Exporting}) parses and formats them.
  1115. Org knows ordered lists, unordered lists, and description lists.
  1116. @itemize @bullet
  1117. @item
  1118. @emph{Unordered} list items start with @samp{-}, @samp{+}, or
  1119. @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
  1120. they will be seen as top-level headlines. Also, when you are hiding leading
  1121. stars to get a clean outline view, plain list items starting with a star are
  1122. visually indistinguishable from true headlines. In short: even though
  1123. @samp{*} is supported, it may be better to not use it for plain list items.}
  1124. as bullets.
  1125. @item
  1126. @emph{Ordered} list items start with a numeral followed by either a period or
  1127. a right parenthesis, such as @samp{1.} or @samp{1)}.
  1128. @item
  1129. @emph{Description} list items are like unordered list items, but contain the
  1130. separator @samp{ :: } to separate the description @emph{term} from the
  1131. description.
  1132. @end itemize
  1133. @vindex org-empty-line-terminates-plain-lists
  1134. Items belonging to the same list must have the same indentation on the first
  1135. line. In particular, if an ordered list reaches number @samp{10.}, then the
  1136. 2--digit numbers must be written left-aligned with the other numbers in the
  1137. list. Indentation also determines the end of a list item. It ends before
  1138. the next line that is indented like the bullet/number, or less. Empty lines
  1139. are part of the previous item, so you can have several paragraphs in one
  1140. item. If you would like an empty line to terminate all currently open plain
  1141. lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
  1142. Here is an example:
  1143. @example
  1144. @group
  1145. ** Lord of the Rings
  1146. My favorite scenes are (in this order)
  1147. 1. The attack of the Rohirrim
  1148. 2. Eowyn's fight with the witch king
  1149. + this was already my favorite scene in the book
  1150. + I really like Miranda Otto.
  1151. 3. Peter Jackson being shot by Legolas
  1152. - on DVD only
  1153. He makes a really funny face when it happens.
  1154. But in the end, no individual scenes matter but the film as a whole.
  1155. Important actors in this film are:
  1156. - @b{Elijah Wood} :: He plays Frodo
  1157. - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
  1158. him very well from his role as Mikey Walsh in @i{The Goonies}.
  1159. @end group
  1160. @end example
  1161. Org supports these lists by tuning filling and wrapping commands to deal with
  1162. them correctly@footnote{Org only changes the filling settings for Emacs. For
  1163. XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
  1164. put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
  1165. properly (@pxref{Exporting}). Since indentation is what governs the
  1166. structure of these lists, many structural constructs like @code{#+BEGIN_...}
  1167. blocks can be indented to signal that they should be part of a list item.
  1168. The following commands act on items when the cursor is in the first line
  1169. of an item (the line with the bullet or number).
  1170. @table @kbd
  1171. @kindex @key{TAB}
  1172. @item @key{TAB}
  1173. @vindex org-cycle-include-plain-lists
  1174. Items can be folded just like headline levels. Normally this works only if
  1175. the cursor is on a plain list item. For more details, see the variable
  1176. @code{org-cycle-include-plain-lists}. to @code{integrate}, plain list items
  1177. will be treated like low-level. The level of an item is then given by the
  1178. indentation of the bullet/number. Items are always subordinate to real
  1179. headlines, however; the hierarchies remain completely separated.
  1180. If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
  1181. fixes the indentation of the current line in a heuristic way.
  1182. @kindex M-@key{RET}
  1183. @item M-@key{RET}
  1184. @vindex org-M-RET-may-split-line
  1185. Insert new item at current level. With a prefix argument, force a new
  1186. heading (@pxref{Structure editing}). If this command is used in the middle
  1187. of a line, the line is @emph{split} and the rest of the line becomes the new
  1188. item@footnote{If you do not want the line to be split, customize the variable
  1189. @code{org-M-RET-may-split-line}.}. If this command is executed in the
  1190. @emph{whitespace before a bullet or number}, the new item is created
  1191. @emph{before} the current item. If the command is executed in the white
  1192. space before the text that is part of an item but does not contain the
  1193. bullet, a bullet is added to the current line.
  1194. @kindex M-S-@key{RET}
  1195. @item M-S-@key{RET}
  1196. Insert a new item with a checkbox (@pxref{Checkboxes}).
  1197. @kindex S-@key{up}
  1198. @kindex S-@key{down}
  1199. @item S-@key{up}
  1200. @itemx S-@key{down}
  1201. @cindex shift-selection-mode
  1202. @vindex org-support-shift-select
  1203. Jump to the previous/next item in the current list, but only if
  1204. @code{org-support-shift-select} is off. If not, you can still use paragraph
  1205. jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
  1206. similar effect.
  1207. @kindex M-S-@key{up}
  1208. @kindex M-S-@key{down}
  1209. @item M-S-@key{up}
  1210. @itemx M-S-@key{down}
  1211. Move the item including subitems up/down (swap with previous/next item
  1212. of same indentation). If the list is ordered, renumbering is
  1213. automatic.
  1214. @kindex M-S-@key{left}
  1215. @kindex M-S-@key{right}
  1216. @item M-S-@key{left}
  1217. @itemx M-S-@key{right}
  1218. Decrease/increase the indentation of the item, including subitems.
  1219. Initially, the item tree is selected based on current indentation.
  1220. When these commands are executed several times in direct succession,
  1221. the initially selected region is used, even if the new indentation
  1222. would imply a different hierarchy. To use the new hierarchy, break
  1223. the command chain with a cursor motion or so.
  1224. @kindex C-c C-c
  1225. @item C-c C-c
  1226. If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
  1227. state of the checkbox. If not, this command makes sure that all the
  1228. items on this list level use the same bullet. Furthermore, if this is
  1229. an ordered list, make sure the numbering is OK.
  1230. @kindex C-c -
  1231. @item C-c -
  1232. Cycle the entire list level through the different itemize/enumerate bullets
  1233. (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
  1234. argument N, select the Nth bullet from this list. If there is an active
  1235. region when calling this, all lines will be converted to list items. If the
  1236. first line already was a list item, any item markers will be removed from the
  1237. list. Finally, even without an active region, a normal line will be
  1238. converted into a list item.
  1239. @kindex S-@key{left}
  1240. @kindex S-@key{right}
  1241. @item S-@key{left}/@key{right}
  1242. @vindex org-support-shift-select
  1243. This command also cycles bullet styles when the cursor in on the bullet or
  1244. anywhere in an item line, details depending on
  1245. @code{org-support-shift-select}.
  1246. @kindex C-c ^
  1247. @item C-c ^
  1248. Sort the plain list. You will be prompted for the sorting method:
  1249. numerically, alphabetically, by time, or by custom function.
  1250. @end table
  1251. @node Drawers, Blocks, Plain lists, Document Structure
  1252. @section Drawers
  1253. @cindex drawers
  1254. @cindex #+DRAWERS
  1255. @cindex visibility cycling, drawers
  1256. @vindex org-drawers
  1257. Sometimes you want to keep information associated with an entry, but you
  1258. normally don't want to see it. For this, Org mode has @emph{drawers}.
  1259. Drawers need to be configured with the variable
  1260. @code{org-drawers}@footnote{You can define drawers on a per-file basis
  1261. with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
  1262. look like this:
  1263. @example
  1264. ** This is a headline
  1265. Still outside the drawer
  1266. :DRAWERNAME:
  1267. This is inside the drawer.
  1268. :END:
  1269. After the drawer.
  1270. @end example
  1271. Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
  1272. show the entry, but keep the drawer collapsed to a single line. In order to
  1273. look inside the drawer, you need to move the cursor to the drawer line and
  1274. press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
  1275. storing properties (@pxref{Properties and Columns}), and you can also arrange
  1276. for state change notes (@pxref{Tracking TODO state changes}) and clock times
  1277. (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.
  1278. @node Blocks, Footnotes, Drawers, Document Structure
  1279. @section Blocks
  1280. @vindex org-hide-block-startup
  1281. @cindex blocks, folding
  1282. Org-mode uses begin...end blocks for various purposes from including source
  1283. code examples (@pxref{Literal examples}) to capturing time logging
  1284. information (@pxref{Clocking work time}). These blocks can be folded and
  1285. unfolded by pressing TAB in the begin line. You can also get all blocks
  1286. folded at startup by configuring the variable @code{org-hide-block-startup}
  1287. or on a per-file basis by using
  1288. @cindex @code{hideblocks}, STARTUP keyword
  1289. @cindex @code{nohideblocks}, STARTUP keyword
  1290. @example
  1291. #+STARTUP: hideblocks
  1292. #+STARTUP: nohideblocks
  1293. @end example
  1294. @node Footnotes, Orgstruct mode, Blocks, Document Structure
  1295. @section Footnotes
  1296. @cindex footnotes
  1297. Org mode supports the creation of footnotes. In contrast to the
  1298. @file{footnote.el} package, Org mode's footnotes are designed for work on a
  1299. larger document, not only for one-off documents like emails. The basic
  1300. syntax is similar to the one used by @file{footnote.el}, @ie a footnote is
  1301. defined in a paragraph that is started by a footnote marker in square
  1302. brackets in column 0, no indentation allowed. If you need a paragraph break
  1303. inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference
  1304. is simply the marker in square brackets, inside text. For example:
  1305. @example
  1306. The Org homepage[fn:1] now looks a lot better than it used to.
  1307. ...
  1308. [fn:1] The link is: http://orgmode.org
  1309. @end example
  1310. Org mode extends the number-based syntax to @emph{named} footnotes and
  1311. optional inline definition. Using plain numbers as markers (as
  1312. @file{footnote.el} does) is supported for backward compatibility, but not
  1313. encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded
  1314. LaTeX}). Here are the valid references:
  1315. @table @code
  1316. @item [1]
  1317. A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
  1318. recommended because somthing like @samp{[1]} could easily be part of a code
  1319. snippet.
  1320. @item [fn:name]
  1321. A named footnote reference, where @code{name} is a unique label word, or, for
  1322. simplicity of automatic creation, a number.
  1323. @item [fn:: This is the inline definition of this footnote]
  1324. A La@TeX{}-like anonymous footnote where the definition is given directly at the
  1325. reference point.
  1326. @item [fn:name: a definition]
  1327. An inline definition of a footnote, which also specifies a name for the note.
  1328. Since Org allows multiple references to the same note, you can then use
  1329. @code{[fn:name]} to create additional references.
  1330. @end table
  1331. @vindex org-footnote-auto-label
  1332. Footnote labels can be created automatically, or you can create names yourself.
  1333. This is handled by the variable @code{org-footnote-auto-label} and its
  1334. corresponding @code{#+STARTUP} keywords, see the docstring of that variable
  1335. for details.
  1336. @noindent The following command handles footnotes:
  1337. @table @kbd
  1338. @kindex C-c C-x f
  1339. @item C-c C-x f
  1340. The footnote action command.
  1341. When the cursor is on a footnote reference, jump to the definition. When it
  1342. is at a definition, jump to the (first) reference.
  1343. @vindex org-footnote-define-inline
  1344. @vindex org-footnote-section
  1345. @vindex org-footnote-auto-adjust
  1346. Otherwise, create a new footnote. Depending on the variable
  1347. @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
  1348. setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
  1349. definition will be placed right into the text as part of the reference, or
  1350. separately into the location determined by the variable
  1351. @code{org-footnote-section}.
  1352. When this command is called with a prefix argument, a menu of additional
  1353. options is offered:
  1354. @example
  1355. s @r{Sort the footnote definitions by reference sequence. During editing,}
  1356. @r{Org makes no effort to sort footnote definitions into a particular}
  1357. @r{sequence. If you want them sorted, use this command, which will}
  1358. @r{also move entries according to @code{org-footnote-section}. Automatic}
  1359. @r{sorting after each insertion/deletion can be configured using the}
  1360. @r{variable @code{org-footnote-auto-adjust}.}
  1361. r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
  1362. @r{after each insertion/deletion can be configured using the variable}
  1363. @r{@code{org-footnote-auto-adjust}.}
  1364. S @r{Short for first @code{r}, then @code{s} action.}
  1365. n @r{Normalize the footnotes by collecting all definitions (including}
  1366. @r{inline definitions) into a special section, and then numbering them}
  1367. @r{in sequence. The references will then also be numbers. This is}
  1368. @r{meant to be the final step before finishing a document (e.g. sending}
  1369. @r{off an email). The exporters do this automatically, and so could}
  1370. @r{something like @code{message-send-hook}.}
  1371. d @r{Delete the footnote at point, and all definitions of and references}
  1372. @r{to it.}
  1373. @end example
  1374. Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
  1375. corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
  1376. renumbering and sorting footnotes can be automatic after each insertion or
  1377. deletion.
  1378. @kindex C-c C-c
  1379. @item C-c C-c
  1380. If the cursor is on a footnote reference, jump to the definition. If it is a
  1381. the definition, jump back to the reference. When called at a footnote
  1382. location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
  1383. @kindex C-c C-o
  1384. @kindex mouse-1
  1385. @kindex mouse-2
  1386. @item C-c C-o @r{or} mouse-1/2
  1387. Footnote labels are also links to the corresponding definition/reference, and
  1388. you can use the usual commands to follow these links.
  1389. @end table
  1390. @node Orgstruct mode, , Footnotes, Document Structure
  1391. @section The Orgstruct minor mode
  1392. @cindex Orgstruct mode
  1393. @cindex minor mode for structure editing
  1394. If you like the intuitive way the Org mode structure editing and list
  1395. formatting works, you might want to use these commands in other modes like
  1396. Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
  1397. this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
  1398. turn it on by default, for example in Mail mode, with one of:
  1399. @lisp
  1400. (add-hook 'mail-mode-hook 'turn-on-orgstruct)
  1401. (add-hook 'mail-mode-hook 'turn-on-orgstruct++)
  1402. @end lisp
  1403. When this mode is active and the cursor is on a line that looks to Org like a
  1404. headline or the first line of a list item, most structure editing commands
  1405. will work, even if the same keys normally have different functionality in the
  1406. major mode you are using. If the cursor is not in one of those special
  1407. lines, Orgstruct mode lurks silently in the shadow. When you use
  1408. @code{orgstruct++-mode}, Org will also export indentation and autofill
  1409. settings into that mode, and detect item context after the first line of an
  1410. item.
  1411. @node Tables, Hyperlinks, Document Structure, Top
  1412. @chapter Tables
  1413. @cindex tables
  1414. @cindex editing tables
  1415. Org comes with a fast and intuitive table editor. Spreadsheet-like
  1416. calculations are supported in connection with the Emacs @file{calc}
  1417. package
  1418. @ifinfo
  1419. (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
  1420. @end ifinfo
  1421. @ifnotinfo
  1422. (see the Emacs Calculator manual for more information about the Emacs
  1423. calculator).
  1424. @end ifnotinfo
  1425. @menu
  1426. * Built-in table editor:: Simple tables
  1427. * Column width and alignment:: Overrule the automatic settings
  1428. * Column groups:: Grouping to trigger vertical lines
  1429. * Orgtbl mode:: The table editor as minor mode
  1430. * The spreadsheet:: The table editor has spreadsheet capabilities
  1431. * Org-Plot:: Plotting from org tables
  1432. @end menu
  1433. @node Built-in table editor, Column width and alignment, Tables, Tables
  1434. @section The built-in table editor
  1435. @cindex table editor, built-in
  1436. Org makes it easy to format tables in plain ASCII. Any line with
  1437. @samp{|} as the first non-whitespace character is considered part of a
  1438. table. @samp{|} is also the column separator. A table might look like
  1439. this:
  1440. @example
  1441. | Name | Phone | Age |
  1442. |-------+-------+-----|
  1443. | Peter | 1234 | 17 |
  1444. | Anna | 4321 | 25 |
  1445. @end example
  1446. A table is re-aligned automatically each time you press @key{TAB} or
  1447. @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
  1448. the next field (@key{RET} to the next row) and creates new table rows
  1449. at the end of the table or before horizontal lines. The indentation
  1450. of the table is set by the first line. Any line starting with
  1451. @samp{|-} is considered as a horizontal separator line and will be
  1452. expanded on the next re-align to span the whole table width. So, to
  1453. create the above table, you would only type
  1454. @example
  1455. |Name|Phone|Age|
  1456. |-
  1457. @end example
  1458. @noindent and then press @key{TAB} to align the table and start filling in
  1459. fields. Even faster would be to type @code{|Name|Phone|Age} followed by
  1460. @kbd{C-c @key{RET}}.
  1461. @vindex org-enable-table-editor
  1462. @vindex org-table-auto-blank-field
  1463. When typing text into a field, Org treats @key{DEL},
  1464. @key{Backspace}, and all character keys in a special way, so that
  1465. inserting and deleting avoids shifting other fields. Also, when
  1466. typing @emph{immediately after the cursor was moved into a new field
  1467. with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
  1468. field is automatically made blank. If this behavior is too
  1469. unpredictable for you, configure the variables
  1470. @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
  1471. @table @kbd
  1472. @tsubheading{Creation and conversion}
  1473. @kindex C-c |
  1474. @item C-c |
  1475. Convert the active region to table. If every line contains at least one
  1476. TAB character, the function assumes that the material is tab separated.
  1477. If every line contains a comma, comma-separated values (CSV) are assumed.
  1478. If not, lines are split at whitespace into fields. You can use a prefix
  1479. argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
  1480. C-u} forces TAB, and a numeric argument N indicates that at least N
  1481. consecutive spaces, or alternatively a TAB will be the separator.
  1482. @*
  1483. If there is no active region, this command creates an empty Org
  1484. table. But it's easier just to start typing, like
  1485. @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
  1486. @tsubheading{Re-aligning and field motion}
  1487. @kindex C-c C-c
  1488. @item C-c C-c
  1489. Re-align the table without moving the cursor.
  1490. @c
  1491. @kindex @key{TAB}
  1492. @item @key{TAB}
  1493. Re-align the table, move to the next field. Creates a new row if
  1494. necessary.
  1495. @c
  1496. @kindex S-@key{TAB}
  1497. @item S-@key{TAB}
  1498. Re-align, move to previous field.
  1499. @c
  1500. @kindex @key{RET}
  1501. @item @key{RET}
  1502. Re-align the table and move down to next row. Creates a new row if
  1503. necessary. At the beginning or end of a line, @key{RET} still does
  1504. NEWLINE, so it can be used to split a table.
  1505. @c
  1506. @kindex M-a
  1507. @item M-a
  1508. Move to beginning of the current table field, or on to the previous field.
  1509. @kindex M-e
  1510. @item M-e
  1511. Move to end of the current table field, or on to the next field.
  1512. @tsubheading{Column and row editing}
  1513. @kindex M-@key{left}
  1514. @kindex M-@key{right}
  1515. @item M-@key{left}
  1516. @itemx M-@key{right}
  1517. Move the current column left/right.
  1518. @c
  1519. @kindex M-S-@key{left}
  1520. @item M-S-@key{left}
  1521. Kill the current column.
  1522. @c
  1523. @kindex M-S-@key{right}
  1524. @item M-S-@key{right}
  1525. Insert a new column to the left of the cursor position.
  1526. @c
  1527. @kindex M-@key{up}
  1528. @kindex M-@key{down}
  1529. @item M-@key{up}
  1530. @itemx M-@key{down}
  1531. Move the current row up/down.
  1532. @c
  1533. @kindex M-S-@key{up}
  1534. @item M-S-@key{up}
  1535. Kill the current row or horizontal line.
  1536. @c
  1537. @kindex M-S-@key{down}
  1538. @item M-S-@key{down}
  1539. Insert a new row above the current row. With a prefix argument, the line is
  1540. created below the current one.
  1541. @c
  1542. @kindex C-c -
  1543. @item C-c -
  1544. Insert a horizontal line below current row. With a prefix argument, the line
  1545. is created above the current line.
  1546. @c
  1547. @kindex C-c @key{RET}
  1548. @item C-c @key{RET}
  1549. Insert a horizontal line below current row, and move the cursor into the row
  1550. below that line.
  1551. @c
  1552. @kindex C-c ^
  1553. @item C-c ^
  1554. Sort the table lines in the region. The position of point indicates the
  1555. column to be used for sorting, and the range of lines is the range
  1556. between the nearest horizontal separator lines, or the entire table. If
  1557. point is before the first column, you will be prompted for the sorting
  1558. column. If there is an active region, the mark specifies the first line
  1559. and the sorting column, while point should be in the last line to be
  1560. included into the sorting. The command prompts for the sorting type
  1561. (alphabetically, numerically, or by time). When called with a prefix
  1562. argument, alphabetic sorting will be case-sensitive.
  1563. @tsubheading{Regions}
  1564. @kindex C-c C-x M-w
  1565. @item C-c C-x M-w
  1566. Copy a rectangular region from a table to a special clipboard. Point
  1567. and mark determine edge fields of the rectangle. The process ignores
  1568. horizontal separator lines.
  1569. @c
  1570. @kindex C-c C-x C-w
  1571. @item C-c C-x C-w
  1572. Copy a rectangular region from a table to a special clipboard, and
  1573. blank all fields in the rectangle. So this is the ``cut'' operation.
  1574. @c
  1575. @kindex C-c C-x C-y
  1576. @item C-c C-x C-y
  1577. Paste a rectangular region into a table.
  1578. The upper left corner ends up in the current field. All involved fields
  1579. will be overwritten. If the rectangle does not fit into the present table,
  1580. the table is enlarged as needed. The process ignores horizontal separator
  1581. lines.
  1582. @c
  1583. @kindex M-@key{RET}
  1584. @itemx M-@kbd{RET}
  1585. Wrap several fields in a column like a paragraph. If there is an active
  1586. region, and both point and mark are in the same column, the text in the
  1587. column is wrapped to minimum width for the given number of lines. A numeric
  1588. prefix argument may be used to change the number of desired lines. If there
  1589. is no region, the current field is split at the cursor position and the text
  1590. fragment to the right of the cursor is prepended to the field one line
  1591. down. If there is no region, but you specify a prefix argument, the current
  1592. field is made blank, and the content is appended to the field above.
  1593. @tsubheading{Calculations}
  1594. @cindex formula, in tables
  1595. @cindex calculations, in tables
  1596. @cindex region, active
  1597. @cindex active region
  1598. @cindex transient mark mode
  1599. @kindex C-c +
  1600. @item C-c +
  1601. Sum the numbers in the current column, or in the rectangle defined by
  1602. the active region. The result is shown in the echo area and can
  1603. be inserted with @kbd{C-y}.
  1604. @c
  1605. @kindex S-@key{RET}
  1606. @item S-@key{RET}
  1607. @vindex org-table-copy-increment
  1608. When current field is empty, copy from first non-empty field above. When not
  1609. empty, copy current field down to next row and move cursor along with it.
  1610. Depending on the variable @code{org-table-copy-increment}, integer field
  1611. values will be incremented during copy. Integers that are too large will not
  1612. be incremented. Also, a @code{0} prefix argument temporarily disables the
  1613. increment. This key is also used by shift-selection and related modes
  1614. (@pxref{Conflicts}).
  1615. @tsubheading{Miscellaneous}
  1616. @kindex C-c `
  1617. @item C-c `
  1618. Edit the current field in a separate window. This is useful for fields that
  1619. are not fully visible (@pxref{Column width and alignment}). When called with
  1620. a @kbd{C-u} prefix, just make the full field visible, so that it can be
  1621. edited in place.
  1622. @c
  1623. @item M-x org-table-import
  1624. Import a file as a table. The table should be TAB or whitespace
  1625. separated. Use, for example, to import a spreadsheet table or data
  1626. from a database, because these programs generally can write
  1627. TAB-separated text files. This command works by inserting the file into
  1628. the buffer and then converting the region to a table. Any prefix
  1629. argument is passed on to the converter, which uses it to determine the
  1630. separator.
  1631. @item C-c |
  1632. Tables can also be imported by pasting tabular text into the Org
  1633. buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
  1634. @kbd{C-c |} command (see above under @i{Creation and conversion}).
  1635. @c
  1636. @item M-x org-table-export
  1637. @vindex org-table-export-default-format
  1638. Export the table, by default as a TAB-separated file. Use for data
  1639. exchange with, for example, spreadsheet or database programs. The format
  1640. used to export the file can be configured in the variable
  1641. @code{org-table-export-default-format}. You may also use properties
  1642. @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
  1643. name and the format for table export in a subtree. Org supports quite
  1644. general formats for exported tables. The exporter format is the same as the
  1645. format used by Orgtbl radio tables, see @ref{Translator functions}, for a
  1646. detailed description.
  1647. @end table
  1648. If you don't like the automatic table editor because it gets in your
  1649. way on lines which you would like to start with @samp{|}, you can turn
  1650. it off with
  1651. @lisp
  1652. (setq org-enable-table-editor nil)
  1653. @end lisp
  1654. @noindent Then the only table command that still works is
  1655. @kbd{C-c C-c} to do a manual re-align.
  1656. @node Column width and alignment, Column groups, Built-in table editor, Tables
  1657. @section Column width and alignment
  1658. @cindex narrow columns in tables
  1659. @cindex alignment in tables
  1660. The width of columns is automatically determined by the table editor. And
  1661. also the alignment of a column is determined automatically from the fraction
  1662. of number-like versus non-number fields in the column.
  1663. Sometimes a single field or a few fields need to carry more text,
  1664. leading to inconveniently wide columns. To limit@footnote{This feature
  1665. does not work on XEmacs.} the width of a column, one field anywhere in
  1666. the column may contain just the string @samp{<N>} where @samp{N} is an
  1667. integer specifying the width of the column in characters. The next
  1668. re-align will then set the width of this column to no more than this
  1669. value.
  1670. @example
  1671. @group
  1672. |---+------------------------------| |---+--------|
  1673. | | | | | <6> |
  1674. | 1 | one | | 1 | one |
  1675. | 2 | two | ----\ | 2 | two |
  1676. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  1677. | 4 | four | | 4 | four |
  1678. |---+------------------------------| |---+--------|
  1679. @end group
  1680. @end example
  1681. @noindent
  1682. Fields that are wider become clipped and end in the string @samp{=>}.
  1683. Note that the full text is still in the buffer, it is only invisible.
  1684. To see the full text, hold the mouse over the field---a tool-tip window
  1685. will show the full content. To edit such a field, use the command
  1686. @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
  1687. open a new window with the full field. Edit it and finish with @kbd{C-c
  1688. C-c}.
  1689. @vindex org-startup-align-all-tables
  1690. When visiting a file containing a table with narrowed columns, the
  1691. necessary character hiding has not yet happened, and the table needs to
  1692. be aligned before it looks nice. Setting the option
  1693. @code{org-startup-align-all-tables} will realign all tables in a file
  1694. upon visiting, but also slow down startup. You can also set this option
  1695. on a per-file basis with:
  1696. @example
  1697. #+STARTUP: align
  1698. #+STARTUP: noalign
  1699. @end example
  1700. If you would like to overrule the automatic alignment of number-rich columns
  1701. to the right and of string-rich column to the left, you and use @samp{<r>} or
  1702. @samp{<l>} in a similar fashion. You may also combine alignment and field
  1703. width like this: @samp{<l10>}.
  1704. @node Column groups, Orgtbl mode, Column width and alignment, Tables
  1705. @section Column groups
  1706. @cindex grouping columns in tables
  1707. When Org exports tables, it does so by default without vertical
  1708. lines because that is visually more satisfying in general. Occasionally
  1709. however, vertical lines can be useful to structure a table into groups
  1710. of columns, much like horizontal lines can do for groups of rows. In
  1711. order to specify column groups, you can use a special row where the
  1712. first field contains only @samp{/}. The further fields can either
  1713. contain @samp{<} to indicate that this column should start a group,
  1714. @samp{>} to indicate the end of a column, or @samp{<>} to make a column
  1715. a group of its own. Boundaries between column groups will upon export be
  1716. marked with vertical lines. Here is an example:
  1717. @example
  1718. | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1719. |---+----+-----+-----+-----+---------+------------|
  1720. | / | <> | < | | > | < | > |
  1721. | # | 1 | 1 | 1 | 1 | 1 | 1 |
  1722. | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
  1723. | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
  1724. |---+----+-----+-----+-----+---------+------------|
  1725. #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
  1726. @end example
  1727. It is also sufficient to just insert the column group starters after
  1728. every vertical line you'd like to have:
  1729. @example
  1730. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1731. |----+-----+-----+-----+---------+------------|
  1732. | / | < | | | < | |
  1733. @end example
  1734. @node Orgtbl mode, The spreadsheet, Column groups, Tables
  1735. @section The Orgtbl minor mode
  1736. @cindex Orgtbl mode
  1737. @cindex minor mode for tables
  1738. If you like the intuitive way the Org table editor works, you
  1739. might also want to use it in other modes like Text mode or Mail mode.
  1740. The minor mode Orgtbl mode makes this possible. You can always toggle
  1741. the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
  1742. example in mail mode, use
  1743. @lisp
  1744. (add-hook 'mail-mode-hook 'turn-on-orgtbl)
  1745. @end lisp
  1746. Furthermore, with some special setup, it is possible to maintain tables
  1747. in arbitrary syntax with Orgtbl mode. For example, it is possible to
  1748. construct La@TeX{} tables with the underlying ease and power of
  1749. Orgtbl mode, including spreadsheet capabilities. For details, see
  1750. @ref{Tables in arbitrary syntax}.
  1751. @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
  1752. @section The spreadsheet
  1753. @cindex calculations, in tables
  1754. @cindex spreadsheet capabilities
  1755. @cindex @file{calc} package
  1756. The table editor makes use of the Emacs @file{calc} package to implement
  1757. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  1758. derive fields from other fields. While fully featured, Org's
  1759. implementation is not identical to other spreadsheets. For example,
  1760. Org knows the concept of a @emph{column formula} that will be
  1761. applied to all non-header fields in a column without having to copy the
  1762. formula to each relevant field.
  1763. @menu
  1764. * References:: How to refer to another field or range
  1765. * Formula syntax for Calc:: Using Calc to compute stuff
  1766. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  1767. * Field formulas:: Formulas valid for a single field
  1768. * Column formulas:: Formulas valid for an entire column
  1769. * Editing and debugging formulas:: Fixing formulas
  1770. * Updating the table:: Recomputing all dependent fields
  1771. * Advanced features:: Field names, parameters and automatic recalc
  1772. @end menu
  1773. @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
  1774. @subsection References
  1775. @cindex references
  1776. To compute fields in the table from other fields, formulas must
  1777. reference other fields or ranges. In Org, fields can be referenced
  1778. by name, by absolute coordinates, and by relative coordinates. To find
  1779. out what the coordinates of a field are, press @kbd{C-c ?} in that
  1780. field, or press @kbd{C-c @}} to toggle the display of a grid.
  1781. @subsubheading Field references
  1782. @cindex field references
  1783. @cindex references, to fields
  1784. Formulas can reference the value of another field in two ways. Like in
  1785. any other spreadsheet, you may reference fields with a letter/number
  1786. combination like @code{B3}, meaning the 2nd field in the 3rd row.
  1787. @c Such references are always fixed to that field, they don't change
  1788. @c when you copy and paste a formula to a different field. So
  1789. @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
  1790. @noindent
  1791. Org also uses another, more general operator that looks like this:
  1792. @example
  1793. @@@var{row}$@var{column}
  1794. @end example
  1795. @noindent
  1796. Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}},
  1797. or relative to the current column like @samp{+1} or @samp{-2}.
  1798. The row specification only counts data lines and ignores horizontal
  1799. separator lines (hlines). You can use absolute row numbers
  1800. @samp{1}...@samp{@var{N}}, and row numbers relative to the current row like
  1801. @samp{+3} or @samp{-1}. Or specify the row relative to one of the
  1802. hlines: @samp{I} refers to the first hline@footnote{Note that only
  1803. hlines are counted that @emph{separate} table lines. If the table
  1804. starts with a hline above the header, it does not count.}, @samp{II} to
  1805. the second, etc@. @samp{-I} refers to the first such line above the
  1806. current line, @samp{+I} to the first such line below the current line.
  1807. You can also write @samp{III+2} which is the second data line after the
  1808. third hline in the table. Relative row numbers like @samp{-3} will not
  1809. cross hlines if the current line is too close to the hline. Instead,
  1810. the value directly at the hline is used.
  1811. @samp{0} refers to the current row and column. Also, if you omit
  1812. either the column or the row part of the reference, the current
  1813. row/column is implied.
  1814. Org's references with @emph{unsigned} numbers are fixed references
  1815. in the sense that if you use the same reference in the formula for two
  1816. different fields, the same field will be referenced each time.
  1817. Org's references with @emph{signed} numbers are floating
  1818. references because the same reference operator can reference different
  1819. fields depending on the field being calculated by the formula.
  1820. As a special case, references like @samp{$LR5} and @samp{$LR12} can be used to
  1821. refer in a stable way to the 5th and 12th field in the last row of the
  1822. table.
  1823. Here are a few examples:
  1824. @example
  1825. @@2$3 @r{2nd row, 3rd column}
  1826. C2 @r{same as previous}
  1827. $5 @r{column 5 in the current row}
  1828. E& @r{same as previous}
  1829. @@2 @r{current column, row 2}
  1830. @@-1$-3 @r{the field one row up, three columns to the left}
  1831. @@-I$2 @r{field just under hline above current row, column 2}
  1832. @end example
  1833. @subsubheading Range references
  1834. @cindex range references
  1835. @cindex references, to ranges
  1836. You may reference a rectangular range of fields by specifying two field
  1837. references connected by two dots @samp{..}. If both fields are in the
  1838. current row, you may simply use @samp{$2..$7}, but if at least one field
  1839. is in a different row, you need to use the general @code{@@row$column}
  1840. format at least for the first field (i.e the reference must start with
  1841. @samp{@@} in order to be interpreted correctly). Examples:
  1842. @example
  1843. $1..$3 @r{First three fields in the current row.}
  1844. $P..$Q @r{Range, using column names (see under Advanced)}
  1845. @@2$1..@@4$3 @r{6 fields between these two fields.}
  1846. A2..C4 @r{Same as above.}
  1847. @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
  1848. @end example
  1849. @noindent Range references return a vector of values that can be fed
  1850. into Calc vector functions. Empty fields in ranges are normally
  1851. suppressed, so that the vector contains only the non-empty fields (but
  1852. see the @samp{E} mode switch below). If there are no non-empty fields,
  1853. @samp{[0]} is returned to avoid syntax errors in formulas.
  1854. @subsubheading Named references
  1855. @cindex named references
  1856. @cindex references, named
  1857. @cindex name, of column or field
  1858. @cindex constants, in calculations
  1859. @cindex #+CONSTANTS
  1860. @vindex org-table-formula-constants
  1861. @samp{$name} is interpreted as the name of a column, parameter or
  1862. constant. Constants are defined globally through the variable
  1863. @code{org-table-formula-constants}, and locally (for the file) through a
  1864. line like
  1865. @example
  1866. #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
  1867. @end example
  1868. @noindent
  1869. @vindex constants-unit-system
  1870. @pindex constants.el
  1871. Also properties (@pxref{Properties and Columns}) can be used as
  1872. constants in table formulas: For a property @samp{:Xyz:} use the name
  1873. @samp{$PROP_Xyz}, and the property will be searched in the current
  1874. outline entry and in the hierarchy above it. If you have the
  1875. @file{constants.el} package, it will also be used to resolve constants,
  1876. including natural constants like @samp{$h} for Planck's constant, and
  1877. units like @samp{$km} for kilometers@footnote{@file{constants.el} can
  1878. supply the values of constants in two different unit systems, @code{SI}
  1879. and @code{cgs}. Which one is used depends on the value of the variable
  1880. @code{constants-unit-system}. You can use the @code{#+STARTUP} options
  1881. @code{constSI} and @code{constcgs} to set this value for the current
  1882. buffer.}. Column names and parameters can be specified in special table
  1883. lines. These are described below, see @ref{Advanced features}. All
  1884. names must start with a letter, and further consist of letters and
  1885. numbers.
  1886. @subsubheading Remote references
  1887. @cindex remote references
  1888. @cindex references, remote
  1889. @cindex references, to a different table
  1890. @cindex name, of column or field
  1891. @cindex constants, in calculations
  1892. @cindex #+TBLNAME
  1893. You may also reference constants, fields and ranges from a different table,
  1894. either in the current file or even in a different file. The syntax is
  1895. @example
  1896. remote(NAME-OR-ID,REF)
  1897. @end example
  1898. @noindent
  1899. where NAME can be the name of a table in the current file as set by a
  1900. @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
  1901. entry, even in a different file, and the reference then refers to the first
  1902. table in that entry. REF is an absolute field or range reference as
  1903. described above for example @code{@@3$3} or @code{$somename}, valid in the
  1904. referenced table.
  1905. @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
  1906. @subsection Formula syntax for Calc
  1907. @cindex formula syntax, Calc
  1908. @cindex syntax, of formulas
  1909. A formula can be any algebraic expression understood by the Emacs
  1910. @file{Calc} package. @b{Note that @file{calc} has the
  1911. non-standard convention that @samp{/} has lower precedence than
  1912. @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
  1913. evaluation by @code{calc-eval} (@pxref{Calling Calc from
  1914. Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
  1915. Emacs Calc Manual}),
  1916. @c FIXME: The link to the Calc manual in HTML does not work.
  1917. variable substitution takes place according to the rules described above.
  1918. @cindex vectors, in table calculations
  1919. The range vectors can be directly fed into the Calc vector functions
  1920. like @samp{vmean} and @samp{vsum}.
  1921. @cindex format specifier
  1922. @cindex mode, for @file{calc}
  1923. @vindex org-calc-default-modes
  1924. A formula can contain an optional mode string after a semicolon. This
  1925. string consists of flags to influence Calc and other modes during
  1926. execution. By default, Org uses the standard Calc modes (precision
  1927. 12, angular units degrees, fraction and symbolic modes off). The display
  1928. format, however, has been changed to @code{(float 8)} to keep tables
  1929. compact. The default settings can be configured using the variable
  1930. @code{org-calc-default-modes}.
  1931. @example
  1932. p20 @r{switch the internal precision to 20 digits}
  1933. n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
  1934. D R @r{angle modes: degrees, radians}
  1935. F S @r{fraction and symbolic modes}
  1936. N @r{interpret all fields as numbers, use 0 for non-numbers}
  1937. T @r{force text interpretation}
  1938. E @r{keep empty fields in ranges}
  1939. L @r{literal}
  1940. @end example
  1941. @noindent
  1942. In addition, you may provide a @code{printf} format specifier to
  1943. reformat the final result. A few examples:
  1944. @example
  1945. $1+$2 @r{Sum of first and second field}
  1946. $1+$2;%.2f @r{Same, format result to two decimals}
  1947. exp($2)+exp($1) @r{Math functions can be used}
  1948. $0;%.1f @r{Reformat current cell to 1 decimal}
  1949. ($3-32)*5/9 @r{Degrees F -> C conversion}
  1950. $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
  1951. tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
  1952. sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
  1953. vmean($2..$7) @r{Compute column range mean, using vector function}
  1954. vmean($2..$7);EN @r{Same, but treat empty fields as 0}
  1955. taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
  1956. @end example
  1957. Calc also contains a complete set of logical operations. For example
  1958. @example
  1959. if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
  1960. @end example
  1961. @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
  1962. @subsection Emacs Lisp forms as formulas
  1963. @cindex Lisp forms, as table formulas
  1964. It is also possible to write a formula in Emacs Lisp; this can be useful
  1965. for string manipulation and control structures, if Calc's
  1966. functionality is not enough. If a formula starts with a single-quote
  1967. followed by an opening parenthesis, then it is evaluated as a Lisp form.
  1968. The evaluation should return either a string or a number. Just as with
  1969. @file{calc} formulas, you can specify modes and a printf format after a
  1970. semicolon. With Emacs Lisp forms, you need to be conscious about the way
  1971. field references are interpolated into the form. By default, a
  1972. reference will be interpolated as a Lisp string (in double-quotes)
  1973. containing the field. If you provide the @samp{N} mode switch, all
  1974. referenced elements will be numbers (non-number fields will be zero) and
  1975. interpolated as Lisp numbers, without quotes. If you provide the
  1976. @samp{L} flag, all fields will be interpolated literally, without quotes.
  1977. @Ie{}, if you want a reference to be interpreted as a string by the Lisp
  1978. form, enclose the reference operator itself in double-quotes, like
  1979. @code{"$3"}. Ranges are inserted as space-separated fields, so you can
  1980. embed them in list or vector syntax. A few examples, note how the
  1981. @samp{N} mode is used when we do computations in Lisp.
  1982. @example
  1983. @r{Swap the first two characters of the content of column 1}
  1984. '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
  1985. @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
  1986. '(+ $1 $2);N
  1987. @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
  1988. '(apply '+ '($1..$4));N
  1989. @end example
  1990. @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
  1991. @subsection Field formulas
  1992. @cindex field formula
  1993. @cindex formula, for individual table field
  1994. To assign a formula to a particular field, type it directly into the
  1995. field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
  1996. press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
  1997. the field, the formula will be stored as the formula for this field,
  1998. evaluated, and the current field replaced with the result.
  1999. @cindex #+TBLFM
  2000. Formulas are stored in a special line starting with @samp{#+TBLFM:}
  2001. directly below the table. If you typed the equation in the 4th field of
  2002. the 3rd data line in the table, the formula will look like
  2003. @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
  2004. with the appropriate commands, @i{absolute references} (but not relative
  2005. ones) in stored formulas are modified in order to still reference the
  2006. same field. Of course this is not true if you edit the table structure
  2007. with normal editing commands---then you must fix the equations yourself.
  2008. The left-hand side of a formula may also be a named field (@pxref{Advanced
  2009. features}), or a last-row reference like @samp{$LR3}.
  2010. Instead of typing an equation into the field, you may also use the
  2011. following command
  2012. @table @kbd
  2013. @kindex C-u C-c =
  2014. @item C-u C-c =
  2015. Install a new formula for the current field. The command prompts for a
  2016. formula with default taken from the @samp{#+TBLFM:} line, applies
  2017. it to the current field, and stores it.
  2018. @end table
  2019. @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
  2020. @subsection Column formulas
  2021. @cindex column formula
  2022. @cindex formula, for table column
  2023. Often in a table, the same formula should be used for all fields in a
  2024. particular column. Instead of having to copy the formula to all fields
  2025. in that column, Org allows you to assign a single formula to an entire
  2026. column. If the table contains horizontal separator hlines, everything
  2027. before the first such line is considered part of the table @emph{header}
  2028. and will not be modified by column formulas.
  2029. To assign a formula to a column, type it directly into any field in the
  2030. column, preceded by an equal sign, like @samp{=$1+$2}. When you press
  2031. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
  2032. the formula will be stored as the formula for the current column, evaluated
  2033. and the current field replaced with the result. If the field contains only
  2034. @samp{=}, the previously stored formula for this column is used. For each
  2035. column, Org will only remember the most recently used formula. In the
  2036. @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand
  2037. side of a column formula cannot currently be the name of column, it
  2038. must be the numeric column reference.
  2039. Instead of typing an equation into the field, you may also use the
  2040. following command:
  2041. @table @kbd
  2042. @kindex C-c =
  2043. @item C-c =
  2044. Install a new formula for the current column and replace current field with
  2045. the result of the formula. The command prompts for a formula, with default
  2046. taken from the @samp{#+TBLFM} line, applies it to the current field and
  2047. stores it. With a numeric prefix argument(@eg @kbd{C-5 C-c =}) the command
  2048. will apply it to that many consecutive fields in the current column.
  2049. @end table
  2050. @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
  2051. @subsection Editing and debugging formulas
  2052. @cindex formula editing
  2053. @cindex editing, of table formulas
  2054. @vindex org-table-use-standard-references
  2055. You can edit individual formulas in the minibuffer or directly in the
  2056. field. Org can also prepare a special buffer with all active
  2057. formulas of a table. When offering a formula for editing, Org
  2058. converts references to the standard format (like @code{B3} or @code{D&})
  2059. if possible. If you prefer to only work with the internal format (like
  2060. @code{@@3$2} or @code{$4}), configure the variable
  2061. @code{org-table-use-standard-references}.
  2062. @table @kbd
  2063. @kindex C-c =
  2064. @kindex C-u C-c =
  2065. @item C-c =
  2066. @itemx C-u C-c =
  2067. Edit the formula associated with the current column/field in the
  2068. minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
  2069. @kindex C-u C-u C-c =
  2070. @item C-u C-u C-c =
  2071. Re-insert the active formula (either a
  2072. field formula, or a column formula) into the current field, so that you
  2073. can edit it directly in the field. The advantage over editing in the
  2074. minibuffer is that you can use the command @kbd{C-c ?}.
  2075. @kindex C-c ?
  2076. @item C-c ?
  2077. While editing a formula in a table field, highlight the field(s)
  2078. referenced by the reference at the cursor position in the formula.
  2079. @kindex C-c @}
  2080. @item C-c @}
  2081. Toggle the display of row and column numbers for a table, using
  2082. overlays. These are updated each time the table is aligned; you can
  2083. force it with @kbd{C-c C-c}.
  2084. @kindex C-c @{
  2085. @item C-c @{
  2086. Toggle the formula debugger on and off. See below.
  2087. @kindex C-c '
  2088. @item C-c '
  2089. Edit all formulas for the current table in a special buffer, where the
  2090. formulas will be displayed one per line. If the current field has an
  2091. active formula, the cursor in the formula editor will mark it.
  2092. While inside the special buffer, Org will automatically highlight
  2093. any field or range reference at the cursor position. You may edit,
  2094. remove and add formulas, and use the following commands:
  2095. @table @kbd
  2096. @kindex C-c C-c
  2097. @kindex C-x C-s
  2098. @item C-c C-c
  2099. @itemx C-x C-s
  2100. Exit the formula editor and store the modified formulas. With @kbd{C-u}
  2101. prefix, also apply the new formulas to the entire table.
  2102. @kindex C-c C-q
  2103. @item C-c C-q
  2104. Exit the formula editor without installing changes.
  2105. @kindex C-c C-r
  2106. @item C-c C-r
  2107. Toggle all references in the formula editor between standard (like
  2108. @code{B3}) and internal (like @code{@@3$2}).
  2109. @kindex @key{TAB}
  2110. @item @key{TAB}
  2111. Pretty-print or indent Lisp formula at point. When in a line containing
  2112. a Lisp formula, format the formula according to Emacs Lisp rules.
  2113. Another @key{TAB} collapses the formula back again. In the open
  2114. formula, @key{TAB} re-indents just like in Emacs Lisp mode.
  2115. @kindex M-@key{TAB}
  2116. @item M-@key{TAB}
  2117. Complete Lisp symbols, just like in Emacs Lisp mode.
  2118. @kindex S-@key{up}
  2119. @kindex S-@key{down}
  2120. @kindex S-@key{left}
  2121. @kindex S-@key{right}
  2122. @item S-@key{up}/@key{down}/@key{left}/@key{right}
  2123. Shift the reference at point. For example, if the reference is
  2124. @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
  2125. This also works for relative references and for hline references.
  2126. @kindex M-S-@key{up}
  2127. @kindex M-S-@key{down}
  2128. @item M-S-@key{up}/@key{down}
  2129. Move the test line for column formulas in the Org buffer up and
  2130. down.
  2131. @kindex M-@key{up}
  2132. @kindex M-@key{down}
  2133. @item M-@key{up}/@key{down}
  2134. Scroll the window displaying the table.
  2135. @kindex C-c @}
  2136. @item C-c @}
  2137. Turn the coordinate grid in the table on and off.
  2138. @end table
  2139. @end table
  2140. Making a table field blank does not remove the formula associated with
  2141. the field, because that is stored in a different line (the @samp{#+TBLFM}
  2142. line)---during the next recalculation the field will be filled again.
  2143. To remove a formula from a field, you have to give an empty reply when
  2144. prompted for the formula, or to edit the @samp{#+TBLFM} line.
  2145. @kindex C-c C-c
  2146. You may edit the @samp{#+TBLFM} directly and re-apply the changed
  2147. equations with @kbd{C-c C-c} in that line or with the normal
  2148. recalculation commands in the table.
  2149. @subsubheading Debugging formulas
  2150. @cindex formula debugging
  2151. @cindex debugging, of table formulas
  2152. When the evaluation of a formula leads to an error, the field content
  2153. becomes the string @samp{#ERROR}. If you would like see what is going
  2154. on during variable substitution and calculation in order to find a bug,
  2155. turn on formula debugging in the @code{Tbl} menu and repeat the
  2156. calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
  2157. field. Detailed information will be displayed.
  2158. @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
  2159. @subsection Updating the table
  2160. @cindex recomputing table fields
  2161. @cindex updating, table
  2162. Recalculation of a table is normally not automatic, but needs to be
  2163. triggered by a command. See @ref{Advanced features}, for a way to make
  2164. recalculation at least semi-automatic.
  2165. In order to recalculate a line of a table or the entire table, use the
  2166. following commands:
  2167. @table @kbd
  2168. @kindex C-c *
  2169. @item C-c *
  2170. Recalculate the current row by first applying the stored column formulas
  2171. from left to right, and all field formulas in the current row.
  2172. @c
  2173. @kindex C-u C-c *
  2174. @item C-u C-c *
  2175. @kindex C-u C-c C-c
  2176. @itemx C-u C-c C-c
  2177. Recompute the entire table, line by line. Any lines before the first
  2178. hline are left alone, assuming that these are part of the table header.
  2179. @c
  2180. @kindex C-u C-u C-c *
  2181. @kindex C-u C-u C-c C-c
  2182. @item C-u C-u C-c *
  2183. @itemx C-u C-u C-c C-c
  2184. Iterate the table by recomputing it until no further changes occur.
  2185. This may be necessary if some computed fields use the value of other
  2186. fields that are computed @i{later} in the calculation sequence.
  2187. @end table
  2188. @node Advanced features, , Updating the table, The spreadsheet
  2189. @subsection Advanced features
  2190. If you want the recalculation of fields to happen automatically, or if
  2191. you want to be able to assign @i{names} to fields and columns, you need
  2192. to reserve the first column of the table for special marking characters.
  2193. @table @kbd
  2194. @kindex C-#
  2195. @item C-#
  2196. Rotate the calculation mark in first column through the states @samp{},
  2197. @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
  2198. change all marks in the region.
  2199. @end table
  2200. Here is an example of a table that collects exam results of students and
  2201. makes use of these features:
  2202. @example
  2203. @group
  2204. |---+---------+--------+--------+--------+-------+------|
  2205. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  2206. |---+---------+--------+--------+--------+-------+------|
  2207. | ! | | P1 | P2 | P3 | Tot | |
  2208. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  2209. | ^ | | m1 | m2 | m3 | mt | |
  2210. |---+---------+--------+--------+--------+-------+------|
  2211. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  2212. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  2213. |---+---------+--------+--------+--------+-------+------|
  2214. | | Average | | | | 29.7 | |
  2215. | ^ | | | | | at | |
  2216. | $ | max=50 | | | | | |
  2217. |---+---------+--------+--------+--------+-------+------|
  2218. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
  2219. @end group
  2220. @end example
  2221. @noindent @b{Important}: Please note that for these special tables,
  2222. recalculating the table with @kbd{C-u C-c *} will only affect rows that
  2223. are marked @samp{#} or @samp{*}, and fields that have a formula assigned
  2224. to the field itself. The column formulas are not applied in rows with
  2225. empty first field.
  2226. @cindex marking characters, tables
  2227. The marking characters have the following meaning:
  2228. @table @samp
  2229. @item !
  2230. The fields in this line define names for the columns, so that you may
  2231. refer to a column as @samp{$Tot} instead of @samp{$6}.
  2232. @item ^
  2233. This row defines names for the fields @emph{above} the row. With such
  2234. a definition, any formula in the table may use @samp{$m1} to refer to
  2235. the value @samp{10}. Also, if you assign a formula to a names field, it
  2236. will be stored as @samp{$name=...}.
  2237. @item _
  2238. Similar to @samp{^}, but defines names for the fields in the row
  2239. @emph{below}.
  2240. @item $
  2241. Fields in this row can define @emph{parameters} for formulas. For
  2242. example, if a field in a @samp{$} row contains @samp{max=50}, then
  2243. formulas in this table can refer to the value 50 using @samp{$max}.
  2244. Parameters work exactly like constants, only that they can be defined on
  2245. a per-table basis.
  2246. @item #
  2247. Fields in this row are automatically recalculated when pressing
  2248. @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
  2249. is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
  2250. lines will be left alone by this command.
  2251. @item *
  2252. Selects this line for global recalculation with @kbd{C-u C-c *}, but
  2253. not for automatic recalculation. Use this when automatic
  2254. recalculation slows down editing too much.
  2255. @item
  2256. Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
  2257. All lines that should be recalculated should be marked with @samp{#}
  2258. or @samp{*}.
  2259. @item /
  2260. Do not export this line. Useful for lines that contain the narrowing
  2261. @samp{<N>} markers.
  2262. @end table
  2263. Finally, just to whet your appetite for what can be done with the
  2264. fantastic @file{calc.el} package, here is a table that computes the Taylor
  2265. series of degree @code{n} at location @code{x} for a couple of
  2266. functions.
  2267. @example
  2268. @group
  2269. |---+-------------+---+-----+--------------------------------------|
  2270. | | Func | n | x | Result |
  2271. |---+-------------+---+-----+--------------------------------------|
  2272. | # | exp(x) | 1 | x | 1 + x |
  2273. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  2274. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  2275. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  2276. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  2277. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  2278. |---+-------------+---+-----+--------------------------------------|
  2279. #+TBLFM: $5=taylor($2,$4,$3);n3
  2280. @end group
  2281. @end example
  2282. @node Org-Plot, , The spreadsheet, Tables
  2283. @section Org-Plot
  2284. @cindex graph, in tables
  2285. @cindex plot tables using gnuplot
  2286. @cindex #+PLOT
  2287. Org-Plot can produce 2D and 3D graphs of information stored in org tables
  2288. using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
  2289. @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
  2290. this in action, ensure that you have both Gnuplot and Gnuplot mode installed
  2291. on your system, then call @code{org-plot/gnuplot} on the following table.
  2292. @example
  2293. @group
  2294. #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
  2295. | Sede | Max cites | H-index |
  2296. |-----------+-----------+---------|
  2297. | Chile | 257.72 | 21.39 |
  2298. | Leeds | 165.77 | 19.68 |
  2299. | Sao Paolo | 71.00 | 11.50 |
  2300. | Stockholm | 134.19 | 14.33 |
  2301. | Morelia | 257.56 | 17.67 |
  2302. @end group
  2303. @end example
  2304. Notice that Org Plot is smart enough to apply the table's headers as labels.
  2305. Further control over the labels, type, content, and appearance of plots can
  2306. be exercised through the @code{#+PLOT:} lines preceding a table. See below
  2307. for a complete list of Org-plot options. For more information and examples
  2308. see the Org-plot tutorial at
  2309. @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
  2310. @subsubheading Plot Options
  2311. @table @code
  2312. @item set
  2313. Specify any @command{gnuplot} option to be set when graphing.
  2314. @item title
  2315. Specify the title of the plot.
  2316. @item ind
  2317. Specify which column of the table to use as the @code{x} axis.
  2318. @item deps
  2319. Specify the columns to graph as a Lisp style list, surrounded by parentheses
  2320. and separated by spaces for example @code{dep:(3 4)} to graph the third and
  2321. fourth columns (defaults to graphing all other columns aside from the @code{ind}
  2322. column).
  2323. @item type
  2324. Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
  2325. @item with
  2326. Specify a @code{with} option to be inserted for every col being plotted
  2327. (@eg @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
  2328. Defaults to @code{lines}.
  2329. @item file
  2330. If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
  2331. @item labels
  2332. List of labels to be used for the deps (defaults to the column headers if
  2333. they exist).
  2334. @item line
  2335. Specify an entire line to be inserted in the Gnuplot script.
  2336. @item map
  2337. When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
  2338. flat mapping rather than a @code{3d} slope.
  2339. @item timefmt
  2340. Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
  2341. Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
  2342. @item script
  2343. If you want total control, you can specify a script file (place the file name
  2344. between double-quotes) which will be used to plot. Before plotting, every
  2345. instance of @code{$datafile} in the specified script will be replaced with
  2346. the path to the generated data file. Note: Even if you set this option, you
  2347. may still want to specify the plot type, as that can impact the content of
  2348. the data file.
  2349. @end table
  2350. @node Hyperlinks, TODO Items, Tables, Top
  2351. @chapter Hyperlinks
  2352. @cindex hyperlinks
  2353. Like HTML, Org provides links inside a file, external links to
  2354. other files, Usenet articles, emails, and much more.
  2355. @menu
  2356. * Link format:: How links in Org are formatted
  2357. * Internal links:: Links to other places in the current file
  2358. * External links:: URL-like links to the world
  2359. * Handling links:: Creating, inserting and following
  2360. * Using links outside Org:: Linking from my C source code?
  2361. * Link abbreviations:: Shortcuts for writing complex links
  2362. * Search options:: Linking to a specific location
  2363. * Custom searches:: When the default search is not enough
  2364. @end menu
  2365. @node Link format, Internal links, Hyperlinks, Hyperlinks
  2366. @section Link format
  2367. @cindex link format
  2368. @cindex format, of links
  2369. Org will recognize plain URL-like links and activate them as
  2370. clickable links. The general link format, however, looks like this:
  2371. @example
  2372. [[link][description]] @r{or alternatively} [[link]]
  2373. @end example
  2374. @noindent
  2375. Once a link in the buffer is complete (all brackets present), Org
  2376. will change the display so that @samp{description} is displayed instead
  2377. of @samp{[[link][description]]} and @samp{link} is displayed instead of
  2378. @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
  2379. which by default is an underlined face. You can directly edit the
  2380. visible part of a link. Note that this can be either the @samp{link}
  2381. part (if there is no description) or the @samp{description} part. To
  2382. edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
  2383. cursor on the link.
  2384. If you place the cursor at the beginning or just behind the end of the
  2385. displayed text and press @key{BACKSPACE}, you will remove the
  2386. (invisible) bracket at that location. This makes the link incomplete
  2387. and the internals are again displayed as plain text. Inserting the
  2388. missing bracket hides the link internals again. To show the
  2389. internal structure of all links, use the menu entry
  2390. @code{Org->Hyperlinks->Literal links}.
  2391. @node Internal links, External links, Link format, Hyperlinks
  2392. @section Internal links
  2393. @cindex internal links
  2394. @cindex links, internal
  2395. @cindex targets, for links
  2396. @cindex property, CUSTOM_ID
  2397. If the link does not look like a URL, it is considered to be internal in the
  2398. current file. The most important case is a link like
  2399. @samp{[[#my-custom-id]]} which will link to the entry with the
  2400. @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
  2401. for HTML export (@pxref{HTML export}) where they produce pretty section
  2402. links. You are responsible yourself to make sure these custom IDs are unique
  2403. in a file.
  2404. Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
  2405. lead to a text search in the current file.
  2406. The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
  2407. or with a mouse click (@pxref{Handling links}). Links to custom IDs will
  2408. point to the corresponding headline. The preferred match for a text link is
  2409. a @i{dedicated target}: the same string in double angular brackets. Targets
  2410. may be located anywhere; sometimes it is convenient to put them into a
  2411. comment line. For example
  2412. @example
  2413. # <<My Target>>
  2414. @end example
  2415. @noindent In HTML export (@pxref{HTML export}), such targets will become
  2416. named anchors for direct access through @samp{http} links@footnote{Note that
  2417. text before the first headline is usually not exported, so the first such
  2418. target should be after the first headline, or in the line directly before the
  2419. first headline.}.
  2420. If no dedicated target exists, Org will search for the words in the link. In
  2421. the above example the search would be for @samp{my target}. Links starting
  2422. with a star like @samp{*My Target} restrict the search to
  2423. headlines@footnote{To insert a link targeting a headline, in-buffer
  2424. completion can be used. Just type a star followed by a few optional letters
  2425. into the buffer and press @kbd{M-@key{TAB}}. All headlines in the current
  2426. buffer will be offered as completions. @xref{Handling links}, for more
  2427. commands creating links.}. When searching, Org mode will first try an
  2428. exact match, but then move on to more and more lenient searches. For
  2429. example, the link @samp{[[*My Targets]]} will find any of the following:
  2430. @example
  2431. ** My targets
  2432. ** TODO my targets are bright
  2433. ** my 20 targets are
  2434. @end example
  2435. Following a link pushes a mark onto Org's own mark ring. You can
  2436. return to the previous position with @kbd{C-c &}. Using this command
  2437. several times in direct succession goes back to positions recorded
  2438. earlier.
  2439. @menu
  2440. * Radio targets:: Make targets trigger links in plain text
  2441. @end menu
  2442. @node Radio targets, , Internal links, Internal links
  2443. @subsection Radio targets
  2444. @cindex radio targets
  2445. @cindex targets, radio
  2446. @cindex links, radio targets
  2447. Org can automatically turn any occurrences of certain target names
  2448. in normal text into a link. So without explicitly creating a link, the
  2449. text connects to the target radioing its position. Radio targets are
  2450. enclosed by triple angular brackets. For example, a target @samp{<<<My
  2451. Target>>>} causes each occurrence of @samp{my target} in normal text to
  2452. become activated as a link. The Org file is scanned automatically
  2453. for radio targets only when the file is first loaded into Emacs. To
  2454. update the target list during editing, press @kbd{C-c C-c} with the
  2455. cursor on or at a target.
  2456. @node External links, Handling links, Internal links, Hyperlinks
  2457. @section External links
  2458. @cindex links, external
  2459. @cindex external links
  2460. @cindex links, external
  2461. @cindex Gnus links
  2462. @cindex BBDB links
  2463. @cindex IRC links
  2464. @cindex URL links
  2465. @cindex file links
  2466. @cindex VM links
  2467. @cindex RMAIL links
  2468. @cindex WANDERLUST links
  2469. @cindex MH-E links
  2470. @cindex USENET links
  2471. @cindex SHELL links
  2472. @cindex Info links
  2473. @cindex Elisp links
  2474. Org supports links to files, websites, Usenet and email messages,
  2475. BBDB database entries and links to both IRC conversations and their
  2476. logs. External links are URL-like locators. They start with a short
  2477. identifying string followed by a colon. There can be no space after
  2478. the colon. The following list shows examples for each link type.
  2479. @example
  2480. http://www.astro.uva.nl/~dominik @r{on the web}
  2481. file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
  2482. /home/dominik/images/jupiter.jpg @r{same as above}
  2483. file:papers/last.pdf @r{file, relative path}
  2484. ./papers/last.pdf @r{same as above}
  2485. file:projects.org @r{another Org file}
  2486. file:projects.org::some words @r{text search in Org file}
  2487. file:projects.org::*task title @r{heading search in Org file}
  2488. id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
  2489. news:comp.emacs @r{Usenet link}
  2490. mailto:adent@@galaxy.net @r{Mail link}
  2491. vm:folder @r{VM folder link}
  2492. vm:folder#id @r{VM message link}
  2493. vm://myself@@some.where.org/folder#id @r{VM on remote machine}
  2494. wl:folder @r{WANDERLUST folder link}
  2495. wl:folder#id @r{WANDERLUST message link}
  2496. mhe:folder @r{MH-E folder link}
  2497. mhe:folder#id @r{MH-E message link}
  2498. rmail:folder @r{RMAIL folder link}
  2499. rmail:folder#id @r{RMAIL message link}
  2500. gnus:group @r{Gnus group link}
  2501. gnus:group#id @r{Gnus article link}
  2502. bbdb:R.*Stallman @r{BBDB link (with regexp)}
  2503. irc:/irc.com/#emacs/bob @r{IRC link}
  2504. shell:ls *.org @r{A shell command}
  2505. elisp:org-agenda @r{Interactive Elisp command}
  2506. elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
  2507. @end example
  2508. A link should be enclosed in double brackets and may contain a
  2509. descriptive text to be displayed instead of the URL (@pxref{Link
  2510. format}), for example:
  2511. @example
  2512. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  2513. @end example
  2514. @noindent
  2515. If the description is a file name or URL that points to an image, HTML
  2516. export (@pxref{HTML export}) will inline the image as a clickable
  2517. button. If there is no description at all and the link points to an
  2518. image,
  2519. that image will be inlined into the exported HTML file.
  2520. @cindex square brackets, around links
  2521. @cindex plain text external links
  2522. Org also finds external links in the normal text and activates them
  2523. as links. If spaces must be part of the link (for example in
  2524. @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
  2525. about the end of the link, enclose them in square brackets.
  2526. @node Handling links, Using links outside Org, External links, Hyperlinks
  2527. @section Handling links
  2528. @cindex links, handling
  2529. Org provides methods to create a link in the correct syntax, to
  2530. insert it into an Org file, and to follow the link.
  2531. @table @kbd
  2532. @kindex C-c l
  2533. @cindex storing links
  2534. @item C-c l
  2535. Store a link to the current location. This is a @emph{global} command (you
  2536. must create the key binding yourself) which can be used in any buffer to
  2537. create a link. The link will be stored for later insertion into an Org
  2538. buffer (see below). What kind of link will be created depends on the current
  2539. buffer:
  2540. @b{Org-mode buffers}@*
  2541. For Org files, if there is a @samp{<<target>>} at the cursor, the link points
  2542. to the target. Otherwise it points to the current headline, which will also
  2543. be the description.
  2544. @vindex org-link-to-org-use-id
  2545. @cindex property, CUSTOM_ID
  2546. @cindex property, ID
  2547. If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
  2548. will be stored. In addition or alternatively (depending on the value of
  2549. @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
  2550. created and/or used to construct a link. So using this command in Org
  2551. buffers will potentially create two links: A human-readable from the custom
  2552. ID, and one that is globally unique and works even if the entry is moved from
  2553. file to file. Later, when inserting the link, you need to decide which one
  2554. to use.
  2555. @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
  2556. Pretty much all Emacs mail clients are supported. The link will point to the
  2557. current article, or, in some GNUS buffers, to the group. The description is
  2558. constructed from the author and the subject.
  2559. @b{Web browsers: W3 and W3M}@*
  2560. Here the link will be the current URL, with the page title as description.
  2561. @b{Contacts: BBDB}@*
  2562. Links created in a BBDB buffer will point to the current entry.
  2563. @b{Chat: IRC}@*
  2564. @vindex org-irc-link-to-logs
  2565. For IRC links, if you set the variable @code{org-irc-link-to-logs} to
  2566. @code{t}, a @samp{file:/} style link to the relevant point in the logs for
  2567. the current conversation is created. Otherwise an @samp{irc:/} style link to
  2568. the user/channel/server under the point will be stored.
  2569. @b{Other files}@*
  2570. For any other files, the link will point to the file, with a search string
  2571. (@pxref{Search options}) pointing to the contents of the current line. If
  2572. there is an active region, the selected words will form the basis of the
  2573. search string. If the automatically created link is not working correctly or
  2574. accurately enough, you can write custom functions to select the search string
  2575. and to do the search for particular file types---see @ref{Custom searches}.
  2576. The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
  2577. @c
  2578. @kindex C-c C-l
  2579. @cindex link completion
  2580. @cindex completion, of links
  2581. @cindex inserting links
  2582. @item C-c C-l
  2583. @vindex org-keep-stored-link-after-insertion
  2584. Insert a link@footnote{ Note that you don't have to use this command to
  2585. insert a link. Links in Org are plain text, and you can type or paste them
  2586. straight into the buffer. By using this command, the links are automatically
  2587. enclosed in double brackets, and you will be asked for the optional
  2588. descriptive text.}. This prompts for a link to be inserted into the buffer.
  2589. You can just type a link, using text for an internal link, or one of the link
  2590. type prefixes mentioned in the examples above. The link will be inserted
  2591. into the buffer@footnote{After insertion of a stored link, the link will be
  2592. removed from the list of stored links. To keep it in the list later use, use
  2593. a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
  2594. @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
  2595. If some text was selected when this command is called, the selected text
  2596. becomes the default description.
  2597. @b{Inserting stored links}@*
  2598. All links stored during the
  2599. current session are part of the history for this prompt, so you can access
  2600. them with @key{up} and @key{down} (or @kbd{M-p/n}).
  2601. @b{Completion support}@* Completion with @key{TAB} will help you to insert
  2602. valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
  2603. defined through link abbreviations (@pxref{Link abbreviations}). If you
  2604. press @key{RET} after inserting only the @var{prefix}, Org will offer
  2605. specific completion support for some link types@footnote{This works by
  2606. calling a special function @code{org-PREFIX-complete-link}.} For
  2607. example, if you type @kbd{file @key{RET}}, file name completion (alternative
  2608. access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
  2609. @key{RET}} you can complete contact names.
  2610. @kindex C-u C-c C-l
  2611. @cindex file name completion
  2612. @cindex completion, of file names
  2613. @item C-u C-c C-l
  2614. When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
  2615. a file will be inserted and you may use file name completion to select
  2616. the name of the file. The path to the file is inserted relative to the
  2617. directory of the current Org file, if the linked file is in the current
  2618. directory or in a sub-directory of it, or if the path is written relative
  2619. to the current directory using @samp{../}. Otherwise an absolute path
  2620. is used, if possible with @samp{~/} for your home directory. You can
  2621. force an absolute path with two @kbd{C-u} prefixes.
  2622. @c
  2623. @item C-c C-l @r{(with cursor on existing link)}
  2624. When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
  2625. link and description parts of the link.
  2626. @c
  2627. @cindex following links
  2628. @kindex C-c C-o
  2629. @kindex RET
  2630. @item C-c C-o @r{or} @key{RET}
  2631. @vindex org-file-apps
  2632. Open link at point. This will launch a web browser for URLs (using
  2633. @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
  2634. the corresponding links, and execute the command in a shell link. When the
  2635. cursor is on an internal link, this commands runs the corresponding search.
  2636. When the cursor is on a TAG list in a headline, it creates the corresponding
  2637. TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
  2638. date. Furthermore, it will visit text and remote files in @samp{file:} links
  2639. with Emacs and select a suitable application for local non-text files.
  2640. Classification of files is based on file extension only. See option
  2641. @code{org-file-apps}. If you want to override the default application and
  2642. visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
  2643. opening in Emacs, use a @kbd{C-u C-u} prefix.
  2644. @c
  2645. @kindex mouse-2
  2646. @kindex mouse-1
  2647. @item mouse-2
  2648. @itemx mouse-1
  2649. On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
  2650. would. Under Emacs 22, @kbd{mouse-1} will also follow a link.
  2651. @c
  2652. @kindex mouse-3
  2653. @item mouse-3
  2654. @vindex org-display-internal-link-with-indirect-buffer
  2655. Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
  2656. internal links to be displayed in another window@footnote{See the
  2657. variable @code{org-display-internal-link-with-indirect-buffer}}.
  2658. @c
  2659. @cindex mark ring
  2660. @kindex C-c %
  2661. @item C-c %
  2662. Push the current position onto the mark ring, to be able to return
  2663. easily. Commands following an internal link do this automatically.
  2664. @c
  2665. @cindex links, returning to
  2666. @kindex C-c &
  2667. @item C-c &
  2668. Jump back to a recorded position. A position is recorded by the
  2669. commands following internal links, and by @kbd{C-c %}. Using this
  2670. command several times in direct succession moves through a ring of
  2671. previously recorded positions.
  2672. @c
  2673. @kindex C-c C-x C-n
  2674. @kindex C-c C-x C-p
  2675. @cindex links, finding next/previous
  2676. @item C-c C-x C-n
  2677. @itemx C-c C-x C-p
  2678. Move forward/backward to the next link in the buffer. At the limit of
  2679. the buffer, the search fails once, and then wraps around. The key
  2680. bindings for this are really too long, you might want to bind this also
  2681. to @kbd{C-n} and @kbd{C-p}
  2682. @lisp
  2683. (add-hook 'org-load-hook
  2684. (lambda ()
  2685. (define-key 'org-mode-map "\C-n" 'org-next-link)
  2686. (define-key 'org-mode-map "\C-p" 'org-previous-link)))
  2687. @end lisp
  2688. @end table
  2689. @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
  2690. @section Using links outside Org
  2691. You can insert and follow links that have Org syntax not only in
  2692. Org, but in any Emacs buffer. For this, you should create two
  2693. global commands, like this (please select suitable global keys
  2694. yourself):
  2695. @lisp
  2696. (global-set-key "\C-c L" 'org-insert-link-global)
  2697. (global-set-key "\C-c o" 'org-open-at-point-global)
  2698. @end lisp
  2699. @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
  2700. @section Link abbreviations
  2701. @cindex link abbreviations
  2702. @cindex abbreviation, links
  2703. Long URLs can be cumbersome to type, and often many similar links are
  2704. needed in a document. For this you can use link abbreviations. An
  2705. abbreviated link looks like this
  2706. @example
  2707. [[linkword:tag][description]]
  2708. @end example
  2709. @noindent
  2710. @vindex org-link-abbrev-alist
  2711. where the tag is optional. The @i{linkword} must be a word; letter, numbers,
  2712. @samp{-}, and @samp{_} are allowed here. Abbreviations are resolved
  2713. according to the information in the variable @code{org-link-abbrev-alist}
  2714. that relates the linkwords to replacement text. Here is an example:
  2715. @lisp
  2716. @group
  2717. (setq org-link-abbrev-alist
  2718. '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
  2719. ("google" . "http://www.google.com/search?q=")
  2720. ("ads" . "http://adsabs.harvard.edu/cgi-bin/
  2721. nph-abs_connect?author=%s&db_key=AST")))
  2722. @end group
  2723. @end lisp
  2724. If the replacement text contains the string @samp{%s}, it will be
  2725. replaced with the tag. Otherwise the tag will be appended to the string
  2726. in order to create the link. You may also specify a function that will
  2727. be called with the tag as the only argument to create the link.
  2728. With the above setting, you could link to a specific bug with
  2729. @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
  2730. @code{[[google:OrgMode]]} and find out what the Org author is
  2731. doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
  2732. If you need special abbreviations just for a single Org buffer, you
  2733. can define them in the file with
  2734. @cindex #+LINK
  2735. @example
  2736. #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
  2737. #+LINK: google http://www.google.com/search?q=%s
  2738. @end example
  2739. @noindent
  2740. In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
  2741. complete link abbreviations. You may also define a function
  2742. @code{org-PREFIX-complete-link} that implements special (@eg completion)
  2743. support for inserting such a link with @kbd{C-c C-l}. Such a function should
  2744. not accept any arguments, and return the full link with prefix.
  2745. @node Search options, Custom searches, Link abbreviations, Hyperlinks
  2746. @section Search options in file links
  2747. @cindex search option in file links
  2748. @cindex file links, searching
  2749. File links can contain additional information to make Emacs jump to a
  2750. particular location in the file when following a link. This can be a
  2751. line number or a search option after a double@footnote{For backward
  2752. compatibility, line numbers can also follow a single colon.} colon. For
  2753. example, when the command @kbd{C-c l} creates a link (@pxref{Handling
  2754. links}) to a file, it encodes the words in the current line as a search
  2755. string that can be used to find this line back later when following the
  2756. link with @kbd{C-c C-o}.
  2757. Here is the syntax of the different ways to attach a search to a file
  2758. link, together with an explanation:
  2759. @example
  2760. [[file:~/code/main.c::255]]
  2761. [[file:~/xx.org::My Target]]
  2762. [[file:~/xx.org::*My Target]]
  2763. [[file:~/xx.org::/regexp/]]
  2764. @end example
  2765. @table @code
  2766. @item 255
  2767. Jump to line 255.
  2768. @item My Target
  2769. Search for a link target @samp{<<My Target>>}, or do a text search for
  2770. @samp{my target}, similar to the search in internal links, see
  2771. @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
  2772. link will become an HTML reference to the corresponding named anchor in
  2773. the linked file.
  2774. @item *My Target
  2775. In an Org file, restrict search to headlines.
  2776. @item /regexp/
  2777. Do a regular expression search for @code{regexp}. This uses the Emacs
  2778. command @code{occur} to list all matches in a separate window. If the
  2779. target file is in Org mode, @code{org-occur} is used to create a
  2780. sparse tree with the matches.
  2781. @c If the target file is a directory,
  2782. @c @code{grep} will be used to search all files in the directory.
  2783. @end table
  2784. As a degenerate case, a file link with an empty file name can be used
  2785. to search the current file. For example, @code{[[file:::find me]]} does
  2786. a search for @samp{find me} in the current file, just as
  2787. @samp{[[find me]]} would.
  2788. @node Custom searches, , Search options, Hyperlinks
  2789. @section Custom Searches
  2790. @cindex custom search strings
  2791. @cindex search strings, custom
  2792. The default mechanism for creating search strings and for doing the
  2793. actual search related to a file link may not work correctly in all
  2794. cases. For example, Bib@TeX{} database files have many entries like
  2795. @samp{year="1993"} which would not result in good search strings,
  2796. because the only unique identification for a Bib@TeX{} entry is the
  2797. citation key.
  2798. @vindex org-create-file-search-functions
  2799. @vindex org-execute-file-search-functions
  2800. If you come across such a problem, you can write custom functions to set
  2801. the right search string for a particular file type, and to do the search
  2802. for the string in the file. Using @code{add-hook}, these functions need
  2803. to be added to the hook variables
  2804. @code{org-create-file-search-functions} and
  2805. @code{org-execute-file-search-functions}. See the docstring for these
  2806. variables for more information. Org actually uses this mechanism
  2807. for Bib@TeX{} database files, and you can use the corresponding code as
  2808. an implementation example. See the file @file{org-bibtex.el}.
  2809. @node TODO Items, Tags, Hyperlinks, Top
  2810. @chapter TODO Items
  2811. @cindex TODO items
  2812. Org mode does not maintain TODO lists as separate documents@footnote{Of
  2813. course, you can make a document that contains only long lists of TODO items,
  2814. but this is not required.}. Instead, TODO items are an integral part of the
  2815. notes file, because TODO items usually come up while taking notes! With Org
  2816. mode, simply mark any entry in a tree as being a TODO item. In this way,
  2817. information is not duplicated, and the entire context from which the TODO
  2818. item emerged is always present.
  2819. Of course, this technique for managing TODO items scatters them
  2820. throughout your notes file. Org mode compensates for this by providing
  2821. methods to give you an overview of all the things that you have to do.
  2822. @menu
  2823. * TODO basics:: Marking and displaying TODO entries
  2824. * TODO extensions:: Workflow and assignments
  2825. * Progress logging:: Dates and notes for progress
  2826. * Priorities:: Some things are more important than others
  2827. * Breaking down tasks:: Splitting a task into manageable pieces
  2828. * Checkboxes:: Tick-off lists
  2829. @end menu
  2830. @node TODO basics, TODO extensions, TODO Items, TODO Items
  2831. @section Basic TODO functionality
  2832. Any headline becomes a TODO item when it starts with the word
  2833. @samp{TODO}, for example:
  2834. @example
  2835. *** TODO Write letter to Sam Fortune
  2836. @end example
  2837. @noindent
  2838. The most important commands to work with TODO entries are:
  2839. @table @kbd
  2840. @kindex C-c C-t
  2841. @cindex cycling, of TODO states
  2842. @item C-c C-t
  2843. Rotate the TODO state of the current item among
  2844. @example
  2845. ,-> (unmarked) -> TODO -> DONE --.
  2846. '--------------------------------'
  2847. @end example
  2848. The same rotation can also be done ``remotely'' from the timeline and
  2849. agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
  2850. @kindex C-u C-c C-t
  2851. @item C-u C-c C-t
  2852. Select a specific keyword using completion or (if it has been set up)
  2853. the fast selection interface. For the latter, you need to assign keys
  2854. to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
  2855. more information.
  2856. @kindex S-@key{right}
  2857. @kindex S-@key{left}
  2858. @vindex org-treat-S-cursor-todo-selection-as-state-change
  2859. @item S-@key{right}
  2860. @itemx S-@key{left}
  2861. Select the following/preceding TODO state, similar to cycling. Useful
  2862. mostly if more than two TODO states are possible (@pxref{TODO
  2863. extensions}). See also @ref{Conflicts}, for a discussion of the interaction
  2864. with @code{shift-selection-mode}. See also the variable
  2865. @code{org-treat-S-cursor-todo-selection-as-state-change}.
  2866. @kindex C-c C-v
  2867. @kindex C-c / t
  2868. @cindex sparse tree, for TODO
  2869. @item C-c C-v
  2870. @itemx C-c / t
  2871. @vindex org-todo-keywords
  2872. View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
  2873. entire buffer, but shows all TODO items and the headings hierarchy above
  2874. them. With a prefix argument, search for a specific TODO. You will be
  2875. prompted for the keyword, and you can also give a list of keywords like
  2876. @code{KWD1|KWD2|...} to list entries that match any one of these keywords.
  2877. With numeric prefix argument N, show the tree for the Nth keyword in the
  2878. variable @code{org-todo-keywords}. With two prefix arguments, find all TODO
  2879. and DONE entries.
  2880. @kindex C-c a t
  2881. @item C-c a t
  2882. Show the global TODO list. Collects the TODO items from all agenda
  2883. files (@pxref{Agenda Views}) into a single buffer. The new buffer will
  2884. be in @code{agenda-mode}, which provides commands to examine and
  2885. manipulate the TODO entries from the new buffer (@pxref{Agenda
  2886. commands}). @xref{Global TODO list}, for more information.
  2887. @kindex S-M-@key{RET}
  2888. @item S-M-@key{RET}
  2889. Insert a new TODO entry below the current one.
  2890. @end table
  2891. @noindent
  2892. @vindex org-todo-state-tags-triggers
  2893. Changing a TODO state can also trigger tag changes. See the docstring of the
  2894. option @code{org-todo-state-tags-triggers} for details.
  2895. @node TODO extensions, Progress logging, TODO basics, TODO Items
  2896. @section Extended use of TODO keywords
  2897. @cindex extended TODO keywords
  2898. @vindex org-todo-keywords
  2899. By default, marked TODO entries have one of only two states: TODO and
  2900. DONE. Org mode allows you to classify TODO items in more complex ways
  2901. with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
  2902. special setup, the TODO keyword system can work differently in different
  2903. files.
  2904. Note that @i{tags} are another way to classify headlines in general and
  2905. TODO items in particular (@pxref{Tags}).
  2906. @menu
  2907. * Workflow states:: From TODO to DONE in steps
  2908. * TODO types:: I do this, Fred does the rest
  2909. * Multiple sets in one file:: Mixing it all, and still finding your way
  2910. * Fast access to TODO states:: Single letter selection of a state
  2911. * Per-file keywords:: Different files, different requirements
  2912. * Faces for TODO keywords:: Highlighting states
  2913. * TODO dependencies:: When one task needs to wait for others
  2914. @end menu
  2915. @node Workflow states, TODO types, TODO extensions, TODO extensions
  2916. @subsection TODO keywords as workflow states
  2917. @cindex TODO workflow
  2918. @cindex workflow states as TODO keywords
  2919. You can use TODO keywords to indicate different @emph{sequential} states
  2920. in the process of working on an item, for example@footnote{Changing
  2921. this variable only becomes effective after restarting Org mode in a
  2922. buffer.}:
  2923. @lisp
  2924. (setq org-todo-keywords
  2925. '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
  2926. @end lisp
  2927. The vertical bar separates the TODO keywords (states that @emph{need
  2928. action}) from the DONE states (which need @emph{no further action}). If
  2929. you don't provide the separator bar, the last state is used as the DONE
  2930. state.
  2931. @cindex completion, of TODO keywords
  2932. With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
  2933. to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
  2934. also use a numeric prefix argument to quickly select a specific state. For
  2935. example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
  2936. Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
  2937. define many keywords, you can use in-buffer completion
  2938. (@pxref{Completion}) or even a special one-key selection scheme
  2939. (@pxref{Fast access to TODO states}) to insert these words into the
  2940. buffer. Changing a TODO state can be logged with a timestamp, see
  2941. @ref{Tracking TODO state changes}, for more information.
  2942. @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
  2943. @subsection TODO keywords as types
  2944. @cindex TODO types
  2945. @cindex names as TODO keywords
  2946. @cindex types as TODO keywords
  2947. The second possibility is to use TODO keywords to indicate different
  2948. @emph{types} of action items. For example, you might want to indicate
  2949. that items are for ``work'' or ``home''. Or, when you work with several
  2950. people on a single project, you might want to assign action items
  2951. directly to persons, by using their names as TODO keywords. This would
  2952. be set up like this:
  2953. @lisp
  2954. (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
  2955. @end lisp
  2956. In this case, different keywords do not indicate a sequence, but rather
  2957. different types. So the normal work flow would be to assign a task to a
  2958. person, and later to mark it DONE. Org mode supports this style by adapting
  2959. the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
  2960. @kbd{t} command in the timeline and agenda buffers.}. When used several
  2961. times in succession, it will still cycle through all names, in order to first
  2962. select the right type for a task. But when you return to the item after some
  2963. time and execute @kbd{C-c C-t} again, it will switch from any name directly
  2964. to DONE. Use prefix arguments or completion to quickly select a specific
  2965. name. You can also review the items of a specific TODO type in a sparse tree
  2966. by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things
  2967. Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items
  2968. from all agenda files into a single buffer, you would use the numeric prefix
  2969. argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
  2970. @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
  2971. @subsection Multiple keyword sets in one file
  2972. @cindex TODO keyword sets
  2973. Sometimes you may want to use different sets of TODO keywords in
  2974. parallel. For example, you may want to have the basic
  2975. @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
  2976. separate state indicating that an item has been canceled (so it is not
  2977. DONE, but also does not require action). Your setup would then look
  2978. like this:
  2979. @lisp
  2980. (setq org-todo-keywords
  2981. '((sequence "TODO" "|" "DONE")
  2982. (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
  2983. (sequence "|" "CANCELED")))
  2984. @end lisp
  2985. The keywords should all be different, this helps Org mode to keep track
  2986. of which subsequence should be used for a given entry. In this setup,
  2987. @kbd{C-c C-t} only operates within a subsequence, so it switches from
  2988. @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
  2989. (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
  2990. select the correct sequence. Besides the obvious ways like typing a
  2991. keyword or using completion, you may also apply the following commands:
  2992. @table @kbd
  2993. @kindex C-S-@key{right}
  2994. @kindex C-S-@key{left}
  2995. @kindex C-u C-u C-c C-t
  2996. @item C-u C-u C-c C-t
  2997. @itemx C-S-@key{right}
  2998. @itemx C-S-@key{left}
  2999. These keys jump from one TODO subset to the next. In the above example,
  3000. @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
  3001. @code{DONE} to @code{REPORT}, and any of the words in the second row to
  3002. @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
  3003. @code{shift-selection-mode} (@pxref{Conflicts}).
  3004. @kindex S-@key{right}
  3005. @kindex S-@key{left}
  3006. @item S-@key{right}
  3007. @itemx S-@key{left}
  3008. @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
  3009. keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
  3010. from @code{DONE} to @code{REPORT} in the example above. See also
  3011. @ref{Conflicts}, for a discussion of the interaction with
  3012. @code{shift-selection-mode}.
  3013. @end table
  3014. @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
  3015. @subsection Fast access to TODO states
  3016. If you would like to quickly change an entry to an arbitrary TODO state
  3017. instead of cycling through the states, you can set up keys for
  3018. single-letter access to the states. This is done by adding the section
  3019. key after each keyword, in parentheses. For example:
  3020. @lisp
  3021. (setq org-todo-keywords
  3022. '((sequence "TODO(t)" "|" "DONE(d)")
  3023. (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
  3024. (sequence "|" "CANCELED(c)")))
  3025. @end lisp
  3026. @vindex org-fast-tag-selection-include-todo
  3027. If you then press @code{C-c C-t} followed by the selection key, the entry
  3028. will be switched to this state. @key{SPC} can be used to remove any TODO
  3029. keyword from an entry.@footnote{Check also the variable
  3030. @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
  3031. state through the tags interface (@pxref{Setting tags}), in case you like to
  3032. mingle the two concepts. Note that this means you need to come up with
  3033. unique keys across both sets of keywords.}
  3034. @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
  3035. @subsection Setting up keywords for individual files
  3036. @cindex keyword options
  3037. @cindex per-file keywords
  3038. @cindex #+TODO
  3039. @cindex #+TYP_TODO
  3040. @cindex #+SEQ_TODO
  3041. It can be very useful to use different aspects of the TODO mechanism in
  3042. different files. For file-local settings, you need to add special lines
  3043. to the file which set the keywords and interpretation for that file
  3044. only. For example, to set one of the two examples discussed above, you
  3045. need one of the following lines, starting in column zero anywhere in the
  3046. file:
  3047. @example
  3048. #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
  3049. @end example
  3050. @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
  3051. interpretation, but it means the same as @code{#+TODO}), or
  3052. @example
  3053. #+TYP_TODO: Fred Sara Lucy Mike | DONE
  3054. @end example
  3055. A setup for using several sets in parallel would be:
  3056. @example
  3057. #+TODO: TODO | DONE
  3058. #+TODO: REPORT BUG KNOWNCAUSE | FIXED
  3059. #+TODO: | CANCELED
  3060. @end example
  3061. @cindex completion, of option keywords
  3062. @kindex M-@key{TAB}
  3063. @noindent To make sure you are using the correct keyword, type
  3064. @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
  3065. @cindex DONE, final TODO keyword
  3066. Remember that the keywords after the vertical bar (or the last keyword
  3067. if no bar is there) must always mean that the item is DONE (although you
  3068. may use a different word). After changing one of these lines, use
  3069. @kbd{C-c C-c} with the cursor still in the line to make the changes
  3070. known to Org mode@footnote{Org mode parses these lines only when
  3071. Org mode is activated after visiting a file. @kbd{C-c C-c} with the
  3072. cursor in a line starting with @samp{#+} is simply restarting Org mode
  3073. for the current buffer.}.
  3074. @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
  3075. @subsection Faces for TODO keywords
  3076. @cindex faces, for TODO keywords
  3077. @vindex org-todo @r{(face)}
  3078. @vindex org-done @r{(face)}
  3079. @vindex org-todo-keyword-faces
  3080. Org mode highlights TODO keywords with special faces: @code{org-todo}
  3081. for keywords indicating that an item still has to be acted upon, and
  3082. @code{org-done} for keywords indicating that an item is finished. If
  3083. you are using more than 2 different states, you might want to use
  3084. special faces for some of them. This can be done using the variable
  3085. @code{org-todo-keyword-faces}. For example:
  3086. @lisp
  3087. @group
  3088. (setq org-todo-keyword-faces
  3089. '(("TODO" . org-warning)
  3090. ("DEFERRED" . shadow)
  3091. ("CANCELED" . (:foreground "blue" :weight bold))))
  3092. @end group
  3093. @end lisp
  3094. While using a list with face properties as shown for CANCELED
  3095. @emph{should} work, this does not aways seem to be the case. If
  3096. necessary, define a special face and use that.
  3097. @node TODO dependencies, , Faces for TODO keywords, TODO extensions
  3098. @subsection TODO dependencies
  3099. @cindex TODO dependencies
  3100. @cindex dependencies, of TODO states
  3101. @vindex org-enforce-todo-dependencies
  3102. @cindex property, ORDERED
  3103. The structure of Org files (hierarchy and lists) makes it easy to define TODO
  3104. dependencies. Usually, a parent TODO task should not be marked DONE until
  3105. all subtasks (defined as children tasks) are marked as DONE. And sometimes
  3106. there is a logical sequence to a number of (sub)tasks, so that one task
  3107. cannot be acted upon before all siblings above it are done. If you customize
  3108. the variable @code{org-enforce-todo-dependencies}, Org will block entries
  3109. from changing state to DONE while they have children that are not DONE.
  3110. Furthermore, if an entry has a property @code{ORDERED}, each of its children
  3111. will be blocked until all earlier siblings are marked DONE. Here is an
  3112. example:
  3113. @example
  3114. * TODO Blocked until (two) is done
  3115. ** DONE one
  3116. ** TODO two
  3117. * Parent
  3118. :PROPERTIES:
  3119. :ORDERED: t
  3120. :END:
  3121. ** TODO a
  3122. ** TODO b, needs to wait for (a)
  3123. ** TODO c, needs to wait for (a) and (b)
  3124. @end example
  3125. @table @kbd
  3126. @kindex C-c C-x o
  3127. @item C-c C-x o
  3128. @vindex org-track-ordered-property-with-tag
  3129. @cindex property, ORDERED
  3130. Toggle the @code{ORDERED} property of the current entry. A property is used
  3131. for this behavior because this should be local to the current entry, not
  3132. inherited like a tag. However, if you would like to @i{track} the value of
  3133. this property with a tag for better visibility, customize the variable
  3134. @code{org-track-ordered-property-with-tag}.
  3135. @kindex C-u C-u C-u C-c C-t
  3136. @item C-u C-u C-u C-c C-t
  3137. Change TODO state, circumventing any state blocking.
  3138. @end table
  3139. @vindex org-agenda-dim-blocked-tasks
  3140. If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
  3141. that cannot be closed because of such dependencies will be shown in a dimmed
  3142. font or even made invisible in agenda views (@pxref{Agenda Views}).
  3143. @cindex checkboxes and TODO dependencies
  3144. @vindex org-enforce-todo-dependencies
  3145. You can also block changes of TODO states by looking at checkboxes
  3146. (@pxref{Checkboxes}). If you set the variable
  3147. @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
  3148. checkboxes will be blocked from switching to DONE.
  3149. If you need more complex dependency structures, for example dependencies
  3150. between entries in different trees or files, check out the contributed
  3151. module @file{org-depend.el}.
  3152. @page
  3153. @node Progress logging, Priorities, TODO extensions, TODO Items
  3154. @section Progress logging
  3155. @cindex progress logging
  3156. @cindex logging, of progress
  3157. Org mode can automatically record a timestamp and possibly a note when
  3158. you mark a TODO item as DONE, or even each time you change the state of
  3159. a TODO item. This system is highly configurable, settings can be on a
  3160. per-keyword basis and can be localized to a file or even a subtree. For
  3161. information on how to clock working time for a task, see @ref{Clocking
  3162. work time}.
  3163. @menu
  3164. * Closing items:: When was this entry marked DONE?
  3165. * Tracking TODO state changes:: When did the status change?
  3166. @end menu
  3167. @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
  3168. @subsection Closing items
  3169. The most basic logging is to keep track of @emph{when} a certain TODO
  3170. item was finished. This is achieved with@footnote{The corresponding
  3171. in-buffer setting is: @code{#+STARTUP: logdone}}.
  3172. @lisp
  3173. (setq org-log-done 'time)
  3174. @end lisp
  3175. @noindent
  3176. Then each time you turn an entry from a TODO (not-done) state into any
  3177. of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
  3178. just after the headline. If you turn the entry back into a TODO item
  3179. through further state cycling, that line will be removed again. If you
  3180. want to record a note along with the timestamp, use@footnote{The
  3181. corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
  3182. @lisp
  3183. (setq org-log-done 'note)
  3184. @end lisp
  3185. @noindent
  3186. You will then be prompted for a note, and that note will be stored below
  3187. the entry with a @samp{Closing Note} heading.
  3188. In the timeline (@pxref{Timeline}) and in the agenda
  3189. (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
  3190. display the TODO items with a @samp{CLOSED} timestamp on each day,
  3191. giving you an overview of what has been done.
  3192. @node Tracking TODO state changes, , Closing items, Progress logging
  3193. @subsection Tracking TODO state changes
  3194. @cindex drawer, for state change recording
  3195. @vindex org-log-states-order-reversed
  3196. @vindex org-log-into-drawer
  3197. @cindex property, LOG_INTO_DRAWER
  3198. When TODO keywords are used as workflow states (@pxref{Workflow states}), you
  3199. might want to keep track of when a state change occurred and maybe take a
  3200. note about this change. You can either record just a timestamp, or a
  3201. time-stamped note for a change. These records will be inserted after the
  3202. headline as an itemized list, newest first@footnote{See the variable
  3203. @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
  3204. want to get the notes out of the way into a drawer (@pxref{Drawers}).
  3205. Customize the variable @code{org-log-into-drawer} to get this
  3206. behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
  3207. also overrule the setting of this variable for a subtree by setting a
  3208. @code{LOG_INTO_DRAWER} property.
  3209. Since it is normally too much to record a note for every state, Org mode
  3210. expects configuration on a per-keyword basis for this. This is achieved by
  3211. adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
  3212. in parentheses after each keyword. For example, with the setting
  3213. @lisp
  3214. (setq org-todo-keywords
  3215. '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
  3216. @end lisp
  3217. @noindent
  3218. @vindex org-log-done
  3219. you not only define global TODO keywords and fast access keys, but also
  3220. request that a time is recorded when the entry is set to
  3221. DONE@footnote{It is possible that Org mode will record two timestamps
  3222. when you are using both @code{org-log-done} and state change logging.
  3223. However, it will never prompt for two notes---if you have configured
  3224. both, the state change recording note will take precedence and cancel
  3225. the @samp{Closing Note}.}, and that a note is recorded when switching to
  3226. WAIT or CANCELED. The setting for WAIT is even more special: The
  3227. @samp{!} after the slash means that in addition to the note taken when
  3228. entering the state, a timestamp should be recorded when @i{leaving} the
  3229. WAIT state, if and only if the @i{target} state does not configure
  3230. logging for entering it. So it has no effect when switching from WAIT
  3231. to DONE, because DONE is configured to record a timestamp only. But
  3232. when switching from WAIT back to TODO, the @samp{/!} in the WAIT
  3233. setting now triggers a timestamp even though TODO has no logging
  3234. configured.
  3235. You can use the exact same syntax for setting logging preferences local
  3236. to a buffer:
  3237. @example
  3238. #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
  3239. @end example
  3240. @cindex property, LOGGING
  3241. In order to define logging settings that are local to a subtree or a
  3242. single item, define a LOGGING property in this entry. Any non-empty
  3243. LOGGING property resets all logging settings to nil. You may then turn
  3244. on logging for this specific tree using STARTUP keywords like
  3245. @code{lognotedone} or @code{logrepeat}, as well as adding state specific
  3246. settings like @code{TODO(!)}. For example
  3247. @example
  3248. * TODO Log each state with only a time
  3249. :PROPERTIES:
  3250. :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
  3251. :END:
  3252. * TODO Only log when switching to WAIT, and when repeating
  3253. :PROPERTIES:
  3254. :LOGGING: WAIT(@@) logrepeat
  3255. :END:
  3256. * TODO No logging at all
  3257. :PROPERTIES:
  3258. :LOGGING: nil
  3259. :END:
  3260. @end example
  3261. @node Priorities, Breaking down tasks, Progress logging, TODO Items
  3262. @section Priorities
  3263. @cindex priorities
  3264. If you use Org mode extensively, you may end up enough TODO items that
  3265. it starts to make sense to prioritize them. Prioritizing can be done by
  3266. placing a @emph{priority cookie} into the headline of a TODO item, like
  3267. this
  3268. @example
  3269. *** TODO [#A] Write letter to Sam Fortune
  3270. @end example
  3271. @noindent
  3272. By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
  3273. @samp{C}. @samp{A} is the highest priority. An entry without a cookie
  3274. is treated as priority @samp{B}. Priorities make a difference only in
  3275. the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
  3276. no inherent meaning to Org mode.
  3277. Priorities can be attached to any outline tree entries; they do not need
  3278. to be TODO items.
  3279. @table @kbd
  3280. @kindex @kbd{C-c ,}
  3281. @item @kbd{C-c ,}
  3282. Set the priority of the current headline. The command prompts for a
  3283. priority character @samp{A}, @samp{B} or @samp{C}. When you press
  3284. @key{SPC} instead, the priority cookie is removed from the headline.
  3285. The priorities can also be changed ``remotely'' from the timeline and
  3286. agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
  3287. @c
  3288. @kindex S-@key{up}
  3289. @kindex S-@key{down}
  3290. @item S-@key{up}
  3291. @itemx S-@key{down}
  3292. @vindex org-priority-start-cycle-with-default
  3293. Increase/decrease priority of current headline@footnote{See also the option
  3294. @code{org-priority-start-cycle-with-default}.}. Note that these keys are
  3295. also used to modify timestamps (@pxref{Creating timestamps}). See also
  3296. @ref{Conflicts}, for a discussion of the interaction with
  3297. @code{shift-selection-mode}.
  3298. @end table
  3299. @vindex org-highest-priority
  3300. @vindex org-lowest-priority
  3301. @vindex org-default-priority
  3302. You can change the range of allowed priorities by setting the variables
  3303. @code{org-highest-priority}, @code{org-lowest-priority}, and
  3304. @code{org-default-priority}. For an individual buffer, you may set
  3305. these values (highest, lowest, default) like this (please make sure that
  3306. the highest priority is earlier in the alphabet than the lowest
  3307. priority):
  3308. @cindex #+PRIORITIES
  3309. @example
  3310. #+PRIORITIES: A C B
  3311. @end example
  3312. @node Breaking down tasks, Checkboxes, Priorities, TODO Items
  3313. @section Breaking tasks down into subtasks
  3314. @cindex tasks, breaking down
  3315. @vindex org-agenda-todo-list-sublevels
  3316. It is often advisable to break down large tasks into smaller, manageable
  3317. subtasks. You can do this by creating an outline tree below a TODO item,
  3318. with detailed subtasks on the tree@footnote{To keep subtasks out of the
  3319. global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
  3320. the overview over the fraction of subtasks that are already completed, insert
  3321. either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
  3322. be updates each time the todo status of a child changes. For example:
  3323. @example
  3324. * Organize Party [33%]
  3325. ** TODO Call people [1/2]
  3326. *** TODO Peter
  3327. *** DONE Sarah
  3328. ** TODO Buy food
  3329. ** DONE Talk to neighbor
  3330. @end example
  3331. @cindex property, COOKIE_DATA
  3332. If a heading has both checkboxes and TODO children below it, the meaning of
  3333. the statistics cookie become ambiguous. Set the property
  3334. @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
  3335. this issue.
  3336. If you would like a TODO entry to automatically change to DONE
  3337. when all children are done, you can use the following setup:
  3338. @example
  3339. (defun org-summary-todo (n-done n-not-done)
  3340. "Switch entry to DONE when all subentries are done, to TODO otherwise."
  3341. (let (org-log-done org-log-states) ; turn off logging
  3342. (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
  3343. (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
  3344. @end example
  3345. Another possibility is the use of checkboxes to identify (a hierarchy of) a
  3346. large number of subtasks (@pxref{Checkboxes}).
  3347. @node Checkboxes, , Breaking down tasks, TODO Items
  3348. @section Checkboxes
  3349. @cindex checkboxes
  3350. Every item in a plain list (@pxref{Plain lists}) can be made into a
  3351. checkbox by starting it with the string @samp{[ ]}. This feature is
  3352. similar to TODO items (@pxref{TODO Items}), but is more lightweight.
  3353. Checkboxes are not included into the global TODO list, so they are often
  3354. great to split a task into a number of simple steps. Or you can use
  3355. them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
  3356. use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
  3357. Here is an example of a checkbox list.
  3358. @example
  3359. * TODO Organize party [2/4]
  3360. - [-] call people [1/3]
  3361. - [ ] Peter
  3362. - [X] Sarah
  3363. - [ ] Sam
  3364. - [X] order food
  3365. - [ ] think about what music to play
  3366. - [X] talk to the neighbors
  3367. @end example
  3368. Checkboxes work hierarchically, so if a checkbox item has children that
  3369. are checkboxes, toggling one of the children checkboxes will make the
  3370. parent checkbox reflect if none, some, or all of the children are
  3371. checked.
  3372. @cindex statistics, for checkboxes
  3373. @cindex checkbox statistics
  3374. @cindex property, COOKIE_DATA
  3375. The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
  3376. indicating how many checkboxes present in this entry have been checked off,
  3377. and the total number of checkboxes present. This can give you an idea on
  3378. how many checkboxes remain, even without opening a folded entry. The cookies
  3379. can be placed into a headline or into (the first line of) a plain list item.
  3380. Each cookie covers checkboxes of direct children structurally below the
  3381. headline/item on which the cookie appears@footnote{Set the variable
  3382. @code{org-recursive-checkbox-statistics} if you want such cookes to represent
  3383. the all checkboxes below the cookie, not just the direct children.}. You
  3384. have to insert the cookie yourself by typing either @samp{[/]} or @samp{[%]}.
  3385. With @samp{[/]} you get an @samp{n out of m} result, as in the examples
  3386. above. With @samp{[%]} you get information about the percentage of
  3387. checkboxes checked (in the above example, this would be @samp{[50%]} and
  3388. @samp{[33%]}, respectively). In a headline, a cookie can count either
  3389. checkboxes below the heading or TODO states of children, and it will display
  3390. whatever was changed last. Set the property @code{COOKIE_DATA} to either
  3391. @samp{checkbox} or @samp{todo} to resolve this issue.
  3392. @cindex blocking, of checkboxes
  3393. @cindex checkbox blocking
  3394. @cindex property, ORDERED
  3395. If the current outline node has an @code{ORDERED} property, checkboxes must
  3396. be checked off in sequence, and an error will be thrown if you try to check
  3397. off a box while there are unchecked boxes bove it.
  3398. @noindent The following commands work with checkboxes:
  3399. @table @kbd
  3400. @kindex C-c C-c
  3401. @item C-c C-c
  3402. Toggle checkbox status or (with prefix arg) checkbox presence at point. With
  3403. double prefix argument, set it to @samp{[-]}, which is considered to be an
  3404. intermediate state.
  3405. @kindex C-c C-x C-b
  3406. @item C-c C-x C-b
  3407. Toggle checkbox status or (with prefix arg) checkbox presence at point. With
  3408. double prefix argument, set it to @samp{[-]}, which is considered to be an
  3409. intermediate state.
  3410. @itemize @minus
  3411. @item
  3412. If there is an active region, toggle the first checkbox in the region
  3413. and set all remaining boxes to the same status as the first. With a prefix
  3414. arg, add or remove the checkbox for all items in the region.
  3415. @item
  3416. If the cursor is in a headline, toggle checkboxes in the region between
  3417. this headline and the next (so @emph{not} the entire subtree).
  3418. @item
  3419. If there is no active region, just toggle the checkbox at point.
  3420. @end itemize
  3421. @kindex M-S-@key{RET}
  3422. @item M-S-@key{RET}
  3423. Insert a new item with a checkbox.
  3424. This works only if the cursor is already in a plain list item
  3425. (@pxref{Plain lists}).
  3426. @kindex C-c C-x o
  3427. @item C-c C-x o
  3428. @vindex org-track-ordered-property-with-tag
  3429. @cindex property, ORDERED
  3430. Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
  3431. be checked off in sequence. A property is used for this behavior because
  3432. this should be local to the current entry, not inherited like a tag.
  3433. However, if you would like to @i{track} the value of this property with a tag
  3434. for better visibility, customize the variable
  3435. @code{org-track-ordered-property-with-tag}.
  3436. @kindex C-c #
  3437. @item C-c #
  3438. Update the checkbox statistics in the current outline entry. When
  3439. called with a @kbd{C-u} prefix, update the entire file. Checkbox
  3440. statistic cookies are updated automatically if you toggle checkboxes
  3441. with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you
  3442. delete boxes or add/change them by hand, use this command to get things
  3443. back into sync. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
  3444. @end table
  3445. @node Tags, Properties and Columns, TODO Items, Top
  3446. @chapter Tags
  3447. @cindex tags
  3448. @cindex headline tagging
  3449. @cindex matching, tags
  3450. @cindex sparse tree, tag based
  3451. An excellent way to implement labels and contexts for cross-correlating
  3452. information is to assign @i{tags} to headlines. Org mode has extensive
  3453. support for tags.
  3454. @vindex org-tag-faces
  3455. Every headline can contain a list of tags; they occur at the end of the
  3456. headline. Tags are normal words containing letters, numbers, @samp{_}, and
  3457. @samp{@@}. Tags must be preceded and followed by a single colon, @eg{},
  3458. @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
  3459. Tags will by default be in bold face with the same color as the headline.
  3460. You may specify special faces for specific tags using the variable
  3461. @code{org-tag-faces}, in much the same way as you can for TODO keywords
  3462. (@pxref{Faces for TODO keywords}).
  3463. @menu
  3464. * Tag inheritance:: Tags use the tree structure of the outline
  3465. * Setting tags:: How to assign tags to a headline
  3466. * Tag searches:: Searching for combinations of tags
  3467. @end menu
  3468. @node Tag inheritance, Setting tags, Tags, Tags
  3469. @section Tag inheritance
  3470. @cindex tag inheritance
  3471. @cindex inheritance, of tags
  3472. @cindex sublevels, inclusion into tags match
  3473. @i{Tags} make use of the hierarchical structure of outline trees. If a
  3474. heading has a certain tag, all subheadings will inherit the tag as
  3475. well. For example, in the list
  3476. @example
  3477. * Meeting with the French group :work:
  3478. ** Summary by Frank :boss:notes:
  3479. *** TODO Prepare slides for him :action:
  3480. @end example
  3481. @noindent
  3482. the final heading will have the tags @samp{:work:}, @samp{:boss:},
  3483. @samp{:notes:}, and @samp{:action:} even though the final heading is not
  3484. explicitly marked with those tags. You can also set tags that all entries in
  3485. a file should inherit just as if these tags were defined in a hypothetical
  3486. level zero that surrounds the entire file.
  3487. @cindex #+FILETAGS
  3488. @example
  3489. #+FILETAGS: :Peter:Boss:Secret:
  3490. @end example
  3491. @noindent
  3492. @vindex org-use-tag-inheritance
  3493. @vindex org-tags-exclude-from-inheritance
  3494. To limit tag inheritance to specific tags, or to turn it off entirely, use
  3495. the variables @code{org-use-tag-inheritance} and
  3496. @code{org-tags-exclude-from-inheritance}.
  3497. @vindex org-tags-match-list-sublevels
  3498. When a headline matches during a tags search while tag inheritance is turned
  3499. on, all the sublevels in the same tree will (for a simple match form) match
  3500. as well@footnote{This is only true if the search does not involve more
  3501. complex tests including properties (@pxref{Property searches}).}. The list
  3502. of matches may then become very long. If you only want to see the first tags
  3503. match in a subtree, configure the variable
  3504. @code{org-tags-match-list-sublevels} (not recommended).
  3505. @node Setting tags, Tag searches, Tag inheritance, Tags
  3506. @section Setting tags
  3507. @cindex setting tags
  3508. @cindex tags, setting
  3509. @kindex M-@key{TAB}
  3510. Tags can simply be typed into the buffer at the end of a headline.
  3511. After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
  3512. also a special command for inserting tags:
  3513. @table @kbd
  3514. @kindex C-c C-q
  3515. @item C-c C-q
  3516. @cindex completion, of tags
  3517. @vindex org-tags-column
  3518. Enter new tags for the current headline. Org mode will either offer
  3519. completion or a special single-key interface for setting tags, see
  3520. below. After pressing @key{RET}, the tags will be inserted and aligned
  3521. to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
  3522. tags in the current buffer will be aligned to that column, just to make
  3523. things look nice. TAGS are automatically realigned after promotion,
  3524. demotion, and TODO state changes (@pxref{TODO basics}).
  3525. @kindex C-c C-c
  3526. @item C-c C-c
  3527. When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
  3528. @end table
  3529. @vindex org-tag-alist
  3530. Org will support tag insertion based on a @emph{list of tags}. By
  3531. default this list is constructed dynamically, containing all tags
  3532. currently used in the buffer. You may also globally specify a hard list
  3533. of tags with the variable @code{org-tag-alist}. Finally you can set
  3534. the default tags for a given file with lines like
  3535. @cindex #+TAGS
  3536. @example
  3537. #+TAGS: @@work @@home @@tennisclub
  3538. #+TAGS: laptop car pc sailboat
  3539. @end example
  3540. If you have globally defined your preferred set of tags using the
  3541. variable @code{org-tag-alist}, but would like to use a dynamic tag list
  3542. in a specific file, add an empty TAGS option line to that file:
  3543. @example
  3544. #+TAGS:
  3545. @end example
  3546. @vindex org-tag-persistent-alist
  3547. If you have a preferred set of tags that you would like to use in every file,
  3548. in addition to those defined on a per-file basis by TAGS option lines, then
  3549. you may specify a list of tags with the variable
  3550. @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
  3551. by adding a STARTUP option line to that file:
  3552. @example
  3553. #+STARTUP: noptag
  3554. @end example
  3555. By default Org mode uses the standard minibuffer completion facilities for
  3556. entering tags. However, it also implements another, quicker, tag selection
  3557. method called @emph{fast tag selection}. This allows you to select and
  3558. deselect tags with just a single key press. For this to work well you should
  3559. assign unique letters to most of your commonly used tags. You can do this
  3560. globally by configuring the variable @code{org-tag-alist} in your
  3561. @file{.emacs} file. For example, you may find the need to tag many items in
  3562. different files with @samp{:@@home:}. In this case you can set something
  3563. like:
  3564. @lisp
  3565. (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
  3566. @end lisp
  3567. @noindent If the tag is only relevant to the file you are working on, then you
  3568. can instead set the TAGS option line as:
  3569. @example
  3570. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
  3571. @end example
  3572. @noindent The tags interface will show the available tags in a splash
  3573. window. If you want to start a new line after a specific tag, insert
  3574. @samp{\n} into the tag list
  3575. @example
  3576. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
  3577. @end example
  3578. @noindent or write them in two lines:
  3579. @example
  3580. #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
  3581. #+TAGS: laptop(l) pc(p)
  3582. @end example
  3583. @noindent
  3584. You can also group together tags that are mutually exclusive by using
  3585. braces, as in:
  3586. @example
  3587. #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
  3588. @end example
  3589. @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
  3590. and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
  3591. @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
  3592. these lines to activate any changes.
  3593. @noindent
  3594. To set these mutually exclusive groups in the variable @code{org-tags-alist},
  3595. you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
  3596. of the braces. Similarly, you can use @code{:newline} to indicate a line
  3597. break. The previous example would be set globally by the following
  3598. configuration:
  3599. @lisp
  3600. (setq org-tag-alist '((:startgroup . nil)
  3601. ("@@work" . ?w) ("@@home" . ?h)
  3602. ("@@tennisclub" . ?t)
  3603. (:endgroup . nil)
  3604. ("laptop" . ?l) ("pc" . ?p)))
  3605. @end lisp
  3606. If at least one tag has a selection key then pressing @kbd{C-c C-c} will
  3607. automatically present you with a special interface, listing inherited tags,
  3608. the tags of the current headline, and a list of all valid tags with
  3609. corresponding keys@footnote{Keys will automatically be assigned to tags which
  3610. have no configured keys.}. In this interface, you can use the following
  3611. keys:
  3612. @table @kbd
  3613. @item a-z...
  3614. Pressing keys assigned to tags will add or remove them from the list of
  3615. tags in the current line. Selecting a tag in a group of mutually
  3616. exclusive tags will turn off any other tags from that group.
  3617. @kindex @key{TAB}
  3618. @item @key{TAB}
  3619. Enter a tag in the minibuffer, even if the tag is not in the predefined
  3620. list. You will be able to complete on all tags present in the buffer.
  3621. @kindex @key{SPC}
  3622. @item @key{SPC}
  3623. Clear all tags for this line.
  3624. @kindex @key{RET}
  3625. @item @key{RET}
  3626. Accept the modified set.
  3627. @item C-g
  3628. Abort without installing changes.
  3629. @item q
  3630. If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
  3631. @item !
  3632. Turn off groups of mutually exclusive tags. Use this to (as an
  3633. exception) assign several tags from such a group.
  3634. @item C-c
  3635. Toggle auto-exit after the next change (see below).
  3636. If you are using expert mode, the first @kbd{C-c} will display the
  3637. selection window.
  3638. @end table
  3639. @noindent
  3640. This method lets you assign tags to a headline with very few keys. With
  3641. the above setup, you could clear the current tags and set @samp{@@home},
  3642. @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
  3643. C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
  3644. @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
  3645. alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
  3646. @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
  3647. @key{RET} @key{RET}}.
  3648. @vindex org-fast-tag-selection-single-key
  3649. If you find that most of the time you need only a single key press to
  3650. modify your list of tags, set the variable
  3651. @code{org-fast-tag-selection-single-key}. Then you no longer have to
  3652. press @key{RET} to exit fast tag selection---it will immediately exit
  3653. after the first change. If you then occasionally need more keys, press
  3654. @kbd{C-c} to turn off auto-exit for the current tag selection process
  3655. (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
  3656. C-c}). If you set the variable to the value @code{expert}, the special
  3657. window is not even shown for single-key tag selection, it comes up only
  3658. when you press an extra @kbd{C-c}.
  3659. @node Tag searches, , Setting tags, Tags
  3660. @section Tag searches
  3661. @cindex tag searches
  3662. @cindex searching for tags
  3663. Once a system of tags has been set up, it can be used to collect related
  3664. information into special lists.
  3665. @table @kbd
  3666. @kindex C-c \
  3667. @kindex C-c / m
  3668. @item C-c \
  3669. @itemx C-c / m
  3670. Create a sparse tree with all headlines matching a tags search. With a
  3671. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  3672. @kindex C-c a m
  3673. @item C-c a m
  3674. Create a global list of tag matches from all agenda files.
  3675. @xref{Matching tags and properties}.
  3676. @kindex C-c a M
  3677. @item C-c a M
  3678. @vindex org-tags-match-list-sublevels
  3679. Create a global list of tag matches from all agenda files, but check
  3680. only TODO items and force checking subitems (see variable
  3681. @code{org-tags-match-list-sublevels}).
  3682. @end table
  3683. These commands all prompt for a match string which allows basic Boolean logic
  3684. like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
  3685. @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
  3686. which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
  3687. string is rich and allows also matching against TODO keywords, entry levels
  3688. and properties. For a complete description with many examples, see
  3689. @ref{Matching tags and properties}.
  3690. @node Properties and Columns, Dates and Times, Tags, Top
  3691. @chapter Properties and Columns
  3692. @cindex properties
  3693. Properties are a set of key-value pairs associated with an entry. There
  3694. are two main applications for properties in Org mode. First, properties
  3695. are like tags, but with a value. Second, you can use properties to
  3696. implement (very basic) database capabilities in an Org buffer. For
  3697. an example of the first application, imagine maintaining a file where
  3698. you document bugs and plan releases for a piece of software. Instead of
  3699. using tags like @code{:release_1:}, @code{:release_2:}, one can use a
  3700. property, say @code{:Release:}, that in different subtrees has different
  3701. values, such as @code{1.0} or @code{2.0}. For an example of the second
  3702. application of properties, imagine keeping track of your music CDs,
  3703. where properties could be things such as the album, artist, date of
  3704. release, number of tracks, and so on.
  3705. Properties can be conveniently edited and viewed in column view
  3706. (@pxref{Column view}).
  3707. @menu
  3708. * Property syntax:: How properties are spelled out
  3709. * Special properties:: Access to other Org mode features
  3710. * Property searches:: Matching property values
  3711. * Property inheritance:: Passing values down the tree
  3712. * Column view:: Tabular viewing and editing
  3713. * Property API:: Properties for Lisp programmers
  3714. @end menu
  3715. @node Property syntax, Special properties, Properties and Columns, Properties and Columns
  3716. @section Property syntax
  3717. @cindex property syntax
  3718. @cindex drawer, for properties
  3719. Properties are key-value pairs. They need to be inserted into a special
  3720. drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
  3721. is specified on a single line, with the key (surrounded by colons)
  3722. first, and the value after it. Here is an example:
  3723. @example
  3724. * CD collection
  3725. ** Classic
  3726. *** Goldberg Variations
  3727. :PROPERTIES:
  3728. :Title: Goldberg Variations
  3729. :Composer: J.S. Bach
  3730. :Artist: Glen Gould
  3731. :Publisher: Deutsche Grammophon
  3732. :NDisks: 1
  3733. :END:
  3734. @end example
  3735. You may define the allowed values for a particular property @samp{:Xyz:}
  3736. by setting a property @samp{:Xyz_ALL:}. This special property is
  3737. @emph{inherited}, so if you set it in a level 1 entry, it will apply to
  3738. the entire tree. When allowed values are defined, setting the
  3739. corresponding property becomes easier and is less prone to typing
  3740. errors. For the example with the CD collection, we can predefine
  3741. publishers and the number of disks in a box like this:
  3742. @example
  3743. * CD collection
  3744. :PROPERTIES:
  3745. :NDisks_ALL: 1 2 3 4
  3746. :Publisher_ALL: "Deutsche Grammophon" Philips EMI
  3747. :END:
  3748. @end example
  3749. If you want to set properties that can be inherited by any entry in a
  3750. file, use a line like
  3751. @cindex property, _ALL
  3752. @cindex #+PROPERTY
  3753. @example
  3754. #+PROPERTY: NDisks_ALL 1 2 3 4
  3755. @end example
  3756. @vindex org-global-properties
  3757. Property values set with the global variable
  3758. @code{org-global-properties} can be inherited by all entries in all
  3759. Org files.
  3760. @noindent
  3761. The following commands help to work with properties:
  3762. @table @kbd
  3763. @kindex M-@key{TAB}
  3764. @item M-@key{TAB}
  3765. After an initial colon in a line, complete property keys. All keys used
  3766. in the current file will be offered as possible completions.
  3767. @kindex C-c C-x p
  3768. @item C-c C-x p
  3769. Set a property. This prompts for a property name and a value. If
  3770. necessary, the property drawer is created as well.
  3771. @item M-x org-insert-property-drawer
  3772. Insert a property drawer into the current entry. The drawer will be
  3773. inserted early in the entry, but after the lines with planning
  3774. information like deadlines.
  3775. @kindex C-c C-c
  3776. @item C-c C-c
  3777. With the cursor in a property drawer, this executes property commands.
  3778. @item C-c C-c s
  3779. Set a property in the current entry. Both the property and the value
  3780. can be inserted using completion.
  3781. @kindex S-@key{right}
  3782. @kindex S-@key{left}
  3783. @item S-@key{left}/@key{right}
  3784. Switch property at point to the next/previous allowed value.
  3785. @item C-c C-c d
  3786. Remove a property from the current entry.
  3787. @item C-c C-c D
  3788. Globally remove a property, from all entries in the current file.
  3789. @item C-c C-c c
  3790. Compute the property at point, using the operator and scope from the
  3791. nearest column format definition.
  3792. @end table
  3793. @node Special properties, Property searches, Property syntax, Properties and Columns
  3794. @section Special properties
  3795. @cindex properties, special
  3796. Special properties provide an alternative access method to Org mode
  3797. features, like the TODO state or the priority of an entry, discussed in the
  3798. previous chapters. This interface exists so that you can include
  3799. these states in a column view (@pxref{Column view}), or to use them in
  3800. queries. The following property names are special and should not be
  3801. used as keys in the properties drawer:
  3802. @cindex property, special, TODO
  3803. @cindex property, special, TAGS
  3804. @cindex property, special, ALLTAGS
  3805. @cindex property, special, CATEGORY
  3806. @cindex property, special, PRIORITY
  3807. @cindex property, special, DEADLINE
  3808. @cindex property, special, SCHEDULED
  3809. @cindex property, special, CLOSED
  3810. @cindex property, special, TIMESTAMP
  3811. @cindex property, special, TIMESTAMP_IA
  3812. @cindex property, special, CLOCKSUM
  3813. @c guessing that ITEM is needed in this area; also, should this list be sorted?
  3814. @cindex property, special, ITEM
  3815. @example
  3816. TODO @r{The TODO keyword of the entry.}
  3817. TAGS @r{The tags defined directly in the headline.}
  3818. ALLTAGS @r{All tags, including inherited ones.}
  3819. CATEGORY @r{The category of an entry.}
  3820. PRIORITY @r{The priority of the entry, a string with a single letter.}
  3821. DEADLINE @r{The deadline time string, without the angular brackets.}
  3822. SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
  3823. CLOSED @r{When was this entry closed?}
  3824. TIMESTAMP @r{The first keyword-less timestamp in the entry.}
  3825. TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
  3826. CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
  3827. @r{must be run first to compute the values.}
  3828. ITEM @r{The content of the entry.}
  3829. @end example
  3830. @node Property searches, Property inheritance, Special properties, Properties and Columns
  3831. @section Property searches
  3832. @cindex properties, searching
  3833. @cindex searching, of properties
  3834. To create sparse trees and special lists with selection based on properties,
  3835. the same commands are used as for tag searches (@pxref{Tag searches}).
  3836. @table @kbd
  3837. @kindex C-c \
  3838. @kindex C-c / m
  3839. @item C-c \
  3840. @itemx C-c / m
  3841. Create a sparse tree with all matching entries. With a
  3842. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  3843. @kindex C-c a m
  3844. @item C-c a m
  3845. Create a global list of tag/property matches from all agenda files.
  3846. @xref{Matching tags and properties}.
  3847. @kindex C-c a M
  3848. @item C-c a M
  3849. @vindex org-tags-match-list-sublevels
  3850. Create a global list of tag matches from all agenda files, but check
  3851. only TODO items and force checking of subitems (see variable
  3852. @code{org-tags-match-list-sublevels}).
  3853. @end table
  3854. The syntax for the search string is described in @ref{Matching tags and
  3855. properties}.
  3856. There is also a special command for creating sparse trees based on a
  3857. single property:
  3858. @table @kbd
  3859. @kindex C-c / p
  3860. @item C-c / p
  3861. Create a sparse tree based on the value of a property. This first
  3862. prompts for the name of a property, and then for a value. A sparse tree
  3863. is created with all entries that define this property with the given
  3864. value. If you enclose the value into curly braces, it is interpreted as
  3865. a regular expression and matched against the property values.
  3866. @end table
  3867. @node Property inheritance, Column view, Property searches, Properties and Columns
  3868. @section Property Inheritance
  3869. @cindex properties, inheritance
  3870. @cindex inheritance, of properties
  3871. @vindex org-use-property-inheritance
  3872. The outline structure of Org-mode documents lends itself for an
  3873. inheritance model of properties: If the parent in a tree has a certain
  3874. property, the children can inherit this property. Org mode does not
  3875. turn this on by default, because it can slow down property searches
  3876. significantly and is often not needed. However, if you find inheritance
  3877. useful, you can turn it on by setting the variable
  3878. @code{org-use-property-inheritance}. It may be set to @code{t} to make
  3879. all properties inherited from the parent, to a list of properties
  3880. that should be inherited, or to a regular expression that matches
  3881. inherited properties.
  3882. Org mode has a few properties for which inheritance is hard-coded, at
  3883. least for the special applications for which they are used:
  3884. @cindex property, COLUMNS
  3885. @table @code
  3886. @item COLUMNS
  3887. The @code{:COLUMNS:} property defines the format of column view
  3888. (@pxref{Column view}). It is inherited in the sense that the level
  3889. where a @code{:COLUMNS:} property is defined is used as the starting
  3890. point for a column view table, independently of the location in the
  3891. subtree from where columns view is turned on.
  3892. @item CATEGORY
  3893. @cindex property, CATEGORY
  3894. For agenda view, a category set through a @code{:CATEGORY:} property
  3895. applies to the entire subtree.
  3896. @item ARCHIVE
  3897. @cindex property, ARCHIVE
  3898. For archiving, the @code{:ARCHIVE:} property may define the archive
  3899. location for the entire subtree (@pxref{Moving subtrees}).
  3900. @item LOGGING
  3901. @cindex property, LOGGING
  3902. The LOGGING property may define logging settings for an entry or a
  3903. subtree (@pxref{Tracking TODO state changes}).
  3904. @end table
  3905. @node Column view, Property API, Property inheritance, Properties and Columns
  3906. @section Column view
  3907. A great way to view and edit properties in an outline tree is
  3908. @emph{column view}. In column view, each outline item is turned into a
  3909. table row. Columns in this table provide access to properties of the
  3910. entries. Org mode implements columns by overlaying a tabular structure
  3911. over the headline of each item. While the headlines have been turned
  3912. into a table row, you can still change the visibility of the outline
  3913. tree. For example, you get a compact table by switching to CONTENTS
  3914. view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
  3915. is active), but you can still open, read, and edit the entry below each
  3916. headline. Or, you can switch to column view after executing a sparse
  3917. tree command and in this way get a table only for the selected items.
  3918. Column view also works in agenda buffers (@pxref{Agenda Views}) where
  3919. queries have collected selected items, possibly from a number of files.
  3920. @menu
  3921. * Defining columns:: The COLUMNS format property
  3922. * Using column view:: How to create and use column view
  3923. * Capturing column view:: A dynamic block for column view
  3924. @end menu
  3925. @node Defining columns, Using column view, Column view, Column view
  3926. @subsection Defining columns
  3927. @cindex column view, for properties
  3928. @cindex properties, column view
  3929. Setting up a column view first requires defining the columns. This is
  3930. done by defining a column format line.
  3931. @menu
  3932. * Scope of column definitions:: Where defined, where valid?
  3933. * Column attributes:: Appearance and content of a column
  3934. @end menu
  3935. @node Scope of column definitions, Column attributes, Defining columns, Defining columns
  3936. @subsubsection Scope of column definitions
  3937. To define a column format for an entire file, use a line like
  3938. @cindex #+COLUMNS
  3939. @example
  3940. #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  3941. @end example
  3942. To specify a format that only applies to a specific tree, add a
  3943. @code{:COLUMNS:} property to the top node of that tree, for example:
  3944. @example
  3945. ** Top node for columns view
  3946. :PROPERTIES:
  3947. :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  3948. :END:
  3949. @end example
  3950. If a @code{:COLUMNS:} property is present in an entry, it defines columns
  3951. for the entry itself, and for the entire subtree below it. Since the
  3952. column definition is part of the hierarchical structure of the document,
  3953. you can define columns on level 1 that are general enough for all
  3954. sublevels, and more specific columns further down, when you edit a
  3955. deeper part of the tree.
  3956. @node Column attributes, , Scope of column definitions, Defining columns
  3957. @subsubsection Column attributes
  3958. A column definition sets the attributes of a column. The general
  3959. definition looks like this:
  3960. @example
  3961. %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
  3962. @end example
  3963. @noindent
  3964. Except for the percent sign and the property name, all items are
  3965. optional. The individual parts have the following meaning:
  3966. @example
  3967. @var{width} @r{An integer specifying the width of the column in characters.}
  3968. @r{If omitted, the width will be determined automatically.}
  3969. @var{property} @r{The property that should be edited in this column.}
  3970. (title) @r{The header text for the column. If omitted, the}
  3971. @r{property name is used.}
  3972. @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
  3973. @r{parent nodes are computed from the children.}
  3974. @r{Supported summary types are:}
  3975. @{+@} @r{Sum numbers in this column.}
  3976. @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
  3977. @{$@} @r{Currency, short for @samp{+;%.2f}.}
  3978. @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
  3979. @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
  3980. @{X/@} @r{Checkbox status, @samp{[n/m]}.}
  3981. @{X%@} @r{Checkbox status, @samp{[n%]}.}
  3982. @{min@} @r{Smallest number in column.}
  3983. @{max@} @r{Largest number.}
  3984. @{mean@} @r{Arithmetic mean of numbers.}
  3985. @{:min@} @r{Smallest time value in column.}
  3986. @{:max@} @r{Largest time value.}
  3987. @{:mean@} @r{Arithmetic mean of time values.}
  3988. @end example
  3989. @noindent
  3990. Here is an example for a complete columns definition, along with allowed
  3991. values.
  3992. @example
  3993. :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.}
  3994. %10Time_Estimate@{:@} %CLOCKSUM
  3995. :Owner_ALL: Tammy Mark Karl Lisa Don
  3996. :Status_ALL: "In progress" "Not started yet" "Finished" ""
  3997. :Approved_ALL: "[ ]" "[X]"
  3998. @end example
  3999. @noindent
  4000. The first column, @samp{%25ITEM}, means the first 25 characters of the
  4001. item itself, @ie of the headline. You probably always should start the
  4002. column definition with the @samp{ITEM} specifier. The other specifiers
  4003. create columns @samp{Owner} with a list of names as allowed values, for
  4004. @samp{Status} with four different possible values, and for a checkbox
  4005. field @samp{Approved}. When no width is given after the @samp{%}
  4006. character, the column will be exactly as wide as it needs to be in order
  4007. to fully display all values. The @samp{Approved} column does have a
  4008. modified title (@samp{Approved?}, with a question mark). Summaries will
  4009. be created for the @samp{Time_Estimate} column by adding time duration
  4010. expressions like HH:MM, and for the @samp{Approved} column, by providing
  4011. an @samp{[X]} status if all children have been checked. The
  4012. @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
  4013. in the subtree.
  4014. @node Using column view, Capturing column view, Defining columns, Column view
  4015. @subsection Using column view
  4016. @table @kbd
  4017. @tsubheading{Turning column view on and off}
  4018. @kindex C-c C-x C-c
  4019. @item C-c C-x C-c
  4020. @vindex org-columns-default-format
  4021. Create the column view for the local environment. This command searches
  4022. the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
  4023. a format. When one is found, the column view table is established for
  4024. the entire tree, starting from the entry that contains the @code{:COLUMNS:}
  4025. property. If none is found, the format is taken from the @code{#+COLUMNS}
  4026. line or from the variable @code{org-columns-default-format}, and column
  4027. view is established for the current entry and its subtree.
  4028. @kindex r
  4029. @item r
  4030. Recreate the column view, to include recent changes made in the buffer.
  4031. @kindex g
  4032. @item g
  4033. Same as @kbd{r}.
  4034. @kindex q
  4035. @item q
  4036. Exit column view.
  4037. @tsubheading{Editing values}
  4038. @item @key{left} @key{right} @key{up} @key{down}
  4039. Move through the column view from field to field.
  4040. @kindex S-@key{left}
  4041. @kindex S-@key{right}
  4042. @item S-@key{left}/@key{right}
  4043. Switch to the next/previous allowed value of the field. For this, you
  4044. have to have specified allowed values for a property.
  4045. @item 1..9,0
  4046. Directly select the nth allowed value, @kbd{0} selects the 10th value.
  4047. @kindex n
  4048. @kindex p
  4049. @itemx n / p
  4050. Same as @kbd{S-@key{left}/@key{right}}
  4051. @kindex e
  4052. @item e
  4053. Edit the property at point. For the special properties, this will
  4054. invoke the same interface that you normally use to change that
  4055. property. For example, when editing a TAGS property, the tag completion
  4056. or fast selection interface will pop up.
  4057. @kindex C-c C-c
  4058. @item C-c C-c
  4059. When there is a checkbox at point, toggle it.
  4060. @kindex v
  4061. @item v
  4062. View the full value of this property. This is useful if the width of
  4063. the column is smaller than that of the value.
  4064. @kindex a
  4065. @item a
  4066. Edit the list of allowed values for this property. If the list is found
  4067. in the hierarchy, the modified values is stored there. If no list is
  4068. found, the new value is stored in the first entry that is part of the
  4069. current column view.
  4070. @tsubheading{Modifying the table structure}
  4071. @kindex <
  4072. @kindex >
  4073. @item < / >
  4074. Make the column narrower/wider by one character.
  4075. @kindex S-M-@key{right}
  4076. @item S-M-@key{right}
  4077. Insert a new column, to the left of the current column.
  4078. @kindex S-M-@key{left}
  4079. @item S-M-@key{left}
  4080. Delete the current column.
  4081. @end table
  4082. @node Capturing column view, , Using column view, Column view
  4083. @subsection Capturing column view
  4084. Since column view is just an overlay over a buffer, it cannot be
  4085. exported or printed directly. If you want to capture a column view, use
  4086. a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
  4087. of this block looks like this:
  4088. @cindex #+BEGIN, columnview
  4089. @example
  4090. * The column view
  4091. #+BEGIN: columnview :hlines 1 :id "label"
  4092. #+END:
  4093. @end example
  4094. @noindent This dynamic block has the following parameters:
  4095. @table @code
  4096. @item :id
  4097. This is the most important parameter. Column view is a feature that is
  4098. often localized to a certain (sub)tree, and the capture block might be
  4099. at a different location in the file. To identify the tree whose view to
  4100. capture, you can use 4 values:
  4101. @cindex property, ID
  4102. @example
  4103. local @r{use the tree in which the capture block is located}
  4104. global @r{make a global view, including all headings in the file}
  4105. "file:@var{path-to-file}"
  4106. @r{run column view at the top of this file}
  4107. "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
  4108. @r{property with the value @i{label}. You can use}
  4109. @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
  4110. @r{the current entry and copy it to the kill-ring.}
  4111. @end example
  4112. @item :hlines
  4113. When @code{t}, insert an hline after every line. When a number @var{N}, insert
  4114. an hline before each headline with level @code{<= @var{N}}.
  4115. @item :vlines
  4116. When set to @code{t}, force column groups to get vertical lines.
  4117. @item :maxlevel
  4118. When set to a number, don't capture entries below this level.
  4119. @item :skip-empty-rows
  4120. When set to @code{t}, skip rows where the only non-empty specifier of the
  4121. column view is @code{ITEM}.
  4122. @end table
  4123. @noindent
  4124. The following commands insert or update the dynamic block:
  4125. @table @kbd
  4126. @kindex C-c C-x i
  4127. @item C-c C-x i
  4128. Insert a dynamic block capturing a column view. You will be prompted
  4129. for the scope or ID of the view.
  4130. @kindex C-c C-c
  4131. @item C-c C-c
  4132. @kindex C-c C-x C-u
  4133. @itemx C-c C-x C-u
  4134. Update dynamic block at point. The cursor needs to be in the
  4135. @code{#+BEGIN} line of the dynamic block.
  4136. @kindex C-u C-c C-x C-u
  4137. @item C-u C-c C-x C-u
  4138. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  4139. you have several clock table blocks in a buffer.
  4140. @end table
  4141. You can add formulas to the column view table and you may add plotting
  4142. instructions in front of the table---these will survive an update of the
  4143. block. If there is a @code{#+TBLFM:} after the table, the table will
  4144. actually be recalculated automatically after an update.
  4145. An alternative way to capture and process property values into a table is
  4146. provided by Eric Schulte's @file{org-collector.el} which is a contributed
  4147. package@footnote{Contributed packages are not part of Emacs, but are
  4148. distributed with the main distribution of Org (visit
  4149. @uref{http://orgmode.org}).}. It provides a general API to collect
  4150. properties from entries in a certain scope, and arbitrary Lisp expressions to
  4151. process these values before inserting them into a table or a dynamic block.
  4152. @node Property API, , Column view, Properties and Columns
  4153. @section The Property API
  4154. @cindex properties, API
  4155. @cindex API, for properties
  4156. There is a full API for accessing and changing properties. This API can
  4157. be used by Emacs Lisp programs to work with properties and to implement
  4158. features based on them. For more information see @ref{Using the
  4159. property API}.
  4160. @node Dates and Times, Capture, Properties and Columns, Top
  4161. @chapter Dates and Times
  4162. @cindex dates
  4163. @cindex times
  4164. @cindex timestamp
  4165. @cindex date stamp
  4166. To assist project planning, TODO items can be labeled with a date and/or
  4167. a time. The specially formatted string carrying the date and time
  4168. information is called a @emph{timestamp} in Org mode. This may be a
  4169. little confusing because timestamp is often used as indicating when
  4170. something was created or last changed. However, in Org mode this term
  4171. is used in a much wider sense.
  4172. @menu
  4173. * Timestamps:: Assigning a time to a tree entry
  4174. * Creating timestamps:: Commands which insert timestamps
  4175. * Deadlines and scheduling:: Planning your work
  4176. * Clocking work time:: Tracking how long you spend on a task
  4177. * Effort estimates:: Planning work effort in advance
  4178. * Relative timer:: Notes with a running timer
  4179. @end menu
  4180. @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
  4181. @section Timestamps, deadlines, and scheduling
  4182. @cindex timestamps
  4183. @cindex ranges, time
  4184. @cindex date stamps
  4185. @cindex deadlines
  4186. @cindex scheduling
  4187. A timestamp is a specification of a date (possibly with a time or a range
  4188. of times) in a special format, either @samp{<2003-09-16 Tue>} or
  4189. @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
  4190. 12:00-12:30>}@footnote{This is the standard ISO date/time format. To
  4191. use an alternative format, see @ref{Custom time format}.}. A timestamp
  4192. can appear anywhere in the headline or body of an Org tree entry. Its
  4193. presence causes entries to be shown on specific dates in the agenda
  4194. (@pxref{Weekly/daily agenda}). We distinguish:
  4195. @table @var
  4196. @item Plain timestamp; Event; Appointment
  4197. @cindex timestamp
  4198. A simple timestamp just assigns a date/time to an item. This is just
  4199. like writing down an appointment or event in a paper agenda. In the
  4200. timeline and agenda displays, the headline of an entry associated with a
  4201. plain timestamp will be shown exactly on that date.
  4202. @example
  4203. * Meet Peter at the movies <2006-11-01 Wed 19:15>
  4204. * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
  4205. @end example
  4206. @item Timestamp with repeater interval
  4207. @cindex timestamp, with repeater interval
  4208. A timestamp may contain a @emph{repeater interval}, indicating that it
  4209. applies not only on the given date, but again and again after a certain
  4210. interval of N days (d), weeks (w), months (m), or years (y). The
  4211. following will show up in the agenda every Wednesday:
  4212. @example
  4213. * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
  4214. @end example
  4215. @item Diary-style sexp entries
  4216. For more complex date specifications, Org mode supports using the
  4217. special sexp diary entries implemented in the Emacs calendar/diary
  4218. package. For example
  4219. @example
  4220. * The nerd meeting on every 2nd Thursday of the month
  4221. <%%(diary-float t 4 2)>
  4222. @end example
  4223. @item Time/Date range
  4224. @cindex timerange
  4225. @cindex date range
  4226. Two timestamps connected by @samp{--} denote a range. The headline
  4227. will be shown on the first and last day of the range, and on any dates
  4228. that are displayed and fall in the range. Here is an example:
  4229. @example
  4230. ** Meeting in Amsterdam
  4231. <2004-08-23 Mon>--<2004-08-26 Thu>
  4232. @end example
  4233. @item Inactive timestamp
  4234. @cindex timestamp, inactive
  4235. @cindex inactive timestamp
  4236. Just like a plain timestamp, but with square brackets instead of
  4237. angular ones. These timestamps are inactive in the sense that they do
  4238. @emph{not} trigger an entry to show up in the agenda.
  4239. @example
  4240. * Gillian comes late for the fifth time [2006-11-01 Wed]
  4241. @end example
  4242. @end table
  4243. @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
  4244. @section Creating timestamps
  4245. @cindex creating timestamps
  4246. @cindex timestamps, creating
  4247. For Org mode to recognize timestamps, they need to be in the specific
  4248. format. All commands listed below produce timestamps in the correct
  4249. format.
  4250. @table @kbd
  4251. @kindex C-c .
  4252. @item C-c .
  4253. Prompt for a date and insert a corresponding timestamp. When the cursor is
  4254. at an existing timestamp in the buffer, the command is used to modify this
  4255. timestamp instead of inserting a new one. When this command is used twice in
  4256. succession, a time range is inserted.
  4257. @c
  4258. @kindex C-c !
  4259. @item C-c !
  4260. Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
  4261. an agenda entry.
  4262. @c
  4263. @kindex C-u C-c .
  4264. @kindex C-u C-c !
  4265. @item C-u C-c .
  4266. @itemx C-u C-c !
  4267. @vindex org-time-stamp-rounding-minutes
  4268. Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
  4269. contains date and time. The default time can be rounded to multiples of 5
  4270. minutes, see the option @code{org-time-stamp-rounding-minutes}.
  4271. @c
  4272. @kindex C-c <
  4273. @item C-c <
  4274. Insert a timestamp corresponding to the cursor date in the Calendar.
  4275. @c
  4276. @kindex C-c >
  4277. @item C-c >
  4278. Access the Emacs calendar for the current date. If there is a
  4279. timestamp in the current line, go to the corresponding date
  4280. instead.
  4281. @c
  4282. @kindex C-c C-o
  4283. @item C-c C-o
  4284. Access the agenda for the date given by the timestamp or -range at
  4285. point (@pxref{Weekly/daily agenda}).
  4286. @c
  4287. @kindex S-@key{left}
  4288. @kindex S-@key{right}
  4289. @item S-@key{left}
  4290. @itemx S-@key{right}
  4291. Change date at cursor by one day. These key bindings conflict with
  4292. shift-selection and related modes (@pxref{Conflicts}).
  4293. @c
  4294. @kindex S-@key{up}
  4295. @kindex S-@key{down}
  4296. @item S-@key{up}
  4297. @itemx S-@key{down}
  4298. Change the item under the cursor in a timestamp. The cursor can be on a
  4299. year, month, day, hour or minute. When the timestamp contains a time range
  4300. like @samp{15:30-16:30}, modifying the first time will also shift the second,
  4301. shifting the time block with constant length. To change the length, modify
  4302. the second time. Note that if the cursor is in a headline and not at a
  4303. timestamp, these same keys modify the priority of an item.
  4304. (@pxref{Priorities}). The key bindings also conflict with shift-selection and
  4305. related modes (@pxref{Conflicts}).
  4306. @c
  4307. @kindex C-c C-y
  4308. @cindex evaluate time range
  4309. @item C-c C-y
  4310. Evaluate a time range by computing the difference between start and end.
  4311. With a prefix argument, insert result after the time range (in a table: into
  4312. the following column).
  4313. @end table
  4314. @menu
  4315. * The date/time prompt:: How Org mode helps you entering date and time
  4316. * Custom time format:: Making dates look different
  4317. @end menu
  4318. @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
  4319. @subsection The date/time prompt
  4320. @cindex date, reading in minibuffer
  4321. @cindex time, reading in minibuffer
  4322. @vindex org-read-date-prefer-future
  4323. When Org mode prompts for a date/time, the default is shown as an ISO
  4324. date, and the prompt therefore seems to ask for an ISO date. But it
  4325. will in fact accept any string containing some date and/or time
  4326. information, and it is really smart about interpreting your input. You
  4327. can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
  4328. copied from an email message. Org mode will find whatever information
  4329. is in there and derive anything you have not specified from the
  4330. @emph{default date and time}. The default is usually the current date
  4331. and time, but when modifying an existing timestamp, or when entering
  4332. the second stamp of a range, it is taken from the stamp in the buffer.
  4333. When filling in information, Org mode assumes that most of the time you
  4334. will want to enter a date in the future: If you omit the month/year and
  4335. the given day/month is @i{before} today, it will assume that you mean a
  4336. future date@footnote{See the variable
  4337. @code{org-read-date-prefer-future}.}.
  4338. For example, let's assume that today is @b{June 13, 2006}. Here is how
  4339. various inputs will be interpreted, the items filled in by Org mode are
  4340. in @b{bold}.
  4341. @example
  4342. 3-2-5 --> 2003-02-05
  4343. 14 --> @b{2006}-@b{06}-14
  4344. 12 --> @b{2006}-@b{07}-12
  4345. Fri --> nearest Friday (defaultdate or later)
  4346. sep 15 --> @b{2006}-09-15
  4347. feb 15 --> @b{2007}-02-15
  4348. sep 12 9 --> 2009-09-12
  4349. 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
  4350. 22 sept 0:34 --> @b{2006}-09-22 0:34
  4351. w4 --> ISO week for of the current year @b{2006}
  4352. 2012 w4 fri --> Friday of ISO week 4 in 2012
  4353. 2012-w04-5 --> Same as above
  4354. @end example
  4355. Furthermore you can specify a relative date by giving, as the
  4356. @emph{first} thing in the input: a plus/minus sign, a number and a
  4357. letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
  4358. single plus or minus, the date is always relative to today. With a
  4359. double plus or minus, it is relative to the default date. If instead of
  4360. a single letter, you use the abbreviation of day name, the date will be
  4361. the nth such day. @Eg
  4362. @example
  4363. +0 --> today
  4364. . --> today
  4365. +4d --> four days from today
  4366. +4 --> same as above
  4367. +2w --> two weeks from today
  4368. ++5 --> five days from default date
  4369. +2tue --> second tuesday from now.
  4370. @end example
  4371. @vindex parse-time-months
  4372. @vindex parse-time-weekdays
  4373. The function understands English month and weekday abbreviations. If
  4374. you want to use unabbreviated names and/or other languages, configure
  4375. the variables @code{parse-time-months} and @code{parse-time-weekdays}.
  4376. @cindex calendar, for selecting date
  4377. @vindex org-popup-calendar-for-date-prompt
  4378. Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
  4379. you don't need/want the calendar, configure the variable
  4380. @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
  4381. prompt, either by clicking on a date in the calendar, or by pressing
  4382. @key{RET}, the date selected in the calendar will be combined with the
  4383. information entered at the prompt. You can control the calendar fully
  4384. from the minibuffer:
  4385. @kindex <
  4386. @kindex >
  4387. @kindex mouse-1
  4388. @kindex S-@key{right}
  4389. @kindex S-@key{left}
  4390. @kindex S-@key{down}
  4391. @kindex S-@key{up}
  4392. @kindex M-S-@key{right}
  4393. @kindex M-S-@key{left}
  4394. @kindex @key{RET}
  4395. @example
  4396. > / < @r{Scroll calendar forward/backward by one month.}
  4397. mouse-1 @r{Select date by clicking on it.}
  4398. S-@key{right}/@key{left} @r{One day forward/backward.}
  4399. S-@key{down}/@key{up} @r{One week forward/backward.}
  4400. M-S-@key{right}/@key{left} @r{One month forward/backward.}
  4401. @key{RET} @r{Choose date in calendar.}
  4402. @end example
  4403. @vindex org-read-date-display-live
  4404. The actions of the date/time prompt may seem complex, but I assure you they
  4405. will grow on you, and you will start getting annoyed by pretty much any other
  4406. way of entering a date/time out there. To help you understand what is going
  4407. on, the current interpretation of your input will be displayed live in the
  4408. minibuffer@footnote{If you find this distracting, turn the display of with
  4409. @code{org-read-date-display-live}.}.
  4410. @node Custom time format, , The date/time prompt, Creating timestamps
  4411. @subsection Custom time format
  4412. @cindex custom date/time format
  4413. @cindex time format, custom
  4414. @cindex date format, custom
  4415. @vindex org-display-custom-times
  4416. @vindex org-time-stamp-custom-formats
  4417. Org mode uses the standard ISO notation for dates and times as it is
  4418. defined in ISO 8601. If you cannot get used to this and require another
  4419. representation of date and time to keep you happy, you can get it by
  4420. customizing the variables @code{org-display-custom-times} and
  4421. @code{org-time-stamp-custom-formats}.
  4422. @table @kbd
  4423. @kindex C-c C-x C-t
  4424. @item C-c C-x C-t
  4425. Toggle the display of custom formats for dates and times.
  4426. @end table
  4427. @noindent
  4428. Org mode needs the default format for scanning, so the custom date/time
  4429. format does not @emph{replace} the default format---instead it is put
  4430. @emph{over} the default format using text properties. This has the
  4431. following consequences:
  4432. @itemize @bullet
  4433. @item
  4434. You cannot place the cursor onto a timestamp anymore, only before or
  4435. after.
  4436. @item
  4437. The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
  4438. each component of a timestamp. If the cursor is at the beginning of
  4439. the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
  4440. just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
  4441. time will be changed by one minute.
  4442. @item
  4443. If the timestamp contains a range of clock times or a repeater, these
  4444. will not be overlayed, but remain in the buffer as they were.
  4445. @item
  4446. When you delete a timestamp character-by-character, it will only
  4447. disappear from the buffer after @emph{all} (invisible) characters
  4448. belonging to the ISO timestamp have been removed.
  4449. @item
  4450. If the custom timestamp format is longer than the default and you are
  4451. using dates in tables, table alignment will be messed up. If the custom
  4452. format is shorter, things do work as expected.
  4453. @end itemize
  4454. @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
  4455. @section Deadlines and scheduling
  4456. A timestamp may be preceded by special keywords to facilitate planning:
  4457. @table @var
  4458. @item DEADLINE
  4459. @cindex DEADLINE keyword
  4460. Meaning: the task (most likely a TODO item, though not necessarily) is supposed
  4461. to be finished on that date.
  4462. @vindex org-deadline-warning-days
  4463. On the deadline date, the task will be listed in the agenda. In
  4464. addition, the agenda for @emph{today} will carry a warning about the
  4465. approaching or missed deadline, starting
  4466. @code{org-deadline-warning-days} before the due date, and continuing
  4467. until the entry is marked DONE. An example:
  4468. @example
  4469. *** TODO write article about the Earth for the Guide
  4470. The editor in charge is [[bbdb:Ford Prefect]]
  4471. DEADLINE: <2004-02-29 Sun>
  4472. @end example
  4473. You can specify a different lead time for warnings for a specific
  4474. deadlines using the following syntax. Here is an example with a warning
  4475. period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
  4476. @item SCHEDULED
  4477. @cindex SCHEDULED keyword
  4478. Meaning: you are planning to start working on that task on the given
  4479. date.
  4480. @vindex org-agenda-skip-scheduled-if-done
  4481. The headline will be listed under the given date@footnote{It will still
  4482. be listed on that date after it has been marked DONE. If you don't like
  4483. this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
  4484. addition, a reminder that the scheduled date has passed will be present
  4485. in the compilation for @emph{today}, until the entry is marked DONE.
  4486. @Ie the task will automatically be forwarded until completed.
  4487. @example
  4488. *** TODO Call Trillian for a date on New Years Eve.
  4489. SCHEDULED: <2004-12-25 Sat>
  4490. @end example
  4491. @noindent
  4492. @b{Important:} Scheduling an item in Org mode should @i{not} be
  4493. understood in the same way that we understand @i{scheduling a meeting}.
  4494. Setting a date for a meeting is just a simple appointment, you should
  4495. mark this entry with a simple plain timestamp, to get this item shown
  4496. on the date where it applies. This is a frequent misunderstanding by
  4497. Org users. In Org mode, @i{scheduling} means setting a date when you
  4498. want to start working on an action item.
  4499. @end table
  4500. You may use timestamps with repeaters in scheduling and deadline
  4501. entries. Org mode will issue early and late warnings based on the
  4502. assumption that the timestamp represents the @i{nearest instance} of
  4503. the repeater. However, the use of diary sexp entries like
  4504. @c
  4505. @code{<%%(diary-float t 42)>}
  4506. @c
  4507. in scheduling and deadline timestamps is limited. Org mode does not
  4508. know enough about the internals of each sexp function to issue early and
  4509. late warnings. However, it will show the item on each day where the
  4510. sexp entry matches.
  4511. @menu
  4512. * Inserting deadline/schedule:: Planning items
  4513. * Repeated tasks:: Items that show up again and again
  4514. @end menu
  4515. @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
  4516. @subsection Inserting deadlines or schedules
  4517. The following commands allow you to quickly insert a deadline or to schedule
  4518. an item:
  4519. @table @kbd
  4520. @c
  4521. @kindex C-c C-d
  4522. @item C-c C-d
  4523. Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
  4524. happen in the line directly following the headline. When called with a
  4525. prefix arg, an existing deadline will be removed from the entry.
  4526. @c FIXME Any CLOSED timestamp will be removed.????????
  4527. @c
  4528. @kindex C-c C-s
  4529. @item C-c C-s
  4530. Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
  4531. happen in the line directly following the headline. Any CLOSED
  4532. timestamp will be removed. When called with a prefix argument, remove
  4533. the scheduling date from the entry.
  4534. @c
  4535. @kindex C-c C-x C-k
  4536. @kindex k a
  4537. @kindex k s
  4538. @item C-c C-x C-k
  4539. Mark the current entry for agenda action. After you have marked the entry
  4540. like this, you can open the agenda or the calendar to find an appropriate
  4541. date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
  4542. schedule the marked item.
  4543. @c
  4544. @kindex C-c / d
  4545. @cindex sparse tree, for deadlines
  4546. @item C-c / d
  4547. @vindex org-deadline-warning-days
  4548. Create a sparse tree with all deadlines that are either past-due, or
  4549. which will become due within @code{org-deadline-warning-days}.
  4550. With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
  4551. prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
  4552. all deadlines due tomorrow.
  4553. @c
  4554. @kindex C-c / b
  4555. @item C-c / b
  4556. Sparse tree for deadlines and scheduled items before a given date.
  4557. @c
  4558. @kindex C-c / a
  4559. @item C-c / a
  4560. Sparse tree for deadlines and scheduled items after a given date.
  4561. @end table
  4562. @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
  4563. @subsection Repeated tasks
  4564. @cindex tasks, repeated
  4565. @cindex repeated tasks
  4566. Some tasks need to be repeated again and again. Org mode helps to
  4567. organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
  4568. or plain timestamp. In the following example
  4569. @example
  4570. ** TODO Pay the rent
  4571. DEADLINE: <2005-10-01 Sat +1m>
  4572. @end example
  4573. @noindent
  4574. the @code{+1m} is a repeater; the intended interpretation is that the task
  4575. has a deadline on <2005-10-01> and repeats itself every (one) month starting
  4576. from that time. If you need both a repeater and a special warning period in
  4577. a deadline entry, the repeater should come first and the warning period last:
  4578. @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
  4579. Deadlines and scheduled items produce entries in the agenda when they
  4580. are over-due, so it is important to be able to mark such an entry as
  4581. completed once you have done so. When you mark a DEADLINE or a SCHEDULE
  4582. with the TODO keyword DONE, it will no longer produce entries in the
  4583. agenda. The problem with this is, however, that then also the
  4584. @emph{next} instance of the repeated entry will not be active. Org mode
  4585. deals with this in the following way: When you try to mark such an entry
  4586. DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
  4587. timestamp by the repeater interval, and immediately set the entry state
  4588. back to TODO. In the example above, setting the state to DONE would
  4589. actually switch the date like this:
  4590. @example
  4591. ** TODO Pay the rent
  4592. DEADLINE: <2005-11-01 Tue +1m>
  4593. @end example
  4594. @vindex org-log-repeat
  4595. A timestamp@footnote{You can change this using the option
  4596. @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
  4597. @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
  4598. will also be prompted for a note.} will be added under the deadline, to keep
  4599. a record that you actually acted on the previous instance of this deadline.
  4600. As a consequence of shifting the base date, this entry will no longer be
  4601. visible in the agenda when checking past dates, but all future instances
  4602. will be visible.
  4603. With the @samp{+1m} cookie, the date shift will always be exactly one
  4604. month. So if you have not paid the rent for three months, marking this
  4605. entry DONE will still keep it as an overdue deadline. Depending on the
  4606. task, this may not be the best way to handle it. For example, if you
  4607. forgot to call you father for 3 weeks, it does not make sense to call
  4608. him 3 times in a single day to make up for it. Finally, there are tasks
  4609. like changing batteries which should always repeat a certain time
  4610. @i{after} the last time you did it. For these tasks, Org mode has
  4611. special repeaters markers with @samp{++} and @samp{.+}. For example:
  4612. @example
  4613. ** TODO Call Father
  4614. DEADLINE: <2008-02-10 Sun ++1w>
  4615. Marking this DONE will shift the date by at least one week,
  4616. but also by as many weeks as it takes to get this date into
  4617. the future. However, it stays on a Sunday, even if you called
  4618. and marked it done on Saturday.
  4619. ** TODO Check the batteries in the smoke detectors
  4620. DEADLINE: <2005-11-01 Tue .+1m>
  4621. Marking this DONE will shift the date to one month after
  4622. today.
  4623. @end example
  4624. You may have both scheduling and deadline information for a specific
  4625. task---just make sure that the repeater intervals on both are the same.
  4626. An alternative to using a repeater is to create a number of copies of a task
  4627. subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
  4628. created for this purpose, it is described in @ref{Structure editing}.
  4629. @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
  4630. @section Clocking work time
  4631. Org mode allows you to clock the time you spend on specific tasks in a
  4632. project. When you start working on an item, you can start the clock.
  4633. When you stop working on that task, or when you mark the task done, the
  4634. clock is stopped and the corresponding time interval is recorded. It
  4635. also computes the total time spent on each subtree of a project.
  4636. Normally, the clock does not survive exiting and re-entereing Emacs, but you
  4637. can arrange for the clock information to persist across Emacs sessions with
  4638. @lisp
  4639. (setq org-clock-persist t)
  4640. (org-clock-persistence-insinuate)
  4641. @end lisp
  4642. @table @kbd
  4643. @kindex C-c C-x C-i
  4644. @item C-c C-x C-i
  4645. @vindex org-clock-into-drawer
  4646. Start the clock on the current item (clock-in). This inserts the CLOCK
  4647. keyword together with a timestamp. If this is not the first clocking of
  4648. this item, the multiple CLOCK lines will be wrapped into a
  4649. @code{:LOGBOOK:} drawer (see also the variable
  4650. @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
  4651. select the task from a list of recently clocked tasks. With two @kbd{C-u
  4652. C-u} prefixes, clock into the task at point and mark it as the default task.
  4653. The default task will always be available when selecting a clocking task,
  4654. with letter @kbd{d}.@*
  4655. @cindex property: CLOCK_MODELINE_TOTAL
  4656. @cindex property: LAST_REPEAT
  4657. @vindex org-clock-modeline-total
  4658. While the clock is running, the current clocking time is shown in the mode
  4659. line, along with the title of the task. The clock time shown will be all
  4660. time ever clocked for this task and its children. If the task is a repeating
  4661. one (@pxref{Repeated tasks}), only the time since the last reset of the task
  4662. @footnote{as recorded by the @code{LAST_REPEAT} property} will be shown.
  4663. More control over what time is shown can be exercised with the
  4664. @code{CLOCK_MODELINE_TOTAL} property. It may have the values @code{current}
  4665. to show only the current clocking instance, @code{today} to show all time
  4666. clocked on this tasks today (see also the variable
  4667. @code{org-extend-today-until}), @code{all} to include all time, or
  4668. @code{auto} which is the default@footnote{See also the variable
  4669. @code{org-clock-modeline-total}.}.@*
  4670. Clicking with @kbd{mouse-1} onto the mode line entry will pop up a menu with
  4671. clocking options.
  4672. @kindex C-c C-x C-o
  4673. @item C-c C-x C-o
  4674. @vindex org-log-note-clock-out
  4675. Stop the clock (clock-out). This inserts another timestamp at the same
  4676. location where the clock was last started. It also directly computes
  4677. the resulting time in inserts it after the time range as @samp{=>
  4678. HH:MM}. See the variable @code{org-log-note-clock-out} for the
  4679. possibility to record an additional note together with the clock-out
  4680. timestamp@footnote{The corresponding in-buffer setting is:
  4681. @code{#+STARTUP: lognoteclock-out}}.
  4682. @kindex C-c C-x C-e
  4683. @item C-c C-x C-e
  4684. Update the effort estimate for the current clock task.
  4685. @kindex C-c C-y
  4686. @kindex C-c C-c
  4687. @item C-c C-y @ @ @r{or}@ @ C-c C-c
  4688. Recompute the time interval after changing one of the timestamps. This
  4689. is only necessary if you edit the timestamps directly. If you change
  4690. them with @kbd{S-@key{cursor}} keys, the update is automatic.
  4691. @kindex C-c C-t
  4692. @item C-c C-t
  4693. Changing the TODO state of an item to DONE automatically stops the clock
  4694. if it is running in this same item.
  4695. @kindex C-c C-x C-x
  4696. @item C-c C-x C-x
  4697. Cancel the current clock. This is useful if a clock was started by
  4698. mistake, or if you ended up working on something else.
  4699. @kindex C-c C-x C-j
  4700. @item C-c C-x C-j
  4701. Jump to the entry that contains the currently running clock. With a
  4702. @kbd{C-u} prefix arg, select the target task from a list of recently clocked
  4703. tasks.
  4704. @kindex C-c C-x C-d
  4705. @item C-c C-x C-d
  4706. @vindex org-remove-highlights-with-change
  4707. Display time summaries for each subtree in the current buffer. This
  4708. puts overlays at the end of each headline, showing the total time
  4709. recorded under that heading, including the time of any subheadings. You
  4710. can use visibility cycling to study the tree, but the overlays disappear
  4711. when you change the buffer (see variable
  4712. @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
  4713. @kindex C-c C-x C-r
  4714. @item C-c C-x C-r
  4715. Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
  4716. report as an Org-mode table into the current file. When the cursor is
  4717. at an existing clock table, just update it. When called with a prefix
  4718. argument, jump to the first clock report in the current document and
  4719. update it.
  4720. @cindex #+BEGIN, clocktable
  4721. @example
  4722. #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
  4723. #+END: clocktable
  4724. @end example
  4725. @noindent
  4726. If such a block already exists at point, its content is replaced by the
  4727. new table. The @samp{BEGIN} line can specify options:
  4728. @example
  4729. :maxlevel @r{Maximum level depth to which times are listed in the table.}
  4730. :emphasize @r{When @code{t}, emphasize level one and level two items.}
  4731. :scope @r{The scope to consider. This can be any of the following:}
  4732. nil @r{the current buffer or narrowed region}
  4733. file @r{the full current buffer}
  4734. subtree @r{the subtree where the clocktable is located}
  4735. tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
  4736. tree @r{the surrounding level 1 tree}
  4737. agenda @r{all agenda files}
  4738. ("file"..) @r{scan these files}
  4739. file-with-archives @r{current file and its archives}
  4740. agenda-with-archives @r{all agenda files, including archives}
  4741. :block @r{The time block to consider. This block is specified either}
  4742. @r{absolute, or relative to the current time and may be any of}
  4743. @r{these formats:}
  4744. 2007-12-31 @r{New year eve 2007}
  4745. 2007-12 @r{December 2007}
  4746. 2007-W50 @r{ISO-week 50 in 2007}
  4747. 2007 @r{the year 2007}
  4748. today, yesterday, today-@var{N} @r{a relative day}
  4749. thisweek, lastweek, thisweek-@var{N} @r{a relative week}
  4750. thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
  4751. thisyear, lastyear, thisyear-@var{N} @r{a relative year}
  4752. @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
  4753. :tstart @r{A time string specifying when to start considering times.}
  4754. :tend @r{A time string specifying when to stop considering times.}
  4755. :step @r{@code{week} or @code{day}, to split the table into chunks.}
  4756. @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
  4757. :link @r{Link the item headlines in the table to their origins.}
  4758. :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
  4759. @r{As a special case, @samp{:formula %} adds a column with % time.}
  4760. @r{If you do not specify a formula here, any existing formula.}
  4761. @r{below the clock table will survive updates and be evaluated.}
  4762. @end example
  4763. To get a clock summary of the current level 1 tree, for the current
  4764. day, you could write
  4765. @example
  4766. #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
  4767. #+END: clocktable
  4768. @end example
  4769. @noindent
  4770. and to use a specific time range you could write@footnote{Note that all
  4771. parameters must be specified in a single line---the line is broken here
  4772. only to fit it into the manual.}
  4773. @example
  4774. #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
  4775. :tend "<2006-08-10 Thu 12:00>"
  4776. #+END: clocktable
  4777. @end example
  4778. A summary of the current subtree with % times would be
  4779. @example
  4780. #+BEGIN: clocktable :scope subtree :link t :formula %
  4781. #+END: clocktable
  4782. @end example
  4783. @kindex C-c C-c
  4784. @item C-c C-c
  4785. @kindex C-c C-x C-u
  4786. @itemx C-c C-x C-u
  4787. Update dynamic block at point. The cursor needs to be in the
  4788. @code{#+BEGIN} line of the dynamic block.
  4789. @kindex C-u C-c C-x C-u
  4790. @item C-u C-c C-x C-u
  4791. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  4792. you have several clock table blocks in a buffer.
  4793. @kindex S-@key{left}
  4794. @kindex S-@key{right}
  4795. @item S-@key{left}
  4796. @itemx S-@key{right}
  4797. Shift the current @code{:block} interval and update the table. The cursor
  4798. needs to be in the @code{#+BEGIN: clocktable} line for this command. If
  4799. @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
  4800. @end table
  4801. The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
  4802. the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
  4803. worked on or closed during a day.
  4804. @node Effort estimates, Relative timer, Clocking work time, Dates and Times
  4805. @section Effort estimates
  4806. @cindex effort estimates
  4807. @cindex property, Effort
  4808. @vindex org-effort-property
  4809. If you want to plan your work in a very detailed way, or if you need to
  4810. produce offers with quotations of the estimated work effort, you may want to
  4811. assign effort estimates to entries. If you are also clocking your work, you
  4812. may later want to compare the planned effort with the actual working time, a
  4813. great way to improve planning estimates. Effort estimates are stored in a
  4814. special property @samp{Effort}@footnote{You may change the property being
  4815. used with the variable @code{org-effort-property}.}. Clearly the best way to
  4816. work with effort estimates is through column view (@pxref{Column view}). You
  4817. should start by setting up discrete values for effort estimates, and a
  4818. @code{COLUMNS} format that displays these values together with clock sums (if
  4819. you want to clock your time). For a specific buffer you can use
  4820. @example
  4821. #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
  4822. #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
  4823. @end example
  4824. @noindent
  4825. @vindex org-global-properties
  4826. @vindex org-columns-default-format
  4827. or, even better, you can set up these values globally by customizing the
  4828. variables @code{org-global-properties} and @code{org-columns-default-format}.
  4829. In particular if you want to use this setup also in the agenda, a global
  4830. setup may be advised.
  4831. The way to assign estimates to individual items is then to switch to column
  4832. mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
  4833. value. The values you enter will immediately be summed up in the hierarchy.
  4834. In the column next to it, any clocked time will be displayed.
  4835. @vindex org-agenda-columns-add-appointments-to-effort-sum
  4836. If you switch to column view in the daily/weekly agenda, the effort column
  4837. will summarize the estimated work effort for each day@footnote{Please note
  4838. the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
  4839. column view}).}, and you can use this to find space in your schedule. To get
  4840. an overview of the entire part of the day that is committed, you can set the
  4841. option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
  4842. appointments on a day that take place over a specified time interval will
  4843. then also be added to the load estimate of the day.
  4844. Effort estimates can be used in secondary agenda filtering that is triggered
  4845. with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
  4846. these estimates defined consistently, two or three key presses will narrow
  4847. down the list to stuff that fits into an available time slot.
  4848. @node Relative timer, , Effort estimates, Dates and Times
  4849. @section Taking notes with a relative timer
  4850. @cindex relative timer
  4851. When taking notes during, for example, a meeting or a video viewing, it can
  4852. be useful to have access to times relative to a starting time. Org provides
  4853. such a relative timer and make it easy to create timed notes.
  4854. @table @kbd
  4855. @kindex C-c C-x .
  4856. @item C-c C-x .
  4857. Insert a relative time into the buffer. The first time you use this, the
  4858. timer will be started. When called with a prefix argument, the timer is
  4859. restarted.
  4860. @kindex C-c C-x -
  4861. @item C-c C-x -
  4862. Insert a description list item with the current relative time. With a prefix
  4863. argument, first reset the timer to 0.
  4864. @kindex M-@key{RET}
  4865. @item M-@key{RET}
  4866. Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
  4867. new timer items.
  4868. @kindex C-c C-x ,
  4869. @item C-c C-x ,
  4870. Pause the timer, or continue it if it is already paused.
  4871. @c removed the sentence because it is redundant to the following item
  4872. @kindex C-u C-c C-x ,
  4873. @item C-u C-c C-x ,
  4874. Stop the timer. After this, you can only start a new timer, not continue the
  4875. old one. This command also removes the timer from the mode line.
  4876. @kindex C-c C-x 0
  4877. @item C-c C-x 0
  4878. Reset the timer without inserting anything into the buffer. By default, the
  4879. timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
  4880. specific starting offset. The user is prompted for the offset, with a
  4881. default taken from a timer string at point, if any, So this can be used to
  4882. restart taking notes after a break in the process. When called with a double
  4883. prefix argument @kbd{C-c C-u}, change all timer strings in the active region
  4884. by a certain amount. This can be used to fix timer strings if the timer was
  4885. not started at exactly the right moment.
  4886. @end table
  4887. @node Capture, Agenda Views, Dates and Times, Top
  4888. @chapter Capture
  4889. @cindex capture
  4890. An important part of any organization system is the ability to quickly
  4891. capture new ideas and tasks, and to associate reference material with them.
  4892. Org uses the @file{remember.el} package to create tasks, and stores files
  4893. related to a task (@i{attachments}) in a special directory.
  4894. @menu
  4895. * Remember:: Capture new tasks/ideas with little interruption
  4896. * Attachments:: Add files to tasks.
  4897. * RSS Feeds:: Getting input from RSS feeds
  4898. * Protocols:: External (@eg Browser) access to Emacs and Org
  4899. @end menu
  4900. @node Remember, Attachments, Capture, Capture
  4901. @section Remember
  4902. @cindex @file{remember.el}
  4903. The Remember package by John Wiegley lets you store quick notes with
  4904. little interruption of your work flow. See
  4905. @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
  4906. information. It is an excellent way to add new notes and tasks to
  4907. Org files. Org significantly expands the possibilities of
  4908. Remember: You may define templates for different note types, and
  4909. associate target files and headlines with specific templates. It also
  4910. allows you to select the location where a note should be stored
  4911. interactively, on the fly.
  4912. @menu
  4913. * Setting up Remember:: Some code for .emacs to get things going
  4914. * Remember templates:: Define the outline of different note types
  4915. * Storing notes:: Directly get the note to where it belongs
  4916. * Refiling notes:: Moving a note or task to a project
  4917. @end menu
  4918. @node Setting up Remember, Remember templates, Remember, Remember
  4919. @subsection Setting up Remember
  4920. The following customization will tell Remember to use Org files as
  4921. target, and to create annotations compatible with Org links.
  4922. @example
  4923. (org-remember-insinuate)
  4924. (setq org-directory "~/path/to/my/orgfiles/")
  4925. (setq org-default-notes-file (concat org-directory "/notes.org"))
  4926. (define-key global-map "\C-cr" 'org-remember)
  4927. @end example
  4928. @noindent
  4929. The last line binds the command @code{org-remember} to a global
  4930. key@footnote{Please select your own key, @kbd{C-c r} is only a
  4931. suggestion.}. @code{org-remember} basically just calls Remember,
  4932. but it makes a few things easier: If there is an active region, it will
  4933. automatically copy the region into the Remember buffer. It also allows
  4934. to jump to the buffer and location where Remember notes are being
  4935. stored: Just call @code{org-remember} with a prefix argument. If you
  4936. use two prefix arguments, Org jumps to the location where the last
  4937. remember note was stored.
  4938. The Remember buffer will actually use @code{org-mode} as its major mode, so
  4939. that all editing features of Org mode are available. In addition to this, a
  4940. minor mode @code{org-remember-mode} is turned on, for the single purpose that
  4941. you can use its keymap @code{org-remember-mode-map} to overwrite some of
  4942. Org mode's key bindings.
  4943. You can also call @code{org-remember} in a special way from the agenda,
  4944. using the @kbd{k r} key combination. With this access, any timestamps
  4945. inserted by the selected Remember template (see below) will default to
  4946. the cursor date in the agenda, rather than to the current date.
  4947. @node Remember templates, Storing notes, Setting up Remember, Remember
  4948. @subsection Remember templates
  4949. @cindex templates, for Remember
  4950. In combination with Org, you can use templates to generate
  4951. different types of Remember notes. For example, if you would like
  4952. to use one template to create general TODO entries, another one for
  4953. journal entries, and a third one for collecting random ideas, you could
  4954. use:
  4955. @example
  4956. (setq org-remember-templates
  4957. '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
  4958. ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
  4959. ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
  4960. @end example
  4961. @vindex org-remember-default-headline
  4962. @vindex org-directory
  4963. @noindent In these entries, the first string is just a name, and the
  4964. character specifies how to select the template. It is useful if the
  4965. character is also the first letter of the name. The next string specifies
  4966. the template. Two more (optional) strings give the file in which, and the
  4967. headline under which, the new note should be stored. The file (if not present
  4968. or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
  4969. @code{org-remember-default-headline}. If the file name is not an absolute
  4970. path, it will be interpreted relative to @code{org-directory}. The heading
  4971. can also be the symbols @code{top} or @code{bottom} to send notes as level 1
  4972. entries to the beginning or end of the file, respectively.
  4973. An optional sixth element specifies the contexts in which the user can select
  4974. the template. This element can be a list of major modes or a function.
  4975. @code{org-remember} will first check whether the function returns @code{t} or
  4976. if we are in any of the listed major modes, and exclude templates for which
  4977. this condition is not fulfilled. Templates that do not specify this element
  4978. at all, or that use @code{nil} or @code{t} as a value will always be
  4979. selectable.
  4980. So for example:
  4981. @example
  4982. (setq org-remember-templates
  4983. '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
  4984. ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check)
  4985. ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
  4986. @end example
  4987. @noindent
  4988. The first template will only be available when invoking @code{org-remember}
  4989. from an buffer in @code{emacs-lisp-mode}. The second template will only be
  4990. available when the function @code{my-check} returns @code{t}. The third
  4991. template will be proposed in any context.
  4992. When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
  4993. something, Org will prompt for a key to select the template (if you have
  4994. more than one template) and then prepare the buffer like
  4995. @example
  4996. * TODO
  4997. [[file:@var{link to where you called remember}]]
  4998. @end example
  4999. @noindent
  5000. During expansion of the template, special @kbd{%}-escapes allow dynamic
  5001. insertion of content:
  5002. @example
  5003. %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
  5004. @r{You may specify a default value and a completion table with}
  5005. @r{%^@{prompt|default|completion2|completion3...@}}
  5006. @r{The arrow keys access a prompt-specific history.}
  5007. %a @r{annotation, normally the link created with @code{org-store-link}}
  5008. %A @r{like @code{%a}, but prompt for the description part}
  5009. %i @r{initial content, the region when remember is called with C-u.}
  5010. @r{The entire text will be indented like @code{%i} itself.}
  5011. %t @r{timestamp, date only}
  5012. %T @r{timestamp with date and time}
  5013. %u, %U @r{like the above, but inactive timestamps}
  5014. %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
  5015. @r{You may define a prompt like @code{%^@{Birthday@}t}}
  5016. %n @r{user name (taken from @code{user-full-name})}
  5017. %c @r{Current kill ring head.}
  5018. %x @r{Content of the X clipboard.}
  5019. %^C @r{Interactive selection of which kill or clip to use.}
  5020. %^L @r{Like @code{%^C}, but insert as link.}
  5021. %^g @r{prompt for tags, with completion on tags in target file.}
  5022. %k @r{title of currently clocked task}
  5023. %K @r{link to currently clocked task}
  5024. %^G @r{prompt for tags, with completion all tags in all agenda files.}
  5025. %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
  5026. %:keyword @r{specific information for certain link types, see below}
  5027. %[@var{file}] @r{insert the contents of the file given by @var{file}}
  5028. %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
  5029. %! @r{immediately store note after completing the template}
  5030. @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
  5031. %& @r{jump to target location immediately after storing note}
  5032. @end example
  5033. @noindent
  5034. For specific link types, the following keywords will be
  5035. defined@footnote{If you define your own link types (@pxref{Adding
  5036. hyperlink types}), any property you store with
  5037. @code{org-store-link-props} can be accessed in remember templates in a
  5038. similar way.}:
  5039. @vindex org-from-is-user-regexp
  5040. @example
  5041. Link type | Available keywords
  5042. -------------------+----------------------------------------------
  5043. bbdb | %:name %:company
  5044. bbdb | %::server %:port %:nick
  5045. vm, wl, mh, rmail | %:type %:subject %:message-id
  5046. | %:from %:fromname %:fromaddress
  5047. | %:to %:toname %:toaddress
  5048. | %: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}.}}
  5049. gnus | %:group, @r{for messages also all email fields}
  5050. w3, w3m | %:url
  5051. info | %:file %:node
  5052. calendar | %:date"
  5053. @end example
  5054. @noindent
  5055. To place the cursor after template expansion use:
  5056. @example
  5057. %? @r{After completing the template, position cursor here.}
  5058. @end example
  5059. @noindent
  5060. If you change your mind about which template to use, call
  5061. @code{org-remember} in the remember buffer. You may then select a new
  5062. template that will be filled with the previous context information.
  5063. @node Storing notes, Refiling notes, Remember templates, Remember
  5064. @subsection Storing notes
  5065. @vindex org-remember-clock-out-on-exit
  5066. When you are finished preparing a note with Remember, you have to press
  5067. @kbd{C-c C-c} to file the note away. If you have started the clock in the
  5068. Remember buffer, you will first be asked if you want to clock out
  5069. now@footnote{To avoid this query, configure the variable
  5070. @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
  5071. will continue to run after the note was filed away.
  5072. The handler will then store the note in the file and under the headline
  5073. specified in the template, or it will use the default file and headline.
  5074. The window configuration will be restored, sending you back to the working
  5075. context before the call to Remember. To re-use the location found
  5076. during the last call to Remember, exit the Remember buffer with
  5077. @kbd{C-0 C-c C-c}, @ie specify a zero prefix argument to @kbd{C-c C-c}.
  5078. Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
  5079. the currently clocked item.
  5080. @vindex org-remember-store-without-prompt
  5081. If you want to store the note directly to a different place, use
  5082. @kbd{C-1 C-c C-c} instead to exit Remember@footnote{Configure the
  5083. variable @code{org-remember-store-without-prompt} to make this behavior
  5084. the default.}. The handler will then first prompt for a target file---if
  5085. you press @key{RET}, the value specified for the template is used.
  5086. Then the command offers the headings tree of the selected file, with the
  5087. cursor position at the default headline (if you specified one in the
  5088. template). You can either immediately press @key{RET} to get the note
  5089. placed there. Or you can use the following keys to find a different
  5090. location:
  5091. @example
  5092. @key{TAB} @r{Cycle visibility.}
  5093. @key{down} / @key{up} @r{Next/previous visible headline.}
  5094. n / p @r{Next/previous visible headline.}
  5095. f / b @r{Next/previous headline same level.}
  5096. u @r{One level up.}
  5097. @c 0-9 @r{Digit argument.}
  5098. @end example
  5099. @noindent
  5100. Pressing @key{RET} or @key{left} or @key{right}
  5101. then leads to the following result.
  5102. @vindex org-reverse-note-order
  5103. @multitable @columnfractions 0.2 0.15 0.65
  5104. @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
  5105. @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
  5106. @item @tab @tab depending on @code{org-reverse-note-order}.
  5107. @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
  5108. @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
  5109. @item @tab @tab depending on @code{org-reverse-note-order}.
  5110. @item not on headline @tab @key{RET}
  5111. @tab at cursor position, level taken from context.
  5112. @end multitable
  5113. Before inserting the text into a tree, the function ensures that the text has
  5114. a headline, @ie a first line that starts with a @samp{*}. If not, a
  5115. headline is constructed from the current date. If you have indented the text
  5116. of the note below the headline, the indentation will be adapted if inserting
  5117. the note into the tree requires demotion from level 1.
  5118. @node Refiling notes, , Storing notes, Remember
  5119. @subsection Refiling notes
  5120. @cindex refiling notes
  5121. Remember is usually used to quickly capture notes and tasks into one or
  5122. a few capture lists. When reviewing the captured data, you may want to
  5123. refile some of the entries into a different list, for example into a
  5124. project. Cutting, finding the right location, and then pasting the note
  5125. is cumbersome. To simplify this process, you can use the following
  5126. special command:
  5127. @table @kbd
  5128. @kindex C-c C-w
  5129. @item C-c C-w
  5130. @vindex org-reverse-note-order
  5131. @vindex org-refile-targets
  5132. @vindex org-refile-use-outline-path
  5133. @vindex org-outline-path-complete-in-steps
  5134. @vindex org-refile-allow-creating-parent-nodes
  5135. Refile the entry or region at point. This command offers possible locations
  5136. for refiling the entry and lets you select one with completion. The item (or
  5137. all items in the region) is filed below the target heading as a subitem.
  5138. Depending on @code{org-reverse-note-order}, it will be either the first or
  5139. last subitem.@*
  5140. By default, all level 1 headlines in the current buffer are considered to be
  5141. targets, but you can have more complex definitions across a number of files.
  5142. See the variable @code{org-refile-targets} for details. If you would like to
  5143. select a location via a file-path-like completion along the outline path, see
  5144. the variables @code{org-refile-use-outline-path} and
  5145. @code{org-outline-path-complete-in-steps}. If you would like to be able to
  5146. create new nodes as new parents for for refiling on the fly, check the
  5147. variable @code{org-refile-allow-creating-parent-nodes}.
  5148. @kindex C-u C-c C-w
  5149. @item C-u C-c C-w
  5150. Use the refile interface to jump to a heading.
  5151. @kindex C-u C-u C-c C-w
  5152. @item C-u C-u C-c C-w
  5153. Jump to the location where @code{org-refile} last moved a tree to.
  5154. @end table
  5155. @node Attachments, RSS Feeds, Remember, Capture
  5156. @section Attachments
  5157. @cindex attachments
  5158. @vindex org-attach-directory
  5159. It is often useful to associate reference material with an outline node/task.
  5160. Small chunks of plain text can simply be stored in the subtree of a project.
  5161. Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
  5162. files that live elsewhere on your computer or in the cloud, like emails or
  5163. source code files belonging to a project. Another method is @i{attachments},
  5164. which are files located in a directory belonging to an outline node. Org
  5165. uses directories named by the unique ID of each entry. These directories are
  5166. located in the @file{data} directory which lives in the same directory where
  5167. your Org file lives@footnote{If you move entries or Org files from one
  5168. directory to another, you may want to configure @code{org-attach-directory}
  5169. to contain an absolute path.}. If you initialize this directory with
  5170. @code{git init}, Org will automatically commit changes when it sees them.
  5171. The attachment system has been contributed to Org by John Wiegley.
  5172. In cases where it seems better to do so, you can also attach a directory of your
  5173. choice to an entry. You can also make children inherit the attachment
  5174. directory from a parent, so that an entire subtree uses the same attached
  5175. directory.
  5176. @noindent The following commands deal with attachments.
  5177. @table @kbd
  5178. @kindex C-c C-a
  5179. @item C-c C-a
  5180. The dispatcher for commands related to the attachment system. After these
  5181. keys, a list of commands is displayed and you need to press an additional key
  5182. to select a command:
  5183. @table @kbd
  5184. @kindex C-c C-a a
  5185. @item a
  5186. @vindex org-attach-method
  5187. Select a file and move it into the task's attachment directory. The file
  5188. will be copied, moved, or linked, depending on @code{org-attach-method}.
  5189. Note that hard links are not supported on all systems.
  5190. @kindex C-c C-a c
  5191. @kindex C-c C-a m
  5192. @kindex C-c C-a l
  5193. @item c/m/l
  5194. Attach a file using the copy/move/link method.
  5195. Note that hard links are not supported on all systems.
  5196. @kindex C-c C-a n
  5197. @item n
  5198. Create a new attachment as an Emacs buffer.
  5199. @kindex C-c C-a z
  5200. @item z
  5201. Synchronize the current task with its attachment directory, in case you added
  5202. attachments yourself.
  5203. @kindex C-c C-a o
  5204. @item o
  5205. @vindex org-file-apps
  5206. Open current task's attachment. If there are more than one, prompt for a
  5207. file name first. Opening will follow the rules set by @code{org-file-apps}.
  5208. For more details, see the information on following hyperlinks
  5209. (@pxref{Handling links}).
  5210. @kindex C-c C-a O
  5211. @item O
  5212. Also open the attachment, but force opening the file in Emacs.
  5213. @kindex C-c C-a f
  5214. @item f
  5215. Open the current task's attachment directory.
  5216. @kindex C-c C-a F
  5217. @item F
  5218. Also open the directory, but force using @command{dired} in Emacs.
  5219. @kindex C-c C-a d
  5220. @item d
  5221. Select and delete a single attachment.
  5222. @kindex C-c C-a D
  5223. @item D
  5224. Delete all of a task's attachments. A safer way is to open the directory in
  5225. @command{dired} and delete from there.
  5226. @kindex C-c C-a s
  5227. @item C-c C-a s
  5228. @cindex property, ATTACH_DIR
  5229. Set a specific directory as the entry's attachment directory. This works by
  5230. putting the directory path into the @code{ATTACH_DIR} property.
  5231. @kindex C-c C-a i
  5232. @item C-c C-a i
  5233. @cindex property, ATTACH_DIR_INHERIT
  5234. Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
  5235. same directory for attachments as the parent does.
  5236. @end table
  5237. @end table
  5238. @node RSS Feeds, Protocols, Attachments, Capture
  5239. @section RSS feeds
  5240. @cindex RSS feeds
  5241. Org has the capablity to add and change entries based on information found in
  5242. RSS feeds. You could use this to make a task out of each new podcast in a
  5243. podcast feed. Or you could use a phone-based note-creating service on the
  5244. web to import tasks into Org. To access feeds, you need to configure the
  5245. variable @code{org-feed-alist}. The docstring of this variable has detailed
  5246. information. Here is just an example:
  5247. @example
  5248. (setq org-feed-alist
  5249. '(("ReQall" "http://www.reqall.com/user/feeds/rss/a1b2c3....."
  5250. "~/org/feeds.org" "ReQall Entries")
  5251. @end example
  5252. @noindent
  5253. will configure that new items from the feed provided by @file{reqall.com}
  5254. will result in new entries in the file @file{~/org/feeds.org} under the
  5255. heading @samp{ReQall Entries}, whenever the following command is used:
  5256. @table @kbd
  5257. @kindex C-c C-x g
  5258. @item C-c C-x g
  5259. Collect items from the feeds configured in @code{org-feed-alist} and act upon
  5260. them.
  5261. @kindex C-c C-x G
  5262. @item C-c C-x G
  5263. Prompt for a feed name and go to the inbox configured for this feed.
  5264. @end table
  5265. Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
  5266. it will store information about the status of items in the feed, to avoid
  5267. adding the same item several times. You should add @samp{FEEDSTATUS} to the
  5268. list of drawers in that file:
  5269. @example
  5270. #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
  5271. @end example
  5272. For more information, see @file{org-feed.el} and the docstring of
  5273. @code{org-feed-alist}.
  5274. @node Protocols, , RSS Feeds, Capture
  5275. @section Protocols for external access
  5276. @cindex protocols, for external access
  5277. @cindex emacsserver
  5278. You can set up Org for handling protocol calls from outside applications that
  5279. are passed to Emacs through the @file{emacsserver}. For example, you can
  5280. configure bookmarks in your web browser to send a link to the current page to
  5281. Org and create a note from it using Remember (@pxref{Remember}). Or you
  5282. could create a bookmark that will tell Emacs to open the local source file of
  5283. a remote website you are looking at with the browser. See
  5284. @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
  5285. documentation and setup instructions.
  5286. @node Agenda Views, Embedded LaTeX, Capture, Top
  5287. @chapter Agenda Views
  5288. @cindex agenda views
  5289. Due to the way Org works, TODO items, time-stamped items, and
  5290. tagged headlines can be scattered throughout a file or even a number of
  5291. files. To get an overview of open action items, or of events that are
  5292. important for a particular date, this information must be collected,
  5293. sorted and displayed in an organized way.
  5294. Org can select items based on various criteria and display them
  5295. in a separate buffer. Seven different view types are provided:
  5296. @itemize @bullet
  5297. @item
  5298. an @emph{agenda} that is like a calendar and shows information
  5299. for specific dates,
  5300. @item
  5301. a @emph{TODO list} that covers all unfinished
  5302. action items,
  5303. @item
  5304. a @emph{match view}, showings headlines based on the tags, properties, and
  5305. TODO state associated with them,
  5306. @item
  5307. a @emph{timeline view} that shows all events in a single Org file,
  5308. in time-sorted view,
  5309. @item
  5310. a @emph{keyword search view} that shows all entries from multiple files
  5311. that contain specified keywords,
  5312. @item
  5313. a @emph{stuck projects view} showing projects that currently don't move
  5314. along, and
  5315. @item
  5316. @emph{custom views} that are special tag/keyword searches and
  5317. combinations of different views.
  5318. @end itemize
  5319. @noindent
  5320. The extracted information is displayed in a special @emph{agenda
  5321. buffer}. This buffer is read-only, but provides commands to visit the
  5322. corresponding locations in the original Org files, and even to
  5323. edit these files remotely.
  5324. @vindex org-agenda-window-setup
  5325. @vindex org-agenda-restore-windows-after-quit
  5326. Two variables control how the agenda buffer is displayed and whether the
  5327. window configuration is restored when the agenda exits:
  5328. @code{org-agenda-window-setup} and
  5329. @code{org-agenda-restore-windows-after-quit}.
  5330. @menu
  5331. * Agenda files:: Files being searched for agenda information
  5332. * Agenda dispatcher:: Keyboard access to agenda views
  5333. * Built-in agenda views:: What is available out of the box?
  5334. * Presentation and sorting:: How agenda items are prepared for display
  5335. * Agenda commands:: Remote editing of Org trees
  5336. * Custom agenda views:: Defining special searches and views
  5337. * Exporting Agenda Views::
  5338. * Agenda column view:: Using column view for collected entries
  5339. @end menu
  5340. @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
  5341. @section Agenda files
  5342. @cindex agenda files
  5343. @cindex files for agenda
  5344. @vindex org-agenda-files
  5345. The information to be shown is normally collected from all @emph{agenda
  5346. files}, the files listed in the variable
  5347. @code{org-agenda-files}@footnote{If the value of that variable is not a
  5348. list, but a single file name, then the list of agenda files will be
  5349. maintained in that external file.}. If a directory is part of this list,
  5350. all files with the extension @file{.org} in this directory will be part
  5351. of the list.
  5352. Thus, even if you only work with a single Org file, that file should
  5353. be put into the list@footnote{When using the dispatcher, pressing
  5354. @kbd{<} before selecting a command will actually limit the command to
  5355. the current file, and ignore @code{org-agenda-files} until the next
  5356. dispatcher command.}. You can customize @code{org-agenda-files}, but
  5357. the easiest way to maintain it is through the following commands
  5358. @cindex files, adding to agenda list
  5359. @table @kbd
  5360. @kindex C-c [
  5361. @item C-c [
  5362. Add current file to the list of agenda files. The file is added to
  5363. the front of the list. If it was already in the list, it is moved to
  5364. the front. With a prefix argument, file is added/moved to the end.
  5365. @kindex C-c ]
  5366. @item C-c ]
  5367. Remove current file from the list of agenda files.
  5368. @kindex C-,
  5369. @kindex C-'
  5370. @item C-,
  5371. @itemx C-'
  5372. Cycle through agenda file list, visiting one file after the other.
  5373. @kindex M-x org-iswitchb
  5374. @item M-x org-iswitchb
  5375. Command to use an @code{iswitchb}-like interface to switch to and between Org
  5376. buffers.
  5377. @end table
  5378. @noindent
  5379. The Org menu contains the current list of files and can be used
  5380. to visit any of them.
  5381. If you would like to focus the agenda temporarily on a file not in
  5382. this list, or on just one file in the list, or even on only a subtree in a
  5383. file, then this can be done in different ways. For a single agenda command,
  5384. you may press @kbd{<} once or several times in the dispatcher
  5385. (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
  5386. extended period, use the following commands:
  5387. @table @kbd
  5388. @kindex C-c C-x <
  5389. @item C-c C-x <
  5390. Permanently restrict the agenda to the current subtree. When with a
  5391. prefix argument, or with the cursor before the first headline in a file,
  5392. the agenda scope is set to the entire file. This restriction remains in
  5393. effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
  5394. or @kbd{>} in the agenda dispatcher. If there is a window displaying an
  5395. agenda view, the new restriction takes effect immediately.
  5396. @kindex C-c C-x >
  5397. @item C-c C-x >
  5398. Remove the permanent restriction created by @kbd{C-c C-x <}.
  5399. @end table
  5400. @noindent
  5401. When working with @file{speedbar.el}, you can use the following commands in
  5402. the Speedbar frame:
  5403. @table @kbd
  5404. @kindex <
  5405. @item < @r{in the speedbar frame}
  5406. Permanently restrict the agenda to the item---either an Org file or a subtree
  5407. in such a file---at the cursor in the Speedbar frame.
  5408. If there is a window displaying an agenda view, the new restriction takes
  5409. effect immediately.
  5410. @kindex >
  5411. @item > @r{in the speedbar frame}
  5412. Lift the restriction.
  5413. @end table
  5414. @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
  5415. @section The agenda dispatcher
  5416. @cindex agenda dispatcher
  5417. @cindex dispatching agenda commands
  5418. The views are created through a dispatcher, which should be bound to a
  5419. global key---for example @kbd{C-c a} (@pxref{Installation}). In the
  5420. following we will assume that @kbd{C-c a} is indeed how the dispatcher
  5421. is accessed and list keyboard access to commands accordingly. After
  5422. pressing @kbd{C-c a}, an additional letter is required to execute a
  5423. command. The dispatcher offers the following default commands:
  5424. @table @kbd
  5425. @item a
  5426. Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
  5427. @item t @r{/} T
  5428. Create a list of all TODO items (@pxref{Global TODO list}).
  5429. @item m @r{/} M
  5430. Create a list of headlines matching a TAGS expression (@pxref{Matching
  5431. tags and properties}).
  5432. @item L
  5433. Create the timeline view for the current buffer (@pxref{Timeline}).
  5434. @item s
  5435. Create a list of entries selected by a boolean expression of keywords
  5436. and/or regular expressions that must or must not occur in the entry.
  5437. @item /
  5438. @vindex org-agenda-text-search-extra-files
  5439. Search for a regular expression in all agenda files and additionally in
  5440. the files listed in @code{org-agenda-text-search-extra-files}. This
  5441. uses the Emacs command @code{multi-occur}. A prefix argument can be
  5442. used to specify the number of context lines for each match, default is
  5443. 1.
  5444. @item # @r{/} !
  5445. Create a list of stuck projects (@pxref{Stuck projects}).
  5446. @item <
  5447. Restrict an agenda command to the current buffer@footnote{For backward
  5448. compatibility, you can also press @kbd{1} to restrict to the current
  5449. buffer.}. After pressing @kbd{<}, you still need to press the character
  5450. selecting the command.
  5451. @item < <
  5452. If there is an active region, restrict the following agenda command to
  5453. the region. Otherwise, restrict it to the current subtree@footnote{For
  5454. backward compatibility, you can also press @kbd{0} to restrict to the
  5455. current region/subtree.}. After pressing @kbd{< <}, you still need to press the
  5456. character selecting the command.
  5457. @end table
  5458. You can also define custom commands that will be accessible through the
  5459. dispatcher, just like the default commands. This includes the
  5460. possibility to create extended agenda buffers that contain several
  5461. blocks together, for example the weekly agenda, the global TODO list and
  5462. a number of special tags matches. @xref{Custom agenda views}.
  5463. @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
  5464. @section The built-in agenda views
  5465. In this section we describe the built-in views.
  5466. @menu
  5467. * Weekly/daily agenda:: The calendar page with current tasks
  5468. * Global TODO list:: All unfinished action items
  5469. * Matching tags and properties:: Structured information with fine-tuned search
  5470. * Timeline:: Time-sorted view for single file
  5471. * Keyword search:: Finding entries by keyword
  5472. * Stuck projects:: Find projects you need to review
  5473. @end menu
  5474. @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
  5475. @subsection The weekly/daily agenda
  5476. @cindex agenda
  5477. @cindex weekly agenda
  5478. @cindex daily agenda
  5479. The purpose of the weekly/daily @emph{agenda} is to act like a page of a
  5480. paper agenda, showing all the tasks for the current week or day.
  5481. @table @kbd
  5482. @cindex org-agenda, command
  5483. @kindex C-c a a
  5484. @item C-c a a
  5485. @vindex org-agenda-ndays
  5486. Compile an agenda for the current week from a list of Org files. The agenda
  5487. shows the entries for each day. With a numeric prefix@footnote{For backward
  5488. compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
  5489. listed before the agenda. This feature is deprecated, use the dedicated TODO
  5490. list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
  5491. C-c a a}) you may set the number of days to be displayed (see also the
  5492. variable @code{org-agenda-ndays})
  5493. @end table
  5494. Remote editing from the agenda buffer means, for example, that you can
  5495. change the dates of deadlines and appointments from the agenda buffer.
  5496. The commands available in the Agenda buffer are listed in @ref{Agenda
  5497. commands}.
  5498. @subsubheading Calendar/Diary integration
  5499. @cindex calendar integration
  5500. @cindex diary integration
  5501. Emacs contains the calendar and diary by Edward M. Reingold. The
  5502. calendar displays a three-month calendar with holidays from different
  5503. countries and cultures. The diary allows you to keep track of
  5504. anniversaries, lunar phases, sunrise/set, recurrent appointments
  5505. (weekly, monthly) and more. In this way, it is quite complementary to
  5506. Org. It can be very useful to combine output from Org with
  5507. the diary.
  5508. In order to include entries from the Emacs diary into Org mode's
  5509. agenda, you only need to customize the variable
  5510. @lisp
  5511. (setq org-agenda-include-diary t)
  5512. @end lisp
  5513. @noindent After that, everything will happen automatically. All diary
  5514. entries including holidays, anniversaries, etc., will be included in the
  5515. agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
  5516. @key{RET} can be used from the agenda buffer to jump to the diary
  5517. file in order to edit existing diary entries. The @kbd{i} command to
  5518. insert new entries for the current date works in the agenda buffer, as
  5519. well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
  5520. Sunrise/Sunset times, show lunar phases and to convert to other
  5521. calendars, respectively. @kbd{c} can be used to switch back and forth
  5522. between calendar and agenda.
  5523. If you are using the diary only for sexp entries and holidays, it is
  5524. faster to not use the above setting, but instead to copy or even move
  5525. the entries into an Org file. Org mode evaluates diary-style sexp
  5526. entries, and does it faster because there is no overhead for first
  5527. creating the diary display. Note that the sexp entries must start at
  5528. the left margin, no whitespace is allowed before them. For example,
  5529. the following segment of an Org file will be processed and entries
  5530. will be made in the agenda:
  5531. @example
  5532. * Birthdays and similar stuff
  5533. #+CATEGORY: Holiday
  5534. %%(org-calendar-holiday) ; special function for holiday names
  5535. #+CATEGORY: Ann
  5536. %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
  5537. %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
  5538. @end example
  5539. @subsubheading Anniversaries from BBDB
  5540. @cindex BBDB, anniversaries
  5541. @cindex anniversaries, from BBDB
  5542. If you are using the Big Brothers Database to store your contacts, you will
  5543. very likely prefer to store anniversaries in BBDB rather than in a
  5544. separate Org or diary file. Org supports this and will show BBDB
  5545. anniversaries as part of the agenda. All you need to do is to add the
  5546. following to one your your agenda files:
  5547. @example
  5548. * Anniversaries
  5549. :PROPERTIES:
  5550. :CATEGORY: Anniv
  5551. :END
  5552. %%(org-bbdb-anniversaries)
  5553. @end example
  5554. You can then go ahead and define anniversaries for a BBDB record. Basically,
  5555. you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
  5556. record and then add the date in the format @code{YYYY-MM-DD}, followed by a
  5557. space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
  5558. a format string). If you omit the class, it will default to @samp{birthday}.
  5559. Here are a few examples, the header for the file @file{org-bbdb.el} contains
  5560. more detailed information.
  5561. @example
  5562. 1973-06-22
  5563. 1955-08-02 wedding
  5564. 2008-04-14 %s released version 6.01 of org-mode, %d years ago
  5565. @end example
  5566. After a change to BBDB, or for the first agenda display during an Emacs
  5567. session, the agenda display will suffer a short delay as Org updates its
  5568. hash with anniversaries. However, from then on things will be very fast---much
  5569. faster in fact than a long list of @samp{%%(diary-anniversary)} entries
  5570. in an Org or Diary file.
  5571. @subsubheading Appointment reminders
  5572. @cindex @file{appt.el}
  5573. @cindex appointment reminders
  5574. Org can interact with Emacs appointments notification facility. To add all
  5575. the appointments of your agenda files, use the command
  5576. @code{org-agenda-to-appt}. This command also lets you filter through the
  5577. list of your appointments and add only those belonging to a specific category
  5578. or matching a regular expression. See the docstring for details.
  5579. @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
  5580. @subsection The global TODO list
  5581. @cindex global TODO list
  5582. @cindex TODO list, global
  5583. The global TODO list contains all unfinished TODO items formatted and
  5584. collected into a single place.
  5585. @table @kbd
  5586. @kindex C-c a t
  5587. @item C-c a t
  5588. Show the global TODO list. This collects the TODO items from all
  5589. agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
  5590. @code{agenda-mode}, so there are commands to examine and manipulate
  5591. the TODO entries directly from that buffer (@pxref{Agenda commands}).
  5592. @kindex C-c a T
  5593. @item C-c a T
  5594. @cindex TODO keyword matching
  5595. @vindex org-todo-keywords
  5596. Like the above, but allows selection of a specific TODO keyword. You
  5597. can also do this by specifying a prefix argument to @kbd{C-c a t}. With
  5598. a @kbd{C-u} prefix you are prompted for a keyword, and you may also
  5599. specify several keywords by separating them with @samp{|} as the boolean OR
  5600. operator. With a numeric prefix, the nth keyword in
  5601. @code{org-todo-keywords} is selected.
  5602. @kindex r
  5603. The @kbd{r} key in the agenda buffer regenerates it, and you can give
  5604. a prefix argument to this command to change the selected TODO keyword,
  5605. for example @kbd{3 r}. If you often need a search for a specific
  5606. keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
  5607. Matching specific TODO keywords can also be done as part of a tags
  5608. search (@pxref{Tag searches}).
  5609. @end table
  5610. Remote editing of TODO items means that you can change the state of a
  5611. TODO entry with a single key press. The commands available in the
  5612. TODO list are described in @ref{Agenda commands}.
  5613. @cindex sublevels, inclusion into TODO list
  5614. Normally the global TODO list simply shows all headlines with TODO
  5615. keywords. This list can become very long. There are two ways to keep
  5616. it more compact:
  5617. @itemize @minus
  5618. @item
  5619. @vindex org-agenda-todo-ignore-scheduled
  5620. @vindex org-agenda-todo-ignore-deadlines
  5621. @vindex org-agenda-todo-ignore-with-date
  5622. Some people view a TODO item that has been @emph{scheduled} for execution or
  5623. have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
  5624. Configure the variables @code{org-agenda-todo-ignore-scheduled},
  5625. @code{org-agenda-todo-ignore-deadlines}, and/or
  5626. @code{org-agenda-todo-ignore-with-date} to exclude such items from the
  5627. global TODO list.
  5628. @item
  5629. @vindex org-agenda-todo-list-sublevels
  5630. TODO items may have sublevels to break up the task into subtasks. In
  5631. such cases it may be enough to list only the highest level TODO headline
  5632. and omit the sublevels from the global list. Configure the variable
  5633. @code{org-agenda-todo-list-sublevels} to get this behavior.
  5634. @end itemize
  5635. @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
  5636. @subsection Matching tags and properties
  5637. @cindex matching, of tags
  5638. @cindex matching, of properties
  5639. @cindex tags view
  5640. @cindex match view
  5641. If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
  5642. or have properties (@pxref{Properties and Columns}), you can select headlines
  5643. based on this metadata and collect them into an agenda buffer. The match
  5644. syntax described here also applies when creating sparse trees with @kbd{C-c /
  5645. m}.
  5646. @table @kbd
  5647. @kindex C-c a m
  5648. @item C-c a m
  5649. Produce a list of all headlines that match a given set of tags. The
  5650. command prompts for a selection criterion, which is a boolean logic
  5651. expression with tags, like @samp{+work+urgent-withboss} or
  5652. @samp{work|home} (@pxref{Tags}). If you often need a specific search,
  5653. define a custom command for it (@pxref{Agenda dispatcher}).
  5654. @kindex C-c a M
  5655. @item C-c a M
  5656. @vindex org-tags-match-list-sublevels
  5657. @vindex org-agenda-tags-todo-honor-ignore-options
  5658. Like @kbd{C-c a m}, but only select headlines that are also TODO items and
  5659. force checking subitems (see variable @code{org-tags-match-list-sublevels}).
  5660. To exclude scheduled/deadline items, see the variable
  5661. @code{org-agenda-tags-todo-honor-ignore-options}. Matching specific TODO
  5662. keywords together with a tags match is also possible, see @ref{Tag searches}.
  5663. @end table
  5664. The commands available in the tags list are described in @ref{Agenda
  5665. commands}.
  5666. @subsubheading Match syntax
  5667. @cindex Boolean logic, for tag/property searches
  5668. A search string can use Boolean operators @samp{&} for AND and @samp{|} for
  5669. OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
  5670. not implemented. Each element in the search is either a tag, a regular
  5671. expression matching tags, or an expression like @code{PROPERTY OPERATOR
  5672. VALUE} with a comparison operator, accessing a property value. Each element
  5673. may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
  5674. sugar for positive selection. The AND operator @samp{&} is optional when
  5675. @samp{+} or @samp{-} is present. Here are some examples, using only tags.
  5676. @table @samp
  5677. @item +work-boss
  5678. Select headlines tagged @samp{:work:}, but discard those also tagged
  5679. @samp{:boss:}.
  5680. @item work|laptop
  5681. Selects lines tagged @samp{:work:} or @samp{:laptop:}.
  5682. @item work|laptop+night
  5683. Like before, but require the @samp{:laptop:} lines to be tagged also
  5684. @samp{:night:}.
  5685. @end table
  5686. @cindex regular expressions, with tags search
  5687. Instead of a tag, you may also specify a regular expression enclosed in curly
  5688. braces. For example,
  5689. @samp{work+@{^boss.*@}} matches headlines that contain the tag
  5690. @samp{:work:} and any tag @i{starting} with @samp{boss}.
  5691. @cindex TODO keyword matching, with tags search
  5692. @cindex level, require for tags/property match
  5693. @cindex category, require for tags/property match
  5694. @vindex org-odd-levels-only
  5695. You may also test for properties (@pxref{Properties and Columns}) at the same
  5696. time as matching tags. The properties may be real properties, or special
  5697. properties that represent other metadata (@pxref{Special properties}). For
  5698. example, the ``property'' @code{TODO} represents the TODO keyword of the
  5699. entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
  5700. So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
  5701. that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
  5702. DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
  5703. count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
  5704. Here are more examples:
  5705. @table @samp
  5706. @item work+TODO="WAITING"
  5707. Select @samp{:work:}-tagged TODO lines with the specific TODO
  5708. keyword @samp{WAITING}.
  5709. @item work+TODO="WAITING"|home+TODO="WAITING"
  5710. Waiting tasks both at work and at home.
  5711. @end table
  5712. When matching properties, a number of different operators can be used to test
  5713. the value of a property. Here is a complex example:
  5714. @example
  5715. +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
  5716. +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
  5717. @end example
  5718. @noindent
  5719. The type of comparison will depend on how the comparison value is written:
  5720. @itemize @minus
  5721. @item
  5722. If the comparison value is a plain number, a numerical comparison is done,
  5723. and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
  5724. @samp{>=}, and @samp{<>}.
  5725. @item
  5726. If the comparison value is enclosed in double-quotes,
  5727. a string comparison is done, and the same operators are allowed.
  5728. @item
  5729. If the comparison value is enclosed in double-quotes @emph{and} angular
  5730. brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
  5731. assumed to be date/time specifications in the standard Org way, and the
  5732. comparison will be done accordingly. Special values that will be recognized
  5733. are @code{"<now>"} for now (including time), and @code{"<today>"}, and
  5734. @code{"<tomorrow>"} for these days at 0:00 hours, @ie without a time
  5735. specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
  5736. @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
  5737. respectively, can be used.
  5738. @item
  5739. If the comparison value is enclosed
  5740. in curly braces, a regexp match is performed, with @samp{=} meaning that the
  5741. regexp matches the property value, and @samp{<>} meaning that it does not
  5742. match.
  5743. @end itemize
  5744. So the search string in the example finds entries tagged @samp{:work:} but
  5745. not @samp{:boss:}, which also have a priority value @samp{A}, a
  5746. @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
  5747. property that is numerically smaller than 2, a @samp{:With:} property that is
  5748. matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
  5749. on or after October 11, 2008.
  5750. Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
  5751. other properties will slow down the search. However, once you have paid the
  5752. price by accessing one property, testing additional properties is cheap
  5753. again.
  5754. You can configure Org mode to use property inheritance during a search, but
  5755. beware that this can slow down searches considerably. See @ref{Property
  5756. inheritance}, for details.
  5757. For backward compatibility, and also for typing speed, there is also a
  5758. different way to test TODO states in a search. For this, terminate the
  5759. tags/property part of the search string (which may include several terms
  5760. connected with @samp{|}) with a @samp{/} and then specify a Boolean
  5761. expression just for TODO keywords. The syntax is then similar to that for
  5762. tags, but should be applied with care: For example, a positive
  5763. selection on several TODO keywords cannot meaningfully be combined with
  5764. boolean AND. However, @emph{negative selection} combined with AND can be
  5765. meaningful. To make sure that only lines are checked that actually have any
  5766. TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, or equivalently
  5767. start the TODO part after the slash with @samp{!}. Examples:
  5768. @table @samp
  5769. @item work/WAITING
  5770. Same as @samp{work+TODO="WAITING"}
  5771. @item work/!-WAITING-NEXT
  5772. Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
  5773. nor @samp{NEXT}
  5774. @item work/!+WAITING|+NEXT
  5775. Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
  5776. @samp{NEXT}.
  5777. @end table
  5778. @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
  5779. @subsection Timeline for a single file
  5780. @cindex timeline, single file
  5781. @cindex time-sorted view
  5782. The timeline summarizes all time-stamped items from a single Org mode
  5783. file in a @emph{time-sorted view}. The main purpose of this command is
  5784. to give an overview over events in a project.
  5785. @table @kbd
  5786. @kindex C-c a L
  5787. @item C-c a L
  5788. Show a time-sorted view of the Org file, with all time-stamped items.
  5789. When called with a @kbd{C-u} prefix, all unfinished TODO entries
  5790. (scheduled or not) are also listed under the current date.
  5791. @end table
  5792. @noindent
  5793. The commands available in the timeline buffer are listed in
  5794. @ref{Agenda commands}.
  5795. @node Keyword search, Stuck projects, Timeline, Built-in agenda views
  5796. @subsection Keyword search
  5797. @cindex keyword search
  5798. @cindex searching, for keywords
  5799. This agenda view is a general text search facility for Org mode entries.
  5800. It is particularly useful to find notes.
  5801. @table @kbd
  5802. @kindex C-c a s
  5803. @item C-c a s
  5804. This is a special search that lets you select entries by keywords or
  5805. regular expression, using a boolean logic. For example, the search
  5806. string
  5807. @example
  5808. +computer +wifi -ethernet -@{8\.11[bg]@}
  5809. @end example
  5810. @noindent
  5811. will search for note entries that contain the keywords @code{computer}
  5812. and @code{wifi}, but not the keyword @code{ethernet}, and which are also
  5813. not matched by the regular expression @code{8\.11[bg]}, meaning to
  5814. exclude both 8.11b and 8.11g.
  5815. @vindex org-agenda-text-search-extra-files
  5816. Note that in addition to the agenda files, this command will also search
  5817. the files listed in @code{org-agenda-text-search-extra-files}.
  5818. @end table
  5819. @node Stuck projects, , Keyword search, Built-in agenda views
  5820. @subsection Stuck projects
  5821. If you are following a system like David Allen's GTD to organize your
  5822. work, one of the ``duties'' you have is a regular review to make sure
  5823. that all projects move along. A @emph{stuck} project is a project that
  5824. has no defined next actions, so it will never show up in the TODO lists
  5825. Org mode produces. During the review, you need to identify such
  5826. projects and define next actions for them.
  5827. @table @kbd
  5828. @kindex C-c a #
  5829. @item C-c a #
  5830. List projects that are stuck.
  5831. @kindex C-c a !
  5832. @item C-c a !
  5833. @vindex org-stuck-projects
  5834. Customize the variable @code{org-stuck-projects} to define what a stuck
  5835. project is and how to find it.
  5836. @end table
  5837. You almost certainly will have to configure this view before it will
  5838. work for you. The built-in default assumes that all your projects are
  5839. level-2 headlines, and that a project is not stuck if it has at least
  5840. one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
  5841. Let's assume that you, in your own way of using Org mode, identify
  5842. projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
  5843. indicate a project that should not be considered yet. Let's further
  5844. assume that the TODO keyword DONE marks finished projects, and that NEXT
  5845. and TODO indicate next actions. The tag @@SHOP indicates shopping and
  5846. is a next action even without the NEXT tag. Finally, if the project
  5847. contains the special word IGNORE anywhere, it should not be listed
  5848. either. In this case you would start by identifying eligible projects
  5849. with a tags/todo match@footnote{@xref{Tag searches}.}
  5850. @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
  5851. IGNORE in the subtree to identify projects that are not stuck. The
  5852. correct customization for this is
  5853. @lisp
  5854. (setq org-stuck-projects
  5855. '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
  5856. "\\<IGNORE\\>"))
  5857. @end lisp
  5858. Note that if a project is identified as non-stuck, the subtree of this entry
  5859. will still be searched for stuck projets.
  5860. @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
  5861. @section Presentation and sorting
  5862. @cindex presentation, of agenda items
  5863. @vindex org-agenda-prefix-format
  5864. Before displaying items in an agenda view, Org mode visually prepares
  5865. the items and sorts them. Each item occupies a single line. The line
  5866. starts with a @emph{prefix} that contains the @emph{category}
  5867. (@pxref{Categories}) of the item and other important information. You can
  5868. customize the prefix using the option @code{org-agenda-prefix-format}.
  5869. The prefix is followed by a cleaned-up version of the outline headline
  5870. associated with the item.
  5871. @menu
  5872. * Categories:: Not all tasks are equal
  5873. * Time-of-day specifications:: How the agenda knows the time
  5874. * Sorting of agenda items:: The order of things
  5875. @end menu
  5876. @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
  5877. @subsection Categories
  5878. @cindex category
  5879. The category is a broad label assigned to each agenda item. By default,
  5880. the category is simply derived from the file name, but you can also
  5881. specify it with a special line in the buffer, like this@footnote{For
  5882. backward compatibility, the following also works: If there are several
  5883. such lines in a file, each specifies the category for the text below it.
  5884. The first category also applies to any text before the first CATEGORY
  5885. line. However, using this method is @emph{strongly} deprecated as it is
  5886. incompatible with the outline structure of the document. The correct
  5887. method for setting multiple categories in a buffer is using a
  5888. property.}:
  5889. @example
  5890. #+CATEGORY: Thesis
  5891. @end example
  5892. @noindent
  5893. @cindex property, CATEGORY
  5894. If you would like to have a special CATEGORY for a single entry or a
  5895. (sub)tree, give the entry a @code{:CATEGORY:} property with the
  5896. special category you want to apply as the value.
  5897. @noindent
  5898. The display in the agenda buffer looks best if the category is not
  5899. longer than 10 characters.
  5900. @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
  5901. @subsection Time-of-day specifications
  5902. @cindex time-of-day specification
  5903. Org mode checks each agenda item for a time-of-day specification. The
  5904. time can be part of the timestamp that triggered inclusion into the
  5905. agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
  5906. ranges can be specified with two timestamps, like
  5907. @c
  5908. @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
  5909. In the headline of the entry itself, a time(range) may also appear as
  5910. plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
  5911. integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
  5912. specifications in diary entries are recognized as well.
  5913. For agenda display, Org mode extracts the time and displays it in a
  5914. standard 24 hour format as part of the prefix. The example times in
  5915. the previous paragraphs would end up in the agenda like this:
  5916. @example
  5917. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  5918. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  5919. 19:00...... The Vogon reads his poem
  5920. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  5921. @end example
  5922. @cindex time grid
  5923. If the agenda is in single-day mode, or for the display of today, the
  5924. timed entries are embedded in a time grid, like
  5925. @example
  5926. 8:00...... ------------------
  5927. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  5928. 10:00...... ------------------
  5929. 12:00...... ------------------
  5930. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  5931. 14:00...... ------------------
  5932. 16:00...... ------------------
  5933. 18:00...... ------------------
  5934. 19:00...... The Vogon reads his poem
  5935. 20:00...... ------------------
  5936. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  5937. @end example
  5938. @vindex org-agenda-use-time-grid
  5939. @vindex org-agenda-time-grid
  5940. The time grid can be turned on and off with the variable
  5941. @code{org-agenda-use-time-grid}, and can be configured with
  5942. @code{org-agenda-time-grid}.
  5943. @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
  5944. @subsection Sorting of agenda items
  5945. @cindex sorting, of agenda items
  5946. @cindex priorities, of agenda items
  5947. Before being inserted into a view, the items are sorted. How this is
  5948. done depends on the type of view.
  5949. @itemize @bullet
  5950. @item
  5951. @vindex org-agenda-files
  5952. For the daily/weekly agenda, the items for each day are sorted. The
  5953. default order is to first collect all items containing an explicit
  5954. time-of-day specification. These entries will be shown at the beginning
  5955. of the list, as a @emph{schedule} for the day. After that, items remain
  5956. grouped in categories, in the sequence given by @code{org-agenda-files}.
  5957. Within each category, items are sorted by priority (@pxref{Priorities}),
  5958. which is composed of the base priority (2000 for priority @samp{A}, 1000
  5959. for @samp{B}, and 0 for @samp{C}), plus additional increments for
  5960. overdue scheduled or deadline items.
  5961. @item
  5962. For the TODO list, items remain in the order of categories, but within
  5963. each category, sorting takes place according to priority
  5964. (@pxref{Priorities}). The priority used for sorting derives from the
  5965. priority cookie, with additions depending on how close an item is to its due
  5966. or scheduled date.
  5967. @item
  5968. For tags matches, items are not sorted at all, but just appear in the
  5969. sequence in which they are found in the agenda files.
  5970. @end itemize
  5971. @vindex org-agenda-sorting-strategy
  5972. Sorting can be customized using the variable
  5973. @code{org-agenda-sorting-strategy}, and may also include criteria based on
  5974. the estimated effort of an entry (@pxref{Effort estimates}).
  5975. @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
  5976. @section Commands in the agenda buffer
  5977. @cindex commands, in agenda buffer
  5978. Entries in the agenda buffer are linked back to the Org file or diary
  5979. file where they originate. You are not allowed to edit the agenda
  5980. buffer itself, but commands are provided to show and jump to the
  5981. original entry location, and to edit the Org files ``remotely'' from
  5982. the agenda buffer. In this way, all information is stored only once,
  5983. removing the risk that your agenda and note files may diverge.
  5984. Some commands can be executed with mouse clicks on agenda lines. For
  5985. the other commands, the cursor needs to be in the desired line.
  5986. @table @kbd
  5987. @tsubheading{Motion}
  5988. @cindex motion commands in agenda
  5989. @kindex n
  5990. @item n
  5991. Next line (same as @key{up} and @kbd{C-p}).
  5992. @kindex p
  5993. @item p
  5994. Previous line (same as @key{down} and @kbd{C-n}).
  5995. @tsubheading{View/Go to Org file}
  5996. @kindex mouse-3
  5997. @kindex @key{SPC}
  5998. @item mouse-3
  5999. @itemx @key{SPC}
  6000. Display the original location of the item in another window.
  6001. With prefix arg, make sure that the entire entry is made visible in the
  6002. outline, not only the heading.
  6003. @c
  6004. @kindex L
  6005. @item L
  6006. Display original location and recenter that window.
  6007. @c
  6008. @kindex mouse-2
  6009. @kindex mouse-1
  6010. @kindex @key{TAB}
  6011. @item mouse-2
  6012. @itemx mouse-1
  6013. @itemx @key{TAB}
  6014. Go to the original location of the item in another window. Under Emacs
  6015. 22, @kbd{mouse-1} will also works for this.
  6016. @c
  6017. @kindex @key{RET}
  6018. @itemx @key{RET}
  6019. Go to the original location of the item and delete other windows.
  6020. @c
  6021. @kindex f
  6022. @item f
  6023. @vindex org-agenda-start-with-follow-mode
  6024. Toggle Follow mode. In Follow mode, as you move the cursor through
  6025. the agenda buffer, the other window always shows the corresponding
  6026. location in the Org file. The initial setting for this mode in new
  6027. agenda buffers can be set with the variable
  6028. @code{org-agenda-start-with-follow-mode}.
  6029. @c
  6030. @kindex b
  6031. @item b
  6032. Display the entire subtree of the current item in an indirect buffer. With a
  6033. numeric prefix argument N, go up to level N and then take that tree. If N is
  6034. negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
  6035. previously used indirect buffer.
  6036. @c
  6037. @kindex v l
  6038. @kindex l
  6039. @item v l @ @r{or short} @ l
  6040. @vindex org-log-done
  6041. @vindex org-agenda-log-mode-items
  6042. Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
  6043. logging was on (variable @code{org-log-done}) are shown in the agenda, as are
  6044. entries that have been clocked on that day. You can configure the entry
  6045. types that should be included in log mode using the variable
  6046. @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
  6047. all possible logbook entries, including state changes. When called with two
  6048. prefix args @kbd{C-u C-u}, show only logging information, nothing else.
  6049. @c
  6050. @kindex v a
  6051. @kindex v A
  6052. @item v a
  6053. @itemx v A
  6054. Toggle Archives mode. In Archives mode, trees that are marked
  6055. @code{ARCHIVED} are also scanned when producing the agenda. When you use the
  6056. capital @kbd{A}, even all archive files are included. To exit archives mode,
  6057. press @kbd{v a} again.
  6058. @c
  6059. @kindex R
  6060. @item R
  6061. @vindex org-agenda-start-with-clockreport-mode
  6062. Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
  6063. always show a table with the clocked times for the timespan and file scope
  6064. covered by the current agenda view. The initial setting for this mode in new
  6065. agenda buffers can be set with the variable
  6066. @code{org-agenda-start-with-clockreport-mode}.
  6067. @tsubheading{Change display}
  6068. @cindex display changing, in agenda
  6069. @kindex o
  6070. @item o
  6071. Delete other windows.
  6072. @c
  6073. @kindex v d
  6074. @kindex d
  6075. @kindex v w
  6076. @kindex w
  6077. @kindex v m
  6078. @kindex v y
  6079. @item v d @ @r{or short} @ d
  6080. @itemx v w @ @r{or short} @ w
  6081. @itemx v m
  6082. @itemx v y
  6083. Switch to day/week/month/year view. When switching to day or week view,
  6084. this setting becomes the default for subsequent agenda commands. Since
  6085. month and year views are slow to create, they do not become the default.
  6086. A numeric prefix argument may be used to jump directly to a specific day
  6087. of the year, ISO week, month, or year, respectively. For example,
  6088. @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
  6089. setting day, week, or month view, a year may be encoded in the prefix
  6090. argument as well. For example, @kbd{200712 w} will jump to week 12 in
  6091. 2007. If such a year specification has only one or two digits, it will
  6092. be mapped to the interval 1938-2037.
  6093. @c
  6094. @kindex D
  6095. @item D
  6096. Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
  6097. @c
  6098. @kindex G
  6099. @item G
  6100. @vindex org-agenda-use-time-grid
  6101. @vindex org-agenda-time-grid
  6102. Toggle the time grid on and off. See also the variables
  6103. @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
  6104. @c
  6105. @kindex r
  6106. @item r
  6107. Recreate the agenda buffer, for example to reflect the changes after
  6108. modification of the timestamps of items with S-@key{left} and
  6109. @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
  6110. argument is interpreted to create a selective list for a specific TODO
  6111. keyword.
  6112. @kindex g
  6113. @item g
  6114. Same as @kbd{r}.
  6115. @c
  6116. @kindex s
  6117. @kindex C-x C-s
  6118. @item s
  6119. @itemx C-x C-s
  6120. Save all Org buffers in the current Emacs session, and also the locations of
  6121. IDs.
  6122. @c
  6123. @kindex @key{right}
  6124. @item @key{right}
  6125. @vindex org-agenda-ndays
  6126. Display the following @code{org-agenda-ndays} days. For example, if
  6127. the display covers a week, switch to the following week. With prefix
  6128. arg, go forward that many times @code{org-agenda-ndays} days.
  6129. @c
  6130. @kindex @key{left}
  6131. @item @key{left}
  6132. Display the previous dates.
  6133. @c
  6134. @kindex .
  6135. @item .
  6136. Go to today.
  6137. @c
  6138. @kindex j
  6139. @item j
  6140. Prompt for a date and go there.
  6141. @c
  6142. @kindex C-c C-x C-c
  6143. @item C-c C-x C-c
  6144. @vindex org-columns-default-format
  6145. Invoke column view (@pxref{Column view}) in the agenda buffer. The column
  6146. view format is taken from the entry at point, or (if there is no entry at
  6147. point), from the first entry in the agenda view. So whatever the format for
  6148. that entry would be in the original buffer (taken from a property, from a
  6149. @code{#+COLUMNS} line, or from the default variable
  6150. @code{org-columns-default-format}), will be used in the agenda.
  6151. @kindex C-c C-x >
  6152. @item C-c C-x >
  6153. Remove the restriction lock on the agenda, if it is currently restricted to a
  6154. file or subtree (@pxref{Agenda files}).
  6155. @tsubheading{Secondary filtering and query editing}
  6156. @cindex filtering, by tag and effort, in agenda
  6157. @cindex tag filtering, in agenda
  6158. @cindex effort filtering, in agenda
  6159. @cindex query editing, in agenda
  6160. @kindex /
  6161. @item /
  6162. @vindex org-agenda-filter-preset
  6163. Filter the current agenda view with respect to a tag and/or effort estimates.
  6164. The difference between this and a custom agenda command is that filtering is
  6165. very fast, so that you can switch quickly between different filters without
  6166. having to recreate the agenda@footnote{Custom commands can preset a filter by
  6167. binding the variable @code{org-agenda-filter-preset} as an option. This
  6168. filter will then be applied to the view and presist as a basic filter through
  6169. refreshes and more secondary filtering.}
  6170. You will be prompted for a tag selection letter. Pressing @key{TAB} at that
  6171. prompt will offer use completion to select a tag (including any tags that do
  6172. not have a selection character). The command then hides all entries that do
  6173. not contain or inherit this tag. When called with prefix arg, remove the
  6174. entries that @emph{do} have the tag. A second @kbd{/} at the prompt will
  6175. turn off the filter and unhide any hidden entries. If the first key you
  6176. press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
  6177. requiring or forbidding the selected additional tag. Instead of pressing
  6178. @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\}
  6179. command.
  6180. @vindex org-sort-agenda-noeffort-is-high
  6181. In order to filter for effort estimates, you should set-up allowed
  6182. efforts globally, for example
  6183. @lisp
  6184. (setq org-global-properties
  6185. '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
  6186. @end lisp
  6187. You can then filter for an effort by first typing an operator, one of
  6188. @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
  6189. estimate in your array of allowed values, where @kbd{0} means the 10th value.
  6190. The filter will then restrict to entries with effort smaller-or-equal, equal,
  6191. or larger-or-equal than the selected value. If the digits 0-9 are not used
  6192. as fast access keys to tags, you can also simply press the index digit
  6193. directly without an operator. In this case, @kbd{<} will be assumed. For
  6194. application of the operator, entries without a defined effort will be treated
  6195. according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
  6196. for tasks without effort definition, press @kbd{?} as the operator.
  6197. @kindex \
  6198. @item \
  6199. Narrow the current agenda filter by an additional condition. When called with
  6200. prefix arg, remove the entries that @emph{do} have the tag, or that do match
  6201. the effort criterion. You can achieve the same effect by pressing @kbd{+} or
  6202. @kbd{-} as the first key after the @kbd{/} command.
  6203. @kindex [
  6204. @kindex ]
  6205. @kindex @{
  6206. @kindex @}
  6207. @item [ ] @{ @}
  6208. In the @i{search view} (@pxref{Keyword search}), these keys add new search
  6209. words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and
  6210. @kbd{@}}) to the query string. The opening bracket/brace will add a positive
  6211. search term prefixed by @samp{+}, indicating that this search term @i{must}
  6212. occur/match in the entry. The closing bracket/brace will add a negative
  6213. search term which @i{must not} occur/match in the entry for it to be
  6214. selected.
  6215. @tsubheading{Remote editing}
  6216. @cindex remote editing, from agenda
  6217. @item 0-9
  6218. Digit argument.
  6219. @c
  6220. @cindex undoing remote-editing events
  6221. @cindex remote editing, undo
  6222. @kindex C-_
  6223. @item C-_
  6224. Undo a change due to a remote editing command. The change is undone
  6225. both in the agenda buffer and in the remote buffer.
  6226. @c
  6227. @kindex t
  6228. @item t
  6229. Change the TODO state of the item, both in the agenda and in the
  6230. original org file.
  6231. @c
  6232. @kindex C-k
  6233. @item C-k
  6234. @vindex org-agenda-confirm-kill
  6235. Delete the current agenda item along with the entire subtree belonging
  6236. to it in the original Org file. If the text to be deleted remotely
  6237. is longer than one line, the kill needs to be confirmed by the user. See
  6238. variable @code{org-agenda-confirm-kill}.
  6239. @c
  6240. @kindex C-c C-w
  6241. @item C-c C-w
  6242. Refile the entry at point.
  6243. @c
  6244. @kindex a
  6245. @item a
  6246. Toggle the ARCHIVE tag for the current headline.
  6247. @c
  6248. @kindex A
  6249. @item A
  6250. Move the subtree corresponding to the current entry to its @emph{archive
  6251. sibling}.
  6252. @c
  6253. @kindex $
  6254. @item $
  6255. Archive the subtree corresponding to the current headline. This means the
  6256. entry will be moved to the configured archive location, most likely a
  6257. different file.
  6258. @c
  6259. @kindex T
  6260. @item T
  6261. @vindex org-agenda-show-inherited-tags
  6262. Show all tags associated with the current item. This is useful if you have
  6263. turned off @code{org-agenda-show-inherited-tags}, but still want to see all
  6264. tags of a headline occasionally.
  6265. @c
  6266. @kindex :
  6267. @item :
  6268. Set tags for the current headline. If there is an active region in the
  6269. agenda, change a tag for all headings in the region.
  6270. @c
  6271. @kindex ,
  6272. @item ,
  6273. Set the priority for the current item. Org mode prompts for the
  6274. priority character. If you reply with @key{SPC}, the priority cookie
  6275. is removed from the entry.
  6276. @c
  6277. @kindex P
  6278. @item P
  6279. Display weighted priority of current item.
  6280. @c
  6281. @kindex +
  6282. @kindex S-@key{up}
  6283. @item +
  6284. @itemx S-@key{up}
  6285. Increase the priority of the current item. The priority is changed in
  6286. the original buffer, but the agenda is not resorted. Use the @kbd{r}
  6287. key for this.
  6288. @c
  6289. @kindex -
  6290. @kindex S-@key{down}
  6291. @item -
  6292. @itemx S-@key{down}
  6293. Decrease the priority of the current item.
  6294. @c
  6295. @kindex z
  6296. @item z
  6297. @vindex org-log-into-drawer
  6298. Add a note to the entry. This note will be recorded, and then files to the
  6299. same location where state change notes are put. Depending on
  6300. @code{org-log-into-drawer}, this maybe inside a drawer.
  6301. @c
  6302. @kindex C-c C-a
  6303. @item C-c C-a
  6304. Dispatcher for all command related to attachments.
  6305. @c
  6306. @kindex C-c C-s
  6307. @item C-c C-s
  6308. Schedule this item
  6309. @c
  6310. @kindex C-c C-d
  6311. @item C-c C-d
  6312. Set a deadline for this item.
  6313. @c
  6314. @kindex k
  6315. @item k
  6316. Agenda actions, to set dates for selected items to the cursor date.
  6317. This command also works in the calendar! The command prompts for an
  6318. additional key:
  6319. @example
  6320. m @r{Mark the entry at point for action. You can also make entries}
  6321. @r{in Org files with @kbd{C-c C-x C-k}.}
  6322. d @r{Set the deadline of the marked entry to the date at point.}
  6323. s @r{Schedule the marked entry at the date at point.}
  6324. r @r{Call @code{org-remember} with the cursor date as default date.}
  6325. @end example
  6326. @noindent
  6327. Press @kbd{r} afterward to refresh the agenda and see the effect of the
  6328. command.
  6329. @c
  6330. @kindex S-@key{right}
  6331. @item S-@key{right}
  6332. Change the timestamp associated with the current line by one day into the
  6333. future. With a numeric prefix argument, change it by that many days. For
  6334. example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
  6335. @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
  6336. command, it will continue to change hours even without the prefix arg. With
  6337. a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
  6338. is changed in the original Org file, but the change is not directly reflected
  6339. in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
  6340. @c
  6341. @kindex S-@key{left}
  6342. @item S-@key{left}
  6343. Change the timestamp associated with the current line by one day
  6344. into the past.
  6345. @c
  6346. @kindex >
  6347. @item >
  6348. Change the timestamp associated with the current line to today.
  6349. The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
  6350. on my keyboard.
  6351. @c
  6352. @kindex I
  6353. @item I
  6354. Start the clock on the current item. If a clock is running already, it
  6355. is stopped first.
  6356. @c
  6357. @kindex O
  6358. @item O
  6359. Stop the previously started clock.
  6360. @c
  6361. @kindex X
  6362. @item X
  6363. Cancel the currently running clock.
  6364. @kindex J
  6365. @item J
  6366. Jump to the running clock in another window.
  6367. @tsubheading{Bulk remote editing selected entries}
  6368. @cindex remote editing, bulk, from agenda
  6369. @kindex m
  6370. @item s
  6371. Mark the entry at point for bulk action.
  6372. @kindex u
  6373. @item u
  6374. Unmark entry for bulk action.
  6375. @kindex U
  6376. @item U
  6377. Unmark all marked entries for bulk action.
  6378. @kindex B
  6379. @item B
  6380. Bulk action: Act on all marked entries in the agenda. This will prompt for
  6381. another key to select the action to be applied:
  6382. @example
  6383. r @r{Prompt for a single refile target and move all entries. The entries}
  6384. @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.}
  6385. $ @r{Archive all selected entries.}
  6386. A @r{Archive entries by moving them to their respective archive siblings.}
  6387. t @r{Change TODO state. This prompts for a single TODO keyword and}
  6388. @r{changes the state of all selected entries, bypassing blocking and}
  6389. @r{suppressing logging notes (but not time stamps).}
  6390. + @r{Add a tag to all selected entries.}
  6391. - @r{Remove a tag from all selected entries.}
  6392. s @r{Schedule all items to a new date. To shift existing schedule dates}
  6393. @r{by a fixed number of days, use something starting with double plus}
  6394. @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
  6395. d @r{Set deadline to a specific date.}
  6396. @end example
  6397. @tsubheading{Calendar commands}
  6398. @cindex calendar commands, from agenda
  6399. @kindex c
  6400. @item c
  6401. Open the Emacs calendar and move to the date at the agenda cursor.
  6402. @c
  6403. @item c
  6404. When in the calendar, compute and show the Org mode agenda for the
  6405. date at the cursor.
  6406. @c
  6407. @cindex diary entries, creating from agenda
  6408. @kindex i
  6409. @item i
  6410. Insert a new entry into the diary. Prompts for the type of entry
  6411. (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
  6412. entry in the diary, just as @kbd{i d}, etc., would do in the calendar.
  6413. The date is taken from the cursor position.
  6414. @c
  6415. @kindex M
  6416. @item M
  6417. Show the phases of the moon for the three months around current date.
  6418. @c
  6419. @kindex S
  6420. @item S
  6421. Show sunrise and sunset times. The geographical location must be set
  6422. with calendar variables, see the documentation for the Emacs calendar.
  6423. @c
  6424. @kindex C
  6425. @item C
  6426. Convert the date at cursor into many other cultural and historic
  6427. calendars.
  6428. @c
  6429. @kindex H
  6430. @item H
  6431. Show holidays for three months around the cursor date.
  6432. @item M-x org-export-icalendar-combine-agenda-files
  6433. Export a single iCalendar file containing entries from all agenda files.
  6434. This is a globally available command, and also available in the agenda menu.
  6435. @tsubheading{Exporting to a file}
  6436. @kindex C-x C-w
  6437. @item C-x C-w
  6438. @cindex exporting agenda views
  6439. @cindex agenda views, exporting
  6440. @vindex org-agenda-exporter-settings
  6441. Write the agenda view to a file. Depending on the extension of the selected
  6442. file name, the view will be exported as HTML (extension @file{.html} or
  6443. @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
  6444. or plain text (any other extension). When called with a @kbd{C-u} prefix
  6445. argument, immediately open the newly created file. Use the variable
  6446. @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
  6447. for @file{htmlize} to be used during export.
  6448. @tsubheading{Quit and Exit}
  6449. @kindex q
  6450. @item q
  6451. Quit agenda, remove the agenda buffer.
  6452. @c
  6453. @kindex x
  6454. @cindex agenda files, removing buffers
  6455. @item x
  6456. Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
  6457. for the compilation of the agenda. Buffers created by the user to
  6458. visit Org files will not be removed.
  6459. @end table
  6460. @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
  6461. @section Custom agenda views
  6462. @cindex custom agenda views
  6463. @cindex agenda views, custom
  6464. Custom agenda commands serve two purposes: to store and quickly access
  6465. frequently used TODO and tags searches, and to create special composite
  6466. agenda buffers. Custom agenda commands will be accessible through the
  6467. dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
  6468. @menu
  6469. * Storing searches:: Type once, use often
  6470. * Block agenda:: All the stuff you need in a single buffer
  6471. * Setting Options:: Changing the rules
  6472. @end menu
  6473. @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
  6474. @subsection Storing searches
  6475. The first application of custom searches is the definition of keyboard
  6476. shortcuts for frequently used searches, either creating an agenda
  6477. buffer, or a sparse tree (the latter covering of course only the current
  6478. buffer).
  6479. @kindex C-c a C
  6480. @vindex org-agenda-custom-commands
  6481. Custom commands are configured in the variable
  6482. @code{org-agenda-custom-commands}. You can customize this variable, for
  6483. example by pressing @kbd{C-c a C}. You can also directly set it with
  6484. Emacs Lisp in @file{.emacs}. The following example contains all valid
  6485. search types:
  6486. @lisp
  6487. @group
  6488. (setq org-agenda-custom-commands
  6489. '(("w" todo "WAITING")
  6490. ("W" todo-tree "WAITING")
  6491. ("u" tags "+boss-urgent")
  6492. ("v" tags-todo "+boss-urgent")
  6493. ("U" tags-tree "+boss-urgent")
  6494. ("f" occur-tree "\\<FIXME\\>")
  6495. ("h" . "HOME+Name tags searches") ; description for "h" prefix
  6496. ("hl" tags "+home+Lisa")
  6497. ("hp" tags "+home+Peter")
  6498. ("hk" tags "+home+Kim")))
  6499. @end group
  6500. @end lisp
  6501. @noindent
  6502. The initial string in each entry defines the keys you have to press
  6503. after the dispatcher command @kbd{C-c a} in order to access the command.
  6504. Usually this will be just a single character, but if you have many
  6505. similar commands, you can also define two-letter combinations where the
  6506. first character is the same in several combinations and serves as a
  6507. prefix key@footnote{You can provide a description for a prefix key by
  6508. inserting a cons cell with the prefix and the description.}. The second
  6509. parameter is the search type, followed by the string or regular
  6510. expression to be used for the matching. The example above will
  6511. therefore define:
  6512. @table @kbd
  6513. @item C-c a w
  6514. as a global search for TODO entries with @samp{WAITING} as the TODO
  6515. keyword
  6516. @item C-c a W
  6517. as the same search, but only in the current buffer and displaying the
  6518. results as a sparse tree
  6519. @item C-c a u
  6520. as a global tags search for headlines marked @samp{:boss:} but not
  6521. @samp{:urgent:}
  6522. @item C-c a v
  6523. as the same search as @kbd{C-c a u}, but limiting the search to
  6524. headlines that are also TODO items
  6525. @item C-c a U
  6526. as the same search as @kbd{C-c a u}, but only in the current buffer and
  6527. displaying the result as a sparse tree
  6528. @item C-c a f
  6529. to create a sparse tree (again: current buffer only) with all entries
  6530. containing the word @samp{FIXME}
  6531. @item C-c a h
  6532. as a prefix command for a HOME tags search where you have to press an
  6533. additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
  6534. Peter, or Kim) as additional tag to match.
  6535. @end table
  6536. @node Block agenda, Setting Options, Storing searches, Custom agenda views
  6537. @subsection Block agenda
  6538. @cindex block agenda
  6539. @cindex agenda, with block views
  6540. Another possibility is the construction of agenda views that comprise
  6541. the results of @emph{several} commands, each of which creates a block in
  6542. the agenda buffer. The available commands include @code{agenda} for the
  6543. daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
  6544. for the global TODO list (as constructed with @kbd{C-c a t}), and the
  6545. matching commands discussed above: @code{todo}, @code{tags}, and
  6546. @code{tags-todo}. Here are two examples:
  6547. @lisp
  6548. @group
  6549. (setq org-agenda-custom-commands
  6550. '(("h" "Agenda and Home-related tasks"
  6551. ((agenda "")
  6552. (tags-todo "home")
  6553. (tags "garden")))
  6554. ("o" "Agenda and Office-related tasks"
  6555. ((agenda "")
  6556. (tags-todo "work")
  6557. (tags "office")))))
  6558. @end group
  6559. @end lisp
  6560. @noindent
  6561. This will define @kbd{C-c a h} to create a multi-block view for stuff
  6562. you need to attend to at home. The resulting agenda buffer will contain
  6563. your agenda for the current week, all TODO items that carry the tag
  6564. @samp{home}, and also all lines tagged with @samp{garden}. Finally the
  6565. command @kbd{C-c a o} provides a similar view for office tasks.
  6566. @node Setting Options, , Block agenda, Custom agenda views
  6567. @subsection Setting options for custom commands
  6568. @cindex options, for custom agenda views
  6569. @vindex org-agenda-custom-commands
  6570. Org mode contains a number of variables regulating agenda construction
  6571. and display. The global variables define the behavior for all agenda
  6572. commands, including the custom commands. However, if you want to change
  6573. some settings just for a single custom view, you can do so. Setting
  6574. options requires inserting a list of variable names and values at the
  6575. right spot in @code{org-agenda-custom-commands}. For example:
  6576. @lisp
  6577. @group
  6578. (setq org-agenda-custom-commands
  6579. '(("w" todo "WAITING"
  6580. ((org-agenda-sorting-strategy '(priority-down))
  6581. (org-agenda-prefix-format " Mixed: ")))
  6582. ("U" tags-tree "+boss-urgent"
  6583. ((org-show-following-heading nil)
  6584. (org-show-hierarchy-above nil)))
  6585. ("N" search ""
  6586. ((org-agenda-files '("~org/notes.org"))
  6587. (org-agenda-text-search-extra-files nil)))))
  6588. @end group
  6589. @end lisp
  6590. @noindent
  6591. Now the @kbd{C-c a w} command will sort the collected entries only by
  6592. priority, and the prefix format is modified to just say @samp{ Mixed: }
  6593. instead of giving the category of the entry. The sparse tags tree of
  6594. @kbd{C-c a U} will now turn out ultra-compact, because neither the
  6595. headline hierarchy above the match, nor the headline following the match
  6596. will be shown. The command @kbd{C-c a N} will do a text search limited
  6597. to only a single file.
  6598. @vindex org-agenda-custom-commands
  6599. For command sets creating a block agenda,
  6600. @code{org-agenda-custom-commands} has two separate spots for setting
  6601. options. You can add options that should be valid for just a single
  6602. command in the set, and options that should be valid for all commands in
  6603. the set. The former are just added to the command entry, the latter
  6604. must come after the list of command entries. Going back to the block
  6605. agenda example (@pxref{Block agenda}), let's change the sorting strategy
  6606. for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
  6607. the results for GARDEN tags query in the opposite order,
  6608. @code{priority-up}. This would look like this:
  6609. @lisp
  6610. @group
  6611. (setq org-agenda-custom-commands
  6612. '(("h" "Agenda and Home-related tasks"
  6613. ((agenda)
  6614. (tags-todo "home")
  6615. (tags "garden"
  6616. ((org-agenda-sorting-strategy '(priority-up)))))
  6617. ((org-agenda-sorting-strategy '(priority-down))))
  6618. ("o" "Agenda and Office-related tasks"
  6619. ((agenda)
  6620. (tags-todo "work")
  6621. (tags "office")))))
  6622. @end group
  6623. @end lisp
  6624. As you see, the values and parentheses setting is a little complex.
  6625. When in doubt, use the customize interface to set this variable---it
  6626. fully supports its structure. Just one caveat: When setting options in
  6627. this interface, the @emph{values} are just Lisp expressions. So if the
  6628. value is a string, you need to add the double-quotes around the value
  6629. yourself.
  6630. @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
  6631. @section Exporting Agenda Views
  6632. @cindex agenda views, exporting
  6633. If you are away from your computer, it can be very useful to have a printed
  6634. version of some agenda views to carry around. Org mode can export custom
  6635. agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
  6636. @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
  6637. ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
  6638. a PDF file with also create the postscript file.}, and iCalendar files. If
  6639. you want to do this only occasionally, use the command
  6640. @table @kbd
  6641. @kindex C-x C-w
  6642. @item C-x C-w
  6643. @cindex exporting agenda views
  6644. @cindex agenda views, exporting
  6645. @vindex org-agenda-exporter-settings
  6646. Write the agenda view to a file. Depending on the extension of the
  6647. selected file name, the view will be exported as HTML (extension
  6648. @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
  6649. iCalendar (extension @file{.ics}), or plain text (any other extension).
  6650. Use the variable @code{org-agenda-exporter-settings} to
  6651. set options for @file{ps-print} and for @file{htmlize} to be used during
  6652. export, for example
  6653. @vindex org-agenda-add-entry-text-maxlines
  6654. @vindex htmlize-output-type
  6655. @vindex ps-number-of-columns
  6656. @vindex ps-landscape-mode
  6657. @lisp
  6658. (setq org-agenda-exporter-settings
  6659. '((ps-number-of-columns 2)
  6660. (ps-landscape-mode t)
  6661. (org-agenda-add-entry-text-maxlines 5)
  6662. (htmlize-output-type 'css)))
  6663. @end lisp
  6664. @end table
  6665. If you need to export certain agenda views frequently, you can associate
  6666. any custom agenda command with a list of output file names
  6667. @footnote{If you want to store standard views like the weekly agenda
  6668. or the global TODO list as well, you need to define custom commands for
  6669. them in order to be able to specify file names.}. Here is an example
  6670. that first defines custom commands for the agenda and the global
  6671. TODO list, together with a number of files to which to export them.
  6672. Then we define two block agenda commands and specify file names for them
  6673. as well. File names can be relative to the current working directory,
  6674. or absolute.
  6675. @lisp
  6676. @group
  6677. (setq org-agenda-custom-commands
  6678. '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
  6679. ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
  6680. ("h" "Agenda and Home-related tasks"
  6681. ((agenda "")
  6682. (tags-todo "home")
  6683. (tags "garden"))
  6684. nil
  6685. ("~/views/home.html"))
  6686. ("o" "Agenda and Office-related tasks"
  6687. ((agenda)
  6688. (tags-todo "work")
  6689. (tags "office"))
  6690. nil
  6691. ("~/views/office.ps" "~/calendars/office.ics"))))
  6692. @end group
  6693. @end lisp
  6694. The extension of the file name determines the type of export. If it is
  6695. @file{.html}, Org mode will use the @file{htmlize.el} package to convert
  6696. the buffer to HTML and save it to this file name. If the extension is
  6697. @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
  6698. Postscript output. If the extension is @file{.ics}, iCalendar export is
  6699. run export over all files that were used to construct the agenda, and
  6700. limit the export to entries listed in the agenda. Any other
  6701. extension produces a plain ASCII file.
  6702. The export files are @emph{not} created when you use one of those
  6703. commands interactively because this might use too much overhead.
  6704. Instead, there is a special command to produce @emph{all} specified
  6705. files in one step:
  6706. @table @kbd
  6707. @kindex C-c a e
  6708. @item C-c a e
  6709. Export all agenda views that have export file names associated with
  6710. them.
  6711. @end table
  6712. You can use the options section of the custom agenda commands to also
  6713. set options for the export commands. For example:
  6714. @lisp
  6715. (setq org-agenda-custom-commands
  6716. '(("X" agenda ""
  6717. ((ps-number-of-columns 2)
  6718. (ps-landscape-mode t)
  6719. (org-agenda-prefix-format " [ ] ")
  6720. (org-agenda-with-colors nil)
  6721. (org-agenda-remove-tags t))
  6722. ("theagenda.ps"))))
  6723. @end lisp
  6724. @noindent
  6725. This command sets two options for the Postscript exporter, to make it
  6726. print in two columns in landscape format---the resulting page can be cut
  6727. in two and then used in a paper agenda. The remaining settings modify
  6728. the agenda prefix to omit category and scheduling information, and
  6729. instead include a checkbox to check off items. We also remove the tags
  6730. to make the lines compact, and we don't want to use colors for the
  6731. black-and-white printer. Settings specified in
  6732. @code{org-agenda-exporter-settings} will also apply, but the settings
  6733. in @code{org-agenda-custom-commands} take precedence.
  6734. @noindent
  6735. From the command line you may also use
  6736. @example
  6737. emacs -f org-batch-store-agenda-views -kill
  6738. @end example
  6739. @noindent
  6740. or, if you need to modify some parameters@footnote{Quoting depends on the
  6741. system you use, please check the FAQ for examples.}
  6742. @example
  6743. emacs -eval '(org-batch-store-agenda-views \
  6744. org-agenda-ndays 30 \
  6745. org-agenda-start-day "2007-11-01" \
  6746. org-agenda-include-diary nil \
  6747. org-agenda-files (quote ("~/org/project.org")))' \
  6748. -kill
  6749. @end example
  6750. @noindent
  6751. which will create the agenda views restricted to the file
  6752. @file{~/org/project.org}, without diary entries and with a 30-day
  6753. extent.
  6754. You can also extract agenda information in a way that allows further
  6755. processing by other programs. See @ref{Extracting agenda information}, for
  6756. more information.
  6757. @node Agenda column view, , Exporting Agenda Views, Agenda Views
  6758. @section Using column view in the agenda
  6759. @cindex column view, in agenda
  6760. @cindex agenda, column view
  6761. Column view (@pxref{Column view}) is normally used to view and edit
  6762. properties embedded in the hierarchical structure of an Org file. It can be
  6763. quite useful to use column view also from the agenda, where entries are
  6764. collected by certain criteria.
  6765. @table @kbd
  6766. @kindex C-c C-x C-c
  6767. @item C-c C-x C-c
  6768. Turn on column view in the agenda.
  6769. @end table
  6770. To understand how to use this properly, it is important to realize that the
  6771. entries in the agenda are no longer in their proper outline environment.
  6772. This causes the following issues:
  6773. @enumerate
  6774. @item
  6775. @vindex org-columns-default-format
  6776. @vindex org-overriding-columns-format
  6777. Org needs to make a decision which @code{COLUMNS} format to use. Since the
  6778. entries in the agenda are collected from different files, and different files
  6779. may have different @code{COLUMNS} formats, this is a non-trivial problem.
  6780. Org first checks if the variable @code{org-overriding-columns-format} is
  6781. currently set, and if so, takes the format from there. Otherwise it takes
  6782. the format associated with the first item in the agenda, or, if that item
  6783. does not have a specific format (defined in a property, or in its file), it
  6784. uses @code{org-columns-default-format}.
  6785. @item
  6786. @cindex property, special, CLOCKSUM
  6787. If any of the columns has a summary type defined (@pxref{Column attributes}),
  6788. turning on column view in the agenda will visit all relevant agenda files and
  6789. make sure that the computations of this property are up to date. This is
  6790. also true for the special @code{CLOCKSUM} property. Org will then sum the
  6791. values displayed in the agenda. In the daily/weekly agenda, the sums will
  6792. cover a single day, in all other views they cover the entire block. It is
  6793. vital to realize that the agenda may show the same entry @emph{twice} (for
  6794. example as scheduled and as a deadline), and it may show two entries from the
  6795. same hierarchy (for example a @emph{parent} and its @emph{child}). In these
  6796. cases, the summation in the agenda will lead to incorrect results because
  6797. some values will count double.
  6798. @item
  6799. When the column view in the agenda shows the @code{CLOCKSUM}, that is always
  6800. the entire clocked time for this item. So even in the daily/weekly agenda,
  6801. the clocksum listed in column view may originate from times outside the
  6802. current view. This has the advantage that you can compare these values with
  6803. a column listing the planned total effort for a task---one of the major
  6804. applications for column view in the agenda. If you want information about
  6805. clocked time in the displayed period use clock table mode (press @kbd{R} in
  6806. the agenda).
  6807. @end enumerate
  6808. @node Embedded LaTeX, Exporting, Agenda Views, Top
  6809. @chapter Embedded La@TeX{}
  6810. @cindex @TeX{} interpretation
  6811. @cindex La@TeX{} interpretation
  6812. Plain ASCII is normally sufficient for almost all note taking. One
  6813. exception, however, are scientific notes which need to be able to contain
  6814. mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
  6815. is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
  6816. features described here as ``La@TeX{}'' are really from @TeX{}, but for
  6817. simplicity I am blurring this distinction.} is widely used to typeset
  6818. scientific documents. Org mode supports embedding La@TeX{} code into its
  6819. files, because many academics are used to reading La@TeX{} source code, and
  6820. because it can be readily processed into images for HTML production.
  6821. It is not necessary to mark La@TeX{} macros and code in any special way.
  6822. If you observe a few conventions, Org mode knows how to find it and what
  6823. to do with it.
  6824. @menu
  6825. * Math symbols:: @TeX{} macros for symbols and Greek letters
  6826. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  6827. * LaTeX fragments:: Complex formulas made easy
  6828. * Processing LaTeX fragments:: Previewing La@TeX{} processing
  6829. * CDLaTeX mode:: Speed up entering of formulas
  6830. @end menu
  6831. @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
  6832. @section Math symbols
  6833. @cindex math symbols
  6834. @cindex @TeX{} macros
  6835. You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
  6836. indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
  6837. for these macros is available, just type @samp{\} and maybe a few letters,
  6838. and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
  6839. code, Org mode allows these macros to be present without surrounding math
  6840. delimiters, for example:
  6841. @example
  6842. Angles are written as Greek letters \alpha, \beta and \gamma.
  6843. @end example
  6844. @noindent
  6845. During HTML export (@pxref{HTML export}), these symbols are translated
  6846. into the proper syntax for HTML, for the above examples this is
  6847. @samp{&alpha;} and @samp{&rarr;}, respectively. If you need such a symbol
  6848. inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
  6849. @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
  6850. @section Subscripts and superscripts
  6851. @cindex subscript
  6852. @cindex superscript
  6853. Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
  6854. and subscripts. Again, these can be used without embedding them in
  6855. math-mode delimiters. To increase the readability of ASCII text, it is
  6856. not necessary (but OK) to surround multi-character sub- and superscripts
  6857. with curly braces. For example
  6858. @example
  6859. The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
  6860. the sun is R_@{sun@} = 6.96 x 10^8 m.
  6861. @end example
  6862. To avoid interpretation as raised or lowered text, you can quote
  6863. @samp{^} and @samp{_} with a backslash: @samp{\^} and @samp{\_}.
  6864. During HTML export (@pxref{HTML export}), subscript and superscripts
  6865. are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
  6866. @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
  6867. @section La@TeX{} fragments
  6868. @cindex La@TeX{} fragments
  6869. @vindex org-format-latex-header
  6870. With symbols, sub- and superscripts, HTML is pretty much at its end when
  6871. it comes to representing mathematical formulas@footnote{Yes, there is
  6872. MathML, but that is not yet fully supported by many browsers, and there
  6873. is no decent converter for turning La@TeX{} or ASCII representations of
  6874. formulas into MathML. So for the time being, converting formulas into
  6875. images seems the way to go.}. More complex expressions need a dedicated
  6876. formula processor. To this end, Org mode can contain arbitrary La@TeX{}
  6877. fragments. It provides commands to preview the typeset result of these
  6878. fragments, and upon export to HTML, all fragments will be converted to
  6879. images and inlined into the HTML document@footnote{The La@TeX{} export
  6880. will not use images for displaying La@TeX{} fragments but include these
  6881. fragments directly into the La@TeX{} code.}. For this to work you
  6882. need to be on a system with a working La@TeX{} installation. You also
  6883. need the @file{dvipng} program, available at
  6884. @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
  6885. will be used when processing a fragment can be configured with the
  6886. variable @code{org-format-latex-header}.
  6887. La@TeX{} fragments don't need any special marking at all. The following
  6888. snippets will be identified as La@TeX{} source code:
  6889. @itemize @bullet
  6890. @item
  6891. Environments of any kind. The only requirement is that the
  6892. @code{\begin} statement appears on a new line, preceded by only
  6893. whitespace.
  6894. @item
  6895. Text within the usual La@TeX{} math delimiters. To avoid conflicts with
  6896. currency specifications, single @samp{$} characters are only recognized as
  6897. math delimiters if the enclosed text contains at most two line breaks, is
  6898. directly attached to the @samp{$} characters with no whitespace in between,
  6899. and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
  6900. For the other delimiters, there is no such restriction, so when in doubt, use
  6901. @samp{\(...\)} as inline math delimiters.
  6902. @end itemize
  6903. @noindent For example:
  6904. @example
  6905. \begin@{equation@} % arbitrary environments,
  6906. x=\sqrt@{b@} % even tables, figures
  6907. \end@{equation@} % etc
  6908. If $a^2=b$ and \( b=2 \), then the solution must be
  6909. either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
  6910. @end example
  6911. @noindent
  6912. @vindex org-format-latex-options
  6913. If you need any of the delimiter ASCII sequences for other purposes, you
  6914. can configure the option @code{org-format-latex-options} to deselect the
  6915. ones you do not wish to have interpreted by the La@TeX{} converter.
  6916. @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
  6917. @section Processing LaTeX fragments
  6918. @cindex LaTeX fragments, preview
  6919. La@TeX{} fragments can be processed to produce preview images of the
  6920. typeset expressions:
  6921. @table @kbd
  6922. @kindex C-c C-x C-l
  6923. @item C-c C-x C-l
  6924. Produce a preview image of the La@TeX{} fragment at point and overlay it
  6925. over the source code. If there is no fragment at point, process all
  6926. fragments in the current entry (between two headlines). When called
  6927. with a prefix argument, process the entire subtree. When called with
  6928. two prefix arguments, or when the cursor is before the first headline,
  6929. process the entire buffer.
  6930. @kindex C-c C-c
  6931. @item C-c C-c
  6932. Remove the overlay preview images.
  6933. @end table
  6934. During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
  6935. converted into images and inlined into the document if the following
  6936. setting is active:
  6937. @lisp
  6938. (setq org-export-with-LaTeX-fragments t)
  6939. @end lisp
  6940. @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
  6941. @section Using CDLa@TeX{} to enter math
  6942. @cindex CDLa@TeX{}
  6943. CDLa@TeX{} mode is a minor mode that is normally used in combination with a
  6944. major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of
  6945. environments and math templates. Inside Org mode, you can make use of
  6946. some of the features of CDLa@TeX{} mode. You need to install
  6947. @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
  6948. AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
  6949. Don't use CDLa@TeX{} mode itself under Org mode, but use the light
  6950. version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
  6951. on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
  6952. Org files with
  6953. @lisp
  6954. (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
  6955. @end lisp
  6956. When this mode is enabled, the following features are present (for more
  6957. details see the documentation of CDLa@TeX{} mode):
  6958. @itemize @bullet
  6959. @kindex C-c @{
  6960. @item
  6961. Environment templates can be inserted with @kbd{C-c @{}.
  6962. @item
  6963. @kindex @key{TAB}
  6964. The @key{TAB} key will do template expansion if the cursor is inside a
  6965. La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
  6966. inside such a fragment, see the documentation of the function
  6967. @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
  6968. expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
  6969. correctly inside the first brace. Another @key{TAB} will get you into
  6970. the second brace. Even outside fragments, @key{TAB} will expand
  6971. environment abbreviations at the beginning of a line. For example, if
  6972. you write @samp{equ} at the beginning of a line and press @key{TAB},
  6973. this abbreviation will be expanded to an @code{equation} environment.
  6974. To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
  6975. @item
  6976. @kindex _
  6977. @kindex ^
  6978. @vindex cdlatex-simplify-sub-super-scripts
  6979. Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
  6980. characters together with a pair of braces. If you use @key{TAB} to move
  6981. out of the braces, and if the braces surround only a single character or
  6982. macro, they are removed again (depending on the variable
  6983. @code{cdlatex-simplify-sub-super-scripts}).
  6984. @item
  6985. @kindex `
  6986. Pressing the backquote @kbd{`} followed by a character inserts math
  6987. macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
  6988. after the backquote, a help window will pop up.
  6989. @item
  6990. @kindex '
  6991. Pressing the single-quote @kbd{'} followed by another character modifies
  6992. the symbol before point with an accent or a font. If you wait more than
  6993. 1.5 seconds after the backquote, a help window will pop up. Character
  6994. modification will work only inside La@TeX{} fragments, outside the quote
  6995. is normal.
  6996. @end itemize
  6997. @node Exporting, Publishing, Embedded LaTeX, Top
  6998. @chapter Exporting
  6999. @cindex exporting
  7000. Org-mode documents can be exported into a variety of other formats. For
  7001. printing and sharing of notes, ASCII export produces a readable and simple
  7002. version of an Org file. HTML export allows you to publish a notes file on
  7003. the web, while the XOXO format provides a solid base for exchange with a
  7004. broad range of other applications. La@TeX{} export lets you use Org mode and
  7005. its structured editing functions to easily create La@TeX{} files. DocBook
  7006. export makes it possible to convert Org files to many other formats using
  7007. DocBook tools. To incorporate entries with associated times like deadlines
  7008. or appointments into a desktop calendar program like iCal, Org mode can also
  7009. produce extracts in the iCalendar format. Currently Org mode only supports
  7010. export, not import of these different formats.
  7011. Org supports export of selected regions when @code{transient-mark-mode} is
  7012. enabled (default in Emacs 23).
  7013. @menu
  7014. * Markup rules:: Which structures are recognized?
  7015. * Selective export:: Using tags to select and exclude trees
  7016. * Export options:: Per-file export settings
  7017. * The export dispatcher:: How to access exporter commands
  7018. * ASCII export:: Exporting to plain ASCII
  7019. * HTML export:: Exporting to HTML
  7020. * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
  7021. * DocBook export:: Exporting to DocBook
  7022. * XOXO export:: Exporting to XOXO
  7023. * iCalendar export:: Exporting in iCalendar format
  7024. @end menu
  7025. @node Markup rules, Selective export, Exporting, Exporting
  7026. @section Markup rules
  7027. When exporting Org-mode documents, the exporter tries to reflect the
  7028. structure of the document as accurately as possible in the backend. Since
  7029. export targets like HTML, La@TeX{}, or DocBook allow much richer formatting,
  7030. Org mode has rules on how to prepare text for rich export. This section
  7031. summarizes the markup rules used in an Org-mode buffer.
  7032. @menu
  7033. * Document title:: How the document title is determined
  7034. * Headings and sections:: The main structure of the exported document
  7035. * Table of contents:: If, where, how to create a table of contents
  7036. * Initial text:: Text before the first headline
  7037. * Lists:: Plain lists are exported
  7038. * Paragraphs:: What determines beginning and ending
  7039. * Literal examples:: Source code and other examples
  7040. * Include files:: Include the contents of a file during export
  7041. * Tables exported:: Tables are exported richly
  7042. * Inlined images:: How to inline images during export
  7043. * Footnote markup:: ASCII representation of footnotes
  7044. * Emphasis and monospace:: To bold or not to bold
  7045. * TeX macros and LaTeX fragments:: Create special, rich export.
  7046. * Horizontal rules:: A line across the page
  7047. * Comment lines:: Some lines will not be exported
  7048. * Macro replacement:: Global replacement of place holdes
  7049. @end menu
  7050. @node Document title, Headings and sections, Markup rules, Markup rules
  7051. @subheading Document title
  7052. @cindex document title, markup rules
  7053. @noindent
  7054. The title of the exported document is taken from the special line
  7055. @cindex #+TITLE
  7056. @example
  7057. #+TITLE: This is the title of the document
  7058. @end example
  7059. @noindent
  7060. If this line does not exist, the title is derived from the first non-empty,
  7061. non-comment line in the buffer. If no such line exists, or if you have
  7062. turned off exporting of the text before the first headline (see below), the
  7063. title will be the file name without extension.
  7064. @cindex property, EXPORT_TITLE
  7065. If you are exporting only a subtree by marking is as the region, the heading
  7066. of the subtree will become the title of the document. If the subtree has a
  7067. property @code{EXPORT_TITLE}, that will take precedence.
  7068. @node Headings and sections, Table of contents, Document title, Markup rules
  7069. @subheading Headings and sections
  7070. @cindex headings and sections, markup rules
  7071. @vindex org-headline-levels
  7072. The outline structure of the document as described in @ref{Document
  7073. Structure}, forms the basis for defining sections of the exported document.
  7074. However, since the outline structure is also used for (for example) lists of
  7075. tasks, only the first three outline levels will be used as headings. Deeper
  7076. levels will become itemized lists. You can change the location of this
  7077. switch globally by setting the variable @code{org-headline-levels}, or on a
  7078. per-file basis with a line
  7079. @cindex #+OPTIONS
  7080. @example
  7081. #+OPTIONS: H:4
  7082. @end example
  7083. @node Table of contents, Initial text, Headings and sections, Markup rules
  7084. @subheading Table of contents
  7085. @cindex table of contents, markup rules
  7086. @vindex org-export-with-toc
  7087. The table of contents is normally inserted directly before the first headline
  7088. of the file. If you would like to get it to a different location, insert the
  7089. string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
  7090. location. The depth of the table of contents is by default the same as the
  7091. number of headline levels, but you can choose a smaller number, or turn off
  7092. the table of contents entirely, by configuring the variable
  7093. @code{org-export-with-toc}, or on a per-file basis with a line like
  7094. @example
  7095. #+OPTIONS: toc:2 (only to two levels in TOC)
  7096. #+OPTIONS: toc:nil (no TOC at all)
  7097. @end example
  7098. @node Initial text, Lists, Table of contents, Markup rules
  7099. @subheading Text before the first headline
  7100. @cindex text before first headline, markup rules
  7101. @cindex #+TEXT
  7102. Org mode normally exports the text before the first headline, and even uses
  7103. the first line as the document title. The text will be fully marked up. If
  7104. you need to include literal HTML, La@TeX{}, or DocBook code, use the special
  7105. constructs described below in the sections for the individual exporters.
  7106. @vindex org-export-skip-text-before-1st-heading
  7107. Some people like to use the space before the first headline for setup and
  7108. internal links and therefore would like to control the exported text before
  7109. the first headline in a different way. You can do so by setting the variable
  7110. @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
  7111. basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
  7112. @noindent
  7113. If you still want to have some text before the first headline, use the
  7114. @code{#+TEXT} construct:
  7115. @example
  7116. #+OPTIONS: skip:t
  7117. #+TEXT: This text will go before the *first* headline.
  7118. #+TEXT: [TABLE-OF-CONTENTS]
  7119. #+TEXT: This goes between the table of contents and the first headline
  7120. @end example
  7121. @node Lists, Paragraphs, Initial text, Markup rules
  7122. @subheading Lists
  7123. @cindex lists, markup rules
  7124. Plain lists as described in @ref{Plain lists}, are translated to the backend's
  7125. syntax for such lists. Most backends support unordered, ordered, and
  7126. description lists.
  7127. @node Paragraphs, Literal examples, Lists, Markup rules
  7128. @subheading Paragraphs, line breaks, and quoting
  7129. @cindex paragraphs, markup rules
  7130. Paragraphs are separated by at least one empty line. If you need to enforce
  7131. a line break within a paragraph, use @samp{\\} at the end of a line.
  7132. To keep the line breaks in a region, but otherwise use normal formatting, you
  7133. can use this construct, which can also be used to format poetry.
  7134. @cindex #+BEGIN_VERSE
  7135. @example
  7136. #+BEGIN_VERSE
  7137. Great clouds overhead
  7138. Tiny black birds rise and fall
  7139. Snow covers Emacs
  7140. -- AlexSchroeder
  7141. #+END_VERSE
  7142. @end example
  7143. When quoting a passage from another document, it is customary to format this
  7144. as a paragraph that is indented on both the left and the right margin. You
  7145. can include quotations in Org-mode documents like this:
  7146. @cindex #+BEGIN_QUOTE
  7147. @example
  7148. #+BEGIN_QUOTE
  7149. Everything should be made as simple as possible,
  7150. but not any simpler -- Albert Einstein
  7151. #+END_QUOTE
  7152. @end example
  7153. If you would like to center some text, do it like this:
  7154. @cindex #+BEGIN_CENTER
  7155. @example
  7156. #+BEGIN_CENTER
  7157. Everything should be made as simple as possible, \\
  7158. but not any simpler
  7159. #+END_CENTER
  7160. @end example
  7161. @node Literal examples, Include files, Paragraphs, Markup rules
  7162. @subheading Literal examples
  7163. @cindex literal examples, markup rules
  7164. @cindex code line refenences, markup rules
  7165. You can include literal examples that should not be subjected to
  7166. markup. Such examples will be typeset in monospace, so this is well suited
  7167. for source code and similar examples.
  7168. @cindex #+BEGIN_EXAMPLE
  7169. @example
  7170. #+BEGIN_EXAMPLE
  7171. Some example from a text file.
  7172. #+END_EXAMPLE
  7173. @end example
  7174. Note that such blocks may be @i{indented} in order to align nicely with
  7175. indented text and in particular with plain list structure (@pxref{Plain
  7176. lists}). For simplicity when using small examples, you can also start the
  7177. example lines with a colon followed by a space. There may also be additional
  7178. whitespace before the colon:
  7179. @example
  7180. Here is an example
  7181. : Some example from a text file.
  7182. @end example
  7183. @cindex formatting source code, markup rules
  7184. If the example is source code from a programming language, or any other text
  7185. that can be marked up by font-lock in Emacs, you can ask for the example to
  7186. look like the fontified Emacs buffer@footnote{Currently this works only for
  7187. the HTML backend, and requires the @file{htmlize.el} package version 1.34 or
  7188. later.}. This is done with the @samp{src} block, where you also need to
  7189. specify the name of the major mode that should be used to fontify the
  7190. example:
  7191. @cindex #+BEGIN_SRC
  7192. @example
  7193. #+BEGIN_SRC emacs-lisp
  7194. (defun org-xor (a b)
  7195. "Exclusive or."
  7196. (if a (not b) b))
  7197. #+END_SRC
  7198. @end example
  7199. Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
  7200. switch to the end of the @code{BEGIN} line, to get the lines of the example
  7201. numbered. If you use a @code{+n} switch, the numbering from the previous
  7202. numbered snippet will be continued in the current one. In literal examples,
  7203. Org will interpret strings like @samp{(ref:name)} as labels, and use them as
  7204. targets for special hyperlinks like @code{[[(name)]]} (@ie the reference
  7205. name enclosed in single parenthesis). In HTML, hovering the mouse over such
  7206. a link will remote-highlight the corresponding code line, which is kind of
  7207. cool. If the example/src snippet is numbered, you can also add a @code{-r}
  7208. switch. Then labels will be @i{removed} from the source code and the links
  7209. will be @i{replaced}@footnote{If you want to explain the use of such labels
  7210. themelves in org-mode example code, you can use the @code{-k} switch to make
  7211. sure they are not touched.} with line numbers from the code listing. Here is
  7212. an example:
  7213. @example
  7214. #+BEGIN_SRC emacs-lisp -n -r
  7215. (save-excursion (ref:sc)
  7216. (goto-char (point-min)) (ref:jump)
  7217. #+END SRC
  7218. In line [[(sc)]] we remember the current positon. [[(jump)][Line (jump)]]
  7219. jumps to point-min.
  7220. @end example
  7221. @vindex org-coderef-label-format
  7222. If the syntax for the label format conflicts with the language syntax, use a
  7223. @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
  7224. -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
  7225. HTML export also allows examples to be published as text areas, @xref{Text
  7226. areas in HTML export}.
  7227. @table @kbd
  7228. @kindex C-c '
  7229. @item C-c '
  7230. Edit the source code example at point in its native mode. This works by
  7231. switching to a temporary buffer with the source code. You need to exit by
  7232. pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
  7233. or @samp{#} will get a comma prepended, to keep them from being interpreted
  7234. by Org as outline nodes or special comments. These commas will be striped
  7235. for editing with @kbd{C-c '}, and also for export.}, the edited version will
  7236. then replace the old version in the Org buffer. Fixed-width regions
  7237. (where each line starts with a colon followed by a space) will be edited
  7238. using @code{artist-mode}@footnote{You may select a different-mode with the
  7239. variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
  7240. drawings easily. Using this command in an empty line will create a new
  7241. fixed-width region.
  7242. @kindex C-c l
  7243. @item C-c l
  7244. Calling @code{org-store-link} while editing a source code example in a
  7245. temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
  7246. that it is unique in the current buffer, and insert it with the proper
  7247. formatting like @samp{(ref:label)} at the end of the current line. Then the
  7248. label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
  7249. @end table
  7250. @node Include files, Tables exported, Literal examples, Markup rules
  7251. @subheading Include files
  7252. @cindex include files, markup rules
  7253. During export, you can include the content of another file. For example, to
  7254. include your @file{.emacs} file, you could use:
  7255. @cindex #+INCLUDE
  7256. @example
  7257. #+INCLUDE: "~/.emacs" src emacs-lisp
  7258. @end example
  7259. @noindent
  7260. The optional second and third parameter are the markup (@samp{quote},
  7261. @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
  7262. language for formatting the contents. The markup is optional, if it is not
  7263. given, the text will be assumed to be in Org mode format and will be
  7264. processed normally. The include line will also allow additional keyword
  7265. parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
  7266. first line and for each following line, as well as any options accepted by
  7267. the selected markup. For example, to include a file as an item, use
  7268. @example
  7269. #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
  7270. @end example
  7271. @table @kbd
  7272. @kindex C-c '
  7273. @item C-c '
  7274. Visit the include file at point.
  7275. @end table
  7276. @node Tables exported, Inlined images, Include files, Markup rules
  7277. @subheading Tables
  7278. @cindex tables, markup rules
  7279. Both the native Org mode tables (@pxref{Tables}) and tables formatted with
  7280. the @file{table.el} package will be exported properly. For Org mode tables,
  7281. the lines before the first horizontal separator line will become table header
  7282. lines. You can use the following lines somewhere before the table to assign
  7283. a caption and a label for cross references:
  7284. @example
  7285. #+CAPTION: This is the caption for the next table (or link)
  7286. #+LABEL: tbl:basic-data
  7287. @end example
  7288. @node Inlined images, Footnote markup, Tables exported, Markup rules
  7289. @subheading Inlined Images
  7290. @cindex inlined images, markup rules
  7291. Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include images
  7292. into the exported document. Org does this, if a link to an image files does
  7293. not have a description part, for example @code{[[./img/a.jpg]]}. If you wish
  7294. to define a caption for the image and maybe a label for internal cross
  7295. references, you can use (before, but close to the link)
  7296. @example
  7297. #+CAPTION: This is the caption for the next figure link (or table)
  7298. #+LABEL: fig:SED-HR4049
  7299. @end example
  7300. You may also define additional attributes for the figure. As this is
  7301. backend-specific, see the sections about the individual backends for more
  7302. information.
  7303. @node Footnote markup, Emphasis and monospace, Inlined images, Markup rules
  7304. @subheading Footnote markup
  7305. @cindex footnotes, markup rules
  7306. @cindex @file{footnote.el}
  7307. Footnotes defined in the way described in @ref{Footnotes}, will be exported by
  7308. all backends. Org allows multiple references to the same note, and
  7309. different backends support this to varying degrees.
  7310. @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
  7311. @subheading Emphasis and monospace
  7312. @cindex underlined text, markup rules
  7313. @cindex bold text, markup rules
  7314. @cindex italic text, markup rules
  7315. @cindex verbatim text, markup rules
  7316. @cindex code text, markup rules
  7317. @cindex strike-through text, markup rules
  7318. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
  7319. and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
  7320. in the code and verbatim string is not processed for Org-mode specific
  7321. syntax, it is exported verbatim.
  7322. @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
  7323. @subheading @TeX{} macros and La@TeX{} fragments
  7324. @cindex La@TeX{} fragments, markup rules
  7325. @cindex @TeX{} macros, markup rules
  7326. @cindex HTML entities
  7327. @cindex La@TeX{} entities
  7328. @vindex org-html-entities
  7329. A @TeX{}-like syntax is used to specify special characters. Where possible,
  7330. these will be transformed into the native format of the exporter backend.
  7331. Strings like @code{\alpha} will be exported as @code{&alpha;} in the HTML
  7332. output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
  7333. @code{\nbsp} will become @code{&nbsp;} in HTML and @code{~} in La@TeX{}.
  7334. This applies for a large number of entities, with names taken from both HTML
  7335. and La@TeX{}, see the variable @code{org-html-entities} for the complete
  7336. list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
  7337. after having typed the backslash and optionally a few characters
  7338. (@pxref{Completion}).
  7339. La@TeX{} fragments are converted into images for HTML export, and they are
  7340. written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}.
  7341. Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
  7342. @samp{...} are all converted into special commands creating hyphens of
  7343. different lengths or a compact set of dots.
  7344. @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
  7345. @subheading Horizontal rules
  7346. @cindex horizontal rules, markup rules
  7347. A line consisting of only dashes, and at least 5 of them, will be
  7348. exported as a horizontal line (@samp{<hr/>} in HTML).
  7349. @node Comment lines, Macro replacement, Horizontal rules, Markup rules
  7350. @subheading Comment lines
  7351. @cindex comment lines
  7352. @cindex exporting, not
  7353. @cindex #+BEGIN_COMMENT
  7354. Lines starting with @samp{#} in column zero are treated as comments and will
  7355. never be exported. Also entire subtrees starting with the word
  7356. @samp{COMMENT} will never be exported. Finally, regions surrounded by
  7357. @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
  7358. @table @kbd
  7359. @kindex C-c ;
  7360. @item C-c ;
  7361. Toggle the COMMENT keyword at the beginning of an entry.
  7362. @end table
  7363. @node Macro replacement, , Comment lines, Markup rules
  7364. @subheading Macro replacement
  7365. @cindex macro replacement, during export
  7366. @cindex #+MACRO
  7367. You can define text snippets with
  7368. @example
  7369. #+MACRO: name replacement text $1, $2 are arguments
  7370. @end example
  7371. @noindent which can be referenced anywhere in the document (even in
  7372. code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
  7373. defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
  7374. will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
  7375. similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
  7376. @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
  7377. and to the modification time of the file being exported, respectively.
  7378. @var{FORMAT} should be a format string understood by
  7379. @code{format-time-string}.
  7380. @node Selective export, Export options, Markup rules, Exporting
  7381. @section Selective export
  7382. @cindex export, selective by tags
  7383. @vindex org-export-select-tags
  7384. @vindex org-export-exclude-tags
  7385. You may use tags to select the parts of a document that should be exported,
  7386. or to exclude parts from export. This behavior is governed by two variables:
  7387. @code{org-export-select-tags} and @code{org-export-exclude-tags}.
  7388. Org first checks if any of the @emph{select} tags is present in the buffer.
  7389. If yes, all trees that do not carry one of these tags will be excluded. If a
  7390. selected tree is a subtree, the heading hierarchy above it will also be
  7391. selected for export, but not the text below those headings.
  7392. @noindent
  7393. If none of the select tags is found, the whole buffer will be selected for
  7394. export.
  7395. @noindent
  7396. Finally, all subtrees that are marked by any of the @emph{exclude} tags will
  7397. be removed from the export buffer.
  7398. @node Export options, The export dispatcher, Selective export, Exporting
  7399. @section Export options
  7400. @cindex options, for export
  7401. @cindex completion, of option keywords
  7402. The exporter recognizes special lines in the buffer which provide
  7403. additional information. These lines may be put anywhere in the file.
  7404. The whole set of lines can be inserted into the buffer with @kbd{C-c
  7405. C-e t}. For individual lines, a good way to make sure the keyword is
  7406. correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
  7407. (@pxref{Completion}). For a summary of other in-buffer settings not
  7408. specifically related to export, see @ref{In-buffer settings}.
  7409. In particular, note that you can place commonly-used (export) options in
  7410. a separate file which can be included using @code{#+SETUPFILE}.
  7411. @table @kbd
  7412. @kindex C-c C-e t
  7413. @item C-c C-e t
  7414. Insert template with export options, see example below.
  7415. @end table
  7416. @cindex #+TITLE
  7417. @cindex #+AUTHOR
  7418. @cindex #+DATE
  7419. @cindex #+EMAIL
  7420. @cindex #+DESCRIPTION
  7421. @cindex #+KEYWORDS
  7422. @cindex #+LANGUAGE
  7423. @cindex #+TEXT
  7424. @cindex #+OPTIONS
  7425. @cindex #+BIND
  7426. @cindex #+LINK_UP
  7427. @cindex #+LINK_HOME
  7428. @cindex #+EXPORT_SELECT_TAGS
  7429. @cindex #+EXPORT_EXCLUDE_TAGS
  7430. @cindex #+LATEX_HEADER
  7431. @vindex user-full-name
  7432. @vindex user-mail-address
  7433. @vindex org-export-default-language
  7434. @example
  7435. #+TITLE: the title to be shown (default is the buffer name)
  7436. #+AUTHOR: the author (default taken from @code{user-full-name})
  7437. #+DATE: a date, fixed, of a format string for @code{format-time-string}
  7438. #+EMAIL: his/her email address (default from @code{user-mail-address})
  7439. #+DESCRIPTION: the page description, @eg for the XHTML meta tag
  7440. #+KEYWORDS: the page keywords, @eg for the XHTML meta tag
  7441. #+LANGUAGE: language for HTML, @eg @samp{en} (@code{org-export-default-language})
  7442. #+TEXT: Some descriptive text to be inserted at the beginning.
  7443. #+TEXT: Several lines may be given.
  7444. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
  7445. #+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
  7446. #+LINK_UP: the ``up'' link of an exported page
  7447. #+LINK_HOME: the ``home'' link of an exported page
  7448. #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
  7449. #+EXPORT_SELECT_TAGS: Tags that select a tree for export
  7450. #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
  7451. @end example
  7452. @noindent
  7453. The OPTIONS line is a compact@footnote{If you want to configure many options
  7454. this way, you can use several OPTIONS lines.} form to specify export settings. Here
  7455. you can:
  7456. @cindex headline levels
  7457. @cindex section-numbers
  7458. @cindex table of contents
  7459. @cindex line-break preservation
  7460. @cindex quoted HTML tags
  7461. @cindex fixed-width sections
  7462. @cindex tables
  7463. @cindex @TeX{}-like syntax for sub- and superscripts
  7464. @cindex footnotes
  7465. @cindex special strings
  7466. @cindex emphasized text
  7467. @cindex @TeX{} macros
  7468. @cindex La@TeX{} fragments
  7469. @cindex author info, in export
  7470. @cindex time info, in export
  7471. @example
  7472. H: @r{set the number of headline levels for export}
  7473. num: @r{turn on/off section-numbers}
  7474. toc: @r{turn on/off table of contents, or set level limit (integer)}
  7475. \n: @r{turn on/off line-break-preservation}
  7476. @@: @r{turn on/off quoted HTML tags}
  7477. :: @r{turn on/off fixed-width sections}
  7478. |: @r{turn on/off tables}
  7479. ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
  7480. @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
  7481. @r{the simple @code{a_b} will be left as it is.}
  7482. -: @r{turn on/off conversion of special strings.}
  7483. f: @r{turn on/off footnotes like this[1].}
  7484. todo: @r{turn on/off inclusion of TODO keywords into exported text}
  7485. pri: @r{turn on/off priority cookies}
  7486. tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
  7487. <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
  7488. *: @r{turn on/off emphasized text (bold, italic, underlined)}
  7489. TeX: @r{turn on/off simple @TeX{} macros in plain text}
  7490. LaTeX: @r{turn on/off La@TeX{} fragments}
  7491. skip: @r{turn on/off skipping the text before the first heading}
  7492. author: @r{turn on/off inclusion of author name/email into exported file}
  7493. creator: @r{turn on/off inclusion of creator info into exported file}
  7494. timestamp: @r{turn on/off inclusion creation time into exported file}
  7495. d: @r{turn on/off inclusion of drawers}
  7496. @end example
  7497. @noindent
  7498. These options take effect in both the HTML and La@TeX{} export, except
  7499. for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
  7500. @code{nil} for the La@TeX{} export.
  7501. When exporting only a single subtree by selecting it with @kbd{C-c @@} before
  7502. calling an export command, the subtree can overrule some of the file's export
  7503. settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
  7504. @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
  7505. @code{EXPORT_OPTIONS}.
  7506. @node The export dispatcher, ASCII export, Export options, Exporting
  7507. @section The export dispatcher
  7508. @cindex dispatcher, for export commands
  7509. All export commands can be reached using the export dispatcher, which is a
  7510. prefix key that prompts for an additional key specifying the command.
  7511. Normally the entire file is exported, but if there is an active region that
  7512. contains one outline tree, the first heading is used as document title and
  7513. the subtrees are exported.
  7514. @table @kbd
  7515. @kindex C-c C-e
  7516. @item C-c C-e
  7517. @vindex org-export-run-in-background
  7518. Dispatcher for export and publishing commands. Displays a help-window
  7519. listing the additional key(s) needed to launch an export or publishing
  7520. command. The prefix arg is passed through to the exporter. A double prefix
  7521. @kbd{C-u C-u} causes most commands to be executed in the background, in a
  7522. separate Emacs process@footnote{To make this behavior the default, customize
  7523. the variable @code{org-export-run-in-background}.}.
  7524. @kindex C-c C-e v
  7525. @item C-c C-e v
  7526. Like @kbd{C-c C-e}, but only export the text that is currently visible
  7527. (@ie not hidden by outline visibility).
  7528. @kindex C-u C-u C-c C-e
  7529. @item C-u C-u C-c C-e
  7530. @vindex org-export-run-in-background
  7531. Call an the exporter, but reverse the setting of
  7532. @code{org-export-run-in-background}, @ie request background processing if
  7533. not set, or force processing in the current Emacs process if set.
  7534. @end table
  7535. @node ASCII export, HTML export, The export dispatcher, Exporting
  7536. @section ASCII export
  7537. @cindex ASCII export
  7538. ASCII export produces a simple and very readable version of an Org-mode
  7539. file.
  7540. @cindex region, active
  7541. @cindex active region
  7542. @cindex transient-mark-mode
  7543. @table @kbd
  7544. @kindex C-c C-e a
  7545. @item C-c C-e a
  7546. @cindex property, EXPORT_FILE_NAME
  7547. Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
  7548. will be @file{myfile.txt}. The file will be overwritten without
  7549. warning. If there is an active region@footnote{This requires
  7550. @code{transient-mark-mode} be turned on.}, only the region will be
  7551. exported. If the selected region is a single tree@footnote{To select the
  7552. current subtree, use @kbd{C-c @@}.}, the tree head will
  7553. become the document title. If the tree head entry has or inherits an
  7554. @code{EXPORT_FILE_NAME} property, that name will be used for the
  7555. export.
  7556. @kindex C-c C-e A
  7557. @item C-c C-e A
  7558. Export to a temporary buffer, do not create a file.
  7559. @kindex C-c C-e v a
  7560. @item C-c C-e v a
  7561. Export only the visible part of the document.
  7562. @end table
  7563. @cindex headline levels, for exporting
  7564. In the exported version, the first 3 outline levels will become
  7565. headlines, defining a general document structure. Additional levels
  7566. will be exported as itemized lists. If you want that transition to occur
  7567. at a different level, specify it with a prefix argument. For example,
  7568. @example
  7569. @kbd{C-1 C-c C-e a}
  7570. @end example
  7571. @noindent
  7572. creates only top level headlines and does the rest as items. When
  7573. headlines are converted to items, the indentation of the text following
  7574. the headline is changed to fit nicely under the item. This is done with
  7575. the assumption that the first body line indicates the base indentation of
  7576. the body text. Any indentation larger than this is adjusted to preserve
  7577. the layout relative to the first line. Should there be lines with less
  7578. indentation than the first, these are left alone.
  7579. @vindex org-export-ascii-links-to-notes
  7580. Links will be exported in a footnote-like style, with the descriptive part in
  7581. the text and the link in a note before the next heading. See the variable
  7582. @code{org-export-ascii-links-to-notes} for details and other options.
  7583. @node HTML export, LaTeX and PDF export, ASCII export, Exporting
  7584. @section HTML export
  7585. @cindex HTML export
  7586. Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
  7587. HTML formatting, in ways similar to John Gruber's @emph{markdown}
  7588. language, but with additional support for tables.
  7589. @menu
  7590. * HTML Export commands:: How to invoke HTML export
  7591. * Quoting HTML tags:: Using direct HTML in Org mode
  7592. * Links:: Transformation of links for HTML
  7593. * Tables in HTML export:: How to modify the formatting of tables
  7594. * Images in HTML export:: How to insert figures into HTML output
  7595. * Text areas in HTML export:: An alternative way to show an example
  7596. * CSS support:: Changing the appearance of the output
  7597. * Javascript support:: Info and Folding in a web browser
  7598. @end menu
  7599. @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
  7600. @subsection HTML export commands
  7601. @cindex region, active
  7602. @cindex active region
  7603. @cindex transient-mark-mode
  7604. @table @kbd
  7605. @kindex C-c C-e h
  7606. @item C-c C-e h
  7607. @cindex property, EXPORT_FILE_NAME
  7608. Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
  7609. the ASCII file will be @file{myfile.html}. The file will be overwritten
  7610. without warning. If there is an active region@footnote{This requires
  7611. @code{transient-mark-mode} be turned on.}, only the region will be
  7612. exported. If the selected region is a single tree@footnote{To select the
  7613. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  7614. title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
  7615. property, that name will be used for the export.
  7616. @kindex C-c C-e b
  7617. @item C-c C-e b
  7618. Export as HTML file and immediately open it with a browser.
  7619. @kindex C-c C-e H
  7620. @item C-c C-e H
  7621. Export to a temporary buffer, do not create a file.
  7622. @kindex C-c C-e R
  7623. @item C-c C-e R
  7624. Export the active region to a temporary buffer. With a prefix argument, do
  7625. not produce the file header and footer, but just the plain HTML section for
  7626. the region. This is good for cut-and-paste operations.
  7627. @kindex C-c C-e v h
  7628. @kindex C-c C-e v b
  7629. @kindex C-c C-e v H
  7630. @kindex C-c C-e v R
  7631. @item C-c C-e v h
  7632. @item C-c C-e v b
  7633. @item C-c C-e v H
  7634. @item C-c C-e v R
  7635. Export only the visible part of the document.
  7636. @item M-x org-export-region-as-html
  7637. Convert the region to HTML under the assumption that it was Org-mode
  7638. syntax before. This is a global command that can be invoked in any
  7639. buffer.
  7640. @item M-x org-replace-region-by-HTML
  7641. Replace the active region (assumed to be in Org-mode syntax) by HTML
  7642. code.
  7643. @end table
  7644. @cindex headline levels, for exporting
  7645. In the exported version, the first 3 outline levels will become headlines,
  7646. defining a general document structure. Additional levels will be exported as
  7647. itemized lists. If you want that transition to occur at a different level,
  7648. specify it with a numeric prefix argument. For example,
  7649. @example
  7650. @kbd{C-2 C-c C-e b}
  7651. @end example
  7652. @noindent
  7653. creates two levels of headings and does the rest as items.
  7654. @node Quoting HTML tags, Links, HTML Export commands, HTML export
  7655. @subsection Quoting HTML tags
  7656. Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
  7657. @samp{&gt;} in HTML export. If you want to include simple HTML tags
  7658. which should be interpreted as such, mark them with @samp{@@} as in
  7659. @samp{@@<b>bold text@@</b>}. Note that this really works only for
  7660. simple tags. For more extensive HTML that should be copied verbatim to
  7661. the exported file use either
  7662. @cindex #+HTML
  7663. @cindex #+BEGIN_HTML
  7664. @example
  7665. #+HTML: Literal HTML code for export
  7666. @end example
  7667. @noindent or
  7668. @cindex #+BEGIN_HTML
  7669. @example
  7670. #+BEGIN_HTML
  7671. All lines between these markers are exported literally
  7672. #+END_HTML
  7673. @end example
  7674. @node Links, Tables in HTML export, Quoting HTML tags, HTML export
  7675. @subsection Links
  7676. @cindex links, in HTML export
  7677. @cindex internal links, in HTML export
  7678. @cindex external links, in HTML export
  7679. Internal links (@pxref{Internal links}) will continue to work in HTML. This
  7680. includes automatic links created by radio targets (@pxref{Radio
  7681. targets}). Links to external files will still work if the target file is on
  7682. the same @i{relative} path as the published Org file. Links to other
  7683. @file{.org} files will be translated into HTML links under the assumption
  7684. that an HTML version also exists of the linked file, at the same relative
  7685. path. @samp{id:} links can then be used to jump to specific entries across
  7686. files. For information related to linking files while publishing them to a
  7687. publishing directory see @ref{Publishing links}.
  7688. If you want to specify attributes for links, you can do so using a special
  7689. @code{#+ATTR_HTML} line to define attributes that will be added to the
  7690. @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
  7691. and @code{style} attributes for a link:
  7692. @cindex #+ATTR_HTML
  7693. @example
  7694. #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
  7695. [[http://orgmode.org]]
  7696. @end example
  7697. @node Tables in HTML export, Images in HTML export, Links, HTML export
  7698. @subsection Tables
  7699. @cindex tables, in HTML
  7700. @vindex org-export-html-table-tag
  7701. Org-mode tables are exported to HTML using the table tag defined in
  7702. @code{org-export-html-table-tag}. The default setting makes tables without
  7703. cell borders and frame. If you would like to change this for individual
  7704. tables, place somthing like the following before the table:
  7705. @cindex #+CAPTION
  7706. @example
  7707. #+CAPTION: This is a table with lines around and between cells
  7708. #+ATTR_HTML: border="2" rules="all" frame="all"
  7709. @end example
  7710. @node Images in HTML export, Text areas in HTML export, Tables in HTML export, HTML export
  7711. @subsection Images
  7712. @cindex images, inline in HTML
  7713. @cindex inlining images in HTML
  7714. @vindex org-export-html-inline-images
  7715. HTML export can inline images given as links in the Org file, and
  7716. it can make an image the clickable part of a link. By
  7717. default@footnote{But see the variable
  7718. @code{org-export-html-inline-images}.}, images are inlined if a link does
  7719. not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
  7720. while @samp{[[file:myimg.jpg][the image]]} will just produce a link
  7721. @samp{the image} that points to the image. If the description part
  7722. itself is a @code{file:} link or a @code{http:} URL pointing to an
  7723. image, this image will be inlined and activated so that clicking on the
  7724. image will activate the link. For example, to include a thumbnail that
  7725. will link to a high resolution version of the image, you could use:
  7726. @example
  7727. [[file:highres.jpg][file:thumb.jpg]]
  7728. @end example
  7729. If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML},
  7730. for example:
  7731. @cindex #+CAPTION
  7732. @example
  7733. #+CAPTION: A black cat stalking a spider
  7734. #+ATTR_HTML: alt="cat/spider image" title="one second before action"
  7735. [[./img/a.jpg]]
  7736. @end example
  7737. @noindent
  7738. and you could use @code{http} addresses just as well.
  7739. @node Text areas in HTML export, CSS support, Images in HTML export, HTML export
  7740. @subsection Text areas
  7741. @cindex text areas, in HTML
  7742. An alternative way to publish literal code examples in HTML is to use text
  7743. areas, where the example can even be edited before pasting it into an
  7744. application. It is triggered by a @code{-t} switch at an @code{example} or
  7745. @code{src} block. Using this switch disables any options for syntax and
  7746. label highlighting, and line numbering, which may be present. You may also
  7747. use @code{-h} and @code{-w} switches to specify the height and width of the
  7748. text area, which default to the number of lines in the example, and 80,
  7749. respectively. For example
  7750. @example
  7751. #+BEGIN_EXAMPLE -t -w 40
  7752. (defun org-xor (a b)
  7753. "Exclusive or."
  7754. (if a (not b) b))
  7755. #+END_EXAMPLE
  7756. @end example
  7757. @node CSS support, Javascript support, Text areas in HTML export, HTML export
  7758. @subsection CSS support
  7759. @cindex CSS, for HTML export
  7760. @cindex HTML export, CSS
  7761. @vindex org-export-html-todo-kwd-class-prefix
  7762. @vindex org-export-html-tag-class-prefix
  7763. You can also give style information for the exported file. The HTML exporter
  7764. assigns the following special CSS classes@footnote{If the classes on TODO
  7765. keywords and tags lead to conflicts, use the variables
  7766. @code{org-export-html-todo-kwd-class-prefix} and
  7767. @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
  7768. parts of the document---your style specifications may change these, in
  7769. addition to any of the standard classes like for headlines, tables, etc.
  7770. @example
  7771. p.author @r{author information, including email}
  7772. p.date @r{publishing date}
  7773. p.creator @r{creator info, about org-mode version}
  7774. .title @r{document title}
  7775. .todo @r{TODO keywords, all not-done states}
  7776. .done @r{the DONE keywords, all stated the count as done}
  7777. .WAITING @r{each TODO keyword also uses a class named after itself}
  7778. .timestamp @r{timestamp}
  7779. .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
  7780. .timestamp-wrapper @r{span around keyword plus timestamp}
  7781. .tag @r{tag in a headline}
  7782. ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
  7783. .target @r{target for links}
  7784. .linenr @r{the line number in a code example}
  7785. .code-highlighted @r{for highlighting referenced code lines}
  7786. div.outline-N @r{div for outline level N (headline plus text))}
  7787. div.outline-text-N @r{extra div for text at outline level N}
  7788. .section-number-N @r{section number in headlines, different for each level}
  7789. div.figure @r{how to format an inlined image}
  7790. pre.src @r{formatted source code}
  7791. pre.example @r{normal example}
  7792. p.verse @r{verse paragraph}
  7793. div.footnotes @r{footnote section headline}
  7794. p.footnote @r{footnote definition paragraph, containing a footnote}
  7795. .footref @r{a footnote reference number (always a <sup>)}
  7796. .footnum @r{footnote number in footnote definition (always <sup>)}
  7797. @end example
  7798. @vindex org-export-html-style-default
  7799. @vindex org-export-html-style-include-default
  7800. @vindex org-export-html-style
  7801. @vindex org-export-html-extra
  7802. @vindex org-export-html-style-default
  7803. Each exported file contains a compact default style that defines these
  7804. classes in a basic way@footnote{This style is defined in the constant
  7805. @code{org-export-html-style-default}, which you should not modify. To turn
  7806. inclusion of these defaults off, customize
  7807. @code{org-export-html-style-include-default}}. You may overwrite these
  7808. settings, or add to them by using the variables @code{org-export-html-style}
  7809. (for Org-wide settings) and @code{org-export-html-style-extra} (for more
  7810. granular settings, like file-local settings). To set the latter variable
  7811. individually for each file, you can use
  7812. @cindex #+STYLE
  7813. @example
  7814. #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  7815. @end example
  7816. @noindent
  7817. For longer style definitions, you can use several such lines. You could also
  7818. directly write a @code{<style>} @code{</style>} section in this way, without
  7819. referring to an external file.
  7820. @c FIXME: More about header and footer styles
  7821. @c FIXME: Talk about links and targets.
  7822. @node Javascript support, , CSS support, HTML export
  7823. @subsection Javascript supported display of web pages
  7824. @cindex Rose, Sebastian
  7825. Sebastian Rose has written a JavaScript program especially designed to
  7826. enhance the web viewing experience of HTML files created with Org. This
  7827. program allows you to view large files in two different ways. The first one
  7828. is an @emph{Info}-like mode where each section is displayed separately and
  7829. navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
  7830. as well, press @kbd{?} for an overview of the available keys). The second
  7831. view type is a @emph{folding} view much like Org provides inside Emacs. The
  7832. script is available at @url{http://orgmode.org/org-info.js} and you can find
  7833. the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
  7834. We host the script at our site, but if you use it a lot, you might
  7835. not want to be dependent on @url{orgmode.org} and prefer to install a local
  7836. copy on your own web server.
  7837. To use the script, you need to make sure that the @file{org-jsinfo.el} module
  7838. gets loaded. It should be loaded by default, but you can try @kbd{M-x
  7839. customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
  7840. this is indeed the case. All it then takes to make use of the program is
  7841. adding a single line to the Org file:
  7842. @cindex #+INFOJS_OPT
  7843. @example
  7844. #+INFOJS_OPT: view:info toc:nil
  7845. @end example
  7846. @noindent
  7847. If this line is found, the HTML header will automatically contain the code
  7848. needed to invoke the script. Using the line above, you can set the following
  7849. viewing options:
  7850. @example
  7851. path: @r{The path to the script. The default is to grab the script from}
  7852. @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
  7853. @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
  7854. view: @r{Initial view when website is first shown. Possible values are:}
  7855. info @r{Info-like interface with one section per page.}
  7856. overview @r{Folding interface, initially showing only top-level.}
  7857. content @r{Folding interface, starting with all headlines visible.}
  7858. showall @r{Folding interface, all headlines and text visible.}
  7859. sdepth: @r{Maximum headline level that will still become an independent}
  7860. @r{section for info and folding modes. The default is taken from}
  7861. @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
  7862. @r{If this is smaller than in @code{org-headline-levels}, each}
  7863. @r{info/folding section can still contain child headlines.}
  7864. toc: @r{Should the table of content @emph{initially} be visible?}
  7865. @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
  7866. tdepth: @r{The depth of the table of contents. The defaults are taken from}
  7867. @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
  7868. ftoc: @r{Does the css of the page specify a fixed position for the "toc"?}
  7869. @r{If yes, the toc will never be displayed as a section.}
  7870. ltoc: @r{Should there be short contents (children) in each section?}
  7871. @r{Make this @code{above} if the section should be above initial text.}
  7872. mouse: @r{Headings are highlighted when the mouse is over them. Should be}
  7873. @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
  7874. buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
  7875. @r{default), only one such button will be present.}
  7876. @end example
  7877. @noindent
  7878. @vindex org-infojs-options
  7879. @vindex org-export-html-use-infojs
  7880. You can choose default values for these options by customizing the variable
  7881. @code{org-infojs-options}. If you always want to apply the script to your
  7882. pages, configure the variable @code{org-export-html-use-infojs}.
  7883. @node LaTeX and PDF export, DocBook export, HTML export, Exporting
  7884. @section La@TeX{} and PDF export
  7885. @cindex La@TeX{} export
  7886. @cindex PDF export
  7887. @cindex Guerry, Bastian
  7888. Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
  7889. further processing, this backend is also used to produce PDF output. Since
  7890. the La@TeX{} output uses @file{hyperref} to implement links and cross
  7891. references, the PDF output file will be fully linked.
  7892. @menu
  7893. * LaTeX/PDF export commands:: Which key invokes which commands
  7894. * Quoting LaTeX code:: Incorporating literal La@TeX{} code
  7895. * Sectioning structure:: Changing sectioning in La@TeX{} output
  7896. * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
  7897. * Images in LaTeX export:: How to insert figures into La@TeX{} output
  7898. @end menu
  7899. @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
  7900. @subsection La@TeX{} export commands
  7901. @cindex region, active
  7902. @cindex active region
  7903. @cindex transient-mark-mode
  7904. @table @kbd
  7905. @kindex C-c C-e l
  7906. @item C-c C-e l
  7907. @cindex property EXPORT_FILE_NAME
  7908. Export as La@TeX{} file @file{myfile.tex}. For an Org file
  7909. @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
  7910. be overwritten without warning. If there is an active region@footnote{This
  7911. requires @code{transient-mark-mode} be turned on.}, only the region will be
  7912. exported. If the selected region is a single tree@footnote{To select the
  7913. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  7914. title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
  7915. property, that name will be used for the export.
  7916. @kindex C-c C-e L
  7917. @item C-c C-e L
  7918. Export to a temporary buffer, do not create a file.
  7919. @kindex C-c C-e v l
  7920. @kindex C-c C-e v L
  7921. @item C-c C-e v l
  7922. @item C-c C-e v L
  7923. Export only the visible part of the document.
  7924. @item M-x org-export-region-as-latex
  7925. Convert the region to La@TeX{} under the assumption that it was Org mode
  7926. syntax before. This is a global command that can be invoked in any
  7927. buffer.
  7928. @item M-x org-replace-region-by-latex
  7929. Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
  7930. code.
  7931. @kindex C-c C-e p
  7932. @item C-c C-e p
  7933. Export as La@TeX{} and then process to PDF.
  7934. @kindex C-c C-e d
  7935. @item C-c C-e d
  7936. Export as La@TeX{} and then process to PDF, then open the resulting PDF file.
  7937. @end table
  7938. @cindex headline levels, for exporting
  7939. @vindex org-latex-low-levels
  7940. In the exported version, the first 3 outline levels will become
  7941. headlines, defining a general document structure. Additional levels
  7942. will be exported as description lists. The exporter can ignore them or
  7943. convert them to a custom string depending on
  7944. @code{org-latex-low-levels}.
  7945. If you want that transition to occur at a different level, specify it
  7946. with a numeric prefix argument. For example,
  7947. @example
  7948. @kbd{C-2 C-c C-e l}
  7949. @end example
  7950. @noindent
  7951. creates two levels of headings and does the rest as items.
  7952. @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
  7953. @subsection Quoting La@TeX{} code
  7954. Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly
  7955. inserted into the La@TeX{} file. This includes simple macros like
  7956. @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
  7957. you can add special code that should only be present in La@TeX{} export with
  7958. the following constructs:
  7959. @cindex #+LaTeX
  7960. @cindex #+BEGIN_LaTeX
  7961. @example
  7962. #+LaTeX: Literal LaTeX code for export
  7963. @end example
  7964. @noindent or
  7965. @cindex #+BEGIN_LaTeX
  7966. @example
  7967. #+BEGIN_LaTeX
  7968. All lines between these markers are exported literally
  7969. #+END_LaTeX
  7970. @end example
  7971. @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
  7972. @subsection Sectioning structure
  7973. @cindex La@TeX{} class
  7974. @cindex La@TeX{} sectioning structure
  7975. By default, the La@TeX{} output uses the class @code{article}.
  7976. @vindex org-export-latex-default-class
  7977. @vindex org-export-latex-classes
  7978. @cindex #+LATEX_HEADER
  7979. @cindex #+LATEX_CLASS
  7980. @cindex property, LATEX_CLASS
  7981. You can change this globally by setting a different value for
  7982. @code{org-export-latex-default-class} or locally by adding an option like
  7983. @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
  7984. property that applies when exporting a region containing only this (sub)tree.
  7985. The class should be listed in @code{org-export-latex-classes}, where you can
  7986. also define the sectioning structure for each class, as well as defining
  7987. additional classes. You can also use @code{#+LATEX_HEADER:
  7988. \usepackage@{xyz@}} to add lines to the header.
  7989. @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
  7990. @subsection Tables in La@TeX{} export
  7991. @cindex tables, in La@TeX{} export
  7992. For La@TeX{} export of a table, you can specify a label and a caption
  7993. (@pxref{Markup rules}). You can also use the @code{ATTR_LaTeX} line to
  7994. request a longtable environment for the table, so that it may span several
  7995. pages. Finally, you can set the alignment string:
  7996. @cindex #+CAPTION
  7997. @cindex #+LABEL
  7998. @cindex #+ATTR_LaTeX
  7999. @example
  8000. #+CAPTION: A long table
  8001. #+LABEL: tbl:long
  8002. #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
  8003. | ..... | ..... |
  8004. | ..... | ..... |
  8005. @end example
  8006. @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export
  8007. @subsection Images in La@TeX{} export
  8008. @cindex images, inline in La@TeX{}
  8009. @cindex inlining images in La@TeX{}
  8010. Images that are linked to without a description part in the link, like
  8011. @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
  8012. output files resulting from La@TeX{} output. Org will use an
  8013. @code{\includegraphics} macro to insert the image. If you have specified a
  8014. caption and/or a label as described in @ref{Markup rules}, the figure will
  8015. be wrapped into a @code{figure} environment and thus become a floating
  8016. element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the
  8017. options that can be used in the optional argument of the
  8018. @code{\includegraphics} macro.
  8019. @cindex #+CAPTION
  8020. @cindex #+LABEL
  8021. @cindex #+ATTR_LaTeX
  8022. @example
  8023. #+CAPTION: The black-body emission of the disk around HR 4049
  8024. #+LABEL: fig:SED-HR4049
  8025. #+ATTR_LaTeX: width=5cm,angle=90
  8026. [[./img/sed-hr4049.pdf]]
  8027. @end example
  8028. @vindex org-export-latex-inline-image-extensions
  8029. If you need references to a label created in this way, write
  8030. @samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}. The default settings will
  8031. recognize files types that can be included as images during processing by
  8032. @command{pdflatex} (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
  8033. files in a different way, you may need to customize the variable
  8034. @code{org-export-latex-inline-image-extensions}.
  8035. @node DocBook export, XOXO export, LaTeX and PDF export, Exporting
  8036. @section DocBook export
  8037. @cindex DocBook export
  8038. @cindex PDF export
  8039. @cindex Cui, Baoqui
  8040. Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
  8041. exported to DocBook format, it can be further processed to produce other
  8042. formats, including PDF, HTML, man pages, etc., using many available DocBook
  8043. tools and stylesheets.
  8044. Currently DocBook exporter only supports DocBook V5.0.
  8045. @menu
  8046. * DocBook export commands:: How to invoke DocBook export
  8047. * Quoting DocBook code:: Incorporating DocBook code in Org files
  8048. * Recursive sections:: Recursive sections in DocBook
  8049. * Tables in DocBook export:: Tables are exported as HTML tables
  8050. * Images in DocBook export:: How to insert figures into DocBook output
  8051. * Special characters:: How to handle special characters
  8052. @end menu
  8053. @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
  8054. @subsection DocBook export commands
  8055. @cindex region, active
  8056. @cindex active region
  8057. @cindex transient-mark-mode
  8058. @table @kbd
  8059. @kindex C-c C-e D
  8060. @item C-c C-e D
  8061. @cindex property EXPORT_FILE_NAME
  8062. Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
  8063. file will be @file{myfile.xml}. The file will be overwritten without
  8064. warning. If there is an active region@footnote{This requires
  8065. @code{transient-mark-mode} to be turned on}, only the region will be
  8066. exported. If the selected region is a single tree@footnote{To select the
  8067. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  8068. title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
  8069. property, that name will be used for the export.
  8070. @kindex C-c C-e V
  8071. @item C-c C-e V
  8072. Export as DocBook file, process to PDF, then open the resulting PDF file.
  8073. @vindex org-export-docbook-xslt-proc-command
  8074. @vindex org-export-docbook-xsl-fo-proc-command
  8075. Note that, in order to produce PDF output based on exported DocBook file, you
  8076. need to have XSLT processor and XSL-FO processor software installed on your
  8077. system. Check variables @code{org-export-docbook-xslt-proc-command} and
  8078. @code{org-export-docbook-xsl-fo-proc-command}.
  8079. @kindex C-c C-e v D
  8080. @item C-c C-e v D
  8081. Export only the visible part of the document.
  8082. @end table
  8083. @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
  8084. @subsection Quoting DocBook code
  8085. You can quote DocBook code in Org files and copy it verbatim into exported
  8086. DocBook file with the following constructs:
  8087. @cindex #+DOCBOOK
  8088. @cindex #+BEGIN_DOCBOOK
  8089. @example
  8090. #+DOCBOOK: Literal DocBook code for export
  8091. @end example
  8092. @noindent or
  8093. @cindex #+BEGIN_DOCBOOK
  8094. @example
  8095. #+BEGIN_DOCBOOK
  8096. All lines between these markers are exported by DocBook exporter
  8097. literally.
  8098. #+END_DOCBOOK
  8099. @end example
  8100. For example, you can use the following lines to include a DocBook warning
  8101. admonition. As to what this warning says, you should pay attention to the
  8102. document context when quoting DocBook code in Org files. You may make
  8103. exported DocBook XML files invalid by not quoting DocBook code correctly.
  8104. @example
  8105. #+BEGIN_DOCBOOK
  8106. <warning>
  8107. <para>You should know what you are doing when quoting DocBook XML code
  8108. in your Org file. Invalid DocBook XML file may be generated by
  8109. DocBook exporter if you are not careful!</para>
  8110. </warning>
  8111. #+END_DOCBOOK
  8112. @end example
  8113. @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
  8114. @subsection Recursive sections
  8115. @cindex DocBook recursive sections
  8116. DocBook exporter exports Org files as articles using the @code{article}
  8117. element in DocBook. Recursive sections, @ie @code{section} elements, are
  8118. used in exported articles. Top level headlines in Org files are exported as
  8119. top level sections, and lower level headlines are exported as nested
  8120. sections. The entire structure of Org files will be exported completely, no
  8121. matter how many nested levels of headlines there are.
  8122. Using recursive sections makes it easy to port and reuse exported DocBook
  8123. code in other DocBook document types like @code{book} or @code{set}.
  8124. @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
  8125. @subsection Tables in DocBook export
  8126. @cindex tables, in DocBook export
  8127. Tables in Org files are exported as HTML tables, which have been supported since
  8128. DocBook V4.3.
  8129. If a table does not have a caption, an informal table is generated using the
  8130. @code{informaltable} element; otherwise, a formal table will be generated
  8131. using the @code{table} element.
  8132. @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
  8133. @subsection Images in DocBook export
  8134. @cindex images, inline in DocBook
  8135. @cindex inlining images in DocBook
  8136. Images that are linked to without a description part in the link, like
  8137. @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
  8138. using @code{mediaobject} elements. Each @code{mediaobject} element contains
  8139. an @code{imageobject} that wraps an @code{imagedata} element. If you have
  8140. specified a caption for an image as described in @ref{Markup rules}, a
  8141. @code{caption} element will be added in @code{mediaobject}. If a label is
  8142. also specified, it will be exported as an @code{xml:id} attribute of the
  8143. @code{mediaobject} element.
  8144. @vindex org-export-docbook-default-image-attributes
  8145. Image attributes supported by the @code{imagedata} element, like @code{align}
  8146. or @code{width}, can be specified in two ways: you can either customize
  8147. variable @code{org-export-docbook-default-image-attributes} or use the
  8148. @code{#+ATTR_DOCBOOK:} line. Attributes sepcified in variable
  8149. @code{org-export-docbook-default-image-attributes} are applied to all inline
  8150. images in the Org file to be exported (unless they are overwritten by image
  8151. attributes specified in @code{#+ATTR_DOCBOOK:} lines).
  8152. The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
  8153. attributes or overwrite default image attributes for individual images. If
  8154. the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
  8155. variable @code{org-export-docbook-default-image-attributes}, the former
  8156. overwrites the latter. Here is an example about how image attributes can be
  8157. set:
  8158. @cindex #+CAPTION
  8159. @cindex #+LABEL
  8160. @cindex #+ATTR_DOCBOOK
  8161. @example
  8162. #+CAPTION: The logo of Org mode
  8163. #+LABEL: unicorn-svg
  8164. #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
  8165. [[./img/org-mode-unicorn.svg]]
  8166. @end example
  8167. @vindex org-export-docbook-inline-image-extensions
  8168. By default, DocBook exporter recognizes the following image file types:
  8169. @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
  8170. customize variable @code{org-export-docbook-inline-image-extensions} to add
  8171. more types to this list as long as DocBook supports them.
  8172. @node Special characters, , Images in DocBook export, DocBook export
  8173. @subsection Special characters in DocBook export
  8174. @cindex Special characters in DocBook export
  8175. @vindex org-export-docbook-doctype
  8176. @vindex org-html-entities
  8177. Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
  8178. @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
  8179. characters are rewritten to XML entities, like @code{&alpha;},
  8180. @code{&Gamma;}, and @code{&Zeta;}, based on the list saved in variable
  8181. @code{org-html-entities}. As long as the generated DocBook file includes the
  8182. corresponding entities, these special characters are recognized.
  8183. You can customize variable @code{org-export-docbook-doctype} to include the
  8184. entities you need. For example, you can set variable
  8185. @code{org-export-docbook-doctype} to the following value to recognize all
  8186. special characters included in XHTML entities:
  8187. @example
  8188. "<!DOCTYPE article [
  8189. <!ENTITY % xhtml1-symbol PUBLIC
  8190. \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
  8191. \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
  8192. >
  8193. %xhtml1-symbol;
  8194. ]>
  8195. "
  8196. @end example
  8197. @node XOXO export, iCalendar export, DocBook export, Exporting
  8198. @section XOXO export
  8199. @cindex XOXO export
  8200. Org mode contains an exporter that produces XOXO-style output.
  8201. Currently, this exporter only handles the general outline structure and
  8202. does not interpret any additional Org-mode features.
  8203. @table @kbd
  8204. @kindex C-c C-e x
  8205. @item C-c C-e x
  8206. Export as XOXO file @file{myfile.html}.
  8207. @kindex C-c C-e v
  8208. @item C-c C-e v x
  8209. Export only the visible part of the document.
  8210. @end table
  8211. @node iCalendar export, , XOXO export, Exporting
  8212. @section iCalendar export
  8213. @cindex iCalendar export
  8214. @vindex org-icalendar-include-todo
  8215. @vindex org-icalendar-use-deadline
  8216. @vindex org-icalendar-use-scheduled
  8217. @vindex org-icalendar-categories
  8218. Some people use Org mode for keeping track of projects, but still prefer a
  8219. standard calendar application for anniversaries and appointments. In this
  8220. case it can be useful to show deadlines and other time-stamped items in Org
  8221. files in the calendar application. Org mode can export calendar information
  8222. in the standard iCalendar format. If you also want to have TODO entries
  8223. included in the export, configure the variable
  8224. @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
  8225. and TODO items as VTODO. It will also create events from deadlines that are
  8226. in non-TODO items. Deadlines and scheduling dates in TODO items will be used
  8227. to set the start and due dates for the TODO entry@footnote{See the variables
  8228. @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
  8229. As categories, it will use the tags locally defined in the heading, and the
  8230. file/tree category@footnote{To add inherited tags or the TODO state,
  8231. configure the variable @code{org-icalendar-categories}.}.
  8232. @vindex org-icalendar-store-UID
  8233. @cindex property, ID
  8234. The iCalendar standard requires each entry to have a globally unique
  8235. identifier (UID). Org creates these identifiers during export. If you set
  8236. the variable @code{org-icalendar-store-UID}, the UID will be stored in the
  8237. @code{:ID:} property of the entry and re-used next time you report this
  8238. entry. Since a single entry can give rise to multiple iCalendar entries (as
  8239. a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
  8240. prefixes to the UID, depending on what triggered the inclusion of the entry.
  8241. In this way the UID remains unique, but a synchronization program can still
  8242. figure out from which entry all the different instances originate.
  8243. @table @kbd
  8244. @kindex C-c C-e i
  8245. @item C-c C-e i
  8246. Create iCalendar entries for the current file and store them in the same
  8247. directory, using a file extension @file{.ics}.
  8248. @kindex C-c C-e I
  8249. @item C-c C-e I
  8250. @vindex org-agenda-files
  8251. Like @kbd{C-c C-e i}, but do this for all files in
  8252. @code{org-agenda-files}. For each of these files, a separate iCalendar
  8253. file will be written.
  8254. @kindex C-c C-e c
  8255. @item C-c C-e c
  8256. @vindex org-combined-agenda-icalendar-file
  8257. Create a single large iCalendar file from all files in
  8258. @code{org-agenda-files} and write it to the file given by
  8259. @code{org-combined-agenda-icalendar-file}.
  8260. @end table
  8261. @vindex org-use-property-inheritance
  8262. @vindex org-icalendar-include-body
  8263. @cindex property, SUMMARY
  8264. @cindex property, DESCRIPTION
  8265. @cindex property, LOCATION
  8266. The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
  8267. property can be inherited from higher in the hierarchy if you configure
  8268. @code{org-use-property-inheritance} accordingly.} properties if the selected
  8269. entries have them. If not, the summary will be derived from the headline,
  8270. and the description from the body (limited to
  8271. @code{org-icalendar-include-body} characters).
  8272. How this calendar is best read and updated, depends on the application
  8273. you are using. The FAQ covers this issue.
  8274. @node Publishing, Miscellaneous, Exporting, Top
  8275. @chapter Publishing
  8276. @cindex publishing
  8277. @cindex O'Toole, David
  8278. Org includes a publishing management system that allows you to configure
  8279. automatic HTML conversion of @emph{projects} composed of interlinked org
  8280. files. You can also configure Org to automatically upload your exported HTML
  8281. pages and related attachments, such as images and source code files, to a web
  8282. server.
  8283. You can also use Org to convert files into PDF, or even combine HTML and PDF
  8284. conversion so that files are available in both formats on the server.
  8285. Publishing has been contributed to Org by David O'Toole.
  8286. @menu
  8287. * Configuration:: Defining projects
  8288. * Uploading files:: How to get files up on the server
  8289. * Sample configuration:: Example projects
  8290. * Triggering publication:: Publication commands
  8291. @end menu
  8292. @node Configuration, Uploading files, Publishing, Publishing
  8293. @section Configuration
  8294. Publishing needs significant configuration to specify files, destination
  8295. and many other properties of a project.
  8296. @menu
  8297. * Project alist:: The central configuration variable
  8298. * Sources and destinations:: From here to there
  8299. * Selecting files:: What files are part of the project?
  8300. * Publishing action:: Setting the function doing the publishing
  8301. * Publishing options:: Tweaking HTML export
  8302. * Publishing links:: Which links keep working after publishing?
  8303. * Project page index:: Publishing a list of project files
  8304. @end menu
  8305. @node Project alist, Sources and destinations, Configuration, Configuration
  8306. @subsection The variable @code{org-publish-project-alist}
  8307. @cindex org-publish-project-alist
  8308. @cindex projects, for publishing
  8309. @vindex org-publish-project-alist
  8310. Publishing is configured almost entirely through setting the value of one
  8311. variable, called @code{org-publish-project-alist}. Each element of the list
  8312. configures one project, and may be in one of the two following forms:
  8313. @lisp
  8314. ("project-name" :property value :property value ...)
  8315. @r{or}
  8316. ("project-name" :components ("project-name" "project-name" ...))
  8317. @end lisp
  8318. In both cases, projects are configured by specifying property values. A
  8319. project defines the set of files that will be published, as well as the
  8320. publishing configuration to use when publishing those files. When a project
  8321. takes the second form listed above, the individual members of the
  8322. @code{:components} property are taken to be sub-projects, which group
  8323. together files requiring different publishing options. When you publish such
  8324. a ``meta-project'', all the components will also be published, in the
  8325. sequence given.
  8326. @node Sources and destinations, Selecting files, Project alist, Configuration
  8327. @subsection Sources and destinations for files
  8328. @cindex directories, for publishing
  8329. Most properties are optional, but some should always be set. In
  8330. particular, Org needs to know where to look for source files,
  8331. and where to put published files.
  8332. @multitable @columnfractions 0.3 0.7
  8333. @item @code{:base-directory}
  8334. @tab Directory containing publishing source files
  8335. @item @code{:publishing-directory}
  8336. @tab Directory where output files will be published. You can directly
  8337. publish to a webserver using a file name syntax appropriate for
  8338. the Emacs @file{tramp} package. Or you can publish to a local directory and
  8339. use external tools to upload your website (@pxref{Uploading files}).
  8340. @item @code{:preparation-function}
  8341. @tab Function called before starting the publishing process, for example, to
  8342. run @code{make} for updating files to be published.
  8343. @item @code{:completion-function}
  8344. @tab Function called after finishing the publishing process, for example, to
  8345. change permissions of the resulting files.
  8346. @end multitable
  8347. @noindent
  8348. @node Selecting files, Publishing action, Sources and destinations, Configuration
  8349. @subsection Selecting files
  8350. @cindex files, selecting for publishing
  8351. By default, all files with extension @file{.org} in the base directory
  8352. are considered part of the project. This can be modified by setting the
  8353. properties
  8354. @multitable @columnfractions 0.25 0.75
  8355. @item @code{:base-extension}
  8356. @tab Extension (without the dot!) of source files. This actually is a
  8357. regular expression. Set this to the symbol @code{any} if you want to get all
  8358. files in @code{:base-directory}, even without extension.
  8359. @item @code{:exclude}
  8360. @tab Regular expression to match file names that should not be
  8361. published, even though they have been selected on the basis of their
  8362. extension.
  8363. @item @code{:include}
  8364. @tab List of files to be included regardless of @code{:base-extension}
  8365. and @code{:exclude}.
  8366. @end multitable
  8367. @node Publishing action, Publishing options, Selecting files, Configuration
  8368. @subsection Publishing action
  8369. @cindex action, for publishing
  8370. Publishing means that a file is copied to the destination directory and
  8371. possibly transformed in the process. The default transformation is to export
  8372. Org files as HTML files, and this is done by the function
  8373. @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
  8374. export}). But you also can publish your content as PDF files using
  8375. @code{org-publish-org-to-pdf}. If you want to publish the Org file itself,
  8376. but with @i{archived}, @i{commented}, and @i{tag-excluded} trees removed, use
  8377. @code{org-publish-org-to-org} and set the parameters @code{:plain-source}
  8378. and/or @code{:htmlized-source}. This will produce @file{file.org} and
  8379. @file{file.org.html} in the publishing
  8380. directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
  8381. source and publishing directories are equal.}. Other files like images only
  8382. need to be copied to the publishing destination, for this you may use
  8383. @code{org-publish-attachment}. For non-Org files, you always need to
  8384. specify the publishing function:
  8385. @multitable @columnfractions 0.3 0.7
  8386. @item @code{:publishing-function}
  8387. @tab Function executing the publication of a file. This may also be a
  8388. list of functions, which will all be called in turn.
  8389. @item @code{:plain-source}
  8390. @tab Non-nil means, publish plain source.
  8391. @item @code{:htmlized-source}
  8392. @tab Non-nil means, publish htmlized source.
  8393. @end multitable
  8394. The function must accept two arguments: a property list containing at least a
  8395. @code{:publishing-directory} property, and the name of the file to be
  8396. published. It should take the specified file, make the necessary
  8397. transformation (if any) and place the result into the destination folder.
  8398. @node Publishing options, Publishing links, Publishing action, Configuration
  8399. @subsection Options for the HTML/La@TeX{} exporters
  8400. @cindex options, for publishing
  8401. The property list can be used to set many export options for the HTML
  8402. and La@TeX{} exporters. In most cases, these properties correspond to user
  8403. variables in Org. The table below lists these properties along
  8404. with the variable they belong to. See the documentation string for the
  8405. respective variable for details.
  8406. @vindex org-export-html-link-up
  8407. @vindex org-export-html-link-home
  8408. @vindex org-export-default-language
  8409. @vindex org-display-custom-times
  8410. @vindex org-export-headline-levels
  8411. @vindex org-export-with-section-numbers
  8412. @vindex org-export-section-number-format
  8413. @vindex org-export-with-toc
  8414. @vindex org-export-preserve-breaks
  8415. @vindex org-export-with-archived-trees
  8416. @vindex org-export-with-emphasize
  8417. @vindex org-export-with-sub-superscripts
  8418. @vindex org-export-with-special-strings
  8419. @vindex org-export-with-footnotes
  8420. @vindex org-export-with-drawers
  8421. @vindex org-export-with-tags
  8422. @vindex org-export-with-todo-keywords
  8423. @vindex org-export-with-priority
  8424. @vindex org-export-with-TeX-macros
  8425. @vindex org-export-with-LaTeX-fragments
  8426. @vindex org-export-skip-text-before-1st-heading
  8427. @vindex org-export-with-fixed-width
  8428. @vindex org-export-with-timestamps
  8429. @vindex org-export-author-info
  8430. @vindex org-export-creator-info
  8431. @vindex org-export-with-tables
  8432. @vindex org-export-highlight-first-table-line
  8433. @vindex org-export-html-style-include-default
  8434. @vindex org-export-html-style
  8435. @vindex org-export-html-style-extra
  8436. @vindex org-export-html-link-org-files-as-html
  8437. @vindex org-export-html-inline-images
  8438. @vindex org-export-html-extension
  8439. @vindex org-export-html-table-tag
  8440. @vindex org-export-html-expand
  8441. @vindex org-export-html-with-timestamp
  8442. @vindex org-export-publishing-directory
  8443. @vindex org-export-html-preamble
  8444. @vindex org-export-html-postamble
  8445. @vindex org-export-html-auto-preamble
  8446. @vindex org-export-html-auto-postamble
  8447. @vindex user-full-name
  8448. @vindex user-mail-address
  8449. @vindex org-export-select-tags
  8450. @vindex org-export-exclude-tags
  8451. @multitable @columnfractions 0.32 0.68
  8452. @item @code{:link-up} @tab @code{org-export-html-link-up}
  8453. @item @code{:link-home} @tab @code{org-export-html-link-home}
  8454. @item @code{:language} @tab @code{org-export-default-language}
  8455. @item @code{:customtime} @tab @code{org-display-custom-times}
  8456. @item @code{:headline-levels} @tab @code{org-export-headline-levels}
  8457. @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
  8458. @item @code{:section-number-format} @tab @code{org-export-section-number-format}
  8459. @item @code{:table-of-contents} @tab @code{org-export-with-toc}
  8460. @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
  8461. @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
  8462. @item @code{:emphasize} @tab @code{org-export-with-emphasize}
  8463. @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
  8464. @item @code{:special-strings} @tab @code{org-export-with-special-strings}
  8465. @item @code{:footnotes} @tab @code{org-export-with-footnotes}
  8466. @item @code{:drawers} @tab @code{org-export-with-drawers}
  8467. @item @code{:tags} @tab @code{org-export-with-tags}
  8468. @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
  8469. @item @code{:priority} @tab @code{org-export-with-priority}
  8470. @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
  8471. @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
  8472. @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
  8473. @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
  8474. @item @code{:timestamps} @tab @code{org-export-with-timestamps}
  8475. @item @code{:author-info} @tab @code{org-export-author-info}
  8476. @item @code{:creator-info} @tab @code{org-export-creator-info}
  8477. @item @code{:tables} @tab @code{org-export-with-tables}
  8478. @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
  8479. @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
  8480. @item @code{:style} @tab @code{org-export-html-style}
  8481. @item @code{:style-extra} @tab @code{org-export-html-style-extra}
  8482. @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
  8483. @item @code{:inline-images} @tab @code{org-export-html-inline-images}
  8484. @item @code{:html-extension} @tab @code{org-export-html-extension}
  8485. @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
  8486. @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
  8487. @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
  8488. @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
  8489. @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
  8490. @item @code{:preamble} @tab @code{org-export-html-preamble}
  8491. @item @code{:postamble} @tab @code{org-export-html-postamble}
  8492. @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
  8493. @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
  8494. @item @code{:author} @tab @code{user-full-name}
  8495. @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
  8496. @item @code{:select-tags} @tab @code{org-export-select-tags}
  8497. @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
  8498. @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
  8499. @end multitable
  8500. Most of the @code{org-export-with-*} variables have the same effect in
  8501. both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
  8502. @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
  8503. La@TeX{} export.
  8504. @vindex org-publish-project-alist
  8505. When a property is given a value in @code{org-publish-project-alist},
  8506. its setting overrides the value of the corresponding user variable (if
  8507. any) during publishing. Options set within a file (@pxref{Export
  8508. options}), however, override everything.
  8509. @node Publishing links, Project page index, Publishing options, Configuration
  8510. @subsection Links between published files
  8511. @cindex links, publishing
  8512. To create a link from one Org file to another, you would use
  8513. something like @samp{[[file:foo.org][The foo]]} or simply
  8514. @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
  8515. becomes a link to @file{foo.html}. In this way, you can interlink the
  8516. pages of your "org web" project and the links will work as expected when
  8517. you publish them to HTML. If you also publish the Org source file and want
  8518. to link to that, use an @code{http:} link instead of a @code{file:} link,
  8519. because @code{file:} links are converted to link to the corresponding
  8520. @file{html} file.
  8521. You may also link to related files, such as images. Provided you are careful
  8522. with relative file names, and provided you have also configured Org to upload
  8523. the related files, these links will work too. See @ref{Complex example}, for
  8524. an example of this usage.
  8525. Sometimes an Org file to be published may contain links that are
  8526. only valid in your production environment, but not in the publishing
  8527. location. In this case, use the property
  8528. @multitable @columnfractions 0.4 0.6
  8529. @item @code{:link-validation-function}
  8530. @tab Function to validate links
  8531. @end multitable
  8532. @noindent
  8533. to define a function for checking link validity. This function must
  8534. accept two arguments, the file name and a directory relative to which
  8535. the file name is interpreted in the production environment. If this
  8536. function returns @code{nil}, then the HTML generator will only insert a
  8537. description into the HTML file, but no link. One option for this
  8538. function is @code{org-publish-validate-link} which checks if the given
  8539. file is part of any project in @code{org-publish-project-alist}.
  8540. @node Project page index, , Publishing links, Configuration
  8541. @subsection Project page index
  8542. @cindex index, of published pages
  8543. The following properties may be used to control publishing of an
  8544. index of files or a summary page for a given project.
  8545. @multitable @columnfractions 0.25 0.75
  8546. @item @code{:auto-index}
  8547. @tab When non-nil, publish an index during @code{org-publish-current-project}
  8548. or @code{org-publish-all}.
  8549. @item @code{:index-filename}
  8550. @tab Filename for output of index. Defaults to @file{sitemap.org} (which
  8551. becomes @file{sitemap.html}).
  8552. @item @code{:index-title}
  8553. @tab Title of index page. Defaults to name of file.
  8554. @item @code{:index-function}
  8555. @tab Plug-in function to use for generation of index.
  8556. Defaults to @code{org-publish-org-index}, which generates a plain list
  8557. of links to all files in the project.
  8558. @end multitable
  8559. @node Uploading files, Sample configuration, Configuration, Publishing
  8560. @section Uploading files
  8561. @cindex rsync
  8562. @cindex unison
  8563. For those people already utilising third party sync tools such as
  8564. @command{rsync} or @command{unison}, it might be preferable not to use the built in
  8565. @i{remote} publishing facilities of Org mode which rely heavily on
  8566. Tramp. Tramp, while very useful and powerful, tends not to be
  8567. so efficient for multiple file transfer and has been known to cause problems
  8568. under heavy usage.
  8569. Specialised synchronization utilities offer several advantages. In addition
  8570. to timestamp comparison, they also do content and permissions/attribute
  8571. checks. For this reason you might prefer to publish your web to a local
  8572. directory (possibly even @i{in place} with your Org files) and then use
  8573. @file{unison} or @file{rsync} to do the synchronisation with the remote host.
  8574. Since Unison (for example) can be configured as to which files to transfer to
  8575. a certain remote destination, it can greatly simplify the project publishing
  8576. definition. Simply keep all files in the correct location, process your Org
  8577. files with @code{org-publish} and let the synchronization tool do the rest.
  8578. You do not need, in this scenario, to include attachments such as @file{jpg},
  8579. @file{css} or @file{gif} files in the project definition since the 3rd party
  8580. tool syncs them.
  8581. Publishing to a local directory is also much faster than to a remote one, so
  8582. that you can afford more easily to republish entire projects. If you set
  8583. @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
  8584. benefit of re-including any changed external files such as source example
  8585. files you might include with @code{#+INCLUDE}. The timestamp mechanism in
  8586. Org is not smart enough to detect if included files have been modified.
  8587. @node Sample configuration, Triggering publication, Uploading files, Publishing
  8588. @section Sample configuration
  8589. Below we provide two example configurations. The first one is a simple
  8590. project publishing only a set of Org files. The second example is
  8591. more complex, with a multi-component project.
  8592. @menu
  8593. * Simple example:: One-component publishing
  8594. * Complex example:: A multi-component publishing example
  8595. @end menu
  8596. @node Simple example, Complex example, Sample configuration, Sample configuration
  8597. @subsection Example: simple publishing configuration
  8598. This example publishes a set of Org files to the @file{public_html}
  8599. directory on the local machine.
  8600. @lisp
  8601. (setq org-publish-project-alist
  8602. '(("org"
  8603. :base-directory "~/org/"
  8604. :publishing-directory "~/public_html"
  8605. :section-numbers nil
  8606. :table-of-contents nil
  8607. :style "<link rel=\"stylesheet\"
  8608. href=\"../other/mystyle.css\"
  8609. type=\"text/css\"/>")))
  8610. @end lisp
  8611. @node Complex example, , Simple example, Sample configuration
  8612. @subsection Example: complex publishing configuration
  8613. This more complicated example publishes an entire website, including
  8614. Org files converted to HTML, image files, Emacs Lisp source code, and
  8615. style sheets. The publishing directory is remote and private files are
  8616. excluded.
  8617. To ensure that links are preserved, care should be taken to replicate
  8618. your directory structure on the web server, and to use relative file
  8619. paths. For example, if your Org files are kept in @file{~/org} and your
  8620. publishable images in @file{~/images}, you'd link to an image with
  8621. @c
  8622. @example
  8623. file:../images/myimage.png
  8624. @end example
  8625. @c
  8626. On the web server, the relative path to the image should be the
  8627. same. You can accomplish this by setting up an "images" folder in the
  8628. right place on the web server, and publishing images to it.
  8629. @lisp
  8630. (setq org-publish-project-alist
  8631. '(("orgfiles"
  8632. :base-directory "~/org/"
  8633. :base-extension "org"
  8634. :publishing-directory "/ssh:user@@host:~/html/notebook/"
  8635. :publishing-function org-publish-org-to-html
  8636. :exclude "PrivatePage.org" ;; regexp
  8637. :headline-levels 3
  8638. :section-numbers nil
  8639. :table-of-contents nil
  8640. :style "<link rel=\"stylesheet\"
  8641. href=\"../other/mystyle.css\" type=\"text/css\"/>"
  8642. :auto-preamble t
  8643. :auto-postamble nil)
  8644. ("images"
  8645. :base-directory "~/images/"
  8646. :base-extension "jpg\\|gif\\|png"
  8647. :publishing-directory "/ssh:user@@host:~/html/images/"
  8648. :publishing-function org-publish-attachment)
  8649. ("other"
  8650. :base-directory "~/other/"
  8651. :base-extension "css\\|el"
  8652. :publishing-directory "/ssh:user@@host:~/html/other/"
  8653. :publishing-function org-publish-attachment)
  8654. ("website" :components ("orgfiles" "images" "other"))))
  8655. @end lisp
  8656. @node Triggering publication, , Sample configuration, Publishing
  8657. @section Triggering publication
  8658. Once properly configured, Org can publish with the following commands:
  8659. @table @kbd
  8660. @kindex C-c C-e C
  8661. @item C-c C-e C
  8662. Prompt for a specific project and publish all files that belong to it.
  8663. @kindex C-c C-e P
  8664. @item C-c C-e P
  8665. Publish the project containing the current file.
  8666. @kindex C-c C-e F
  8667. @item C-c C-e F
  8668. Publish only the current file.
  8669. @kindex C-c C-e E
  8670. @item C-c C-e E
  8671. Publish every project.
  8672. @end table
  8673. @vindex org-publish-use-timestamps-flag
  8674. Org uses timestamps to track when a file has changed. The above functions
  8675. normally only publish changed files. You can override this and force
  8676. publishing of all files by giving a prefix argument, or by customizing the
  8677. variable @code{org-publish-use-timestamps-flag}. This may be necessary in
  8678. particular if files include other files via @code{#+SETUPFILE:} or
  8679. @code{#+INCLUDE:}.
  8680. @node Miscellaneous, Hacking, Publishing, Top
  8681. @chapter Miscellaneous
  8682. @menu
  8683. * Completion:: M-TAB knows what you need
  8684. * Customization:: Adapting Org to your taste
  8685. * In-buffer settings:: Overview of the #+KEYWORDS
  8686. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  8687. * Clean view:: Getting rid of leading stars in the outline
  8688. * TTY keys:: Using Org on a tty
  8689. * Interaction:: Other Emacs packages
  8690. @end menu
  8691. @node Completion, Customization, Miscellaneous, Miscellaneous
  8692. @section Completion
  8693. @cindex completion, of @TeX{} symbols
  8694. @cindex completion, of TODO keywords
  8695. @cindex completion, of dictionary words
  8696. @cindex completion, of option keywords
  8697. @cindex completion, of tags
  8698. @cindex completion, of property keys
  8699. @cindex completion, of link abbreviations
  8700. @cindex @TeX{} symbol completion
  8701. @cindex TODO keywords completion
  8702. @cindex dictionary word completion
  8703. @cindex option keyword completion
  8704. @cindex tag completion
  8705. @cindex link abbreviations, completion of
  8706. Org supports in-buffer completion. This type of completion does
  8707. not make use of the minibuffer. You simply type a few letters into
  8708. the buffer and use the key to complete text right there.
  8709. @table @kbd
  8710. @kindex M-@key{TAB}
  8711. @item M-@key{TAB}
  8712. Complete word at point
  8713. @itemize @bullet
  8714. @item
  8715. At the beginning of a headline, complete TODO keywords.
  8716. @item
  8717. After @samp{\}, complete @TeX{} symbols supported by the exporter.
  8718. @item
  8719. After @samp{*}, complete headlines in the current buffer so that they
  8720. can be used in search links like @samp{[[*find this headline]]}.
  8721. @item
  8722. After @samp{:} in a headline, complete tags. The list of tags is taken
  8723. from the variable @code{org-tag-alist} (possibly set through the
  8724. @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
  8725. dynamically from all tags used in the current buffer.
  8726. @item
  8727. After @samp{:} and not in a headline, complete property keys. The list
  8728. of keys is constructed dynamically from all keys used in the current
  8729. buffer.
  8730. @item
  8731. After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
  8732. @item
  8733. After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
  8734. @samp{OPTIONS} which set file-specific options for Org mode. When the
  8735. option keyword is already complete, pressing @kbd{M-@key{TAB}} again
  8736. will insert example settings for this keyword.
  8737. @item
  8738. In the line after @samp{#+STARTUP: }, complete startup keywords,
  8739. @ie valid keys for this line.
  8740. @item
  8741. Elsewhere, complete dictionary words using Ispell.
  8742. @end itemize
  8743. @end table
  8744. @node Customization, In-buffer settings, Completion, Miscellaneous
  8745. @section Customization
  8746. @cindex customization
  8747. @cindex options, for customization
  8748. @cindex variables, for customization
  8749. There are more than 180 variables that can be used to customize
  8750. Org. For the sake of compactness of the manual, I am not
  8751. describing the variables here. A structured overview of customization
  8752. variables is available with @kbd{M-x org-customize}. Or select
  8753. @code{Browse Org Group} from the @code{Org->Customization} menu. Many
  8754. settings can also be activated on a per-file basis, by putting special
  8755. lines into the buffer (@pxref{In-buffer settings}).
  8756. @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
  8757. @section Summary of in-buffer settings
  8758. @cindex in-buffer settings
  8759. @cindex special keywords
  8760. Org mode uses special lines in the buffer to define settings on a
  8761. per-file basis. These lines start with a @samp{#+} followed by a
  8762. keyword, a colon, and then individual words defining a setting. Several
  8763. setting words can be in the same line, but you can also have multiple
  8764. lines for the keyword. While these settings are described throughout
  8765. the manual, here is a summary. After changing any of those lines in the
  8766. buffer, press @kbd{C-c C-c} with the cursor still in the line to
  8767. activate the changes immediately. Otherwise they become effective only
  8768. when the file is visited again in a new Emacs session.
  8769. @vindex org-archive-location
  8770. @table @kbd
  8771. @item #+ARCHIVE: %s_done::
  8772. This line sets the archive location for the agenda file. It applies for
  8773. all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
  8774. of the file. The first such line also applies to any entries before it.
  8775. The corresponding variable is @code{org-archive-location}.
  8776. @item #+CATEGORY:
  8777. This line sets the category for the agenda file. The category applies
  8778. for all subsequent lines until the next @samp{#+CATEGORY} line, or the
  8779. end of the file. The first such line also applies to any entries before it.
  8780. @item #+COLUMNS: %25ITEM .....
  8781. @cindex property, COLUMNS
  8782. Set the default format for columns view. This format applies when
  8783. columns view is invoked in locations where no @code{COLUMNS} property
  8784. applies.
  8785. @item #+CONSTANTS: name1=value1 ...
  8786. @vindex org-table-formula-constants
  8787. @vindex org-table-formula
  8788. Set file-local values for constants to be used in table formulas. This
  8789. line set the local variable @code{org-table-formula-constants-local}.
  8790. The global version of this variable is
  8791. @code{org-table-formula-constants}.
  8792. @item #+FILETAGS: :tag1:tag2:tag3:
  8793. Set tags that can be inherited by any entry in the file, including the
  8794. top-level entries.
  8795. @item #+DRAWERS: NAME1 .....
  8796. @vindex org-drawers
  8797. Set the file-local set of drawers. The corresponding global variable is
  8798. @code{org-drawers}.
  8799. @item #+LINK: linkword replace
  8800. @vindex org-link-abbrev-alist
  8801. These lines (several are allowed) specify link abbreviations.
  8802. @xref{Link abbreviations}. The corresponding variable is
  8803. @code{org-link-abbrev-alist}.
  8804. @item #+PRIORITIES: highest lowest default
  8805. @vindex org-highest-priority
  8806. @vindex org-lowest-priority
  8807. @vindex org-default-priority
  8808. This line sets the limits and the default for the priorities. All three
  8809. must be either letters A-Z or numbers 0-9. The highest priority must
  8810. have a lower ASCII number that the lowest priority.
  8811. @item #+PROPERTY: Property_Name Value
  8812. This line sets a default inheritance value for entries in the current
  8813. buffer, most useful for specifying the allowed values of a property.
  8814. @cindex #+SETUPFILE
  8815. @item #+SETUPFILE: file
  8816. This line defines a file that holds more in-buffer setup. Normally this is
  8817. entirely ignored. Only when the buffer is parsed for option-setting lines
  8818. (@ie when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
  8819. settings line, or when exporting), then the contents of this file are parsed
  8820. as if they had been included in the buffer. In particular, the file can be
  8821. any other Org mode file with internal setup. You can visit the file the
  8822. cursor is in the line with @kbd{C-c '}.
  8823. @item #+STARTUP:
  8824. @cindex #+STARTUP:
  8825. @vindex org-startup-folded
  8826. This line sets options to be used at startup of Org mode, when an
  8827. Org file is being visited. The first set of options deals with the
  8828. initial visibility of the outline tree. The corresponding variable for
  8829. global default settings is @code{org-startup-folded}, with a default
  8830. value @code{t}, which means @code{overview}.
  8831. @cindex @code{overview}, STARTUP keyword
  8832. @cindex @code{content}, STARTUP keyword
  8833. @cindex @code{showall}, STARTUP keyword
  8834. @example
  8835. overview @r{top-level headlines only}
  8836. content @r{all headlines}
  8837. showall @r{no folding at all, show everything}
  8838. @end example
  8839. @vindex org-startup-align-all-tables
  8840. Then there are options for aligning tables upon visiting a file. This
  8841. is useful in files containing narrowed table columns. The corresponding
  8842. variable is @code{org-startup-align-all-tables}, with a default value
  8843. @code{nil}.
  8844. @cindex @code{align}, STARTUP keyword
  8845. @cindex @code{noalign}, STARTUP keyword
  8846. @example
  8847. align @r{align all tables}
  8848. noalign @r{don't align tables on startup}
  8849. @end example
  8850. @vindex org-log-done
  8851. @vindex org-log-note-clock-out
  8852. @vindex org-log-repeat
  8853. Logging the closing and reopening of TODO items and clock intervals can be
  8854. configured using these options (see variables @code{org-log-done},
  8855. @code{org-log-note-clock-out} and @code{org-log-repeat})
  8856. @cindex @code{logdone}, STARTUP keyword
  8857. @cindex @code{lognotedone}, STARTUP keyword
  8858. @cindex @code{nologdone}, STARTUP keyword
  8859. @cindex @code{lognoteclock-out}, STARTUP keyword
  8860. @cindex @code{nolognoteclock-out}, STARTUP keyword
  8861. @cindex @code{logrepeat}, STARTUP keyword
  8862. @cindex @code{lognoterepeat}, STARTUP keyword
  8863. @cindex @code{nologrepeat}, STARTUP keyword
  8864. @example
  8865. logdone @r{record a timestamp when an item is marked DONE}
  8866. lognotedone @r{record timestamp and a note when DONE}
  8867. nologdone @r{don't record when items are marked DONE}
  8868. logrepeat @r{record a time when reinstating a repeating item}
  8869. lognoterepeat @r{record a note when reinstating a repeating item}
  8870. nologrepeat @r{do not record when reinstating repeating item}
  8871. lognoteclock-out @r{record a note when clocking out}
  8872. nolognoteclock-out @r{don't record a note when clocking out}
  8873. @end example
  8874. @vindex org-hide-leading-stars
  8875. @vindex org-odd-levels-only
  8876. Here are the options for hiding leading stars in outline headings, and for
  8877. indenting outlines. The corresponding variables are
  8878. @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
  8879. default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
  8880. @cindex @code{hidestars}, STARTUP keyword
  8881. @cindex @code{showstars}, STARTUP keyword
  8882. @cindex @code{odd}, STARTUP keyword
  8883. @cindex @code{even}, STARTUP keyword
  8884. @example
  8885. hidestars @r{make all but one of the stars starting a headline invisible.}
  8886. showstars @r{show all stars starting a headline}
  8887. indent @r{virtual indentation according to outline level}
  8888. noindent @r{no virtual indentation according to outline level}
  8889. odd @r{allow only odd outline levels (1,3,...)}
  8890. oddeven @r{allow all outline levels}
  8891. @end example
  8892. @vindex org-put-time-stamp-overlays
  8893. @vindex org-time-stamp-overlay-formats
  8894. To turn on custom format overlays over timestamps (variables
  8895. @code{org-put-time-stamp-overlays} and
  8896. @code{org-time-stamp-overlay-formats}), use
  8897. @cindex @code{customtime}, STARTUP keyword
  8898. @example
  8899. customtime @r{overlay custom time format}
  8900. @end example
  8901. @vindex constants-unit-system
  8902. The following options influence the table spreadsheet (variable
  8903. @code{constants-unit-system}).
  8904. @cindex @code{constcgs}, STARTUP keyword
  8905. @cindex @code{constSI}, STARTUP keyword
  8906. @example
  8907. constcgs @r{@file{constants.el} should use the c-g-s unit system}
  8908. constSI @r{@file{constants.el} should use the SI unit system}
  8909. @end example
  8910. @vindex org-footnote-define-inline
  8911. @vindex org-footnote-auto-label
  8912. @vindex org-footnote-auto-adjust
  8913. To influence footnote settings, use the following keywords. The
  8914. corresponding variables are @code{org-footnote-define-inline},
  8915. @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
  8916. @cindex @code{fninline}, STARTUP keyword
  8917. @cindex @code{nofninline}, STARTUP keyword
  8918. @cindex @code{fnlocal}, STARTUP keyword
  8919. @cindex @code{fnprompt}, STARTUP keyword
  8920. @cindex @code{fnauto}, STARTUP keyword
  8921. @cindex @code{fnconfirm}, STARTUP keyword
  8922. @cindex @code{fnplain}, STARTUP keyword
  8923. @cindex @code{fnadjust}, STARTUP keyword
  8924. @cindex @code{nofnadjust}, STARTUP keyword
  8925. @example
  8926. fninline @r{define footnotes inline}
  8927. fnnoinline @r{define footnotes in separate section}
  8928. fnlocal @r{define footnotes near first reference, but not inline}
  8929. fnprompt @r{prompt for footnote labels}
  8930. fnauto @r{create [fn:1]-like labels automatically (default)}
  8931. fnconfirm @r{offer automatic label for editing or confirmation}
  8932. fnplain @r{create [1]-like labels automatically}
  8933. fnadjust @r{automatically renumber and sort footnotes}
  8934. nofnadjust @r{do not renumber and sort automatically}
  8935. @end example
  8936. @cindex org-hide-block-startup
  8937. To hide blocks on startup, use these keywords. The corresponding variable is
  8938. @code{org-hide-block-startup}.
  8939. @cindex @code{hideblocks}, STARTUP keyword
  8940. @cindex @code{nohideblocks}, STARTUP keyword
  8941. @example
  8942. hideblocks @r{Hide all begin/end blocks on startup}
  8943. nohideblocks @r{Do not hide blocks on startup}
  8944. @end example
  8945. @item #+TAGS: TAG1(c1) TAG2(c2)
  8946. @vindex org-tag-alist
  8947. These lines (several such lines are allowed) specify the valid tags in
  8948. this file, and (potentially) the corresponding @emph{fast tag selection}
  8949. keys. The corresponding variable is @code{org-tag-alist}.
  8950. @item #+TBLFM:
  8951. This line contains the formulas for the table directly above the line.
  8952. @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
  8953. @itemx #+OPTIONS:, #+BIND:
  8954. @itemx #+DESCRIPTION:, #+KEYWORDS:
  8955. @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
  8956. @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
  8957. These lines provide settings for exporting files. For more details see
  8958. @ref{Export options}.
  8959. @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
  8960. @vindex org-todo-keywords
  8961. These lines set the TODO keywords and their interpretation in the
  8962. current file. The corresponding variable is @code{org-todo-keywords}.
  8963. @end table
  8964. @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
  8965. @section The very busy C-c C-c key
  8966. @kindex C-c C-c
  8967. @cindex C-c C-c, overview
  8968. The key @kbd{C-c C-c} has many purposes in Org, which are all
  8969. mentioned scattered throughout this manual. One specific function of
  8970. this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
  8971. other circumstances it means something like @emph{``Hey Org, look
  8972. here and update according to what you see here''}. Here is a summary of
  8973. what this means in different contexts.
  8974. @itemize @minus
  8975. @item
  8976. If there are highlights in the buffer from the creation of a sparse
  8977. tree, or from clock display, remove these highlights.
  8978. @item
  8979. If the cursor is in one of the special @code{#+KEYWORD} lines, this
  8980. triggers scanning the buffer for these lines and updating the
  8981. information.
  8982. @item
  8983. If the cursor is inside a table, realign the table. This command
  8984. works even if the automatic table editor has been turned off.
  8985. @item
  8986. If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
  8987. the entire table.
  8988. @item
  8989. If the cursor is inside a table created by the @file{table.el} package,
  8990. activate that table.
  8991. @item
  8992. If the current buffer is a Remember buffer, close the note and file it.
  8993. With a prefix argument, file it, without further interaction, to the
  8994. default location.
  8995. @item
  8996. If the cursor is on a @code{<<<target>>>}, update radio targets and
  8997. corresponding links in this buffer.
  8998. @item
  8999. If the cursor is in a property line or at the start or end of a property
  9000. drawer, offer property commands.
  9001. @item
  9002. If the cursor is at a footnote reference, go to the corresponding
  9003. definition, and vice versa.
  9004. @item
  9005. If the cursor is in a plain list item with a checkbox, toggle the status
  9006. of the checkbox.
  9007. @item
  9008. If the cursor is on a numbered item in a plain list, renumber the
  9009. ordered list.
  9010. @item
  9011. If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
  9012. block is updated.
  9013. @end itemize
  9014. @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
  9015. @section A cleaner outline view
  9016. @cindex hiding leading stars
  9017. @cindex dynamic indentation
  9018. @cindex odd-levels-only outlines
  9019. @cindex clean outline view
  9020. Some people find it noisy and distracting that the Org headlines start
  9021. with a potentially large number of stars, and that text below the headlines
  9022. is not indented. This is not really a problem when you are writing a book
  9023. where the outline headings are really section headlines. However, in a more
  9024. list-oriented outline, it is clear that an indented structure is a lot
  9025. cleaner, as can be seen by comparing the two columns in the following
  9026. example:
  9027. @example
  9028. @group
  9029. * Top level headline | * Top level headline
  9030. ** Second level | * Second level
  9031. *** 3rd level | * 3rd level
  9032. some text | some text
  9033. *** 3rd level | * 3rd level
  9034. more text | more text
  9035. * Another top level headline | * Another top level headline
  9036. @end group
  9037. @end example
  9038. @noindent
  9039. It is non-trivial to make such a look work in Emacs, but Org contains three
  9040. separate features that, combined, achieve just that.
  9041. @enumerate
  9042. @item
  9043. @emph{Indentation of text below headlines}@*
  9044. You may indent text below each headline to make the left boundary line up
  9045. with the headline, like
  9046. @example
  9047. *** 3rd level
  9048. more text, now indented
  9049. @end example
  9050. @vindex org-adapt-indentation
  9051. A good way to get this indentation is by hand, and Org supports this with
  9052. paragraph filling, line wrapping, and structure editing@footnote{See also the
  9053. variable @code{org-adapt-indentation}.} preserving or adapting the
  9054. indentation as appropriate. A different approach would be to have a way to
  9055. automatically indent lines according to outline structure by adding overlays
  9056. or text properties. But I have not yet found a robust and efficient way to
  9057. do this in large files.
  9058. @item
  9059. @vindex org-hide-leading-stars
  9060. @emph{Hiding leading stars}@* You can modify the display in such a way that
  9061. all leading stars become invisible. To do this in a global way, configure
  9062. the variable @code{org-hide-leading-stars} or change this on a per-file basis
  9063. with
  9064. @example
  9065. #+STARTUP: hidestars
  9066. @end example
  9067. @noindent
  9068. Note that the opposite behavior is selected with @code{showstars}.
  9069. With hidden stars, the tree becomes:
  9070. @example
  9071. @group
  9072. * Top level headline
  9073. * Second level
  9074. * 3rd level
  9075. ...
  9076. @end group
  9077. @end example
  9078. @noindent
  9079. @vindex org-hide @r{(face)}
  9080. Note that the leading stars are not truly replaced by whitespace, they
  9081. are only fontified with the face @code{org-hide} that uses the
  9082. background color as font color. If you are not using either white or
  9083. black background, you may have to customize this face to get the wanted
  9084. effect. Another possibility is to set this font such that the extra
  9085. stars are @i{almost} invisible, for example using the color
  9086. @code{grey90} on a white background.
  9087. @item
  9088. @vindex org-odd-levels-only
  9089. Things become cleaner still if you skip all the even levels and use only odd
  9090. levels 1, 3, 5..., effectively adding two stars to go from one outline level
  9091. to the next@footnote{When you need to specify a level for a property search
  9092. or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
  9093. way we get the outline view shown at the beginning of this section. In order
  9094. to make the structure editing and export commands handle this convention
  9095. correctly, configure the variable @code{org-odd-levels-only}, or set this on
  9096. a per-file basis with one of the following lines:
  9097. @example
  9098. #+STARTUP: odd
  9099. #+STARTUP: oddeven
  9100. @end example
  9101. You can convert an Org file from single-star-per-level to the
  9102. double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
  9103. RET} in that file. The reverse operation is @kbd{M-x
  9104. org-convert-to-oddeven-levels}.
  9105. @end enumerate
  9106. @node TTY keys, Interaction, Clean view, Miscellaneous
  9107. @section Using Org on a tty
  9108. @cindex tty key bindings
  9109. Because Org contains a large number of commands, by default many of
  9110. Org's core commands are bound to keys that are generally not
  9111. accessible on a tty, such as the cursor keys (@key{left}, @key{right},
  9112. @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
  9113. together with modifiers like @key{Meta} and/or @key{Shift}. To access
  9114. these commands on a tty when special keys are unavailable, the following
  9115. alternative bindings can be used. The tty bindings below will likely be
  9116. more cumbersome; you may find for some of the bindings below that a
  9117. customized workaround suits you better. For example, changing a timestamp
  9118. is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
  9119. tty you would rather use @kbd{C-c .} to re-insert the timestamp.
  9120. @multitable @columnfractions 0.15 0.2 0.2
  9121. @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
  9122. @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
  9123. @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
  9124. @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
  9125. @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
  9126. @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
  9127. @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
  9128. @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
  9129. @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
  9130. @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
  9131. @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
  9132. @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
  9133. @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
  9134. @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
  9135. @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
  9136. @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
  9137. @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
  9138. @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
  9139. @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
  9140. @end multitable
  9141. @node Interaction, , TTY keys, Miscellaneous
  9142. @section Interaction with other packages
  9143. @cindex packages, interaction with other
  9144. Org lives in the world of GNU Emacs and interacts in various ways
  9145. with other code out there.
  9146. @menu
  9147. * Cooperation:: Packages Org cooperates with
  9148. * Conflicts:: Packages that lead to conflicts
  9149. @end menu
  9150. @node Cooperation, Conflicts, Interaction, Interaction
  9151. @subsection Packages that Org cooperates with
  9152. @table @asis
  9153. @cindex @file{calc.el}
  9154. @cindex Gillespie, Dave
  9155. @item @file{calc.el} by Dave Gillespie
  9156. Org uses the Calc package for implementing spreadsheet
  9157. functionality in its tables (@pxref{The spreadsheet}). Org
  9158. checks for the availability of Calc by looking for the function
  9159. @code{calc-eval} which will have been autoloaded during setup if Calc has
  9160. been installed properly. As of Emacs 22, Calc is part of the Emacs
  9161. distribution. Another possibility for interaction between the two
  9162. packages is using Calc for embedded calculations. @xref{Embedded Mode,
  9163. , Embedded Mode, Calc, GNU Emacs Calc Manual}.
  9164. @item @file{constants.el} by Carsten Dominik
  9165. @cindex @file{constants.el}
  9166. @cindex Dominik, Carsten
  9167. @vindex org-table-formula-constants
  9168. In a table formula (@pxref{The spreadsheet}), it is possible to use
  9169. names for natural constants or units. Instead of defining your own
  9170. constants in the variable @code{org-table-formula-constants}, install
  9171. the @file{constants} package which defines a large number of constants
  9172. and units, and lets you use unit prefixes like @samp{M} for
  9173. @samp{Mega}, etc@. You will need version 2.0 of this package, available
  9174. at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
  9175. the function @code{constants-get}, which has to be autoloaded in your
  9176. setup. See the installation instructions in the file
  9177. @file{constants.el}.
  9178. @item @file{cdlatex.el} by Carsten Dominik
  9179. @cindex @file{cdlatex.el}
  9180. @cindex Dominik, Carsten
  9181. Org mode can make use of the CDLa@TeX{} package to efficiently enter
  9182. La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
  9183. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
  9184. @cindex @file{imenu.el}
  9185. Imenu allows menu access to an index of items in a file. Org mode
  9186. supports Imenu---all you need to do to get the index is the following:
  9187. @lisp
  9188. (add-hook 'org-mode-hook
  9189. (lambda () (imenu-add-to-menubar "Imenu")))
  9190. @end lisp
  9191. @vindex org-imenu-depth
  9192. By default the index is two levels deep---you can modify the depth using
  9193. the option @code{org-imenu-depth}.
  9194. @item @file{remember.el} by John Wiegley
  9195. @cindex @file{remember.el}
  9196. @cindex Wiegley, John
  9197. Org cooperates with remember, see @ref{Remember}.
  9198. @file{Remember.el} is not part of Emacs, find it on the web.
  9199. @item @file{speedbar.el} by Eric M. Ludlam
  9200. @cindex @file{speedbar.el}
  9201. @cindex Ludlam, Eric M.
  9202. Speedbar is a package that creates a special frame displaying files and
  9203. index items in files. Org mode supports Speedbar and allows you to
  9204. drill into Org files directly from the Speedbar. It also allows you to
  9205. restrict the scope of agenda commands to a file or a subtree by using
  9206. the command @kbd{<} in the Speedbar frame.
  9207. @cindex @file{table.el}
  9208. @item @file{table.el} by Takaaki Ota
  9209. @kindex C-c C-c
  9210. @cindex table editor, @file{table.el}
  9211. @cindex @file{table.el}
  9212. @cindex Ota, Takaaki
  9213. Complex ASCII tables with automatic line wrapping, column- and
  9214. row-spanning, and alignment can be created using the Emacs table
  9215. package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
  9216. and also part of Emacs 22).
  9217. When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
  9218. will call @command{table-recognize-table} and move the cursor into the
  9219. table. Inside a table, the keymap of Org mode is inactive. In order
  9220. to execute Org mode-related commands, leave the table.
  9221. @table @kbd
  9222. @kindex C-c C-c
  9223. @item C-c C-c
  9224. Recognize @file{table.el} table. Works when the cursor is in a
  9225. table.el table.
  9226. @c
  9227. @kindex C-c ~
  9228. @item C-c ~
  9229. Insert a @file{table.el} table. If there is already a table at point, this
  9230. command converts it between the @file{table.el} format and the Org-mode
  9231. format. See the documentation string of the command
  9232. @code{org-convert-table} for the restrictions under which this is
  9233. possible.
  9234. @end table
  9235. @file{table.el} is part of Emacs 22.
  9236. @item @file{footnote.el} by Steven L. Baur
  9237. @cindex @file{footnote.el}
  9238. @cindex Baur, Steven L.
  9239. Org mode recognizes numerical footnotes as provided by this package.
  9240. However, Org mode also has its own footnote support (@pxref{Footnotes}),
  9241. which makes using @file{footnote.el} unnecessary.
  9242. @end table
  9243. @node Conflicts, , Cooperation, Interaction
  9244. @subsection Packages that lead to conflicts with Org mode
  9245. @table @asis
  9246. @cindex @code{shift-selection-mode}
  9247. @vindex org-support-shift-select
  9248. In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
  9249. cursor motions combined with the shift key should start or enlarge regions.
  9250. This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
  9251. timestamps, TODO keywords, priorities, and item bullet types if the cursor is
  9252. at such a location. By default, @kbd{S-@key{cursor}} commands outside
  9253. special contexts don't do anything, but you can customize the variable
  9254. @code{org-support-shift-select}. Org mode then tries to accommodate shift
  9255. selection by (i) using it outside of the special contexts where special
  9256. commands apply, and by (ii) extending an existing active region even if the
  9257. cursor moves across a special context.
  9258. @item @file{CUA.el} by Kim. F. Storm
  9259. @cindex @file{CUA.el}
  9260. @cindex Storm, Kim. F.
  9261. @vindex org-replace-disputed-keys
  9262. Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
  9263. (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
  9264. region. In fact, Emacs 23 has this built-in in the form of
  9265. @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
  9266. 23, you probably don't want to use another package for this purpose. However,
  9267. if you prefer to leave these keys to a different package while working in
  9268. Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
  9269. Org will move the following key bindings in Org files, and in the agenda
  9270. buffer (but not during date selection).
  9271. @example
  9272. S-UP -> M-p S-DOWN -> M-n
  9273. S-LEFT -> M-- S-RIGHT -> M-+
  9274. C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
  9275. @end example
  9276. @vindex org-disputed-keys
  9277. Yes, these are unfortunately more difficult to remember. If you want
  9278. to have other replacement keys, look at the variable
  9279. @code{org-disputed-keys}.
  9280. @item @file{yasnippet.el}
  9281. @cindex @file{yasnippet.el}
  9282. The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
  9283. @code{"\t"}) overrules yasnippets' access to this key. The following code
  9284. fixed this problem:
  9285. @lisp
  9286. (add-hook 'org-mode-hook
  9287. (lambda ()
  9288. (org-set-local 'yas/trigger-key [tab])
  9289. (define-key yas/keymap [tab] 'yas/next-field-group)))
  9290. @end lisp
  9291. @item @file{windmove.el} by Hovav Shacham
  9292. @cindex @file{windmove.el}
  9293. This package also uses the @kbd{S-<cursor>} keys, so everything written
  9294. in the paragraph above about CUA mode also applies here.
  9295. @end table
  9296. @node Hacking, History and Acknowledgments, Miscellaneous, Top
  9297. @appendix Hacking
  9298. @cindex hacking
  9299. This appendix covers some aspects where users can extend the functionality of
  9300. Org.
  9301. @menu
  9302. * Hooks:: Who to reach into Org's internals
  9303. * Add-on packages:: Available extensions
  9304. * Adding hyperlink types:: New custom link types
  9305. * Context-sensitive commands:: How to add functioality to such commands
  9306. * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
  9307. * Dynamic blocks:: Automatically filled blocks
  9308. * Special agenda views:: Customized views
  9309. * Extracting agenda information:: Postprocessing of agenda information
  9310. * Using the property API:: Writing programs that use entry properties
  9311. * Using the mapping API:: Mapping over all or selected entries
  9312. @end menu
  9313. @node Hooks, Add-on packages, Hacking, Hacking
  9314. @section Hooks
  9315. @cindex hooks
  9316. Org has a large number of hook variables that can be used to add
  9317. functionality. This appendix about hacking is going to illustrate the
  9318. use of some of them. A complete list of all hooks with documentation is
  9319. maintained by the Worg project and can be found at
  9320. @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
  9321. @node Add-on packages, Adding hyperlink types, Hooks, Hacking
  9322. @section Add-on packages
  9323. @cindex add-on packages
  9324. A large number of add-on packages have been written by various authors.
  9325. These packages are not part of Emacs, but they are distributed as contributed
  9326. packages with the separate release available at the Org mode home page at
  9327. @uref{http://orgmode.org}. The list of contributed packages, along with
  9328. documentation about each package, is maintained by the Worg project at
  9329. @uref{http://orgmode.org/worg/org-contrib/}.
  9330. @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
  9331. @section Adding hyperlink types
  9332. @cindex hyperlinks, adding new types
  9333. Org has a large number of hyperlink types built-in
  9334. (@pxref{Hyperlinks}). If you would like to add new link types, Org
  9335. provides an interface for doing so. Let's look at an example file,
  9336. @file{org-man.el}, that will add support for creating links like
  9337. @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
  9338. Emacs:
  9339. @lisp
  9340. ;;; org-man.el - Support for links to manpages in Org
  9341. (require 'org)
  9342. (org-add-link-type "man" 'org-man-open)
  9343. (add-hook 'org-store-link-functions 'org-man-store-link)
  9344. (defcustom org-man-command 'man
  9345. "The Emacs command to be used to display a man page."
  9346. :group 'org-link
  9347. :type '(choice (const man) (const woman)))
  9348. (defun org-man-open (path)
  9349. "Visit the manpage on PATH.
  9350. PATH should be a topic that can be thrown at the man command."
  9351. (funcall org-man-command path))
  9352. (defun org-man-store-link ()
  9353. "Store a link to a manpage."
  9354. (when (memq major-mode '(Man-mode woman-mode))
  9355. ;; This is a man page, we do make this link
  9356. (let* ((page (org-man-get-page-name))
  9357. (link (concat "man:" page))
  9358. (description (format "Manpage for %s" page)))
  9359. (org-store-link-props
  9360. :type "man"
  9361. :link link
  9362. :description description))))
  9363. (defun org-man-get-page-name ()
  9364. "Extract the page name from the buffer name."
  9365. ;; This works for both `Man-mode' and `woman-mode'.
  9366. (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
  9367. (match-string 1 (buffer-name))
  9368. (error "Cannot create link to this man page")))
  9369. (provide 'org-man)
  9370. ;;; org-man.el ends here
  9371. @end lisp
  9372. @noindent
  9373. You would activate this new link type in @file{.emacs} with
  9374. @lisp
  9375. (require 'org-man)
  9376. @end lisp
  9377. @noindent
  9378. Let's go through the file and see what it does.
  9379. @enumerate
  9380. @item
  9381. It does @code{(require 'org)} to make sure that @file{org.el} has been
  9382. loaded.
  9383. @item
  9384. The next line calls @code{org-add-link-type} to define a new link type
  9385. with prefix @samp{man}. The call also contains the name of a function
  9386. that will be called to follow such a link.
  9387. @item
  9388. @vindex org-store-link-functions
  9389. The next line adds a function to @code{org-store-link-functions}, in
  9390. order to allow the command @kbd{C-c l} to record a useful link in a
  9391. buffer displaying a man page.
  9392. @end enumerate
  9393. The rest of the file defines the necessary variables and functions.
  9394. First there is a customization variable that determines which Emacs
  9395. command should be used to display man pages. There are two options,
  9396. @code{man} and @code{woman}. Then the function to follow a link is
  9397. defined. It gets the link path as an argument---in this case the link
  9398. path is just a topic for the manual command. The function calls the
  9399. value of @code{org-man-command} to display the man page.
  9400. Finally the function @code{org-man-store-link} is defined. When you try
  9401. to store a link with @kbd{C-c l}, this function will be called to
  9402. try to make a link. The function must first decide if it is supposed to
  9403. create the link for this buffer type; we do this by checking the value
  9404. of the variable @code{major-mode}. If not, the function must exit and
  9405. return the value @code{nil}. If yes, the link is created by getting the
  9406. manual topic from the buffer name and prefixing it with the string
  9407. @samp{man:}. Then it must call the command @code{org-store-link-props}
  9408. and set the @code{:type} and @code{:link} properties. Optionally you
  9409. can also set the @code{:description} property to provide a default for
  9410. the link description when the link is later inserted into an Org
  9411. buffer with @kbd{C-c C-l}.
  9412. When is makes sense for your new link type, you may also define a function
  9413. @code{org-PREFIX-complete-link} that implements special (@eg completion)
  9414. support for inserting such a link with @kbd{C-c C-l}. Such a function should
  9415. not accept any arguments, and return the full link with prefix.
  9416. @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
  9417. @section Context-sensitive commands
  9418. @cindex context-sensitive commands, hooks
  9419. @cindex add-ons, context-sensitive commands
  9420. @vindex org-ctrl-c-ctrl-c-hook
  9421. Org has several commands that act differently depending on context. The most
  9422. important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
  9423. Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
  9424. Add-ons can tap into this functionality by providing a function that detects
  9425. special context for that add-on and executes functionality appropriate for
  9426. the context. Here is an example from Dan Davison's @file{org-R.el} which
  9427. allows you to evaluate commands based on the @file{R} programming language. For
  9428. this package, special contexts are lines that start with @code{#+R:} or
  9429. @code{#+RR:}.
  9430. @lisp
  9431. (defun org-R-apply-maybe ()
  9432. "Detect if this is context for org-R and execute R commands."
  9433. (if (save-excursion
  9434. (beginning-of-line 1)
  9435. (looking-at "#\\+RR?:"))
  9436. (progn (call-interactively 'org-R-apply)
  9437. t) ;; to signal that we took action
  9438. nil)) ;; to signal that we did not
  9439. (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
  9440. @end lisp
  9441. The function first checks if the cursor is in such a line. If that is the
  9442. case, @code{org-R-apply} is called and the function returns @code{t} to
  9443. signal that action was taken, and @kbd{C-c C-c} will stop looking for other
  9444. contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
  9445. @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
  9446. @section Tables and lists in arbitrary syntax
  9447. @cindex tables, in other modes
  9448. @cindex lists, in other modes
  9449. @cindex Orgtbl mode
  9450. Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
  9451. frequent feature request has been to make it work with native tables in
  9452. specific languages, for example La@TeX{}. However, this is extremely
  9453. hard to do in a general way, would lead to a customization nightmare,
  9454. and would take away much of the simplicity of the Orgtbl-mode table
  9455. editor.
  9456. This appendix describes a different approach. We keep the Orgtbl mode
  9457. table in its native format (the @i{source table}), and use a custom
  9458. function to @i{translate} the table to the correct syntax, and to
  9459. @i{install} it in the right location (the @i{target table}). This puts
  9460. the burden of writing conversion functions on the user, but it allows
  9461. for a very flexible system.
  9462. Bastien added the ability to do the same with lists. You can use Org's
  9463. facilities to edit and structure lists by turning @code{orgstruct-mode}
  9464. on, then locally exporting such lists in another format (HTML, La@TeX{}
  9465. or Texinfo.)
  9466. @menu
  9467. * Radio tables:: Sending and receiving
  9468. * A LaTeX example:: Step by step, almost a tutorial
  9469. * Translator functions:: Copy and modify
  9470. * Radio lists:: Doing the same for lists
  9471. @end menu
  9472. @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
  9473. @subsection Radio tables
  9474. @cindex radio tables
  9475. To define the location of the target table, you first need to create two
  9476. lines that are comments in the current mode, but contain magic words for
  9477. Orgtbl mode to find. Orgtbl mode will insert the translated table
  9478. between these lines, replacing whatever was there before. For example:
  9479. @example
  9480. /* BEGIN RECEIVE ORGTBL table_name */
  9481. /* END RECEIVE ORGTBL table_name */
  9482. @end example
  9483. @noindent
  9484. Just above the source table, we put a special line that tells
  9485. Orgtbl mode how to translate this table and where to install it. For
  9486. example:
  9487. @cindex #+ORGTBL
  9488. @example
  9489. #+ORGTBL: SEND table_name translation_function arguments....
  9490. @end example
  9491. @noindent
  9492. @code{table_name} is the reference name for the table that is also used
  9493. in the receiver lines. @code{translation_function} is the Lisp function
  9494. that does the translation. Furthermore, the line can contain a list of
  9495. arguments (alternating key and value) at the end. The arguments will be
  9496. passed as a property list to the translation function for
  9497. interpretation. A few standard parameters are already recognized and
  9498. acted upon before the translation function is called:
  9499. @table @code
  9500. @item :skip N
  9501. Skip the first N lines of the table. Hlines do count as separate lines for
  9502. this parameter!
  9503. @item :skipcols (n1 n2 ...)
  9504. List of columns that should be skipped. If the table has a column with
  9505. calculation marks, that column is automatically discarded as well.
  9506. Please note that the translator function sees the table @emph{after} the
  9507. removal of these columns, the function never knows that there have been
  9508. additional columns.
  9509. @end table
  9510. @noindent
  9511. The one problem remaining is how to keep the source table in the buffer
  9512. without disturbing the normal workings of the file, for example during
  9513. compilation of a C file or processing of a La@TeX{} file. There are a
  9514. number of different solutions:
  9515. @itemize @bullet
  9516. @item
  9517. The table could be placed in a block comment if that is supported by the
  9518. language. For example, in C mode you could wrap the table between
  9519. @samp{/*} and @samp{*/} lines.
  9520. @item
  9521. Sometimes it is possible to put the table after some kind of @i{END}
  9522. statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
  9523. in La@TeX{}.
  9524. @item
  9525. You can just comment the table line-by-line whenever you want to process
  9526. the file, and uncomment it whenever you need to edit the table. This
  9527. only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
  9528. makes this comment-toggling very easy, in particular if you bind it to a
  9529. key.
  9530. @end itemize
  9531. @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
  9532. @subsection A La@TeX{} example of radio tables
  9533. @cindex La@TeX{}, and Orgtbl mode
  9534. The best way to wrap the source table in La@TeX{} is to use the
  9535. @code{comment} environment provided by @file{comment.sty}. It has to be
  9536. activated by placing @code{\usepackage@{comment@}} into the document
  9537. header. Orgtbl mode can insert a radio table skeleton@footnote{By
  9538. default this works only for La@TeX{}, HTML, and Texinfo. Configure the
  9539. variable @code{orgtbl-radio-tables} to install templates for other
  9540. modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
  9541. be prompted for a table name, let's say we use @samp{salesfigures}. You
  9542. will then get the following template:
  9543. @cindex #+ORGTBL, SEND
  9544. @example
  9545. % BEGIN RECEIVE ORGTBL salesfigures
  9546. % END RECEIVE ORGTBL salesfigures
  9547. \begin@{comment@}
  9548. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  9549. | | |
  9550. \end@{comment@}
  9551. @end example
  9552. @noindent
  9553. @vindex La@TeX{}-verbatim-environments
  9554. The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
  9555. @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
  9556. into the receiver location with name @code{salesfigures}. You may now
  9557. fill in the table, feel free to use the spreadsheet features@footnote{If
  9558. the @samp{#+TBLFM} line contains an odd number of dollar characters,
  9559. this may cause problems with font-lock in La@TeX{} mode. As shown in the
  9560. example you can fix this by adding an extra line inside the
  9561. @code{comment} environment that is used to balance the dollar
  9562. expressions. If you are using AUC@TeX{} with the font-latex library, a
  9563. much better solution is to add the @code{comment} environment to the
  9564. variable @code{LaTeX-verbatim-environments}.}:
  9565. @example
  9566. % BEGIN RECEIVE ORGTBL salesfigures
  9567. % END RECEIVE ORGTBL salesfigures
  9568. \begin@{comment@}
  9569. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  9570. | Month | Days | Nr sold | per day |
  9571. |-------+------+---------+---------|
  9572. | Jan | 23 | 55 | 2.4 |
  9573. | Feb | 21 | 16 | 0.8 |
  9574. | March | 22 | 278 | 12.6 |
  9575. #+TBLFM: $4=$3/$2;%.1f
  9576. % $ (optional extra dollar to keep font-lock happy, see footnote)
  9577. \end@{comment@}
  9578. @end example
  9579. @noindent
  9580. When you are done, press @kbd{C-c C-c} in the table to get the converted
  9581. table inserted between the two marker lines.
  9582. Now let's assume you want to make the table header by hand, because you
  9583. want to control how columns are aligned, etc@. In this case we make sure
  9584. that the table translator skips the first 2 lines of the source
  9585. table, and tell the command to work as a @i{splice}, @ie to not produce
  9586. header and footer commands of the target table:
  9587. @example
  9588. \begin@{tabular@}@{lrrr@}
  9589. Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
  9590. % BEGIN RECEIVE ORGTBL salesfigures
  9591. % END RECEIVE ORGTBL salesfigures
  9592. \end@{tabular@}
  9593. %
  9594. \begin@{comment@}
  9595. #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
  9596. | Month | Days | Nr sold | per day |
  9597. |-------+------+---------+---------|
  9598. | Jan | 23 | 55 | 2.4 |
  9599. | Feb | 21 | 16 | 0.8 |
  9600. | March | 22 | 278 | 12.6 |
  9601. #+TBLFM: $4=$3/$2;%.1f
  9602. \end@{comment@}
  9603. @end example
  9604. The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
  9605. Orgtbl mode. It uses a @code{tabular} environment to typeset the table
  9606. and marks horizontal lines with @code{\hline}. Furthermore, it
  9607. interprets the following parameters (see also @pxref{Translator functions}):
  9608. @table @code
  9609. @item :splice nil/t
  9610. When set to t, return only table body lines, don't wrap them into a
  9611. tabular environment. Default is nil.
  9612. @item :fmt fmt
  9613. A format to be used to wrap each field, it should contain @code{%s} for the
  9614. original field value. For example, to wrap each field value in dollars,
  9615. you could use @code{:fmt "$%s$"}. This may also be a property list with
  9616. column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
  9617. A function of one argument can be used in place of the strings; the
  9618. function must return a formatted string.
  9619. @item :efmt efmt
  9620. Use this format to print numbers with exponentials. The format should
  9621. have @code{%s} twice for inserting mantissa and exponent, for example
  9622. @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
  9623. may also be a property list with column numbers and formats, for example
  9624. @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
  9625. @code{efmt} has been applied to a value, @code{fmt} will also be
  9626. applied. Similar to @code{fmt}, functions of two arguments can be
  9627. supplied instead of strings.
  9628. @end table
  9629. @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
  9630. @subsection Translator functions
  9631. @cindex HTML, and Orgtbl mode
  9632. @cindex translator function
  9633. Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
  9634. (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
  9635. @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
  9636. Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
  9637. code that produces tables during HTML export.}, these all use a generic
  9638. translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
  9639. itself is a very short function that computes the column definitions for the
  9640. @code{tabular} environment, defines a few field and line separators and then
  9641. hands processing over to the generic translator. Here is the entire code:
  9642. @lisp
  9643. @group
  9644. (defun orgtbl-to-latex (table params)
  9645. "Convert the Orgtbl mode TABLE to LaTeX."
  9646. (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
  9647. org-table-last-alignment ""))
  9648. (params2
  9649. (list
  9650. :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
  9651. :tend "\\end@{tabular@}"
  9652. :lstart "" :lend " \\\\" :sep " & "
  9653. :efmt "%s\\,(%s)" :hline "\\hline")))
  9654. (orgtbl-to-generic table (org-combine-plists params2 params))))
  9655. @end group
  9656. @end lisp
  9657. As you can see, the properties passed into the function (variable
  9658. @var{PARAMS}) are combined with the ones newly defined in the function
  9659. (variable @var{PARAMS2}). The ones passed into the function (@ie the
  9660. ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
  9661. would like to use the La@TeX{} translator, but wanted the line endings to
  9662. be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
  9663. overrule the default with
  9664. @example
  9665. #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
  9666. @end example
  9667. For a new language, you can either write your own converter function in
  9668. analogy with the La@TeX{} translator, or you can use the generic function
  9669. directly. For example, if you have a language where a table is started
  9670. with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
  9671. started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
  9672. separator is a TAB, you could call the generic translator like this (on
  9673. a single line!):
  9674. @example
  9675. #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
  9676. :lstart "!BL! " :lend " !EL!" :sep "\t"
  9677. @end example
  9678. @noindent
  9679. Please check the documentation string of the function
  9680. @code{orgtbl-to-generic} for a full list of parameters understood by
  9681. that function, and remember that you can pass each of them into
  9682. @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
  9683. using the generic function.
  9684. Of course you can also write a completely new function doing complicated
  9685. things the generic translator cannot do. A translator function takes
  9686. two arguments. The first argument is the table, a list of lines, each
  9687. line either the symbol @code{hline} or a list of fields. The second
  9688. argument is the property list containing all parameters specified in the
  9689. @samp{#+ORGTBL: SEND} line. The function must return a single string
  9690. containing the formatted table. If you write a generally useful
  9691. translator, please post it on @email{emacs-orgmode@@gnu.org} so that
  9692. others can benefit from your work.
  9693. @node Radio lists, , Translator functions, Tables in arbitrary syntax
  9694. @subsection Radio lists
  9695. @cindex radio lists
  9696. @cindex org-list-insert-radio-list
  9697. Sending and receiving radio lists works exactly the same way than
  9698. sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
  9699. need to load the @code{org-export-latex.el} package to use radio lists
  9700. since the relevant code is there for now.}. As for radio tables, you
  9701. can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by
  9702. calling @code{org-list-insert-radio-list}.
  9703. Here are the differences with radio tables:
  9704. @itemize @minus
  9705. @item
  9706. Use @code{ORGLST} instead of @code{ORGTBL}.
  9707. @item
  9708. The available translation functions for radio lists don't take
  9709. parameters.
  9710. @item
  9711. @kbd{C-c C-c} will work when pressed on the first item of the list.
  9712. @end itemize
  9713. Here is a La@TeX{} example. Let's say that you have this in your
  9714. La@TeX{} file:
  9715. @cindex #+ORGLIST
  9716. @example
  9717. % BEGIN RECEIVE ORGLST to-buy
  9718. % END RECEIVE ORGLST to-buy
  9719. \begin@{comment@}
  9720. #+ORGLIST: SEND to-buy orgtbl-to-latex
  9721. - a new house
  9722. - a new computer
  9723. + a new keyboard
  9724. + a new mouse
  9725. - a new life
  9726. \end@{comment@}
  9727. @end example
  9728. Pressing `C-c C-c' on @code{a new house} and will insert the converted
  9729. La@TeX{} list between the two marker lines.
  9730. @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
  9731. @section Dynamic blocks
  9732. @cindex dynamic blocks
  9733. Org documents can contain @emph{dynamic blocks}. These are
  9734. specially marked regions that are updated by some user-written function.
  9735. A good example for such a block is the clock table inserted by the
  9736. command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
  9737. Dynamic block are enclosed by a BEGIN-END structure that assigns a name
  9738. to the block and can also specify parameters for the function producing
  9739. the content of the block.
  9740. #+BEGIN:dynamic block
  9741. @example
  9742. #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
  9743. #+END:
  9744. @end example
  9745. Dynamic blocks are updated with the following commands
  9746. @table @kbd
  9747. @kindex C-c C-x C-u
  9748. @item C-c C-x C-u
  9749. Update dynamic block at point.
  9750. @kindex C-u C-c C-x C-u
  9751. @item C-u C-c C-x C-u
  9752. Update all dynamic blocks in the current file.
  9753. @end table
  9754. Updating a dynamic block means to remove all the text between BEGIN and
  9755. END, parse the BEGIN line for parameters and then call the specific
  9756. writer function for this block to insert the new content. If you want
  9757. to use the original content in the writer function, you can use the
  9758. extra parameter @code{:content}.
  9759. For a block with name @code{myblock}, the writer function is
  9760. @code{org-dblock-write:myblock} with as only parameter a property list
  9761. with the parameters given in the begin line. Here is a trivial example
  9762. of a block that keeps track of when the block update function was last
  9763. run:
  9764. @example
  9765. #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
  9766. #+END:
  9767. @end example
  9768. @noindent
  9769. The corresponding block writer function could look like this:
  9770. @lisp
  9771. (defun org-dblock-write:block-update-time (params)
  9772. (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
  9773. (insert "Last block update at: "
  9774. (format-time-string fmt (current-time)))))
  9775. @end lisp
  9776. If you want to make sure that all dynamic blocks are always up-to-date,
  9777. you could add the function @code{org-update-all-dblocks} to a hook, for
  9778. example @code{before-save-hook}. @code{org-update-all-dblocks} is
  9779. written in a way such that it does nothing in buffers that are not in
  9780. @code{org-mode}.
  9781. @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
  9782. @section Special agenda views
  9783. @cindex agenda views, user-defined
  9784. Org provides a special hook that can be used to narrow down the
  9785. selection made by any of the agenda views. You may specify a function
  9786. that is used at each match to verify if the match should indeed be part
  9787. of the agenda view, and if not, how much should be skipped.
  9788. Let's say you want to produce a list of projects that contain a WAITING
  9789. tag anywhere in the project tree. Let's further assume that you have
  9790. marked all tree headings that define a project with the TODO keyword
  9791. PROJECT. In this case you would run a TODO search for the keyword
  9792. PROJECT, but skip the match unless there is a WAITING tag anywhere in
  9793. the subtree belonging to the project line.
  9794. To achieve this, you must write a function that searches the subtree for
  9795. the tag. If the tag is found, the function must return @code{nil} to
  9796. indicate that this match should not be skipped. If there is no such
  9797. tag, return the location of the end of the subtree, to indicate that
  9798. search should continue from there.
  9799. @lisp
  9800. (defun my-skip-unless-waiting ()
  9801. "Skip trees that are not waiting"
  9802. (let ((subtree-end (save-excursion (org-end-of-subtree t))))
  9803. (if (re-search-forward ":waiting:" subtree-end t)
  9804. nil ; tag found, do not skip
  9805. subtree-end))) ; tag not found, continue after end of subtree
  9806. @end lisp
  9807. Now you may use this function in an agenda custom command, for example
  9808. like this:
  9809. @lisp
  9810. (org-add-agenda-custom-command
  9811. '("b" todo "PROJECT"
  9812. ((org-agenda-skip-function 'my-skip-unless-waiting)
  9813. (org-agenda-overriding-header "Projects waiting for something: "))))
  9814. @end lisp
  9815. @vindex org-agenda-overriding-header
  9816. Note that this also binds @code{org-agenda-overriding-header} to get a
  9817. meaningful header in the agenda view.
  9818. @vindex org-odd-levels-only
  9819. @vindex org-agenda-skip-function
  9820. A general way to create custom searches is to base them on a search for
  9821. entries with a certain level limit. If you want to study all entries with
  9822. your custom search function, simply do a search for
  9823. @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
  9824. level number corresponds to order in the hierarchy, not to the number of
  9825. stars.}, and then use @code{org-agenda-skip-function} to select the entries
  9826. you really want to have.
  9827. You may also put a Lisp form into @code{org-agenda-skip-function}. In
  9828. particular, you may use the functions @code{org-agenda-skip-entry-if}
  9829. and @code{org-agenda-skip-subtree-if} in this form, for example:
  9830. @table @code
  9831. @item '(org-agenda-skip-entry-if 'scheduled)
  9832. Skip current entry if it has been scheduled.
  9833. @item '(org-agenda-skip-entry-if 'notscheduled)
  9834. Skip current entry if it has not been scheduled.
  9835. @item '(org-agenda-skip-entry-if 'deadline)
  9836. Skip current entry if it has a deadline.
  9837. @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
  9838. Skip current entry if it has a deadline, or if it is scheduled.
  9839. @item '(org-agenda-skip-entry-if 'timestamp)
  9840. Skip current entry if it has any timestamp, may also be deadline or scheduled.
  9841. @item '(org-agenda-skip-entry 'regexp "regular expression")
  9842. Skip current entry if the regular expression matches in the entry.
  9843. @item '(org-agenda-skip-entry 'notregexp "regular expression")
  9844. Skip current entry unless the regular expression matches.
  9845. @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
  9846. Same as above, but check and skip the entire subtree.
  9847. @end table
  9848. Therefore we could also have written the search for WAITING projects
  9849. like this, even without defining a special function:
  9850. @lisp
  9851. (org-add-agenda-custom-command
  9852. '("b" todo "PROJECT"
  9853. ((org-agenda-skip-function '(org-agenda-skip-subtree-if
  9854. 'regexp ":waiting:"))
  9855. (org-agenda-overriding-header "Projects waiting for something: "))))
  9856. @end lisp
  9857. @node Extracting agenda information, Using the property API, Special agenda views, Hacking
  9858. @section Extracting agenda information
  9859. @cindex agenda, pipe
  9860. @cindex Scripts, for agenda processing
  9861. @vindex org-agenda-custom-commands
  9862. Org provides commands to access agenda information for the command
  9863. line in Emacs batch mode. This extracted information can be sent
  9864. directly to a printer, or it can be read by a program that does further
  9865. processing of the data. The first of these commands is the function
  9866. @code{org-batch-agenda}, that produces an agenda view and sends it as
  9867. ASCII text to STDOUT. The command takes a single string as parameter.
  9868. If the string has length 1, it is used as a key to one of the commands
  9869. you have configured in @code{org-agenda-custom-commands}, basically any
  9870. key you can use after @kbd{C-c a}. For example, to directly print the
  9871. current TODO list, you could use
  9872. @example
  9873. emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
  9874. @end example
  9875. If the parameter is a string with 2 or more characters, it is used as a
  9876. tags/TODO match string. For example, to print your local shopping list
  9877. (all items with the tag @samp{shop}, but excluding the tag
  9878. @samp{NewYork}), you could use
  9879. @example
  9880. emacs -batch -l ~/.emacs \
  9881. -eval '(org-batch-agenda "+shop-NewYork")' | lpr
  9882. @end example
  9883. @noindent
  9884. You may also modify parameters on the fly like this:
  9885. @example
  9886. emacs -batch -l ~/.emacs \
  9887. -eval '(org-batch-agenda "a" \
  9888. org-agenda-ndays 30 \
  9889. org-agenda-include-diary nil \
  9890. org-agenda-files (quote ("~/org/project.org")))' \
  9891. | lpr
  9892. @end example
  9893. @noindent
  9894. which will produce a 30-day agenda, fully restricted to the Org file
  9895. @file{~/org/projects.org}, not even including the diary.
  9896. If you want to process the agenda data in more sophisticated ways, you
  9897. can use the command @code{org-batch-agenda-csv} to get a comma-separated
  9898. list of values for each agenda item. Each line in the output will
  9899. contain a number of fields separated by commas. The fields in a line
  9900. are:
  9901. @example
  9902. category @r{The category of the item}
  9903. head @r{The headline, without TODO keyword, TAGS and PRIORITY}
  9904. type @r{The type of the agenda entry, can be}
  9905. todo @r{selected in TODO match}
  9906. tagsmatch @r{selected in tags match}
  9907. diary @r{imported from diary}
  9908. deadline @r{a deadline}
  9909. scheduled @r{scheduled}
  9910. timestamp @r{appointment, selected by timestamp}
  9911. closed @r{entry was closed on date}
  9912. upcoming-deadline @r{warning about nearing deadline}
  9913. past-scheduled @r{forwarded scheduled item}
  9914. block @r{entry has date block including date}
  9915. todo @r{The TODO keyword, if any}
  9916. tags @r{All tags including inherited ones, separated by colons}
  9917. date @r{The relevant date, like 2007-2-14}
  9918. time @r{The time, like 15:00-16:50}
  9919. extra @r{String with extra planning info}
  9920. priority-l @r{The priority letter if any was given}
  9921. priority-n @r{The computed numerical priority}
  9922. @end example
  9923. @noindent
  9924. Time and date will only be given if a timestamp (or deadline/scheduled)
  9925. led to the selection of the item.
  9926. A CSV list like this is very easy to use in a post-processing script.
  9927. For example, here is a Perl program that gets the TODO list from
  9928. Emacs/Org and prints all the items, preceded by a checkbox:
  9929. @example
  9930. #!/usr/bin/perl
  9931. # define the Emacs command to run
  9932. $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
  9933. # run it and capture the output
  9934. $agenda = qx@{$cmd 2>/dev/null@};
  9935. # loop over all lines
  9936. foreach $line (split(/\n/,$agenda)) @{
  9937. # get the individual values
  9938. ($category,$head,$type,$todo,$tags,$date,$time,$extra,
  9939. $priority_l,$priority_n) = split(/,/,$line);
  9940. # process and print
  9941. print "[ ] $head\n";
  9942. @}
  9943. @end example
  9944. @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
  9945. @section Using the property API
  9946. @cindex API, for properties
  9947. @cindex properties, API
  9948. Here is a description of the functions that can be used to work with
  9949. properties.
  9950. @defun org-entry-properties &optional pom which
  9951. Get all properties of the entry at point-or-marker POM.@*
  9952. This includes the TODO keyword, the tags, time strings for deadline,
  9953. scheduled, and clocking, and any additional properties defined in the
  9954. entry. The return value is an alist, keys may occur multiple times
  9955. if the property key was used several times.@*
  9956. POM may also be nil, in which case the current entry is used.
  9957. If WHICH is nil or `all', get all properties. If WHICH is
  9958. `special' or `standard', only get that subclass.
  9959. @end defun
  9960. @vindex org-use-property-inheritance
  9961. @defun org-entry-get pom property &optional inherit
  9962. Get value of PROPERTY for entry at point-or-marker POM. By default,
  9963. this only looks at properties defined locally in the entry. If INHERIT
  9964. is non-nil and the entry does not have the property, then also check
  9965. higher levels of the hierarchy. If INHERIT is the symbol
  9966. @code{selective}, use inheritance if and only if the setting of
  9967. @code{org-use-property-inheritance} selects PROPERTY for inheritance.
  9968. @end defun
  9969. @defun org-entry-delete pom property
  9970. Delete the property PROPERTY from entry at point-or-marker POM.
  9971. @end defun
  9972. @defun org-entry-put pom property value
  9973. Set PROPERTY to VALUE for entry at point-or-marker POM.
  9974. @end defun
  9975. @defun org-buffer-property-keys &optional include-specials
  9976. Get all property keys in the current buffer.
  9977. @end defun
  9978. @defun org-insert-property-drawer
  9979. Insert a property drawer at point.
  9980. @end defun
  9981. @defun org-entry-put-multivalued-property pom property &rest values
  9982. Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
  9983. strings. They will be concatenated, with spaces as separators.
  9984. @end defun
  9985. @defun org-entry-get-multivalued-property pom property
  9986. Treat the value of the property PROPERTY as a whitespace-separated list of
  9987. values and return the values as a list of strings.
  9988. @end defun
  9989. @defun org-entry-add-to-multivalued-property pom property value
  9990. Treat the value of the property PROPERTY as a whitespace-separated list of
  9991. values and make sure that VALUE is in this list.
  9992. @end defun
  9993. @defun org-entry-remove-from-multivalued-property pom property value
  9994. Treat the value of the property PROPERTY as a whitespace-separated list of
  9995. values and make sure that VALUE is @emph{not} in this list.
  9996. @end defun
  9997. @defun org-entry-member-in-multivalued-property pom property value
  9998. Treat the value of the property PROPERTY as a whitespace-separated list of
  9999. values and check if VALUE is in this list.
  10000. @end defun
  10001. @node Using the mapping API, , Using the property API, Hacking
  10002. @section Using the mapping API
  10003. @cindex API, for mapping
  10004. @cindex mapping entries, API
  10005. Org has sophisticated mapping capabilities to find all entries satisfying
  10006. certain criteria. Internally, this functionality is used to produce agenda
  10007. views, but there is also an API that can be used to execute arbitrary
  10008. functions for each or selected entries. The main entry point for this API
  10009. is:
  10010. @defun org-map-entries func &optional match scope &rest skip
  10011. Call FUNC at each headline selected by MATCH in SCOPE.
  10012. FUNC is a function or a Lisp form. The function will be called without
  10013. arguments, with the cursor positioned at the beginning of the headline.
  10014. The return values of all calls to the function will be collected and
  10015. returned as a list.
  10016. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  10017. does not need to preserve point. After evaluaton, the cursor will be
  10018. moved to the end of the line (presumably of the headline of the
  10019. processed entry) and search continues from there. Under some
  10020. circumstances, this may not produce the wanted results. For example,
  10021. if you have removed (@eg archived) the current (sub)tree it could
  10022. mean that the next entry will be skipped entirely. In such cases, you
  10023. can specify the position from where search should continue by making
  10024. FUNC set the variable `org-map-continue-from' to the desired buffer
  10025. position.
  10026. MATCH is a tags/property/todo match as it is used in the agenda match view.
  10027. Only headlines that are matched by this query will be considered during
  10028. the iteration. When MATCH is nil or t, all headlines will be
  10029. visited by the iteration.
  10030. SCOPE determines the scope of this command. It can be any of:
  10031. @example
  10032. nil @r{the current buffer, respecting the restriction if any}
  10033. tree @r{the subtree started with the entry at point}
  10034. file @r{the current buffer, without restriction}
  10035. file-with-archives
  10036. @r{the current buffer, and any archives associated with it}
  10037. agenda @r{all agenda files}
  10038. agenda-with-archives
  10039. @r{all agenda files with any archive files associated with them}
  10040. (file1 file2 ...)
  10041. @r{if this is a list, all files in the list will be scanned}
  10042. @end example
  10043. @noindent
  10044. The remaining args are treated as settings for the skipping facilities of
  10045. the scanner. The following items can be given here:
  10046. @vindex org-agenda-skip-function
  10047. @example
  10048. archive @r{skip trees with the archive tag}
  10049. comment @r{skip trees with the COMMENT keyword}
  10050. function or Lisp form
  10051. @r{will be used as value for @code{org-agenda-skip-function},}
  10052. @r{so whenever the function returns t, FUNC}
  10053. @r{will not be called for that entry and search will}
  10054. @r{continue from the point where the function leaves it}
  10055. @end example
  10056. @end defun
  10057. The function given to that mapping routine can really do anything you like.
  10058. It can use the property API (@pxref{Using the property API}) to gather more
  10059. information about the entry, or in order to change metadata in the entry.
  10060. Here are a couple of functions that might be handy:
  10061. @defun org-todo &optional arg
  10062. Change the TODO state of the entry, see the docstring of the functions for
  10063. the many possible values for the argument ARG.
  10064. @end defun
  10065. @defun org-priority &optional action
  10066. Change the priority of the entry, see the docstring of this function for the
  10067. possible values for ACTION.
  10068. @end defun
  10069. @defun org-toggle-tag tag &optional onoff
  10070. Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
  10071. or @code{off} will not toggle tag, but ensure that it is either on or off.
  10072. @end defun
  10073. @defun org-promote
  10074. Promote the current entry.
  10075. @end defun
  10076. @defun org-demote
  10077. Demote the current entry.
  10078. @end defun
  10079. Here is a simple example that will turn all entries in the current file with
  10080. a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
  10081. Entries in comment trees and in archive trees will be ignored.
  10082. @lisp
  10083. (org-map-entries
  10084. '(org-todo "UPCOMING")
  10085. "+TOMORROW" 'file 'archive 'comment)
  10086. @end lisp
  10087. The following example counts the number of entries with TODO keyword
  10088. @code{WAITING}, in all agenda files.
  10089. @lisp
  10090. (length (org-map-entries t "/+WAITING" 'agenda))
  10091. @end lisp
  10092. @node History and Acknowledgments, Main Index, Hacking, Top
  10093. @appendix History and Acknowledgments
  10094. @cindex acknowledgments
  10095. @cindex history
  10096. @cindex thanks
  10097. Org was born in 2003, out of frustration over the user interface
  10098. of the Emacs Outline mode. I was trying to organize my notes and
  10099. projects, and using Emacs seemed to be the natural way to go. However,
  10100. having to remember eleven different commands with two or three keys per
  10101. command, only to hide and show parts of the outline tree, that seemed
  10102. entirely unacceptable to me. Also, when using outlines to take notes, I
  10103. constantly wanted to restructure the tree, organizing it parallel to my
  10104. thoughts and plans. @emph{Visibility cycling} and @emph{structure
  10105. editing} were originally implemented in the package
  10106. @file{outline-magic.el}, but quickly moved to the more general
  10107. @file{org.el}. As this environment became comfortable for project
  10108. planning, the next step was adding @emph{TODO entries}, basic
  10109. @emph{timestamps}, and @emph{table support}. These areas highlighted the two main
  10110. goals that Org still has today: To be a new, outline-based,
  10111. plain text mode with innovative and intuitive editing features, and to
  10112. incorporate project planning functionality directly into a notes file.
  10113. A special thanks goes to @i{Bastien Guerry} who has not only written a large
  10114. number of extensions to Org (most of them integrated into the core by now),
  10115. but who has also helped in the development and maintenance of Org so much that he
  10116. should be considered the main co-contributor to this package.
  10117. Since the first release, literally thousands of emails to me or to
  10118. @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
  10119. reports, feedback, new ideas, and sometimes patches and add-on code.
  10120. Many thanks to everyone who has helped to improve this package. I am
  10121. trying to keep here a list of the people who had significant influence
  10122. in shaping one or more aspects of Org. The list may not be
  10123. complete, if I have forgotten someone, please accept my apologies and
  10124. let me know.
  10125. @itemize @bullet
  10126. @item
  10127. @i{Russel Adams} came up with the idea for drawers.
  10128. @item
  10129. @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
  10130. @item
  10131. @i{Christophe Bataillon} created the great unicorn logo that we use on the
  10132. Org-mode website.
  10133. @item
  10134. @i{Alex Bochannek} provided a patch for rounding timestamps.
  10135. @item
  10136. @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
  10137. @item
  10138. @i{Tom Breton} wrote @file{org-choose.el}.
  10139. @item
  10140. @i{Charles Cave}'s suggestion sparked the implementation of templates
  10141. for Remember.
  10142. @item
  10143. @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
  10144. specified time.
  10145. @item
  10146. @i{Gregory Chernov} patched support for Lisp forms into table
  10147. calculations and improved XEmacs compatibility, in particular by porting
  10148. @file{nouline.el} to XEmacs.
  10149. @item
  10150. @i{Sacha Chua} suggested copying some linking code from Planner.
  10151. @item
  10152. @i{Baoqiu Cui} contributed the DocBook exporter.
  10153. @item
  10154. @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
  10155. came up with the idea of properties, and that there should be an API for
  10156. them.
  10157. @item
  10158. @i{Nick Dokos} tracked down several nasty bugs.
  10159. @item
  10160. @i{Kees Dullemond} used to edit projects lists directly in HTML and so
  10161. inspired some of the early development, including HTML export. He also
  10162. asked for a way to narrow wide table columns.
  10163. @item
  10164. @i{Christian Egli} converted the documentation into Texinfo format,
  10165. patched CSS formatting into the HTML exporter, and inspired the agenda.
  10166. @item
  10167. @i{David Emery} provided a patch for custom CSS support in exported
  10168. HTML agendas.
  10169. @item
  10170. @i{Nic Ferrier} contributed mailcap and XOXO support.
  10171. @item
  10172. @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
  10173. @item
  10174. @i{John Foerch} figured out how to make incremental search show context
  10175. around a match in a hidden outline tree.
  10176. @item
  10177. @i{Niels Giesen} had the idea to automatically archive DONE trees.
  10178. @item
  10179. @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
  10180. has been prolific with patches, ideas, and bug reports.
  10181. @item
  10182. @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
  10183. @item
  10184. @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
  10185. task state change logging, and the clocktable. His clear explanations have
  10186. been critical when we started to adopt the Git version control system.
  10187. @item
  10188. @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
  10189. patches.
  10190. @item
  10191. @i{Phil Jackson} wrote @file{org-irc.el}.
  10192. @item
  10193. @i{Scott Jaderholm} proposed footnotes, control over whitespace between
  10194. folded entries, and column view for properties.
  10195. @item
  10196. @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
  10197. @item
  10198. @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
  10199. provided frequent feedback and some patches.
  10200. @item
  10201. @i{Matt Lundin} has proposed last-row references for table formulas and named
  10202. invisible anchors. He has also worked a lot on the FAQ.
  10203. @item
  10204. @i{Jason F. McBrayer} suggested agenda export to CSV format.
  10205. @item
  10206. @i{Max Mikhanosha} came up with the idea of refiling.
  10207. @item
  10208. @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
  10209. basis.
  10210. @item
  10211. @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
  10212. happy.
  10213. @item
  10214. @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
  10215. and being able to quickly restrict the agenda to a subtree.
  10216. @item
  10217. @i{Todd Neal} provided patches for links to Info files and Elisp forms.
  10218. @item
  10219. @i{Greg Newman} refreshed the unicorn logo into its current form.
  10220. @item
  10221. @i{Tim O'Callaghan} suggested in-file links, search options for general
  10222. file links, and TAGS.
  10223. @item
  10224. @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
  10225. into Japanese.
  10226. @item
  10227. @i{Oliver Oppitz} suggested multi-state TODO items.
  10228. @item
  10229. @i{Scott Otterson} sparked the introduction of descriptive text for
  10230. links, among other things.
  10231. @item
  10232. @i{Pete Phillips} helped during the development of the TAGS feature, and
  10233. provided frequent feedback.
  10234. @item
  10235. @i{Martin Pohlack} provided the code snippet to bundle character insertion
  10236. into bundles of 20 for undo.
  10237. @item
  10238. @i{T.V. Raman} reported bugs and suggested improvements.
  10239. @item
  10240. @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
  10241. control.
  10242. @item
  10243. @i{Paul Rivier} provided the basic implementation of named footnotes.
  10244. @item
  10245. @i{Kevin Rogers} contributed code to access VM files on remote hosts.
  10246. @item
  10247. @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
  10248. webpages derived from Org using an Info-like or a folding interface with
  10249. single-key navigation.
  10250. @item
  10251. @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
  10252. conflict with @file{allout.el}.
  10253. @item
  10254. @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
  10255. extensive patches.
  10256. @item
  10257. @i{Philip Rooke} created the Org reference card, provided lots
  10258. of feedback, developed and applied standards to the Org documentation.
  10259. @item
  10260. @i{Christian Schlauer} proposed angular brackets around links, among
  10261. other things.
  10262. @item
  10263. @i{Eric Schulte} wrote @file{org-plot.el} and contributed various patches,
  10264. small features and modules.
  10265. @item
  10266. Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
  10267. @file{organizer-mode.el}.
  10268. @item
  10269. @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
  10270. examples, and remote highlighting for referenced code lines.
  10271. @item
  10272. @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
  10273. now packaged into Org's @file{contrib} directory.
  10274. @item
  10275. @i{Daniel Sinder} came up with the idea of internal archiving by locking
  10276. subtrees.
  10277. @item
  10278. @i{Dale Smith} proposed link abbreviations.
  10279. @item
  10280. @i{James TD Smith} has contributed a large number of patches for useful
  10281. tweaks and features.
  10282. @item
  10283. @i{Adam Spiers} asked for global linking commands, inspired the link
  10284. extension system, added support for mairix, and proposed the mapping API.
  10285. @item
  10286. @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
  10287. with links transformation to Org syntax.
  10288. @item
  10289. @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
  10290. chapter about publishing.
  10291. @item
  10292. @i{J@"urgen Vollmer} contributed code generating the table of contents
  10293. in HTML output.
  10294. @item
  10295. @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
  10296. keyword.
  10297. @item
  10298. @i{David Wainberg} suggested archiving, and improvements to the linking
  10299. system.
  10300. @item
  10301. @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
  10302. @file{muse.el}, which have some overlap with Org. Initially the development
  10303. of Org was fully independent because I was not aware of the existence of
  10304. these packages. But with time I have occasionally looked at John's code and
  10305. learned a lot from it. John has also contributed a number of great ideas and
  10306. patches directly to Org, including the attachment system
  10307. (@file{org-attach.el}), integration with Apple Mail
  10308. (@file{org-mac-message.el}), and hierarchical dependencies of TODO items.
  10309. @item
  10310. @i{Carsten Wimmer} suggested some changes and helped fix a bug in
  10311. linking to Gnus.
  10312. @item
  10313. @i{Roland Winkler} requested additional key bindings to make Org
  10314. work on a tty.
  10315. @item
  10316. @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
  10317. and contributed various ideas and code snippets.
  10318. @end itemize
  10319. @node Main Index, Key Index, History and Acknowledgments, Top
  10320. @unnumbered Concept Index
  10321. @printindex cp
  10322. @node Key Index, Variable Index, Main Index, Top
  10323. @unnumbered Key Index
  10324. @printindex ky
  10325. @node Variable Index, , Key Index, Top
  10326. @unnumbered Variable Index
  10327. This is not a complete index of variables and faces, only the ones that are
  10328. mentioned in the manual. For a more complete list, use @kbd{M-x
  10329. org-customize @key{RET}} and then klick yourself through the tree.
  10330. @printindex vr
  10331. @bye
  10332. @ignore
  10333. arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
  10334. @end ignore
  10335. @c Local variables:
  10336. @c ispell-local-dictionary: "en_US-w_accents"
  10337. @c ispell-local-pdict: "./.aspell.org.pws"
  10338. @c fill-column: 77
  10339. @c End: