org.texi 701 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095
  1. \input texinfo
  2. @c %**start of header
  3. @setfilename ../../info/org
  4. @settitle The Org Manual
  5. @include org-version.inc
  6. @c Use proper quote and backtick for code sections in PDF output
  7. @c Cf. Texinfo manual 14.2
  8. @set txicodequoteundirected
  9. @set txicodequotebacktick
  10. @c Version and Contact Info
  11. @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
  12. @set AUTHOR Carsten Dominik
  13. @set MAINTAINER Carsten Dominik
  14. @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
  15. @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
  16. @c %**end of header
  17. @finalout
  18. @c -----------------------------------------------------------------------------
  19. @c Macro definitions for commands and keys
  20. @c =======================================
  21. @c The behavior of the key/command macros will depend on the flag cmdnames
  22. @c When set, commands names are shown. When clear, they are not shown.
  23. @set cmdnames
  24. @c Below we define the following macros for Org key tables:
  25. @c orgkey{key} A key item
  26. @c orgcmd{key,cmd} Key with command name
  27. @c xorgcmd{key,cmd} Key with command name as @itemx
  28. @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
  29. @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
  30. @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
  31. @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
  32. @c different functions, so format as @itemx
  33. @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
  34. @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
  35. @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
  36. @c a key but no command
  37. @c Inserts: @item key
  38. @macro orgkey{key}
  39. @kindex \key\
  40. @item @kbd{\key\}
  41. @end macro
  42. @macro xorgkey{key}
  43. @kindex \key\
  44. @itemx @kbd{\key\}
  45. @end macro
  46. @c one key with a command
  47. @c Inserts: @item KEY COMMAND
  48. @macro orgcmd{key,command}
  49. @ifset cmdnames
  50. @kindex \key\
  51. @findex \command\
  52. @iftex
  53. @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  54. @end iftex
  55. @ifnottex
  56. @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  57. @end ifnottex
  58. @end ifset
  59. @ifclear cmdnames
  60. @kindex \key\
  61. @item @kbd{\key\}
  62. @end ifclear
  63. @end macro
  64. @c One key with one command, formatted using @itemx
  65. @c Inserts: @itemx KEY COMMAND
  66. @macro xorgcmd{key,command}
  67. @ifset cmdnames
  68. @kindex \key\
  69. @findex \command\
  70. @iftex
  71. @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  72. @end iftex
  73. @ifnottex
  74. @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  75. @end ifnottex
  76. @end ifset
  77. @ifclear cmdnames
  78. @kindex \key\
  79. @itemx @kbd{\key\}
  80. @end ifclear
  81. @end macro
  82. @c one key with a command, bit do not index the key
  83. @c Inserts: @item KEY COMMAND
  84. @macro orgcmdnki{key,command}
  85. @ifset cmdnames
  86. @findex \command\
  87. @iftex
  88. @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  89. @end iftex
  90. @ifnottex
  91. @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  92. @end ifnottex
  93. @end ifset
  94. @ifclear cmdnames
  95. @item @kbd{\key\}
  96. @end ifclear
  97. @end macro
  98. @c one key with a command, and special text to replace key in item
  99. @c Inserts: @item TEXT COMMAND
  100. @macro orgcmdtkc{text,key,command}
  101. @ifset cmdnames
  102. @kindex \key\
  103. @findex \command\
  104. @iftex
  105. @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
  106. @end iftex
  107. @ifnottex
  108. @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  109. @end ifnottex
  110. @end ifset
  111. @ifclear cmdnames
  112. @kindex \key\
  113. @item @kbd{\text\}
  114. @end ifclear
  115. @end macro
  116. @c two keys with one command
  117. @c Inserts: @item KEY1 or KEY2 COMMAND
  118. @macro orgcmdkkc{key1,key2,command}
  119. @ifset cmdnames
  120. @kindex \key1\
  121. @kindex \key2\
  122. @findex \command\
  123. @iftex
  124. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  125. @end iftex
  126. @ifnottex
  127. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  128. @end ifnottex
  129. @end ifset
  130. @ifclear cmdnames
  131. @kindex \key1\
  132. @kindex \key2\
  133. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
  134. @end ifclear
  135. @end macro
  136. @c Two keys with one command name, but different functions, so format as
  137. @c @itemx
  138. @c Inserts: @item KEY1
  139. @c @itemx KEY2 COMMAND
  140. @macro orgcmdkxkc{key1,key2,command}
  141. @ifset cmdnames
  142. @kindex \key1\
  143. @kindex \key2\
  144. @findex \command\
  145. @iftex
  146. @item @kbd{\key1\}
  147. @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  148. @end iftex
  149. @ifnottex
  150. @item @kbd{\key1\}
  151. @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  152. @end ifnottex
  153. @end ifset
  154. @ifclear cmdnames
  155. @kindex \key1\
  156. @kindex \key2\
  157. @item @kbd{\key1\}
  158. @itemx @kbd{\key2\}
  159. @end ifclear
  160. @end macro
  161. @c Same as previous, but use "or short"
  162. @c Inserts: @item KEY1 or short KEY2 COMMAND
  163. @macro orgcmdkskc{key1,key2,command}
  164. @ifset cmdnames
  165. @kindex \key1\
  166. @kindex \key2\
  167. @findex \command\
  168. @iftex
  169. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  170. @end iftex
  171. @ifnottex
  172. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  173. @end ifnottex
  174. @end ifset
  175. @ifclear cmdnames
  176. @kindex \key1\
  177. @kindex \key2\
  178. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
  179. @end ifclear
  180. @end macro
  181. @c Same as previous, but use @itemx
  182. @c Inserts: @itemx KEY1 or short KEY2 COMMAND
  183. @macro xorgcmdkskc{key1,key2,command}
  184. @ifset cmdnames
  185. @kindex \key1\
  186. @kindex \key2\
  187. @findex \command\
  188. @iftex
  189. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  190. @end iftex
  191. @ifnottex
  192. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  193. @end ifnottex
  194. @end ifset
  195. @ifclear cmdnames
  196. @kindex \key1\
  197. @kindex \key2\
  198. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
  199. @end ifclear
  200. @end macro
  201. @c two keys with two commands
  202. @c Inserts: @item KEY1 COMMAND1
  203. @c @itemx KEY2 COMMAND2
  204. @macro orgcmdkkcc{key1,key2,command1,command2}
  205. @ifset cmdnames
  206. @kindex \key1\
  207. @kindex \key2\
  208. @findex \command1\
  209. @findex \command2\
  210. @iftex
  211. @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
  212. @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
  213. @end iftex
  214. @ifnottex
  215. @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
  216. @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
  217. @end ifnottex
  218. @end ifset
  219. @ifclear cmdnames
  220. @kindex \key1\
  221. @kindex \key2\
  222. @item @kbd{\key1\}
  223. @itemx @kbd{\key2\}
  224. @end ifclear
  225. @end macro
  226. @c -----------------------------------------------------------------------------
  227. @iftex
  228. @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
  229. @end iftex
  230. @c Subheadings inside a table.
  231. @macro tsubheading{text}
  232. @ifinfo
  233. @subsubheading \text\
  234. @end ifinfo
  235. @ifnotinfo
  236. @item @b{\text\}
  237. @end ifnotinfo
  238. @end macro
  239. @copying
  240. This manual is for Org version @value{VERSION}.
  241. Copyright @copyright{} 2004--2013 Free Software Foundation, Inc.
  242. @quotation
  243. Permission is granted to copy, distribute and/or modify this document
  244. under the terms of the GNU Free Documentation License, Version 1.3 or
  245. any later version published by the Free Software Foundation; with no
  246. Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
  247. and with the Back-Cover Texts as in (a) below. A copy of the license
  248. is included in the section entitled ``GNU Free Documentation License.''
  249. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
  250. modify this GNU manual.''
  251. @end quotation
  252. @end copying
  253. @dircategory Emacs editing modes
  254. @direntry
  255. * Org Mode: (org). Outline-based notes management and organizer
  256. @end direntry
  257. @titlepage
  258. @title The Org Manual
  259. @subtitle Release @value{VERSION}
  260. @author by Carsten Dominik
  261. with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, Thomas Dye and Jambunathan K.
  262. @c The following two commands start the copyright page.
  263. @page
  264. @vskip 0pt plus 1filll
  265. @insertcopying
  266. @end titlepage
  267. @c Output the table of contents at the beginning.
  268. @contents
  269. @ifnottex
  270. @c FIXME These hand-written next,prev,up node pointers make editing a lot
  271. @c harder. There should be no need for them, makeinfo can do it
  272. @c automatically for any document with a normal structure.
  273. @node Top, Introduction, (dir), (dir)
  274. @top Org Mode Manual
  275. @insertcopying
  276. @end ifnottex
  277. @menu
  278. * Introduction:: Getting started
  279. * Document Structure:: A tree works like your brain
  280. * Tables:: Pure magic for quick formatting
  281. * Hyperlinks:: Notes in context
  282. * TODO Items:: Every tree branch can be a TODO item
  283. * Tags:: Tagging headlines and matching sets of tags
  284. * Properties and Columns:: Storing information about an entry
  285. * Dates and Times:: Making items useful for planning
  286. * Capture - Refile - Archive:: The ins and outs for projects
  287. * Agenda Views:: Collecting information into views
  288. * Markup:: Prepare text for rich export
  289. * Exporting:: Sharing and publishing of notes
  290. * Publishing:: Create a web site of linked Org files
  291. * Working With Source Code:: Export, evaluate, and tangle code blocks
  292. * Miscellaneous:: All the rest which did not fit elsewhere
  293. * Hacking:: How to hack your way around
  294. * MobileOrg:: Viewing and capture on a mobile device
  295. * History and Acknowledgments:: How Org came into being
  296. * GNU Free Documentation License:: The license for this documentation.
  297. * Main Index:: An index of Org's concepts and features
  298. * Key Index:: Key bindings and where they are described
  299. * Command and Function Index:: Command names and some internal functions
  300. * Variable Index:: Variables mentioned in the manual
  301. @detailmenu
  302. --- The Detailed Node Listing ---
  303. Introduction
  304. * Summary:: Brief summary of what Org does
  305. * Installation:: Installing Org
  306. * Activation:: How to activate Org for certain buffers
  307. * Feedback:: Bug reports, ideas, patches etc.
  308. * Conventions:: Typesetting conventions in the manual
  309. Document structure
  310. * Outlines:: Org is based on Outline mode
  311. * Headlines:: How to typeset Org tree headlines
  312. * Visibility cycling:: Show and hide, much simplified
  313. * Motion:: Jumping to other headlines
  314. * Structure editing:: Changing sequence and level of headlines
  315. * Sparse trees:: Matches embedded in context
  316. * Plain lists:: Additional structure within an entry
  317. * Drawers:: Tucking stuff away
  318. * Blocks:: Folding blocks
  319. * Footnotes:: How footnotes are defined in Org's syntax
  320. * Orgstruct mode:: Structure editing outside Org
  321. Tables
  322. * Built-in table editor:: Simple tables
  323. * Column width and alignment:: Overrule the automatic settings
  324. * Column groups:: Grouping to trigger vertical lines
  325. * Orgtbl mode:: The table editor as minor mode
  326. * The spreadsheet:: The table editor has spreadsheet capabilities
  327. * Org-Plot:: Plotting from org tables
  328. The spreadsheet
  329. * References:: How to refer to another field or range
  330. * Formula syntax for Calc:: Using Calc to compute stuff
  331. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  332. * Durations and time values:: How to compute durations and time values
  333. * Field and range formulas:: Formula for specific (ranges of) fields
  334. * Column formulas:: Formulas valid for an entire column
  335. * Lookup functions:: Lookup functions for searching tables
  336. * Editing and debugging formulas:: Fixing formulas
  337. * Updating the table:: Recomputing all dependent fields
  338. * Advanced features:: Field and column names, parameters and automatic recalc
  339. Hyperlinks
  340. * Link format:: How links in Org are formatted
  341. * Internal links:: Links to other places in the current file
  342. * External links:: URL-like links to the world
  343. * Handling links:: Creating, inserting and following
  344. * Using links outside Org:: Linking from my C source code?
  345. * Link abbreviations:: Shortcuts for writing complex links
  346. * Search options:: Linking to a specific location
  347. * Custom searches:: When the default search is not enough
  348. Internal links
  349. * Radio targets:: Make targets trigger links in plain text
  350. TODO items
  351. * TODO basics:: Marking and displaying TODO entries
  352. * TODO extensions:: Workflow and assignments
  353. * Progress logging:: Dates and notes for progress
  354. * Priorities:: Some things are more important than others
  355. * Breaking down tasks:: Splitting a task into manageable pieces
  356. * Checkboxes:: Tick-off lists
  357. Extended use of TODO keywords
  358. * Workflow states:: From TODO to DONE in steps
  359. * TODO types:: I do this, Fred does the rest
  360. * Multiple sets in one file:: Mixing it all, and still finding your way
  361. * Fast access to TODO states:: Single letter selection of a state
  362. * Per-file keywords:: Different files, different requirements
  363. * Faces for TODO keywords:: Highlighting states
  364. * TODO dependencies:: When one task needs to wait for others
  365. Progress logging
  366. * Closing items:: When was this entry marked DONE?
  367. * Tracking TODO state changes:: When did the status change?
  368. * Tracking your habits:: How consistent have you been?
  369. Tags
  370. * Tag inheritance:: Tags use the tree structure of the outline
  371. * Setting tags:: How to assign tags to a headline
  372. * Tag searches:: Searching for combinations of tags
  373. Properties and columns
  374. * Property syntax:: How properties are spelled out
  375. * Special properties:: Access to other Org mode features
  376. * Property searches:: Matching property values
  377. * Property inheritance:: Passing values down the tree
  378. * Column view:: Tabular viewing and editing
  379. * Property API:: Properties for Lisp programmers
  380. Column view
  381. * Defining columns:: The COLUMNS format property
  382. * Using column view:: How to create and use column view
  383. * Capturing column view:: A dynamic block for column view
  384. Defining columns
  385. * Scope of column definitions:: Where defined, where valid?
  386. * Column attributes:: Appearance and content of a column
  387. Dates and times
  388. * Timestamps:: Assigning a time to a tree entry
  389. * Creating timestamps:: Commands which insert timestamps
  390. * Deadlines and scheduling:: Planning your work
  391. * Clocking work time:: Tracking how long you spend on a task
  392. * Effort estimates:: Planning work effort in advance
  393. * Relative timer:: Notes with a running timer
  394. * Countdown timer:: Starting a countdown timer for a task
  395. Creating timestamps
  396. * The date/time prompt:: How Org mode helps you entering date and time
  397. * Custom time format:: Making dates look different
  398. Deadlines and scheduling
  399. * Inserting deadline/schedule:: Planning items
  400. * Repeated tasks:: Items that show up again and again
  401. Clocking work time
  402. * Clocking commands:: Starting and stopping a clock
  403. * The clock table:: Detailed reports
  404. * Resolving idle time:: Resolving time when you've been idle
  405. Capture - Refile - Archive
  406. * Capture:: Capturing new stuff
  407. * Attachments:: Add files to tasks
  408. * RSS Feeds:: Getting input from RSS feeds
  409. * Protocols:: External (e.g., Browser) access to Emacs and Org
  410. * Refile and copy:: Moving/copying a tree from one place to another
  411. * Archiving:: What to do with finished projects
  412. Capture
  413. * Setting up capture:: Where notes will be stored
  414. * Using capture:: Commands to invoke and terminate capture
  415. * Capture templates:: Define the outline of different note types
  416. Capture templates
  417. * Template elements:: What is needed for a complete template entry
  418. * Template expansion:: Filling in information about time and context
  419. * Templates in contexts:: Only show a template in a specific context
  420. Archiving
  421. * Moving subtrees:: Moving a tree to an archive file
  422. * Internal archiving:: Switch off a tree but keep it in the file
  423. Agenda views
  424. * Agenda files:: Files being searched for agenda information
  425. * Agenda dispatcher:: Keyboard access to agenda views
  426. * Built-in agenda views:: What is available out of the box?
  427. * Presentation and sorting:: How agenda items are prepared for display
  428. * Agenda commands:: Remote editing of Org trees
  429. * Custom agenda views:: Defining special searches and views
  430. * Exporting Agenda Views:: Writing a view to a file
  431. * Agenda column view:: Using column view for collected entries
  432. The built-in agenda views
  433. * Weekly/daily agenda:: The calendar page with current tasks
  434. * Global TODO list:: All unfinished action items
  435. * Matching tags and properties:: Structured information with fine-tuned search
  436. * Timeline:: Time-sorted view for single file
  437. * Search view:: Find entries by searching for text
  438. * Stuck projects:: Find projects you need to review
  439. Presentation and sorting
  440. * Categories:: Not all tasks are equal
  441. * Time-of-day specifications:: How the agenda knows the time
  442. * Sorting of agenda items:: The order of things
  443. Custom agenda views
  444. * Storing searches:: Type once, use often
  445. * Block agenda:: All the stuff you need in a single buffer
  446. * Setting Options:: Changing the rules
  447. Markup for rich export
  448. * Structural markup elements:: The basic structure as seen by the exporter
  449. * Images and tables:: Tables and Images will be included
  450. * Literal examples:: Source code examples with special formatting
  451. * Include files:: Include additional files into a document
  452. * Index entries:: Making an index
  453. * Macro replacement:: Use macros to create complex output
  454. * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
  455. Structural markup elements
  456. * Document title:: Where the title is taken from
  457. * Headings and sections:: The document structure as seen by the exporter
  458. * Table of contents:: The if and where of the table of contents
  459. * Initial text:: Text before the first heading?
  460. * Lists:: Lists
  461. * Paragraphs:: Paragraphs
  462. * Footnote markup:: Footnotes
  463. * Emphasis and monospace:: Bold, italic, etc.
  464. * Horizontal rules:: Make a line
  465. * Comment lines:: What will *not* be exported
  466. Embedded @LaTeX{}
  467. * Special symbols:: Greek letters and other symbols
  468. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  469. * @LaTeX{} fragments:: Complex formulas made easy
  470. * Previewing @LaTeX{} fragments:: What will this snippet look like?
  471. * CDLaTeX mode:: Speed up entering of formulas
  472. Exporting
  473. * Selective export:: Using tags to select and exclude trees
  474. * Export options:: Per-file export settings
  475. * The export dispatcher:: How to access exporter commands
  476. * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
  477. * HTML export:: Exporting to HTML
  478. * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
  479. * DocBook export:: Exporting to DocBook
  480. * OpenDocument Text export:: Exporting to OpenDocument Text
  481. * TaskJuggler export:: Exporting to TaskJuggler
  482. * Freemind export:: Exporting to Freemind mind maps
  483. * XOXO export:: Exporting to XOXO
  484. * iCalendar export:: Exporting in iCalendar format
  485. HTML export
  486. * HTML Export commands:: How to invoke HTML export
  487. * HTML preamble and postamble:: How to insert a preamble and a postamble
  488. * Quoting HTML tags:: Using direct HTML in Org mode
  489. * Links in HTML export:: How links will be interpreted and formatted
  490. * Tables in HTML export:: How to modify the formatting of tables
  491. * Images in HTML export:: How to insert figures into HTML output
  492. * Math formatting in HTML export:: Beautiful math also on the web
  493. * Text areas in HTML export:: An alternative way to show an example
  494. * CSS support:: Changing the appearance of the output
  495. * JavaScript support:: Info and Folding in a web browser
  496. @LaTeX{} and PDF export
  497. * @LaTeX{}/PDF export commands::
  498. * Header and sectioning:: Setting up the export file structure
  499. * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
  500. * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
  501. * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
  502. * Beamer class export:: Turning the file into a presentation
  503. DocBook export
  504. * DocBook export commands:: How to invoke DocBook export
  505. * Quoting DocBook code:: Incorporating DocBook code in Org files
  506. * Recursive sections:: Recursive sections in DocBook
  507. * Tables in DocBook export:: Tables are exported as HTML tables
  508. * Images in DocBook export:: How to insert figures into DocBook output
  509. * Special characters:: How to handle special characters
  510. OpenDocument Text export
  511. * Pre-requisites for ODT export:: What packages ODT exporter relies on
  512. * ODT export commands:: How to invoke ODT export
  513. * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
  514. * Applying custom styles:: How to apply custom styles to the output
  515. * Links in ODT export:: How links will be interpreted and formatted
  516. * Tables in ODT export:: How Tables are exported
  517. * Images in ODT export:: How to insert images
  518. * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
  519. * Labels and captions in ODT export:: How captions are rendered
  520. * Literal examples in ODT export:: How source and example blocks are formatted
  521. * Advanced topics in ODT export:: Read this if you are a power user
  522. Math formatting in ODT export
  523. * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
  524. * Working with MathML or OpenDocument formula files:: How to embed equations in native format
  525. Advanced topics in ODT export
  526. * Configuring a document converter:: How to register a document converter
  527. * Working with OpenDocument style files:: Explore the internals
  528. * Creating one-off styles:: How to produce custom highlighting etc
  529. * Customizing tables in ODT export:: How to define and use Table templates
  530. * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
  531. Publishing
  532. * Configuration:: Defining projects
  533. * Uploading files:: How to get files up on the server
  534. * Sample configuration:: Example projects
  535. * Triggering publication:: Publication commands
  536. Configuration
  537. * Project alist:: The central configuration variable
  538. * Sources and destinations:: From here to there
  539. * Selecting files:: What files are part of the project?
  540. * Publishing action:: Setting the function doing the publishing
  541. * Publishing options:: Tweaking HTML/@LaTeX{} export
  542. * Publishing links:: Which links keep working after publishing?
  543. * Sitemap:: Generating a list of all pages
  544. * Generating an index:: An index that reaches across pages
  545. Sample configuration
  546. * Simple example:: One-component publishing
  547. * Complex example:: A multi-component publishing example
  548. Working with source code
  549. * Structure of code blocks:: Code block syntax described
  550. * Editing source code:: Language major-mode editing
  551. * Exporting code blocks:: Export contents and/or results
  552. * Extracting source code:: Create pure source code files
  553. * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
  554. * Library of Babel:: Use and contribute to a library of useful code blocks
  555. * Languages:: List of supported code block languages
  556. * Header arguments:: Configure code block functionality
  557. * Results of evaluation:: How evaluation results are handled
  558. * Noweb reference syntax:: Literate programming in Org mode
  559. * Key bindings and useful functions:: Work quickly with code blocks
  560. * Batch execution:: Call functions from the command line
  561. Header arguments
  562. * Using header arguments:: Different ways to set header arguments
  563. * Specific header arguments:: List of header arguments
  564. Using header arguments
  565. * System-wide header arguments:: Set global default values
  566. * Language-specific header arguments:: Set default values by language
  567. * Buffer-wide header arguments:: Set default values for a specific buffer
  568. * Header arguments in Org mode properties:: Set default values for a buffer or heading
  569. * Code block specific header arguments:: The most common way to set values
  570. * Header arguments in function calls:: The most specific level
  571. Specific header arguments
  572. * var:: Pass arguments to code blocks
  573. * results:: Specify the type of results and how they will
  574. be collected and handled
  575. * file:: Specify a path for file output
  576. * file-desc:: Specify a description for file results
  577. * dir:: Specify the default (possibly remote)
  578. directory for code block execution
  579. * exports:: Export code and/or results
  580. * tangle:: Toggle tangling and specify file name
  581. * mkdirp:: Toggle creation of parent directories of target
  582. files during tangling
  583. * comments:: Toggle insertion of comments in tangled
  584. code files
  585. * padline:: Control insertion of padding lines in tangled
  586. code files
  587. * no-expand:: Turn off variable assignment and noweb
  588. expansion during tangling
  589. * session:: Preserve the state of code evaluation
  590. * noweb:: Toggle expansion of noweb references
  591. * noweb-ref:: Specify block's noweb reference resolution target
  592. * noweb-sep:: String used to separate noweb references
  593. * cache:: Avoid re-evaluating unchanged code blocks
  594. * sep:: Delimiter for writing tabular results outside Org
  595. * hlines:: Handle horizontal lines in tables
  596. * colnames:: Handle column names in tables
  597. * rownames:: Handle row names in tables
  598. * shebang:: Make tangled files executable
  599. * eval:: Limit evaluation of specific code blocks
  600. * wrap:: Mark source block evaluation results
  601. Miscellaneous
  602. * Completion:: M-TAB knows what you need
  603. * Easy Templates:: Quick insertion of structural elements
  604. * Speed keys:: Electric commands at the beginning of a headline
  605. * Code evaluation security:: Org mode files evaluate inline code
  606. * Customization:: Adapting Org to your taste
  607. * In-buffer settings:: Overview of the #+KEYWORDS
  608. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  609. * Clean view:: Getting rid of leading stars in the outline
  610. * TTY keys:: Using Org on a tty
  611. * Interaction:: Other Emacs packages
  612. * org-crypt.el:: Encrypting Org files
  613. Interaction with other packages
  614. * Cooperation:: Packages Org cooperates with
  615. * Conflicts:: Packages that lead to conflicts
  616. Hacking
  617. * Hooks:: How to reach into Org's internals
  618. * Add-on packages:: Available extensions
  619. * Adding hyperlink types:: New custom link types
  620. * Context-sensitive commands:: How to add functionality to such commands
  621. * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
  622. * Dynamic blocks:: Automatically filled blocks
  623. * Special agenda views:: Customized views
  624. * Extracting agenda information:: Postprocessing of agenda information
  625. * Using the property API:: Writing programs that use entry properties
  626. * Using the mapping API:: Mapping over all or selected entries
  627. Tables and lists in arbitrary syntax
  628. * Radio tables:: Sending and receiving radio tables
  629. * A @LaTeX{} example:: Step by step, almost a tutorial
  630. * Translator functions:: Copy and modify
  631. * Radio lists:: Doing the same for lists
  632. MobileOrg
  633. * Setting up the staging area:: Where to interact with the mobile device
  634. * Pushing to MobileOrg:: Uploading Org files and agendas
  635. * Pulling from MobileOrg:: Integrating captured and flagged items
  636. @end detailmenu
  637. @end menu
  638. @node Introduction, Document Structure, Top, Top
  639. @chapter Introduction
  640. @cindex introduction
  641. @menu
  642. * Summary:: Brief summary of what Org does
  643. * Installation:: Installing Org
  644. * Activation:: How to activate Org for certain buffers
  645. * Feedback:: Bug reports, ideas, patches etc.
  646. * Conventions:: Typesetting conventions in the manual
  647. @end menu
  648. @node Summary, Installation, Introduction, Introduction
  649. @section Summary
  650. @cindex summary
  651. Org is a mode for keeping notes, maintaining TODO lists, and doing
  652. project planning with a fast and effective plain-text system.
  653. Org develops organizational tasks around NOTES files that contain
  654. lists or information about projects as plain text. Org is
  655. implemented on top of Outline mode, which makes it possible to keep the
  656. content of large files well structured. Visibility cycling and
  657. structure editing help to work with the tree. Tables are easily created
  658. with a built-in table editor. Org supports TODO items, deadlines,
  659. timestamps, and scheduling. It dynamically compiles entries into an
  660. agenda that utilizes and smoothly integrates much of the Emacs calendar
  661. and diary. Plain text URL-like links connect to websites, emails,
  662. Usenet messages, BBDB entries, and any files related to the projects.
  663. For printing and sharing of notes, an Org file can be exported as a
  664. structured ASCII file, as HTML, or (TODO and agenda items only) as an
  665. iCalendar file. It can also serve as a publishing tool for a set of
  666. linked web pages.
  667. As a project planning environment, Org works by adding metadata to outline
  668. nodes. Based on this data, specific entries can be extracted in queries and
  669. create dynamic @i{agenda views}.
  670. Org mode contains the Org Babel environment which allows you to work with
  671. embedded source code blocks in a file, to facilitate code evaluation,
  672. documentation, and literate programming techniques.
  673. Org's automatic, context-sensitive table editor with spreadsheet
  674. capabilities can be integrated into any major mode by activating the
  675. minor Orgtbl mode. Using a translation step, it can be used to maintain
  676. tables in arbitrary file types, for example in @LaTeX{}. The structure
  677. editing and list creation capabilities can be used outside Org with
  678. the minor Orgstruct mode.
  679. Org keeps simple things simple. When first fired up, it should
  680. feel like a straightforward, easy to use outliner. Complexity is not
  681. imposed, but a large amount of functionality is available when you need
  682. it. Org is a toolbox and can be used in different ways and for different
  683. ends, for example:
  684. @example
  685. @r{@bullet{} an outline extension with visibility cycling and structure editing}
  686. @r{@bullet{} an ASCII system and table editor for taking structured notes}
  687. @r{@bullet{} a TODO list editor}
  688. @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
  689. @pindex GTD, Getting Things Done
  690. @r{@bullet{} an environment in which to implement David Allen's GTD system}
  691. @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
  692. @r{@bullet{} a publishing tool to create a set of interlinked webpages}
  693. @r{@bullet{} an environment for literate programming}
  694. @end example
  695. @cindex FAQ
  696. There is a website for Org which provides links to the newest
  697. version of Org, as well as additional information, frequently asked
  698. questions (FAQ), links to tutorials, etc. This page is located at
  699. @uref{http://orgmode.org}.
  700. @cindex print edition
  701. The version 7.3 of this manual is available as a
  702. @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
  703. Theory Ltd.}
  704. @page
  705. @node Installation, Activation, Summary, Introduction
  706. @section Installation
  707. @cindex installation
  708. @cindex XEmacs
  709. Org is part of recent distributions of GNU Emacs, so you normally don't need
  710. to install it. If, for one reason or another, you want to install Org on top
  711. of this pre-packaged version, there are three ways to do it:
  712. @itemize @bullet
  713. @item By using Emacs package system.
  714. @item By downloading Org as an archive.
  715. @item By using Org's git repository.
  716. @end itemize
  717. We @b{strongly recommend} to stick to a single installation method.
  718. @subsubheading Using Emacs packaging system
  719. Recent Emacs distributions include a packaging system which lets you install
  720. Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
  721. To make sure your Org configuration is well taken into account, initialize
  722. the package system with @code{(package-initialize)} before setting any Org
  723. option. If you want to use Org's package repository, check out the
  724. @uref{http://orgmode.org/elpa.html, Org ELPA page}.
  725. @subsubheading Downloading Org as an archive
  726. You can download Org latest release from @uref{http://orgmode.org/, Org's
  727. website}. In this case, make sure you set the load-path correctly in your
  728. @file{.emacs}:
  729. @example
  730. (add-to-list 'load-path "~/path/to/orgdir/lisp")
  731. @end example
  732. The downloaded archive contains contributed libraries that are not included
  733. in Emacs. If you want to use them, add the @file{contrib} directory to your
  734. load-path:
  735. @example
  736. (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
  737. @end example
  738. Optionally, you can compile the files and/or install them in your system.
  739. Run @code{make help} to list compilation and installation options.
  740. @subsubheading Using Org's git repository
  741. You can clone Org's repository and install Org like this:
  742. @example
  743. $ cd ~/src/
  744. $ git clone git://orgmode.org/org-mode.git
  745. $ make autoloads
  746. @end example
  747. Note that in this case, @code{make autoloads} is mandatory: it defines Org's
  748. version in @file{org-version.el} and Org's autoloads in
  749. @file{org-loaddefs.el}.
  750. Remember to add the correct load-path as described in the method above.
  751. You can also compile with @code{make}, generate the documentation with
  752. @code{make doc}, create a local configuration with @code{make config} and
  753. install Org with @code{make install}. Please run @code{make help} to get
  754. the list of compilation/installation options.
  755. For more detailed explanations on Org's build system, please check the Org
  756. Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
  757. Worg}.
  758. @node Activation, Feedback, Installation, Introduction
  759. @section Activation
  760. @cindex activation
  761. @cindex autoload
  762. @cindex ELPA
  763. @cindex global key bindings
  764. @cindex key bindings, global
  765. @findex org-agenda
  766. @findex org-capture
  767. @findex org-store-link
  768. @findex org-iswitchb
  769. Since Emacs 22.2, files with the @file{.org} extension use Org mode by
  770. default. If you are using an earlier version of Emacs, add this line to your
  771. @file{.emacs} file:
  772. @lisp
  773. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
  774. @end lisp
  775. Org mode buffers need font-lock to be turned on: this is the default in
  776. Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
  777. with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
  778. There are compatibility issues between Org mode and some other Elisp
  779. packages, please take the time to check the list (@pxref{Conflicts}).
  780. The four Org commands @command{org-store-link}, @command{org-capture},
  781. @command{org-agenda}, and @command{org-iswitchb} should be accessible through
  782. global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
  783. suggested bindings for these keys, please modify the keys to your own
  784. liking.
  785. @lisp
  786. (global-set-key "\C-cl" 'org-store-link)
  787. (global-set-key "\C-cc" 'org-capture)
  788. (global-set-key "\C-ca" 'org-agenda)
  789. (global-set-key "\C-cb" 'org-iswitchb)
  790. @end lisp
  791. @cindex Org mode, turning on
  792. With this setup, all files with extension @samp{.org} will be put
  793. into Org mode. As an alternative, make the first line of a file look
  794. like this:
  795. @example
  796. MY PROJECTS -*- mode: org; -*-
  797. @end example
  798. @vindex org-insert-mode-line-in-empty-file
  799. @noindent which will select Org mode for this buffer no matter what
  800. the file's name is. See also the variable
  801. @code{org-insert-mode-line-in-empty-file}.
  802. Many commands in Org work on the region if the region is @i{active}. To make
  803. use of this, you need to have @code{transient-mark-mode}
  804. (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
  805. in Emacs 22 you need to do this yourself with
  806. @lisp
  807. (transient-mark-mode 1)
  808. @end lisp
  809. @noindent If you do not like @code{transient-mark-mode}, you can create an
  810. active region by using the mouse to select a region, or pressing
  811. @kbd{C-@key{SPC}} twice before moving the cursor.
  812. @node Feedback, Conventions, Activation, Introduction
  813. @section Feedback
  814. @cindex feedback
  815. @cindex bug reports
  816. @cindex maintainer
  817. @cindex author
  818. If you find problems with Org, or if you have questions, remarks, or ideas
  819. about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
  820. If you are not a member of the mailing list, your mail will be passed to the
  821. list after a moderator has approved it@footnote{Please consider subscribing
  822. to the mailing list, in order to minimize the work the mailing list
  823. moderators have to do.}.
  824. For bug reports, please first try to reproduce the bug with the latest
  825. version of Org available---if you are running an outdated version, it is
  826. quite possible that the bug has been fixed already. If the bug persists,
  827. prepare a report and provide as much information as possible, including the
  828. version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
  829. (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
  830. @file{.emacs}. The easiest way to do this is to use the command
  831. @example
  832. @kbd{M-x org-submit-bug-report}
  833. @end example
  834. @noindent which will put all this information into an Emacs mail buffer so
  835. that you only need to add your description. If you re not sending the Email
  836. from within Emacs, please copy and paste the content into your Email program.
  837. Sometimes you might face a problem due to an error in your Emacs or Org mode
  838. setup. Before reporting a bug, it is very helpful to start Emacs with minimal
  839. customizations and reproduce the problem. Doing so often helps you determine
  840. if the problem is with your customization or with Org mode itself. You can
  841. start a typical minimal session with a command like the example below.
  842. @example
  843. $ emacs -Q -l /path/to/minimal-org.el
  844. @end example
  845. However if you are using Org mode as distributed with Emacs, a minimal setup
  846. is not necessary. In that case it is sufficient to start Emacs as
  847. @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
  848. shown below.
  849. @example
  850. ;;; Minimal setup to load latest `org-mode'
  851. ;; activate debugging
  852. (setq debug-on-error t
  853. debug-on-signal nil
  854. debug-on-quit nil)
  855. ;; add latest org-mode to load path
  856. (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
  857. (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
  858. @end example
  859. If an error occurs, a backtrace can be very useful (see below on how to
  860. create one). Often a small example file helps, along with clear information
  861. about:
  862. @enumerate
  863. @item What exactly did you do?
  864. @item What did you expect to happen?
  865. @item What happened instead?
  866. @end enumerate
  867. @noindent Thank you for helping to improve this program.
  868. @subsubheading How to create a useful backtrace
  869. @cindex backtrace of an error
  870. If working with Org produces an error with a message you don't
  871. understand, you may have hit a bug. The best way to report this is by
  872. providing, in addition to what was mentioned above, a @emph{backtrace}.
  873. This is information from the built-in debugger about where and how the
  874. error occurred. Here is how to produce a useful backtrace:
  875. @enumerate
  876. @item
  877. Reload uncompiled versions of all Org mode Lisp files. The backtrace
  878. contains much more information if it is produced with uncompiled code.
  879. To do this, use
  880. @example
  881. C-u M-x org-reload RET
  882. @end example
  883. @noindent
  884. or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
  885. menu.
  886. @item
  887. Go to the @code{Options} menu and select @code{Enter Debugger on Error}
  888. (XEmacs has this option in the @code{Troubleshooting} sub-menu).
  889. @item
  890. Do whatever you have to do to hit the error. Don't forget to
  891. document the steps you take.
  892. @item
  893. When you hit the error, a @file{*Backtrace*} buffer will appear on the
  894. screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
  895. attach it to your bug report.
  896. @end enumerate
  897. @node Conventions, , Feedback, Introduction
  898. @section Typesetting conventions used in this manual
  899. @subsubheading TODO keywords, tags, properties, etc.
  900. Org mainly uses three types of keywords: TODO keywords, tags and property
  901. names. In this manual we use the following conventions:
  902. @table @code
  903. @item TODO
  904. @itemx WAITING
  905. TODO keywords are written with all capitals, even if they are
  906. user-defined.
  907. @item boss
  908. @itemx ARCHIVE
  909. User-defined tags are written in lowercase; built-in tags with special
  910. meaning are written with all capitals.
  911. @item Release
  912. @itemx PRIORITY
  913. User-defined properties are capitalized; built-in properties with
  914. special meaning are written with all capitals.
  915. @end table
  916. Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
  917. and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
  918. environment). They are written in uppercase in the manual to enhance its
  919. readability, but you can use lowercase in your Org files@footnote{Easy
  920. templates insert lowercase keywords and Babel dynamically inserts
  921. @code{#+results}.}
  922. @subsubheading Keybindings and commands
  923. @kindex C-c a
  924. @findex org-agenda
  925. @kindex C-c c
  926. @findex org-capture
  927. The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda}
  928. and @kbd{C-c c} for @code{org-capture}. These are only suggestions, but the
  929. rest of the manual assumes that you are using these keybindings.
  930. Also, the manual lists both the keys and the corresponding commands for
  931. accessing a functionality. Org mode often uses the same key for different
  932. functions, depending on context. The command that is bound to such keys has
  933. a generic name, like @code{org-metaright}. In the manual we will, wherever
  934. possible, give the function that is internally called by the generic command.
  935. For example, in the chapter on document structure, @kbd{M-@key{right}} will
  936. be listed to call @code{org-do-demote}, while in the chapter on tables, it
  937. will be listed to call @code{org-table-move-column-right}. If you prefer,
  938. you can compile the manual without the command names by unsetting the flag
  939. @code{cmdnames} in @file{org.texi}.
  940. @node Document Structure, Tables, Introduction, Top
  941. @chapter Document structure
  942. @cindex document structure
  943. @cindex structure of document
  944. Org is based on Outline mode and provides flexible commands to
  945. edit the structure of the document.
  946. @menu
  947. * Outlines:: Org is based on Outline mode
  948. * Headlines:: How to typeset Org tree headlines
  949. * Visibility cycling:: Show and hide, much simplified
  950. * Motion:: Jumping to other headlines
  951. * Structure editing:: Changing sequence and level of headlines
  952. * Sparse trees:: Matches embedded in context
  953. * Plain lists:: Additional structure within an entry
  954. * Drawers:: Tucking stuff away
  955. * Blocks:: Folding blocks
  956. * Footnotes:: How footnotes are defined in Org's syntax
  957. * Orgstruct mode:: Structure editing outside Org
  958. @end menu
  959. @node Outlines, Headlines, Document Structure, Document Structure
  960. @section Outlines
  961. @cindex outlines
  962. @cindex Outline mode
  963. Org is implemented on top of Outline mode. Outlines allow a
  964. document to be organized in a hierarchical structure, which (at least
  965. for me) is the best representation of notes and thoughts. An overview
  966. of this structure is achieved by folding (hiding) large parts of the
  967. document to show only the general document structure and the parts
  968. currently being worked on. Org greatly simplifies the use of
  969. outlines by compressing the entire show/hide functionality into a single
  970. command, @command{org-cycle}, which is bound to the @key{TAB} key.
  971. @node Headlines, Visibility cycling, Outlines, Document Structure
  972. @section Headlines
  973. @cindex headlines
  974. @cindex outline tree
  975. @vindex org-special-ctrl-a/e
  976. @vindex org-special-ctrl-k
  977. @vindex org-ctrl-k-protect-subtree
  978. Headlines define the structure of an outline tree. The headlines in Org
  979. start with one or more stars, on the left margin@footnote{See the variables
  980. @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
  981. @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
  982. @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
  983. headings indented less then 30 stars.}. For example:
  984. @example
  985. * Top level headline
  986. ** Second level
  987. *** 3rd level
  988. some text
  989. *** 3rd level
  990. more text
  991. * Another top level headline
  992. @end example
  993. @noindent Some people find the many stars too noisy and would prefer an
  994. outline that has whitespace followed by a single star as headline
  995. starters. @ref{Clean view}, describes a setup to realize this.
  996. @vindex org-cycle-separator-lines
  997. An empty line after the end of a subtree is considered part of it and
  998. will be hidden when the subtree is folded. However, if you leave at
  999. least two empty lines, one empty line will remain visible after folding
  1000. the subtree, in order to structure the collapsed view. See the
  1001. variable @code{org-cycle-separator-lines} to modify this behavior.
  1002. @node Visibility cycling, Motion, Headlines, Document Structure
  1003. @section Visibility cycling
  1004. @cindex cycling, visibility
  1005. @cindex visibility cycling
  1006. @cindex trees, visibility
  1007. @cindex show hidden text
  1008. @cindex hide text
  1009. Outlines make it possible to hide parts of the text in the buffer.
  1010. Org uses just two commands, bound to @key{TAB} and
  1011. @kbd{S-@key{TAB}} to change the visibility in the buffer.
  1012. @cindex subtree visibility states
  1013. @cindex subtree cycling
  1014. @cindex folded, subtree visibility state
  1015. @cindex children, subtree visibility state
  1016. @cindex subtree, subtree visibility state
  1017. @table @asis
  1018. @orgcmd{@key{TAB},org-cycle}
  1019. @emph{Subtree cycling}: Rotate current subtree among the states
  1020. @example
  1021. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  1022. '-----------------------------------'
  1023. @end example
  1024. @vindex org-cycle-emulate-tab
  1025. @vindex org-cycle-global-at-bob
  1026. The cursor must be on a headline for this to work@footnote{see, however,
  1027. the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
  1028. beginning of the buffer and the first line is not a headline, then
  1029. @key{TAB} actually runs global cycling (see below)@footnote{see the
  1030. option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
  1031. argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
  1032. @cindex global visibility states
  1033. @cindex global cycling
  1034. @cindex overview, global visibility state
  1035. @cindex contents, global visibility state
  1036. @cindex show all, global visibility state
  1037. @orgcmd{S-@key{TAB},org-global-cycle}
  1038. @itemx C-u @key{TAB}
  1039. @emph{Global cycling}: Rotate the entire buffer among the states
  1040. @example
  1041. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  1042. '--------------------------------------'
  1043. @end example
  1044. When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
  1045. CONTENTS view up to headlines of level N will be shown. Note that inside
  1046. tables, @kbd{S-@key{TAB}} jumps to the previous field.
  1047. @cindex show all, command
  1048. @orgcmd{C-u C-u C-u @key{TAB},show-all}
  1049. Show all, including drawers.
  1050. @cindex revealing context
  1051. @orgcmd{C-c C-r,org-reveal}
  1052. Reveal context around point, showing the current entry, the following heading
  1053. and the hierarchy above. Useful for working near a location that has been
  1054. exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
  1055. (@pxref{Agenda commands}). With a prefix argument show, on each
  1056. level, all sibling headings. With a double prefix argument, also show the
  1057. entire subtree of the parent.
  1058. @cindex show branches, command
  1059. @orgcmd{C-c C-k,show-branches}
  1060. Expose all the headings of the subtree, CONTENT view for just one subtree.
  1061. @cindex show children, command
  1062. @orgcmd{C-c @key{TAB},show-children}
  1063. Expose all direct children of the subtree. With a numeric prefix argument N,
  1064. expose all children down to level N@.
  1065. @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
  1066. Show the current subtree in an indirect buffer@footnote{The indirect
  1067. buffer
  1068. @ifinfo
  1069. (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
  1070. @end ifinfo
  1071. @ifnotinfo
  1072. (see the Emacs manual for more information about indirect buffers)
  1073. @end ifnotinfo
  1074. will contain the entire buffer, but will be narrowed to the current
  1075. tree. Editing the indirect buffer will also change the original buffer,
  1076. but without affecting visibility in that buffer.}. With a numeric
  1077. prefix argument N, go up to level N and then take that tree. If N is
  1078. negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
  1079. the previously used indirect buffer.
  1080. @orgcmd{C-c C-x v,org-copy-visible}
  1081. Copy the @i{visible} text in the region into the kill ring.
  1082. @end table
  1083. @vindex org-startup-folded
  1084. @cindex @code{overview}, STARTUP keyword
  1085. @cindex @code{content}, STARTUP keyword
  1086. @cindex @code{showall}, STARTUP keyword
  1087. @cindex @code{showeverything}, STARTUP keyword
  1088. When Emacs first visits an Org file, the global state is set to
  1089. OVERVIEW, i.e., only the top level headlines are visible. This can be
  1090. configured through the variable @code{org-startup-folded}, or on a
  1091. per-file basis by adding one of the following lines anywhere in the
  1092. buffer:
  1093. @example
  1094. #+STARTUP: overview
  1095. #+STARTUP: content
  1096. #+STARTUP: showall
  1097. #+STARTUP: showeverything
  1098. @end example
  1099. @cindex property, VISIBILITY
  1100. @noindent
  1101. Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
  1102. and Columns}) will get their visibility adapted accordingly. Allowed values
  1103. for this property are @code{folded}, @code{children}, @code{content}, and
  1104. @code{all}.
  1105. @table @asis
  1106. @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
  1107. Switch back to the startup visibility of the buffer, i.e., whatever is
  1108. requested by startup options and @samp{VISIBILITY} properties in individual
  1109. entries.
  1110. @end table
  1111. @node Motion, Structure editing, Visibility cycling, Document Structure
  1112. @section Motion
  1113. @cindex motion, between headlines
  1114. @cindex jumping, to headlines
  1115. @cindex headline navigation
  1116. The following commands jump to other headlines in the buffer.
  1117. @table @asis
  1118. @orgcmd{C-c C-n,outline-next-visible-heading}
  1119. Next heading.
  1120. @orgcmd{C-c C-p,outline-previous-visible-heading}
  1121. Previous heading.
  1122. @orgcmd{C-c C-f,org-forward-same-level}
  1123. Next heading same level.
  1124. @orgcmd{C-c C-b,org-backward-same-level}
  1125. Previous heading same level.
  1126. @orgcmd{C-c C-u,outline-up-heading}
  1127. Backward to higher level heading.
  1128. @orgcmd{C-c C-j,org-goto}
  1129. Jump to a different place without changing the current outline
  1130. visibility. Shows the document structure in a temporary buffer, where
  1131. you can use the following keys to find your destination:
  1132. @vindex org-goto-auto-isearch
  1133. @example
  1134. @key{TAB} @r{Cycle visibility.}
  1135. @key{down} / @key{up} @r{Next/previous visible headline.}
  1136. @key{RET} @r{Select this location.}
  1137. @kbd{/} @r{Do a Sparse-tree search}
  1138. @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
  1139. n / p @r{Next/previous visible headline.}
  1140. f / b @r{Next/previous headline same level.}
  1141. u @r{One level up.}
  1142. 0-9 @r{Digit argument.}
  1143. q @r{Quit}
  1144. @end example
  1145. @vindex org-goto-interface
  1146. @noindent
  1147. See also the variable @code{org-goto-interface}.
  1148. @end table
  1149. @node Structure editing, Sparse trees, Motion, Document Structure
  1150. @section Structure editing
  1151. @cindex structure editing
  1152. @cindex headline, promotion and demotion
  1153. @cindex promotion, of subtrees
  1154. @cindex demotion, of subtrees
  1155. @cindex subtree, cut and paste
  1156. @cindex pasting, of subtrees
  1157. @cindex cutting, of subtrees
  1158. @cindex copying, of subtrees
  1159. @cindex sorting, of subtrees
  1160. @cindex subtrees, cut and paste
  1161. @table @asis
  1162. @orgcmd{M-@key{RET},org-insert-heading}
  1163. @vindex org-M-RET-may-split-line
  1164. Insert new heading with same level as current. If the cursor is in a plain
  1165. list item, a new item is created (@pxref{Plain lists}). To force creation of
  1166. a new headline, use a prefix argument. When this command is used in the
  1167. middle of a line, the line is split and the rest of the line becomes the new
  1168. headline@footnote{If you do not want the line to be split, customize the
  1169. variable @code{org-M-RET-may-split-line}.}. If the command is used at the
  1170. beginning of a headline, the new headline is created before the current line.
  1171. If at the beginning of any other line, the content of that line is made the
  1172. new heading. If the command is used at the end of a folded subtree (i.e.,
  1173. behind the ellipses at the end of a headline), then a headline like the
  1174. current one will be inserted after the end of the subtree.
  1175. @orgcmd{C-@key{RET},org-insert-heading-respect-content}
  1176. Just like @kbd{M-@key{RET}}, except when adding a new heading below the
  1177. current heading, the new heading is placed after the body instead of before
  1178. it. This command works from anywhere in the entry.
  1179. @orgcmd{M-S-@key{RET},org-insert-todo-heading}
  1180. @vindex org-treat-insert-todo-heading-as-state-change
  1181. Insert new TODO entry with same level as current heading. See also the
  1182. variable @code{org-treat-insert-todo-heading-as-state-change}.
  1183. @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
  1184. Insert new TODO entry with same level as current heading. Like
  1185. @kbd{C-@key{RET}}, the new headline will be inserted after the current
  1186. subtree.
  1187. @orgcmd{@key{TAB},org-cycle}
  1188. In a new entry with no text yet, the first @key{TAB} demotes the entry to
  1189. become a child of the previous one. The next @key{TAB} makes it a parent,
  1190. and so on, all the way to top level. Yet another @key{TAB}, and you are back
  1191. to the initial level.
  1192. @orgcmd{M-@key{left},org-do-promote}
  1193. Promote current heading by one level.
  1194. @orgcmd{M-@key{right},org-do-demote}
  1195. Demote current heading by one level.
  1196. @orgcmd{M-S-@key{left},org-promote-subtree}
  1197. Promote the current subtree by one level.
  1198. @orgcmd{M-S-@key{right},org-demote-subtree}
  1199. Demote the current subtree by one level.
  1200. @orgcmd{M-S-@key{up},org-move-subtree-up}
  1201. Move subtree up (swap with previous subtree of same
  1202. level).
  1203. @orgcmd{M-S-@key{down},org-move-subtree-down}
  1204. Move subtree down (swap with next subtree of same level).
  1205. @orgcmd{M-h,org-mark-element}
  1206. Mark the element at point. Hitting repeatedly will mark subsequent elements
  1207. of the one just marked. E.g. hitting @key{M-h} on a paragraph will mark it,
  1208. hitting @key{M-h} immediately again will mark the next one.
  1209. @orgcmd{C-c @@,org-mark-subtree}
  1210. Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
  1211. of the same level than the marked subtree.
  1212. @orgcmd{C-c C-x C-w,org-cut-subtree}
  1213. Kill subtree, i.e., remove it from buffer but save in kill ring.
  1214. With a numeric prefix argument N, kill N sequential subtrees.
  1215. @orgcmd{C-c C-x M-w,org-copy-subtree}
  1216. Copy subtree to kill ring. With a numeric prefix argument N, copy the N
  1217. sequential subtrees.
  1218. @orgcmd{C-c C-x C-y,org-paste-subtree}
  1219. Yank subtree from kill ring. This does modify the level of the subtree to
  1220. make sure the tree fits in nicely at the yank position. The yank level can
  1221. also be specified with a numeric prefix argument, or by yanking after a
  1222. headline marker like @samp{****}.
  1223. @orgcmd{C-y,org-yank}
  1224. @vindex org-yank-adjusted-subtrees
  1225. @vindex org-yank-folded-subtrees
  1226. Depending on the variables @code{org-yank-adjusted-subtrees} and
  1227. @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
  1228. paste subtrees folded and in a clever way, using the same command as @kbd{C-c
  1229. C-x C-y}. With the default settings, no level adjustment will take place,
  1230. but the yanked tree will be folded unless doing so would swallow text
  1231. previously visible. Any prefix argument to this command will force a normal
  1232. @code{yank} to be executed, with the prefix passed along. A good way to
  1233. force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
  1234. yank, it will yank previous kill items plainly, without adjustment and
  1235. folding.
  1236. @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
  1237. Clone a subtree by making a number of sibling copies of it. You will be
  1238. prompted for the number of copies to make, and you can also specify if any
  1239. timestamps in the entry should be shifted. This can be useful, for example,
  1240. to create a number of tasks related to a series of lectures to prepare. For
  1241. more details, see the docstring of the command
  1242. @code{org-clone-subtree-with-time-shift}.
  1243. @orgcmd{C-c C-w,org-refile}
  1244. Refile entry or region to a different location. @xref{Refile and copy}.
  1245. @orgcmd{C-c ^,org-sort}
  1246. Sort same-level entries. When there is an active region, all entries in the
  1247. region will be sorted. Otherwise the children of the current headline are
  1248. sorted. The command prompts for the sorting method, which can be
  1249. alphabetically, numerically, by time (first timestamp with active preferred,
  1250. creation time, scheduled time, deadline time), by priority, by TODO keyword
  1251. (in the sequence the keywords have been defined in the setup) or by the value
  1252. of a property. Reverse sorting is possible as well. You can also supply
  1253. your own function to extract the sorting key. With a @kbd{C-u} prefix,
  1254. sorting will be case-sensitive.
  1255. @orgcmd{C-x n s,org-narrow-to-subtree}
  1256. Narrow buffer to current subtree.
  1257. @orgcmd{C-x n b,org-narrow-to-block}
  1258. Narrow buffer to current block.
  1259. @orgcmd{C-x n w,widen}
  1260. Widen buffer to remove narrowing.
  1261. @orgcmd{C-c *,org-toggle-heading}
  1262. Turn a normal line or plain list item into a headline (so that it becomes a
  1263. subheading at its location). Also turn a headline into a normal line by
  1264. removing the stars. If there is an active region, turn all lines in the
  1265. region into headlines. If the first line in the region was an item, turn
  1266. only the item lines into headlines. Finally, if the first line is a
  1267. headline, remove the stars from all headlines in the region.
  1268. @end table
  1269. @cindex region, active
  1270. @cindex active region
  1271. @cindex transient mark mode
  1272. When there is an active region (Transient Mark mode), promotion and
  1273. demotion work on all headlines in the region. To select a region of
  1274. headlines, it is best to place both point and mark at the beginning of a
  1275. line, mark at the beginning of the first headline, and point at the line
  1276. just after the last headline to change. Note that when the cursor is
  1277. inside a table (@pxref{Tables}), the Meta-Cursor keys have different
  1278. functionality.
  1279. @node Sparse trees, Plain lists, Structure editing, Document Structure
  1280. @section Sparse trees
  1281. @cindex sparse trees
  1282. @cindex trees, sparse
  1283. @cindex folding, sparse trees
  1284. @cindex occur, command
  1285. @vindex org-show-hierarchy-above
  1286. @vindex org-show-following-heading
  1287. @vindex org-show-siblings
  1288. @vindex org-show-entry-below
  1289. An important feature of Org mode is the ability to construct @emph{sparse
  1290. trees} for selected information in an outline tree, so that the entire
  1291. document is folded as much as possible, but the selected information is made
  1292. visible along with the headline structure above it@footnote{See also the
  1293. variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
  1294. @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
  1295. control on how much context is shown around each match.}. Just try it out
  1296. and you will see immediately how it works.
  1297. Org mode contains several commands creating such trees, all these
  1298. commands can be accessed through a dispatcher:
  1299. @table @asis
  1300. @orgcmd{C-c /,org-sparse-tree}
  1301. This prompts for an extra key to select a sparse-tree creating command.
  1302. @orgcmd{C-c / r,org-occur}
  1303. @vindex org-remove-highlights-with-change
  1304. Prompts for a regexp and shows a sparse tree with all matches. If
  1305. the match is in a headline, the headline is made visible. If the match is in
  1306. the body of an entry, headline and body are made visible. In order to
  1307. provide minimal context, also the full hierarchy of headlines above the match
  1308. is shown, as well as the headline following the match. Each match is also
  1309. highlighted; the highlights disappear when the buffer is changed by an
  1310. editing command@footnote{This depends on the option
  1311. @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
  1312. When called with a @kbd{C-u} prefix argument, previous highlights are kept,
  1313. so several calls to this command can be stacked.
  1314. @orgcmdkkc{M-g n,M-g M-n,next-error}
  1315. Jump to the next sparse tree match in this buffer.
  1316. @orgcmdkkc{M-g p,M-g M-p,previous-error}
  1317. Jump to the previous sparse tree match in this buffer.
  1318. @end table
  1319. @noindent
  1320. @vindex org-agenda-custom-commands
  1321. For frequently used sparse trees of specific search strings, you can
  1322. use the variable @code{org-agenda-custom-commands} to define fast
  1323. keyboard access to specific sparse trees. These commands will then be
  1324. accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
  1325. For example:
  1326. @lisp
  1327. (setq org-agenda-custom-commands
  1328. '(("f" occur-tree "FIXME")))
  1329. @end lisp
  1330. @noindent will define the key @kbd{C-c a f} as a shortcut for creating
  1331. a sparse tree matching the string @samp{FIXME}.
  1332. The other sparse tree commands select headings based on TODO keywords,
  1333. tags, or properties and will be discussed later in this manual.
  1334. @kindex C-c C-e v
  1335. @cindex printing sparse trees
  1336. @cindex visible text, printing
  1337. To print a sparse tree, you can use the Emacs command
  1338. @code{ps-print-buffer-with-faces} which does not print invisible parts
  1339. of the document @footnote{This does not work under XEmacs, because
  1340. XEmacs uses selective display for outlining, not text properties.}.
  1341. Or you can use the command @kbd{C-c C-e v} to export only the visible
  1342. part of the document and print the resulting file.
  1343. @node Plain lists, Drawers, Sparse trees, Document Structure
  1344. @section Plain lists
  1345. @cindex plain lists
  1346. @cindex lists, plain
  1347. @cindex lists, ordered
  1348. @cindex ordered lists
  1349. Within an entry of the outline tree, hand-formatted lists can provide
  1350. additional structure. They also provide a way to create lists of checkboxes
  1351. (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
  1352. (@pxref{Exporting}) can parse and format them.
  1353. Org knows ordered lists, unordered lists, and description lists.
  1354. @itemize @bullet
  1355. @item
  1356. @emph{Unordered} list items start with @samp{-}, @samp{+}, or
  1357. @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
  1358. they will be seen as top-level headlines. Also, when you are hiding leading
  1359. stars to get a clean outline view, plain list items starting with a star may
  1360. be hard to distinguish from true headlines. In short: even though @samp{*}
  1361. is supported, it may be better to not use it for plain list items.} as
  1362. bullets.
  1363. @item
  1364. @vindex org-plain-list-ordered-item-terminator
  1365. @vindex org-alphabetical-lists
  1366. @emph{Ordered} list items start with a numeral followed by either a period or
  1367. a right parenthesis@footnote{You can filter out any of them by configuring
  1368. @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
  1369. @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
  1370. @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
  1371. confusion with normal text, those are limited to one character only. Beyond
  1372. that limit, bullets will automatically fallback to numbers.}. If you want a
  1373. list to start with a different value (e.g., 20), start the text of the item
  1374. with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
  1375. must be put @emph{before} the checkbox. If you have activated alphabetical
  1376. lists, you can also use counters like @code{[@@b]}.}. Those constructs can
  1377. be used in any item of the list in order to enforce a particular numbering.
  1378. @item
  1379. @emph{Description} list items are unordered list items, and contain the
  1380. separator @samp{ :: } to distinguish the description @emph{term} from the
  1381. description.
  1382. @end itemize
  1383. Items belonging to the same list must have the same indentation on the first
  1384. line. In particular, if an ordered list reaches number @samp{10.}, then the
  1385. 2--digit numbers must be written left-aligned with the other numbers in the
  1386. list. An item ends before the next line that is less or equally indented
  1387. than its bullet/number.
  1388. @vindex org-empty-line-terminates-plain-lists
  1389. A list ends whenever every item has ended, which means before any line less
  1390. or equally indented than items at top level. It also ends before two blank
  1391. lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
  1392. that case, all items are closed. Here is an example:
  1393. @example
  1394. @group
  1395. ** Lord of the Rings
  1396. My favorite scenes are (in this order)
  1397. 1. The attack of the Rohirrim
  1398. 2. Eowyn's fight with the witch king
  1399. + this was already my favorite scene in the book
  1400. + I really like Miranda Otto.
  1401. 3. Peter Jackson being shot by Legolas
  1402. - on DVD only
  1403. He makes a really funny face when it happens.
  1404. But in the end, no individual scenes matter but the film as a whole.
  1405. Important actors in this film are:
  1406. - @b{Elijah Wood} :: He plays Frodo
  1407. - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
  1408. him very well from his role as Mikey Walsh in @i{The Goonies}.
  1409. @end group
  1410. @end example
  1411. Org supports these lists by tuning filling and wrapping commands to deal with
  1412. them correctly@footnote{Org only changes the filling settings for Emacs. For
  1413. XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
  1414. put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
  1415. properly (@pxref{Exporting}). Since indentation is what governs the
  1416. structure of these lists, many structural constructs like @code{#+BEGIN_...}
  1417. blocks can be indented to signal that they belong to a particular item.
  1418. @vindex org-list-demote-modify-bullet
  1419. @vindex org-list-indent-offset
  1420. If you find that using a different bullet for a sub-list (than that used for
  1421. the current list-level) improves readability, customize the variable
  1422. @code{org-list-demote-modify-bullet}. To get a greater difference of
  1423. indentation between items and theirs sub-items, customize
  1424. @code{org-list-indent-offset}.
  1425. @vindex org-list-automatic-rules
  1426. The following commands act on items when the cursor is in the first line of
  1427. an item (the line with the bullet or number). Some of them imply the
  1428. application of automatic rules to keep list structure intact. If some of
  1429. these actions get in your way, configure @code{org-list-automatic-rules}
  1430. to disable them individually.
  1431. @table @asis
  1432. @orgcmd{@key{TAB},org-cycle}
  1433. @cindex cycling, in plain lists
  1434. @vindex org-cycle-include-plain-lists
  1435. Items can be folded just like headline levels. Normally this works only if
  1436. the cursor is on a plain list item. For more details, see the variable
  1437. @code{org-cycle-include-plain-lists}. If this variable is set to
  1438. @code{integrate}, plain list items will be treated like low-level
  1439. headlines. The level of an item is then given by the indentation of the
  1440. bullet/number. Items are always subordinate to real headlines, however; the
  1441. hierarchies remain completely separated. In a new item with no text yet, the
  1442. first @key{TAB} demotes the item to become a child of the previous
  1443. one. Subsequent @key{TAB}s move the item to meaningful levels in the list
  1444. and eventually get it back to its initial position.
  1445. @orgcmd{M-@key{RET},org-insert-heading}
  1446. @vindex org-M-RET-may-split-line
  1447. @vindex org-list-automatic-rules
  1448. Insert new item at current level. With a prefix argument, force a new
  1449. heading (@pxref{Structure editing}). If this command is used in the middle
  1450. of an item, that item is @emph{split} in two, and the second part becomes the
  1451. new item@footnote{If you do not want the item to be split, customize the
  1452. variable @code{org-M-RET-may-split-line}.}. If this command is executed
  1453. @emph{before item's body}, the new item is created @emph{before} the current
  1454. one.
  1455. @end table
  1456. @table @kbd
  1457. @kindex M-S-@key{RET}
  1458. @item M-S-RET
  1459. Insert a new item with a checkbox (@pxref{Checkboxes}).
  1460. @kindex S-@key{down}
  1461. @item S-up
  1462. @itemx S-down
  1463. @cindex shift-selection-mode
  1464. @vindex org-support-shift-select
  1465. @vindex org-list-use-circular-motion
  1466. Jump to the previous/next item in the current list@footnote{If you want to
  1467. cycle around items that way, you may customize
  1468. @code{org-list-use-circular-motion}.}, but only if
  1469. @code{org-support-shift-select} is off. If not, you can still use paragraph
  1470. jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
  1471. similar effect.
  1472. @kindex M-@key{up}
  1473. @kindex M-@key{down}
  1474. @item M-up
  1475. @itemx M-down
  1476. Move the item including subitems up/down@footnote{See
  1477. @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
  1478. previous/next item of same indentation). If the list is ordered, renumbering
  1479. is automatic.
  1480. @kindex M-@key{left}
  1481. @kindex M-@key{right}
  1482. @item M-left
  1483. @itemx M-right
  1484. Decrease/increase the indentation of an item, leaving children alone.
  1485. @kindex M-S-@key{left}
  1486. @kindex M-S-@key{right}
  1487. @item M-S-left
  1488. @itemx M-S-right
  1489. Decrease/increase the indentation of the item, including subitems.
  1490. Initially, the item tree is selected based on current indentation. When
  1491. these commands are executed several times in direct succession, the initially
  1492. selected region is used, even if the new indentation would imply a different
  1493. hierarchy. To use the new hierarchy, break the command chain with a cursor
  1494. motion or so.
  1495. As a special case, using this command on the very first item of a list will
  1496. move the whole list. This behavior can be disabled by configuring
  1497. @code{org-list-automatic-rules}. The global indentation of a list has no
  1498. influence on the text @emph{after} the list.
  1499. @kindex C-c C-c
  1500. @item C-c C-c
  1501. If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
  1502. state of the checkbox. In any case, verify bullets and indentation
  1503. consistency in the whole list.
  1504. @kindex C-c -
  1505. @vindex org-plain-list-ordered-item-terminator
  1506. @item C-c -
  1507. Cycle the entire list level through the different itemize/enumerate bullets
  1508. (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
  1509. depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
  1510. and its indentation. With a numeric prefix argument N, select the Nth bullet
  1511. from this list. If there is an active region when calling this, selected
  1512. text will be changed into an item. With a prefix argument, all lines will be
  1513. converted to list items. If the first line already was a list item, any item
  1514. marker will be removed from the list. Finally, even without an active
  1515. region, a normal line will be converted into a list item.
  1516. @kindex C-c *
  1517. @item C-c *
  1518. Turn a plain list item into a headline (so that it becomes a subheading at
  1519. its location). @xref{Structure editing}, for a detailed explanation.
  1520. @kindex C-c C-*
  1521. @item C-c C-*
  1522. Turn the whole plain list into a subtree of the current heading. Checkboxes
  1523. (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
  1524. (resp. checked).
  1525. @kindex S-@key{left}
  1526. @kindex S-@key{right}
  1527. @item S-left/right
  1528. @vindex org-support-shift-select
  1529. This command also cycles bullet styles when the cursor in on the bullet or
  1530. anywhere in an item line, details depending on
  1531. @code{org-support-shift-select}.
  1532. @kindex C-c ^
  1533. @item C-c ^
  1534. Sort the plain list. You will be prompted for the sorting method:
  1535. numerically, alphabetically, by time, or by custom function.
  1536. @end table
  1537. @node Drawers, Blocks, Plain lists, Document Structure
  1538. @section Drawers
  1539. @cindex drawers
  1540. @cindex #+DRAWERS
  1541. @cindex visibility cycling, drawers
  1542. @vindex org-drawers
  1543. @cindex org-insert-drawer
  1544. @kindex C-c C-x d
  1545. Sometimes you want to keep information associated with an entry, but you
  1546. normally don't want to see it. For this, Org mode has @emph{drawers}.
  1547. Drawers need to be configured with the variable
  1548. @code{org-drawers}@footnote{You can define additional drawers on a
  1549. per-file basis with a line like @code{#+DRAWERS: HIDDEN STATE}}. Drawers
  1550. look like this:
  1551. @example
  1552. ** This is a headline
  1553. Still outside the drawer
  1554. :DRAWERNAME:
  1555. This is inside the drawer.
  1556. :END:
  1557. After the drawer.
  1558. @end example
  1559. You can interactively insert drawers at point by calling
  1560. @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
  1561. region, this command will put the region inside the drawer. With a prefix
  1562. argument, this command calls @code{org-insert-property-drawer} and add a
  1563. property drawer right below the current headline. Completion over drawer
  1564. keywords is also possible using @key{M-TAB}.
  1565. Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
  1566. show the entry, but keep the drawer collapsed to a single line. In order to
  1567. look inside the drawer, you need to move the cursor to the drawer line and
  1568. press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
  1569. storing properties (@pxref{Properties and Columns}), and you can also arrange
  1570. for state change notes (@pxref{Tracking TODO state changes}) and clock times
  1571. (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
  1572. want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
  1573. @table @kbd
  1574. @kindex C-c C-z
  1575. @item C-c C-z
  1576. Add a time-stamped note to the LOGBOOK drawer.
  1577. @end table
  1578. @node Blocks, Footnotes, Drawers, Document Structure
  1579. @section Blocks
  1580. @vindex org-hide-block-startup
  1581. @cindex blocks, folding
  1582. Org mode uses begin...end blocks for various purposes from including source
  1583. code examples (@pxref{Literal examples}) to capturing time logging
  1584. information (@pxref{Clocking work time}). These blocks can be folded and
  1585. unfolded by pressing TAB in the begin line. You can also get all blocks
  1586. folded at startup by configuring the variable @code{org-hide-block-startup}
  1587. or on a per-file basis by using
  1588. @cindex @code{hideblocks}, STARTUP keyword
  1589. @cindex @code{nohideblocks}, STARTUP keyword
  1590. @example
  1591. #+STARTUP: hideblocks
  1592. #+STARTUP: nohideblocks
  1593. @end example
  1594. @node Footnotes, Orgstruct mode, Blocks, Document Structure
  1595. @section Footnotes
  1596. @cindex footnotes
  1597. Org mode supports the creation of footnotes. In contrast to the
  1598. @file{footnote.el} package, Org mode's footnotes are designed for work on a
  1599. larger document, not only for one-off documents like emails. The basic
  1600. syntax is similar to the one used by @file{footnote.el}, i.e., a footnote is
  1601. defined in a paragraph that is started by a footnote marker in square
  1602. brackets in column 0, no indentation allowed. If you need a paragraph break
  1603. inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
  1604. is simply the marker in square brackets, inside text. For example:
  1605. @example
  1606. The Org homepage[fn:1] now looks a lot better than it used to.
  1607. ...
  1608. [fn:1] The link is: http://orgmode.org
  1609. @end example
  1610. Org mode extends the number-based syntax to @emph{named} footnotes and
  1611. optional inline definition. Using plain numbers as markers (as
  1612. @file{footnote.el} does) is supported for backward compatibility, but not
  1613. encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
  1614. @LaTeX{}}). Here are the valid references:
  1615. @table @code
  1616. @item [1]
  1617. A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
  1618. recommended because something like @samp{[1]} could easily be part of a code
  1619. snippet.
  1620. @item [fn:name]
  1621. A named footnote reference, where @code{name} is a unique label word, or, for
  1622. simplicity of automatic creation, a number.
  1623. @item [fn:: This is the inline definition of this footnote]
  1624. A @LaTeX{}-like anonymous footnote where the definition is given directly at the
  1625. reference point.
  1626. @item [fn:name: a definition]
  1627. An inline definition of a footnote, which also specifies a name for the note.
  1628. Since Org allows multiple references to the same note, you can then use
  1629. @code{[fn:name]} to create additional references.
  1630. @end table
  1631. @vindex org-footnote-auto-label
  1632. Footnote labels can be created automatically, or you can create names yourself.
  1633. This is handled by the variable @code{org-footnote-auto-label} and its
  1634. corresponding @code{#+STARTUP} keywords. See the docstring of that variable
  1635. for details.
  1636. @noindent The following command handles footnotes:
  1637. @table @kbd
  1638. @kindex C-c C-x f
  1639. @item C-c C-x f
  1640. The footnote action command.
  1641. When the cursor is on a footnote reference, jump to the definition. When it
  1642. is at a definition, jump to the (first) reference.
  1643. @vindex org-footnote-define-inline
  1644. @vindex org-footnote-section
  1645. @vindex org-footnote-auto-adjust
  1646. Otherwise, create a new footnote. Depending on the variable
  1647. @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
  1648. setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
  1649. definition will be placed right into the text as part of the reference, or
  1650. separately into the location determined by the variable
  1651. @code{org-footnote-section}.
  1652. When this command is called with a prefix argument, a menu of additional
  1653. options is offered:
  1654. @example
  1655. s @r{Sort the footnote definitions by reference sequence. During editing,}
  1656. @r{Org makes no effort to sort footnote definitions into a particular}
  1657. @r{sequence. If you want them sorted, use this command, which will}
  1658. @r{also move entries according to @code{org-footnote-section}. Automatic}
  1659. @r{sorting after each insertion/deletion can be configured using the}
  1660. @r{variable @code{org-footnote-auto-adjust}.}
  1661. r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
  1662. @r{after each insertion/deletion can be configured using the variable}
  1663. @r{@code{org-footnote-auto-adjust}.}
  1664. S @r{Short for first @code{r}, then @code{s} action.}
  1665. n @r{Normalize the footnotes by collecting all definitions (including}
  1666. @r{inline definitions) into a special section, and then numbering them}
  1667. @r{in sequence. The references will then also be numbers. This is}
  1668. @r{meant to be the final step before finishing a document (e.g., sending}
  1669. @r{off an email). The exporters do this automatically, and so could}
  1670. @r{something like @code{message-send-hook}.}
  1671. d @r{Delete the footnote at point, and all definitions of and references}
  1672. @r{to it.}
  1673. @end example
  1674. Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
  1675. corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
  1676. renumbering and sorting footnotes can be automatic after each insertion or
  1677. deletion.
  1678. @kindex C-c C-c
  1679. @item C-c C-c
  1680. If the cursor is on a footnote reference, jump to the definition. If it is a
  1681. the definition, jump back to the reference. When called at a footnote
  1682. location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
  1683. @kindex C-c C-o
  1684. @kindex mouse-1
  1685. @kindex mouse-2
  1686. @item C-c C-o @r{or} mouse-1/2
  1687. Footnote labels are also links to the corresponding definition/reference, and
  1688. you can use the usual commands to follow these links.
  1689. @end table
  1690. @node Orgstruct mode, , Footnotes, Document Structure
  1691. @section The Orgstruct minor mode
  1692. @cindex Orgstruct mode
  1693. @cindex minor mode for structure editing
  1694. If you like the intuitive way the Org mode structure editing and list
  1695. formatting works, you might want to use these commands in other modes like
  1696. Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
  1697. this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
  1698. turn it on by default, for example in Message mode, with one of:
  1699. @lisp
  1700. (add-hook 'message-mode-hook 'turn-on-orgstruct)
  1701. (add-hook 'message-mode-hook 'turn-on-orgstruct++)
  1702. @end lisp
  1703. When this mode is active and the cursor is on a line that looks to Org like a
  1704. headline or the first line of a list item, most structure editing commands
  1705. will work, even if the same keys normally have different functionality in the
  1706. major mode you are using. If the cursor is not in one of those special
  1707. lines, Orgstruct mode lurks silently in the shadows. When you use
  1708. @code{orgstruct++-mode}, Org will also export indentation and autofill
  1709. settings into that mode, and detect item context after the first line of an
  1710. item.
  1711. @node Tables, Hyperlinks, Document Structure, Top
  1712. @chapter Tables
  1713. @cindex tables
  1714. @cindex editing tables
  1715. Org comes with a fast and intuitive table editor. Spreadsheet-like
  1716. calculations are supported using the Emacs @file{calc} package
  1717. (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
  1718. @menu
  1719. * Built-in table editor:: Simple tables
  1720. * Column width and alignment:: Overrule the automatic settings
  1721. * Column groups:: Grouping to trigger vertical lines
  1722. * Orgtbl mode:: The table editor as minor mode
  1723. * The spreadsheet:: The table editor has spreadsheet capabilities
  1724. * Org-Plot:: Plotting from org tables
  1725. @end menu
  1726. @node Built-in table editor, Column width and alignment, Tables, Tables
  1727. @section The built-in table editor
  1728. @cindex table editor, built-in
  1729. Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
  1730. the first non-whitespace character is considered part of a table. @samp{|}
  1731. is also the column separator@footnote{To insert a vertical bar into a table
  1732. field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
  1733. might look like this:
  1734. @example
  1735. | Name | Phone | Age |
  1736. |-------+-------+-----|
  1737. | Peter | 1234 | 17 |
  1738. | Anna | 4321 | 25 |
  1739. @end example
  1740. A table is re-aligned automatically each time you press @key{TAB} or
  1741. @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
  1742. the next field (@key{RET} to the next row) and creates new table rows
  1743. at the end of the table or before horizontal lines. The indentation
  1744. of the table is set by the first line. Any line starting with
  1745. @samp{|-} is considered as a horizontal separator line and will be
  1746. expanded on the next re-align to span the whole table width. So, to
  1747. create the above table, you would only type
  1748. @example
  1749. |Name|Phone|Age|
  1750. |-
  1751. @end example
  1752. @noindent and then press @key{TAB} to align the table and start filling in
  1753. fields. Even faster would be to type @code{|Name|Phone|Age} followed by
  1754. @kbd{C-c @key{RET}}.
  1755. @vindex org-enable-table-editor
  1756. @vindex org-table-auto-blank-field
  1757. When typing text into a field, Org treats @key{DEL},
  1758. @key{Backspace}, and all character keys in a special way, so that
  1759. inserting and deleting avoids shifting other fields. Also, when
  1760. typing @emph{immediately after the cursor was moved into a new field
  1761. with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
  1762. field is automatically made blank. If this behavior is too
  1763. unpredictable for you, configure the variables
  1764. @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
  1765. @table @kbd
  1766. @tsubheading{Creation and conversion}
  1767. @orgcmd{C-c |,org-table-create-or-convert-from-region}
  1768. Convert the active region to table. If every line contains at least one
  1769. TAB character, the function assumes that the material is tab separated.
  1770. If every line contains a comma, comma-separated values (CSV) are assumed.
  1771. If not, lines are split at whitespace into fields. You can use a prefix
  1772. argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
  1773. C-u} forces TAB, and a numeric argument N indicates that at least N
  1774. consecutive spaces, or alternatively a TAB will be the separator.
  1775. @*
  1776. If there is no active region, this command creates an empty Org
  1777. table. But it is easier just to start typing, like
  1778. @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
  1779. @tsubheading{Re-aligning and field motion}
  1780. @orgcmd{C-c C-c,org-table-align}
  1781. Re-align the table and don't move to another field.
  1782. @c
  1783. @orgcmd{<TAB>,org-table-next-field}
  1784. Re-align the table, move to the next field. Creates a new row if
  1785. necessary.
  1786. @c
  1787. @orgcmd{S-@key{TAB},org-table-previous-field}
  1788. Re-align, move to previous field.
  1789. @c
  1790. @orgcmd{@key{RET},org-table-next-row}
  1791. Re-align the table and move down to next row. Creates a new row if
  1792. necessary. At the beginning or end of a line, @key{RET} still does
  1793. NEWLINE, so it can be used to split a table.
  1794. @c
  1795. @orgcmd{M-a,org-table-beginning-of-field}
  1796. Move to beginning of the current table field, or on to the previous field.
  1797. @orgcmd{M-e,org-table-end-of-field}
  1798. Move to end of the current table field, or on to the next field.
  1799. @tsubheading{Column and row editing}
  1800. @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
  1801. Move the current column left/right.
  1802. @c
  1803. @orgcmd{M-S-@key{left},org-table-delete-column}
  1804. Kill the current column.
  1805. @c
  1806. @orgcmd{M-S-@key{right},org-table-insert-column}
  1807. Insert a new column to the left of the cursor position.
  1808. @c
  1809. @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
  1810. Move the current row up/down.
  1811. @c
  1812. @orgcmd{M-S-@key{up},org-table-kill-row}
  1813. Kill the current row or horizontal line.
  1814. @c
  1815. @orgcmd{M-S-@key{down},org-table-insert-row}
  1816. Insert a new row above the current row. With a prefix argument, the line is
  1817. created below the current one.
  1818. @c
  1819. @orgcmd{C-c -,org-table-insert-hline}
  1820. Insert a horizontal line below current row. With a prefix argument, the line
  1821. is created above the current line.
  1822. @c
  1823. @orgcmd{C-c @key{RET},org-table-hline-and-move}
  1824. Insert a horizontal line below current row, and move the cursor into the row
  1825. below that line.
  1826. @c
  1827. @orgcmd{C-c ^,org-table-sort-lines}
  1828. Sort the table lines in the region. The position of point indicates the
  1829. column to be used for sorting, and the range of lines is the range
  1830. between the nearest horizontal separator lines, or the entire table. If
  1831. point is before the first column, you will be prompted for the sorting
  1832. column. If there is an active region, the mark specifies the first line
  1833. and the sorting column, while point should be in the last line to be
  1834. included into the sorting. The command prompts for the sorting type
  1835. (alphabetically, numerically, or by time). When called with a prefix
  1836. argument, alphabetic sorting will be case-sensitive.
  1837. @tsubheading{Regions}
  1838. @orgcmd{C-c C-x M-w,org-table-copy-region}
  1839. Copy a rectangular region from a table to a special clipboard. Point and
  1840. mark determine edge fields of the rectangle. If there is no active region,
  1841. copy just the current field. The process ignores horizontal separator lines.
  1842. @c
  1843. @orgcmd{C-c C-x C-w,org-table-cut-region}
  1844. Copy a rectangular region from a table to a special clipboard, and
  1845. blank all fields in the rectangle. So this is the ``cut'' operation.
  1846. @c
  1847. @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
  1848. Paste a rectangular region into a table.
  1849. The upper left corner ends up in the current field. All involved fields
  1850. will be overwritten. If the rectangle does not fit into the present table,
  1851. the table is enlarged as needed. The process ignores horizontal separator
  1852. lines.
  1853. @c
  1854. @orgcmd{M-@key{RET},org-table-wrap-region}
  1855. Split the current field at the cursor position and move the rest to the line
  1856. below. If there is an active region, and both point and mark are in the same
  1857. column, the text in the column is wrapped to minimum width for the given
  1858. number of lines. A numeric prefix argument may be used to change the number
  1859. of desired lines. If there is no region, but you specify a prefix argument,
  1860. the current field is made blank, and the content is appended to the field
  1861. above.
  1862. @tsubheading{Calculations}
  1863. @cindex formula, in tables
  1864. @cindex calculations, in tables
  1865. @cindex region, active
  1866. @cindex active region
  1867. @cindex transient mark mode
  1868. @orgcmd{C-c +,org-table-sum}
  1869. Sum the numbers in the current column, or in the rectangle defined by
  1870. the active region. The result is shown in the echo area and can
  1871. be inserted with @kbd{C-y}.
  1872. @c
  1873. @orgcmd{S-@key{RET},org-table-copy-down}
  1874. @vindex org-table-copy-increment
  1875. When current field is empty, copy from first non-empty field above. When not
  1876. empty, copy current field down to next row and move cursor along with it.
  1877. Depending on the variable @code{org-table-copy-increment}, integer field
  1878. values will be incremented during copy. Integers that are too large will not
  1879. be incremented. Also, a @code{0} prefix argument temporarily disables the
  1880. increment. This key is also used by shift-selection and related modes
  1881. (@pxref{Conflicts}).
  1882. @tsubheading{Miscellaneous}
  1883. @orgcmd{C-c `,org-table-edit-field}
  1884. Edit the current field in a separate window. This is useful for fields that
  1885. are not fully visible (@pxref{Column width and alignment}). When called with
  1886. a @kbd{C-u} prefix, just make the full field visible, so that it can be
  1887. edited in place. When called with two @kbd{C-u} prefixes, make the editor
  1888. window follow the cursor through the table and always show the current
  1889. field. The follow mode exits automatically when the cursor leaves the table,
  1890. or when you repeat this command with @kbd{C-u C-u C-c `}.
  1891. @c
  1892. @item M-x org-table-import
  1893. Import a file as a table. The table should be TAB or whitespace
  1894. separated. Use, for example, to import a spreadsheet table or data
  1895. from a database, because these programs generally can write
  1896. TAB-separated text files. This command works by inserting the file into
  1897. the buffer and then converting the region to a table. Any prefix
  1898. argument is passed on to the converter, which uses it to determine the
  1899. separator.
  1900. @orgcmd{C-c |,org-table-create-or-convert-from-region}
  1901. Tables can also be imported by pasting tabular text into the Org
  1902. buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
  1903. @kbd{C-c |} command (see above under @i{Creation and conversion}).
  1904. @c
  1905. @item M-x org-table-export
  1906. @findex org-table-export
  1907. @vindex org-table-export-default-format
  1908. Export the table, by default as a TAB-separated file. Use for data
  1909. exchange with, for example, spreadsheet or database programs. The format
  1910. used to export the file can be configured in the variable
  1911. @code{org-table-export-default-format}. You may also use properties
  1912. @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
  1913. name and the format for table export in a subtree. Org supports quite
  1914. general formats for exported tables. The exporter format is the same as the
  1915. format used by Orgtbl radio tables, see @ref{Translator functions}, for a
  1916. detailed description.
  1917. @end table
  1918. If you don't like the automatic table editor because it gets in your
  1919. way on lines which you would like to start with @samp{|}, you can turn
  1920. it off with
  1921. @lisp
  1922. (setq org-enable-table-editor nil)
  1923. @end lisp
  1924. @noindent Then the only table command that still works is
  1925. @kbd{C-c C-c} to do a manual re-align.
  1926. @node Column width and alignment, Column groups, Built-in table editor, Tables
  1927. @section Column width and alignment
  1928. @cindex narrow columns in tables
  1929. @cindex alignment in tables
  1930. The width of columns is automatically determined by the table editor. And
  1931. also the alignment of a column is determined automatically from the fraction
  1932. of number-like versus non-number fields in the column.
  1933. Sometimes a single field or a few fields need to carry more text, leading to
  1934. inconveniently wide columns. Or maybe you want to make a table with several
  1935. columns having a fixed width, regardless of content. To set@footnote{This
  1936. feature does not work on XEmacs.} the width of a column, one field anywhere
  1937. in the column may contain just the string @samp{<N>} where @samp{N} is an
  1938. integer specifying the width of the column in characters. The next re-align
  1939. will then set the width of this column to this value.
  1940. @example
  1941. @group
  1942. |---+------------------------------| |---+--------|
  1943. | | | | | <6> |
  1944. | 1 | one | | 1 | one |
  1945. | 2 | two | ----\ | 2 | two |
  1946. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  1947. | 4 | four | | 4 | four |
  1948. |---+------------------------------| |---+--------|
  1949. @end group
  1950. @end example
  1951. @noindent
  1952. Fields that are wider become clipped and end in the string @samp{=>}.
  1953. Note that the full text is still in the buffer but is hidden.
  1954. To see the full text, hold the mouse over the field---a tool-tip window
  1955. will show the full content. To edit such a field, use the command
  1956. @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
  1957. open a new window with the full field. Edit it and finish with @kbd{C-c
  1958. C-c}.
  1959. @vindex org-startup-align-all-tables
  1960. When visiting a file containing a table with narrowed columns, the
  1961. necessary character hiding has not yet happened, and the table needs to
  1962. be aligned before it looks nice. Setting the option
  1963. @code{org-startup-align-all-tables} will realign all tables in a file
  1964. upon visiting, but also slow down startup. You can also set this option
  1965. on a per-file basis with:
  1966. @example
  1967. #+STARTUP: align
  1968. #+STARTUP: noalign
  1969. @end example
  1970. If you would like to overrule the automatic alignment of number-rich columns
  1971. to the right and of string-rich column to the left, you can use @samp{<r>},
  1972. @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
  1973. effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
  1974. also combine alignment and field width like this: @samp{<r10>}.
  1975. Lines which only contain these formatting cookies will be removed
  1976. automatically when exporting the document.
  1977. @node Column groups, Orgtbl mode, Column width and alignment, Tables
  1978. @section Column groups
  1979. @cindex grouping columns in tables
  1980. When Org exports tables, it does so by default without vertical
  1981. lines because that is visually more satisfying in general. Occasionally
  1982. however, vertical lines can be useful to structure a table into groups
  1983. of columns, much like horizontal lines can do for groups of rows. In
  1984. order to specify column groups, you can use a special row where the
  1985. first field contains only @samp{/}. The further fields can either
  1986. contain @samp{<} to indicate that this column should start a group,
  1987. @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
  1988. and @samp{>}) to make a column
  1989. a group of its own. Boundaries between column groups will upon export be
  1990. marked with vertical lines. Here is an example:
  1991. @example
  1992. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1993. |---+-----+-----+-----+---------+------------|
  1994. | / | < | | > | < | > |
  1995. | 1 | 1 | 1 | 1 | 1 | 1 |
  1996. | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
  1997. | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
  1998. |---+-----+-----+-----+---------+------------|
  1999. #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
  2000. @end example
  2001. It is also sufficient to just insert the column group starters after
  2002. every vertical line you would like to have:
  2003. @example
  2004. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  2005. |----+-----+-----+-----+---------+------------|
  2006. | / | < | | | < | |
  2007. @end example
  2008. @node Orgtbl mode, The spreadsheet, Column groups, Tables
  2009. @section The Orgtbl minor mode
  2010. @cindex Orgtbl mode
  2011. @cindex minor mode for tables
  2012. If you like the intuitive way the Org table editor works, you
  2013. might also want to use it in other modes like Text mode or Mail mode.
  2014. The minor mode Orgtbl mode makes this possible. You can always toggle
  2015. the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
  2016. example in Message mode, use
  2017. @lisp
  2018. (add-hook 'message-mode-hook 'turn-on-orgtbl)
  2019. @end lisp
  2020. Furthermore, with some special setup, it is possible to maintain tables
  2021. in arbitrary syntax with Orgtbl mode. For example, it is possible to
  2022. construct @LaTeX{} tables with the underlying ease and power of
  2023. Orgtbl mode, including spreadsheet capabilities. For details, see
  2024. @ref{Tables in arbitrary syntax}.
  2025. @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
  2026. @section The spreadsheet
  2027. @cindex calculations, in tables
  2028. @cindex spreadsheet capabilities
  2029. @cindex @file{calc} package
  2030. The table editor makes use of the Emacs @file{calc} package to implement
  2031. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  2032. derive fields from other fields. While fully featured, Org's implementation
  2033. is not identical to other spreadsheets. For example, Org knows the concept
  2034. of a @emph{column formula} that will be applied to all non-header fields in a
  2035. column without having to copy the formula to each relevant field. There is
  2036. also a formula debugger, and a formula editor with features for highlighting
  2037. fields in the table corresponding to the references at the point in the
  2038. formula, moving these references by arrow keys
  2039. @menu
  2040. * References:: How to refer to another field or range
  2041. * Formula syntax for Calc:: Using Calc to compute stuff
  2042. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  2043. * Durations and time values:: How to compute durations and time values
  2044. * Field and range formulas:: Formula for specific (ranges of) fields
  2045. * Column formulas:: Formulas valid for an entire column
  2046. * Lookup functions:: Lookup functions for searching tables
  2047. * Editing and debugging formulas:: Fixing formulas
  2048. * Updating the table:: Recomputing all dependent fields
  2049. * Advanced features:: Field and column names, parameters and automatic recalc
  2050. @end menu
  2051. @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
  2052. @subsection References
  2053. @cindex references
  2054. To compute fields in the table from other fields, formulas must
  2055. reference other fields or ranges. In Org, fields can be referenced
  2056. by name, by absolute coordinates, and by relative coordinates. To find
  2057. out what the coordinates of a field are, press @kbd{C-c ?} in that
  2058. field, or press @kbd{C-c @}} to toggle the display of a grid.
  2059. @subsubheading Field references
  2060. @cindex field references
  2061. @cindex references, to fields
  2062. Formulas can reference the value of another field in two ways. Like in
  2063. any other spreadsheet, you may reference fields with a letter/number
  2064. combination like @code{B3}, meaning the 2nd field in the 3rd row.
  2065. @vindex org-table-use-standard-references
  2066. However, Org prefers@footnote{Org will understand references typed by the
  2067. user as @samp{B4}, but it will not use this syntax when offering a formula
  2068. for editing. You can customize this behavior using the variable
  2069. @code{org-table-use-standard-references}.} to use another, more general
  2070. representation that looks like this:
  2071. @example
  2072. @@@var{row}$@var{column}
  2073. @end example
  2074. Column specifications can be absolute like @code{$1},
  2075. @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
  2076. column of the field which is being computed) like @code{$+1} or @code{$-2}.
  2077. @code{$<} and @code{$>} are immutable references to the first and last
  2078. column, respectively, and you can use @code{$>>>} to indicate the third
  2079. column from the right.
  2080. The row specification only counts data lines and ignores horizontal separator
  2081. lines (hlines). Like with columns, you can use absolute row numbers
  2082. @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
  2083. current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
  2084. immutable references the first and last@footnote{For backward compatibility
  2085. you can also use special names like @code{$LR5} and @code{$LR12} to refer in
  2086. a stable way to the 5th and 12th field in the last row of the table.
  2087. However, this syntax is deprecated, it should not be used for new documents.
  2088. Use @code{@@>$} instead.} row in the table, respectively. You may also
  2089. specify the row relative to one of the hlines: @code{@@I} refers to the first
  2090. hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
  2091. line above the current line, @code{@@+I} to the first such line below the
  2092. current line. You can also write @code{@@III+2} which is the second data line
  2093. after the third hline in the table.
  2094. @code{@@0} and @code{$0} refer to the current row and column, respectively,
  2095. i.e., to the row/column for the field being computed. Also, if you omit
  2096. either the column or the row part of the reference, the current row/column is
  2097. implied.
  2098. Org's references with @emph{unsigned} numbers are fixed references
  2099. in the sense that if you use the same reference in the formula for two
  2100. different fields, the same field will be referenced each time.
  2101. Org's references with @emph{signed} numbers are floating
  2102. references because the same reference operator can reference different
  2103. fields depending on the field being calculated by the formula.
  2104. Here are a few examples:
  2105. @example
  2106. @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
  2107. $5 @r{column 5 in the current row (same as @code{E&})}
  2108. @@2 @r{current column, row 2}
  2109. @@-1$-3 @r{the field one row up, three columns to the left}
  2110. @@-I$2 @r{field just under hline above current row, column 2}
  2111. @@>$5 @r{field in the last row, in column 5}
  2112. @end example
  2113. @subsubheading Range references
  2114. @cindex range references
  2115. @cindex references, to ranges
  2116. You may reference a rectangular range of fields by specifying two field
  2117. references connected by two dots @samp{..}. If both fields are in the
  2118. current row, you may simply use @samp{$2..$7}, but if at least one field
  2119. is in a different row, you need to use the general @code{@@row$column}
  2120. format at least for the first field (i.e the reference must start with
  2121. @samp{@@} in order to be interpreted correctly). Examples:
  2122. @example
  2123. $1..$3 @r{first three fields in the current row}
  2124. $P..$Q @r{range, using column names (see under Advanced)}
  2125. $<<<..$>> @r{start in third column, continue to the one but last}
  2126. @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
  2127. @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
  2128. @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
  2129. @end example
  2130. @noindent Range references return a vector of values that can be fed
  2131. into Calc vector functions. Empty fields in ranges are normally
  2132. suppressed, so that the vector contains only the non-empty fields (but
  2133. see the @samp{E} mode switch below). If there are no non-empty fields,
  2134. @samp{[0]} is returned to avoid syntax errors in formulas.
  2135. @subsubheading Field coordinates in formulas
  2136. @cindex field coordinates
  2137. @cindex coordinates, of field
  2138. @cindex row, of field coordinates
  2139. @cindex column, of field coordinates
  2140. For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
  2141. get the row or column number of the field where the formula result goes.
  2142. The traditional Lisp formula equivalents are @code{org-table-current-dline}
  2143. and @code{org-table-current-column}. Examples:
  2144. @example
  2145. if(@@# % 2, $#, string("")) @r{column number on odd lines only}
  2146. $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
  2147. @r{column 3 of the current table}
  2148. @end example
  2149. @noindent For the second example, table FOO must have at least as many rows
  2150. as the current table. Note that this is inefficient@footnote{The computation time scales as
  2151. O(N^2) because table FOO is parsed for each field to be copied.} for large
  2152. number of rows.
  2153. @subsubheading Named references
  2154. @cindex named references
  2155. @cindex references, named
  2156. @cindex name, of column or field
  2157. @cindex constants, in calculations
  2158. @cindex #+CONSTANTS
  2159. @vindex org-table-formula-constants
  2160. @samp{$name} is interpreted as the name of a column, parameter or
  2161. constant. Constants are defined globally through the variable
  2162. @code{org-table-formula-constants}, and locally (for the file) through a
  2163. line like
  2164. @example
  2165. #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
  2166. @end example
  2167. @noindent
  2168. @vindex constants-unit-system
  2169. @pindex constants.el
  2170. Also properties (@pxref{Properties and Columns}) can be used as
  2171. constants in table formulas: for a property @samp{:Xyz:} use the name
  2172. @samp{$PROP_Xyz}, and the property will be searched in the current
  2173. outline entry and in the hierarchy above it. If you have the
  2174. @file{constants.el} package, it will also be used to resolve constants,
  2175. including natural constants like @samp{$h} for Planck's constant, and
  2176. units like @samp{$km} for kilometers@footnote{@file{constants.el} can
  2177. supply the values of constants in two different unit systems, @code{SI}
  2178. and @code{cgs}. Which one is used depends on the value of the variable
  2179. @code{constants-unit-system}. You can use the @code{#+STARTUP} options
  2180. @code{constSI} and @code{constcgs} to set this value for the current
  2181. buffer.}. Column names and parameters can be specified in special table
  2182. lines. These are described below, see @ref{Advanced features}. All
  2183. names must start with a letter, and further consist of letters and
  2184. numbers.
  2185. @subsubheading Remote references
  2186. @cindex remote references
  2187. @cindex references, remote
  2188. @cindex references, to a different table
  2189. @cindex name, of column or field
  2190. @cindex constants, in calculations
  2191. @cindex #+TBLNAME
  2192. You may also reference constants, fields and ranges from a different table,
  2193. either in the current file or even in a different file. The syntax is
  2194. @example
  2195. remote(NAME-OR-ID,REF)
  2196. @end example
  2197. @noindent
  2198. where NAME can be the name of a table in the current file as set by a
  2199. @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
  2200. entry, even in a different file, and the reference then refers to the first
  2201. table in that entry. REF is an absolute field or range reference as
  2202. described above for example @code{@@3$3} or @code{$somename}, valid in the
  2203. referenced table.
  2204. @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
  2205. @subsection Formula syntax for Calc
  2206. @cindex formula syntax, Calc
  2207. @cindex syntax, of formulas
  2208. A formula can be any algebraic expression understood by the Emacs
  2209. @file{Calc} package. @b{Note that @file{calc} has the
  2210. non-standard convention that @samp{/} has lower precedence than
  2211. @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
  2212. evaluation by @code{calc-eval} (@pxref{Calling Calc from
  2213. Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc, GNU
  2214. Emacs Calc Manual}),
  2215. variable substitution takes place according to the rules described above.
  2216. @cindex vectors, in table calculations
  2217. The range vectors can be directly fed into the Calc vector functions
  2218. like @samp{vmean} and @samp{vsum}.
  2219. @cindex format specifier
  2220. @cindex mode, for @file{calc}
  2221. @vindex org-calc-default-modes
  2222. A formula can contain an optional mode string after a semicolon. This
  2223. string consists of flags to influence Calc and other modes during
  2224. execution. By default, Org uses the standard Calc modes (precision
  2225. 12, angular units degrees, fraction and symbolic modes off). The display
  2226. format, however, has been changed to @code{(float 8)} to keep tables
  2227. compact. The default settings can be configured using the variable
  2228. @code{org-calc-default-modes}.
  2229. @example
  2230. p20 @r{set the internal Calc calculation precision to 20 digits}
  2231. n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
  2232. @r{format of the result of Calc passed back to Org.}
  2233. @r{Calc formatting is unlimited in precision as}
  2234. @r{long as the Calc calculation precision is greater.}
  2235. D R @r{angle modes: degrees, radians}
  2236. F S @r{fraction and symbolic modes}
  2237. E @r{keep empty fields in ranges and use nan (not a number)}
  2238. @r{in Calc formulas for empty fields in range references and}
  2239. @r{for empty field references; else suppress empty fields in}
  2240. @r{range references and use 0 for empty field references, see}
  2241. @r{also the notes for `Range references' in @pxref{References}}
  2242. N @r{interpret all fields as numbers, use 0 for non-numbers;}
  2243. @r{N has higher precedence than E (for the value of the field)}
  2244. L @r{literal, for Lisp formulas only}
  2245. @end example
  2246. @noindent
  2247. Unless you use large integer numbers or high-precision-calculation
  2248. and -display for floating point numbers you may alternatively provide a
  2249. @code{printf} format specifier to reformat the Calc result after it has been
  2250. passed back to Org instead of letting Calc already do the
  2251. formatting@footnote{The @code{printf} reformatting is limited in precision
  2252. because the value passed to it is converted into an @code{integer} or
  2253. @code{double}. The @code{integer} is limited in size by truncating the
  2254. signed value to 32 bits. The @code{double} is limited in precision to 64
  2255. bits overall which leaves approximately 16 significant decimal digits.}.
  2256. A few examples:
  2257. @example
  2258. $1+$2 @r{Sum of first and second field}
  2259. $1+$2;%.2f @r{Same, format result to two decimals}
  2260. exp($2)+exp($1) @r{Math functions can be used}
  2261. $0;%.1f @r{Reformat current cell to 1 decimal}
  2262. ($3-32)*5/9 @r{Degrees F -> C conversion}
  2263. $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
  2264. tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
  2265. sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
  2266. vmean($2..$7) @r{Compute column range mean, suppress empty fields}
  2267. vmean($2..$7);EN @r{Same, but treat empty fields as 0}
  2268. taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
  2269. @end example
  2270. Calc also contains a complete set of logical operations. For example
  2271. @example
  2272. if($1 < 20, teen, string(""))
  2273. @r{"teen" if age $1 is less than 20, else empty}
  2274. if("$1" = "nan" || "$2" = "nan", string(""), $1 + $2); E
  2275. @r{sum of first two columns unless one or both empty}
  2276. @end example
  2277. Note that you can also use two org-specific flags @code{T} and @code{t} for
  2278. durations computations @ref{Durations and time values}.
  2279. You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
  2280. and use them in formula syntax for Calc.
  2281. @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
  2282. @subsection Emacs Lisp forms as formulas
  2283. @cindex Lisp forms, as table formulas
  2284. It is also possible to write a formula in Emacs Lisp. This can be useful
  2285. for string manipulation and control structures, if Calc's functionality is
  2286. not enough.
  2287. If a formula starts with a single-quote followed by an opening parenthesis,
  2288. then it is evaluated as a Lisp form. The evaluation should return either a
  2289. string or a number. Just as with @file{calc} formulas, you can specify modes
  2290. and a printf format after a semicolon.
  2291. With Emacs Lisp forms, you need to be conscious about the way field
  2292. references are interpolated into the form. By default, a reference will be
  2293. interpolated as a Lisp string (in double-quotes) containing the field. If
  2294. you provide the @samp{N} mode switch, all referenced elements will be numbers
  2295. (non-number fields will be zero) and interpolated as Lisp numbers, without
  2296. quotes. If you provide the @samp{L} flag, all fields will be interpolated
  2297. literally, without quotes. I.e., if you want a reference to be interpreted
  2298. as a string by the Lisp form, enclose the reference operator itself in
  2299. double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
  2300. fields, so you can embed them in list or vector syntax.
  2301. Here are a few examples---note how the @samp{N} mode is used when we do
  2302. computations in Lisp:
  2303. @example
  2304. @r{Swap the first two characters of the content of column 1}
  2305. '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
  2306. @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
  2307. '(+ $1 $2);N
  2308. @r{Compute the sum of columns 1--4, like Calc's @code{vsum($1..$4)}}
  2309. '(apply '+ '($1..$4));N
  2310. @end example
  2311. @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
  2312. @subsection Durations and time values
  2313. @cindex Duration, computing
  2314. @cindex Time, computing
  2315. @vindex org-table-duration-custom-format
  2316. If you want to compute time values use the @code{T} flag, either in Calc
  2317. formulas or Elisp formulas:
  2318. @example
  2319. @group
  2320. | Task 1 | Task 2 | Total |
  2321. |---------+----------+----------|
  2322. | 2:12 | 1:47 | 03:59:00 |
  2323. | 3:02:20 | -2:07:00 | 0.92 |
  2324. #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
  2325. @end group
  2326. @end example
  2327. Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
  2328. are optional. With the @code{T} flag, computed durations will be displayed
  2329. as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
  2330. computed durations will be displayed according to the value of the variable
  2331. @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
  2332. will display the result as a fraction of hours (see the second formula in the
  2333. example above).
  2334. Negative duration values can be manipulated as well, and integers will be
  2335. considered as seconds in addition and subtraction.
  2336. @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
  2337. @subsection Field and range formulas
  2338. @cindex field formula
  2339. @cindex range formula
  2340. @cindex formula, for individual table field
  2341. @cindex formula, for range of fields
  2342. To assign a formula to a particular field, type it directly into the field,
  2343. preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
  2344. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
  2345. the formula will be stored as the formula for this field, evaluated, and the
  2346. current field will be replaced with the result.
  2347. @cindex #+TBLFM
  2348. Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
  2349. below the table. If you type the equation in the 4th field of the 3rd data
  2350. line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
  2351. inserting/deleting/swapping column and rows with the appropriate commands,
  2352. @i{absolute references} (but not relative ones) in stored formulas are
  2353. modified in order to still reference the same field. To avoid this from
  2354. happening, in particular in range references, anchor ranges at the table
  2355. borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
  2356. using the @code{@@I} notation. Automatic adaptation of field references does
  2357. of course not happen if you edit the table structure with normal editing
  2358. commands---then you must fix the equations yourself.
  2359. Instead of typing an equation into the field, you may also use the following
  2360. command
  2361. @table @kbd
  2362. @orgcmd{C-u C-c =,org-table-eval-formula}
  2363. Install a new formula for the current field. The command prompts for a
  2364. formula with default taken from the @samp{#+TBLFM:} line, applies
  2365. it to the current field, and stores it.
  2366. @end table
  2367. The left-hand side of a formula can also be a special expression in order to
  2368. assign the formula to a number of different fields. There is no keyboard
  2369. shortcut to enter such range formulas. To add them, use the formula editor
  2370. (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
  2371. directly.
  2372. @table @code
  2373. @item $2=
  2374. Column formula, valid for the entire column. This is so common that Org
  2375. treats these formulas in a special way, see @ref{Column formulas}.
  2376. @item @@3=
  2377. Row formula, applies to all fields in the specified row. @code{@@>=} means
  2378. the last row.
  2379. @item @@1$2..@@4$3=
  2380. Range formula, applies to all fields in the given rectangular range. This
  2381. can also be used to assign a formula to some but not all fields in a row.
  2382. @item $name=
  2383. Named field, see @ref{Advanced features}.
  2384. @end table
  2385. @node Column formulas, Lookup functions, Field and range formulas, The spreadsheet
  2386. @subsection Column formulas
  2387. @cindex column formula
  2388. @cindex formula, for table column
  2389. When you assign a formula to a simple column reference like @code{$3=}, the
  2390. same formula will be used in all fields of that column, with the following
  2391. very convenient exceptions: (i) If the table contains horizontal separator
  2392. hlines with rows above and below, everything before the first such hline is
  2393. considered part of the table @emph{header} and will not be modified by column
  2394. formulas. Therefore a header is mandatory when you use column formulas and
  2395. want to add hlines to group rows, like for example to separate a total row at
  2396. the bottom from the summand rows above. (ii) Fields that already get a value
  2397. from a field/range formula will be left alone by column formulas. These
  2398. conditions make column formulas very easy to use.
  2399. To assign a formula to a column, type it directly into any field in the
  2400. column, preceded by an equal sign, like @samp{=$1+$2}. When you press
  2401. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
  2402. the formula will be stored as the formula for the current column, evaluated
  2403. and the current field replaced with the result. If the field contains only
  2404. @samp{=}, the previously stored formula for this column is used. For each
  2405. column, Org will only remember the most recently used formula. In the
  2406. @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
  2407. left-hand side of a column formula can not be the name of column, it must be
  2408. the numeric column reference or @code{$>}.
  2409. Instead of typing an equation into the field, you may also use the
  2410. following command:
  2411. @table @kbd
  2412. @orgcmd{C-c =,org-table-eval-formula}
  2413. Install a new formula for the current column and replace current field with
  2414. the result of the formula. The command prompts for a formula, with default
  2415. taken from the @samp{#+TBLFM} line, applies it to the current field and
  2416. stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
  2417. will apply it to that many consecutive fields in the current column.
  2418. @end table
  2419. @node Lookup functions, Editing and debugging formulas, Column formulas, The spreadsheet
  2420. @subsection Lookup functions
  2421. @cindex lookup functions in tables
  2422. @cindex table lookup functions
  2423. Org has three predefined Emacs Lisp functions for lookups in tables.
  2424. @table @code
  2425. @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
  2426. @findex org-lookup-first
  2427. Searches for the first element @code{S} in list @code{S-LIST} for which
  2428. @lisp
  2429. (PREDICATE VAL S)
  2430. @end lisp
  2431. is @code{t}; returns the value from the corresponding position in list
  2432. @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
  2433. parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
  2434. order as the correspoding parameters are in the call to
  2435. @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
  2436. @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
  2437. is returned.
  2438. @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
  2439. @findex org-lookup-last
  2440. Similar to @code{org-lookup-first} above, but searches for the @i{last}
  2441. element for which @code{PREDICATE} is @code{t}.
  2442. @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
  2443. @findex org-lookup-all
  2444. Similar to @code{org-lookup-first}, but searches for @i{all} elements for
  2445. which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
  2446. values. This function can not be used by itself in a formula, because it
  2447. returns a list of values. However, powerful lookups can be built when this
  2448. function is combined with other Emacs Lisp functions.
  2449. @end table
  2450. If the ranges used in these functions contain empty fields, the @code{E} mode
  2451. for the formula should usually be specified: otherwise empty fields will not be
  2452. included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
  2453. in an incorrect mapping from an element of @code{S-LIST} to the corresponding
  2454. element of @code{R-LIST}.
  2455. These three functions can be used to implement associative arrays, count
  2456. matching cells, rank results, group data etc. For practical examples
  2457. see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
  2458. tutorial on Worg}.
  2459. @node Editing and debugging formulas, Updating the table, Lookup functions, The spreadsheet
  2460. @subsection Editing and debugging formulas
  2461. @cindex formula editing
  2462. @cindex editing, of table formulas
  2463. @vindex org-table-use-standard-references
  2464. You can edit individual formulas in the minibuffer or directly in the
  2465. field. Org can also prepare a special buffer with all active
  2466. formulas of a table. When offering a formula for editing, Org
  2467. converts references to the standard format (like @code{B3} or @code{D&})
  2468. if possible. If you prefer to only work with the internal format (like
  2469. @code{@@3$2} or @code{$4}), configure the variable
  2470. @code{org-table-use-standard-references}.
  2471. @table @kbd
  2472. @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
  2473. Edit the formula associated with the current column/field in the
  2474. minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
  2475. @orgcmd{C-u C-u C-c =,org-table-eval-formula}
  2476. Re-insert the active formula (either a
  2477. field formula, or a column formula) into the current field, so that you
  2478. can edit it directly in the field. The advantage over editing in the
  2479. minibuffer is that you can use the command @kbd{C-c ?}.
  2480. @orgcmd{C-c ?,org-table-field-info}
  2481. While editing a formula in a table field, highlight the field(s)
  2482. referenced by the reference at the cursor position in the formula.
  2483. @kindex C-c @}
  2484. @findex org-table-toggle-coordinate-overlays
  2485. @item C-c @}
  2486. Toggle the display of row and column numbers for a table, using overlays
  2487. (@command{org-table-toggle-coordinate-overlays}). These are updated each
  2488. time the table is aligned; you can force it with @kbd{C-c C-c}.
  2489. @kindex C-c @{
  2490. @findex org-table-toggle-formula-debugger
  2491. @item C-c @{
  2492. Toggle the formula debugger on and off
  2493. (@command{org-table-toggle-formula-debugger}). See below.
  2494. @orgcmd{C-c ',org-table-edit-formulas}
  2495. Edit all formulas for the current table in a special buffer, where the
  2496. formulas will be displayed one per line. If the current field has an
  2497. active formula, the cursor in the formula editor will mark it.
  2498. While inside the special buffer, Org will automatically highlight
  2499. any field or range reference at the cursor position. You may edit,
  2500. remove and add formulas, and use the following commands:
  2501. @table @kbd
  2502. @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
  2503. Exit the formula editor and store the modified formulas. With @kbd{C-u}
  2504. prefix, also apply the new formulas to the entire table.
  2505. @orgcmd{C-c C-q,org-table-fedit-abort}
  2506. Exit the formula editor without installing changes.
  2507. @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
  2508. Toggle all references in the formula editor between standard (like
  2509. @code{B3}) and internal (like @code{@@3$2}).
  2510. @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
  2511. Pretty-print or indent Lisp formula at point. When in a line containing
  2512. a Lisp formula, format the formula according to Emacs Lisp rules.
  2513. Another @key{TAB} collapses the formula back again. In the open
  2514. formula, @key{TAB} re-indents just like in Emacs Lisp mode.
  2515. @orgcmd{M-@key{TAB},lisp-complete-symbol}
  2516. Complete Lisp symbols, just like in Emacs Lisp mode.
  2517. @kindex S-@key{up}
  2518. @kindex S-@key{down}
  2519. @kindex S-@key{left}
  2520. @kindex S-@key{right}
  2521. @findex org-table-fedit-ref-up
  2522. @findex org-table-fedit-ref-down
  2523. @findex org-table-fedit-ref-left
  2524. @findex org-table-fedit-ref-right
  2525. @item S-@key{up}/@key{down}/@key{left}/@key{right}
  2526. Shift the reference at point. For example, if the reference is
  2527. @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
  2528. This also works for relative references and for hline references.
  2529. @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
  2530. Move the test line for column formulas in the Org buffer up and
  2531. down.
  2532. @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
  2533. Scroll the window displaying the table.
  2534. @kindex C-c @}
  2535. @findex org-table-toggle-coordinate-overlays
  2536. @item C-c @}
  2537. Turn the coordinate grid in the table on and off.
  2538. @end table
  2539. @end table
  2540. Making a table field blank does not remove the formula associated with
  2541. the field, because that is stored in a different line (the @samp{#+TBLFM}
  2542. line)---during the next recalculation the field will be filled again.
  2543. To remove a formula from a field, you have to give an empty reply when
  2544. prompted for the formula, or to edit the @samp{#+TBLFM} line.
  2545. @kindex C-c C-c
  2546. You may edit the @samp{#+TBLFM} directly and re-apply the changed
  2547. equations with @kbd{C-c C-c} in that line or with the normal
  2548. recalculation commands in the table.
  2549. @subsubheading Debugging formulas
  2550. @cindex formula debugging
  2551. @cindex debugging, of table formulas
  2552. When the evaluation of a formula leads to an error, the field content
  2553. becomes the string @samp{#ERROR}. If you would like see what is going
  2554. on during variable substitution and calculation in order to find a bug,
  2555. turn on formula debugging in the @code{Tbl} menu and repeat the
  2556. calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
  2557. field. Detailed information will be displayed.
  2558. @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
  2559. @subsection Updating the table
  2560. @cindex recomputing table fields
  2561. @cindex updating, table
  2562. Recalculation of a table is normally not automatic, but needs to be
  2563. triggered by a command. See @ref{Advanced features}, for a way to make
  2564. recalculation at least semi-automatic.
  2565. In order to recalculate a line of a table or the entire table, use the
  2566. following commands:
  2567. @table @kbd
  2568. @orgcmd{C-c *,org-table-recalculate}
  2569. Recalculate the current row by first applying the stored column formulas
  2570. from left to right, and all field/range formulas in the current row.
  2571. @c
  2572. @kindex C-u C-c *
  2573. @item C-u C-c *
  2574. @kindex C-u C-c C-c
  2575. @itemx C-u C-c C-c
  2576. Recompute the entire table, line by line. Any lines before the first
  2577. hline are left alone, assuming that these are part of the table header.
  2578. @c
  2579. @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
  2580. Iterate the table by recomputing it until no further changes occur.
  2581. This may be necessary if some computed fields use the value of other
  2582. fields that are computed @i{later} in the calculation sequence.
  2583. @item M-x org-table-recalculate-buffer-tables
  2584. @findex org-table-recalculate-buffer-tables
  2585. Recompute all tables in the current buffer.
  2586. @item M-x org-table-iterate-buffer-tables
  2587. @findex org-table-iterate-buffer-tables
  2588. Iterate all tables in the current buffer, in order to converge table-to-table
  2589. dependencies.
  2590. @end table
  2591. @node Advanced features, , Updating the table, The spreadsheet
  2592. @subsection Advanced features
  2593. If you want the recalculation of fields to happen automatically, or if you
  2594. want to be able to assign @i{names}@footnote{Such names must start by an
  2595. alphabetic character and use only alphanumeric/underscore characters.} to
  2596. fields and columns, you need to reserve the first column of the table for
  2597. special marking characters.
  2598. @table @kbd
  2599. @orgcmd{C-#,org-table-rotate-recalc-marks}
  2600. Rotate the calculation mark in first column through the states @samp{ },
  2601. @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
  2602. change all marks in the region.
  2603. @end table
  2604. Here is an example of a table that collects exam results of students and
  2605. makes use of these features:
  2606. @example
  2607. @group
  2608. |---+---------+--------+--------+--------+-------+------|
  2609. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  2610. |---+---------+--------+--------+--------+-------+------|
  2611. | ! | | P1 | P2 | P3 | Tot | |
  2612. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  2613. | ^ | | m1 | m2 | m3 | mt | |
  2614. |---+---------+--------+--------+--------+-------+------|
  2615. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  2616. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  2617. |---+---------+--------+--------+--------+-------+------|
  2618. | | Average | | | | 25.0 | |
  2619. | ^ | | | | | at | |
  2620. | $ | max=50 | | | | | |
  2621. |---+---------+--------+--------+--------+-------+------|
  2622. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
  2623. @end group
  2624. @end example
  2625. @noindent @b{Important}: please note that for these special tables,
  2626. recalculating the table with @kbd{C-u C-c *} will only affect rows that
  2627. are marked @samp{#} or @samp{*}, and fields that have a formula assigned
  2628. to the field itself. The column formulas are not applied in rows with
  2629. empty first field.
  2630. @cindex marking characters, tables
  2631. The marking characters have the following meaning:
  2632. @table @samp
  2633. @item !
  2634. The fields in this line define names for the columns, so that you may
  2635. refer to a column as @samp{$Tot} instead of @samp{$6}.
  2636. @item ^
  2637. This row defines names for the fields @emph{above} the row. With such
  2638. a definition, any formula in the table may use @samp{$m1} to refer to
  2639. the value @samp{10}. Also, if you assign a formula to a names field, it
  2640. will be stored as @samp{$name=...}.
  2641. @item _
  2642. Similar to @samp{^}, but defines names for the fields in the row
  2643. @emph{below}.
  2644. @item $
  2645. Fields in this row can define @emph{parameters} for formulas. For
  2646. example, if a field in a @samp{$} row contains @samp{max=50}, then
  2647. formulas in this table can refer to the value 50 using @samp{$max}.
  2648. Parameters work exactly like constants, only that they can be defined on
  2649. a per-table basis.
  2650. @item #
  2651. Fields in this row are automatically recalculated when pressing
  2652. @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
  2653. is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
  2654. lines will be left alone by this command.
  2655. @item *
  2656. Selects this line for global recalculation with @kbd{C-u C-c *}, but
  2657. not for automatic recalculation. Use this when automatic
  2658. recalculation slows down editing too much.
  2659. @item @w{ }
  2660. Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
  2661. All lines that should be recalculated should be marked with @samp{#}
  2662. or @samp{*}.
  2663. @item /
  2664. Do not export this line. Useful for lines that contain the narrowing
  2665. @samp{<N>} markers or column group markers.
  2666. @end table
  2667. Finally, just to whet your appetite for what can be done with the
  2668. fantastic @file{calc.el} package, here is a table that computes the Taylor
  2669. series of degree @code{n} at location @code{x} for a couple of
  2670. functions.
  2671. @example
  2672. @group
  2673. |---+-------------+---+-----+--------------------------------------|
  2674. | | Func | n | x | Result |
  2675. |---+-------------+---+-----+--------------------------------------|
  2676. | # | exp(x) | 1 | x | 1 + x |
  2677. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  2678. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  2679. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  2680. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  2681. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  2682. |---+-------------+---+-----+--------------------------------------|
  2683. #+TBLFM: $5=taylor($2,$4,$3);n3
  2684. @end group
  2685. @end example
  2686. @node Org-Plot, , The spreadsheet, Tables
  2687. @section Org-Plot
  2688. @cindex graph, in tables
  2689. @cindex plot tables using Gnuplot
  2690. @cindex #+PLOT
  2691. Org-Plot can produce 2D and 3D graphs of information stored in org tables
  2692. using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
  2693. @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
  2694. that you have both Gnuplot and Gnuplot mode installed on your system, then
  2695. call @code{org-plot/gnuplot} on the following table.
  2696. @example
  2697. @group
  2698. #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
  2699. | Sede | Max cites | H-index |
  2700. |-----------+-----------+---------|
  2701. | Chile | 257.72 | 21.39 |
  2702. | Leeds | 165.77 | 19.68 |
  2703. | Sao Paolo | 71.00 | 11.50 |
  2704. | Stockholm | 134.19 | 14.33 |
  2705. | Morelia | 257.56 | 17.67 |
  2706. @end group
  2707. @end example
  2708. Notice that Org Plot is smart enough to apply the table's headers as labels.
  2709. Further control over the labels, type, content, and appearance of plots can
  2710. be exercised through the @code{#+PLOT:} lines preceding a table. See below
  2711. for a complete list of Org-plot options. For more information and examples
  2712. see the Org-plot tutorial at
  2713. @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
  2714. @subsubheading Plot Options
  2715. @table @code
  2716. @item set
  2717. Specify any @command{gnuplot} option to be set when graphing.
  2718. @item title
  2719. Specify the title of the plot.
  2720. @item ind
  2721. Specify which column of the table to use as the @code{x} axis.
  2722. @item deps
  2723. Specify the columns to graph as a Lisp style list, surrounded by parentheses
  2724. and separated by spaces for example @code{dep:(3 4)} to graph the third and
  2725. fourth columns (defaults to graphing all other columns aside from the @code{ind}
  2726. column).
  2727. @item type
  2728. Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
  2729. @item with
  2730. Specify a @code{with} option to be inserted for every col being plotted
  2731. (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
  2732. Defaults to @code{lines}.
  2733. @item file
  2734. If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
  2735. @item labels
  2736. List of labels to be used for the @code{deps} (defaults to the column headers
  2737. if they exist).
  2738. @item line
  2739. Specify an entire line to be inserted in the Gnuplot script.
  2740. @item map
  2741. When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
  2742. flat mapping rather than a @code{3d} slope.
  2743. @item timefmt
  2744. Specify format of Org mode timestamps as they will be parsed by Gnuplot.
  2745. Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
  2746. @item script
  2747. If you want total control, you can specify a script file (place the file name
  2748. between double-quotes) which will be used to plot. Before plotting, every
  2749. instance of @code{$datafile} in the specified script will be replaced with
  2750. the path to the generated data file. Note: even if you set this option, you
  2751. may still want to specify the plot type, as that can impact the content of
  2752. the data file.
  2753. @end table
  2754. @node Hyperlinks, TODO Items, Tables, Top
  2755. @chapter Hyperlinks
  2756. @cindex hyperlinks
  2757. Like HTML, Org provides links inside a file, external links to
  2758. other files, Usenet articles, emails, and much more.
  2759. @menu
  2760. * Link format:: How links in Org are formatted
  2761. * Internal links:: Links to other places in the current file
  2762. * External links:: URL-like links to the world
  2763. * Handling links:: Creating, inserting and following
  2764. * Using links outside Org:: Linking from my C source code?
  2765. * Link abbreviations:: Shortcuts for writing complex links
  2766. * Search options:: Linking to a specific location
  2767. * Custom searches:: When the default search is not enough
  2768. @end menu
  2769. @node Link format, Internal links, Hyperlinks, Hyperlinks
  2770. @section Link format
  2771. @cindex link format
  2772. @cindex format, of links
  2773. Org will recognize plain URL-like links and activate them as
  2774. clickable links. The general link format, however, looks like this:
  2775. @example
  2776. [[link][description]] @r{or alternatively} [[link]]
  2777. @end example
  2778. @noindent
  2779. Once a link in the buffer is complete (all brackets present), Org
  2780. will change the display so that @samp{description} is displayed instead
  2781. of @samp{[[link][description]]} and @samp{link} is displayed instead of
  2782. @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
  2783. which by default is an underlined face. You can directly edit the
  2784. visible part of a link. Note that this can be either the @samp{link}
  2785. part (if there is no description) or the @samp{description} part. To
  2786. edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
  2787. cursor on the link.
  2788. If you place the cursor at the beginning or just behind the end of the
  2789. displayed text and press @key{BACKSPACE}, you will remove the
  2790. (invisible) bracket at that location. This makes the link incomplete
  2791. and the internals are again displayed as plain text. Inserting the
  2792. missing bracket hides the link internals again. To show the
  2793. internal structure of all links, use the menu entry
  2794. @code{Org->Hyperlinks->Literal links}.
  2795. @node Internal links, External links, Link format, Hyperlinks
  2796. @section Internal links
  2797. @cindex internal links
  2798. @cindex links, internal
  2799. @cindex targets, for links
  2800. @cindex property, CUSTOM_ID
  2801. If the link does not look like a URL, it is considered to be internal in the
  2802. current file. The most important case is a link like
  2803. @samp{[[#my-custom-id]]} which will link to the entry with the
  2804. @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
  2805. for HTML export (@pxref{HTML export}) where they produce pretty section
  2806. links. You are responsible yourself to make sure these custom IDs are unique
  2807. in a file.
  2808. Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
  2809. lead to a text search in the current file.
  2810. The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
  2811. or with a mouse click (@pxref{Handling links}). Links to custom IDs will
  2812. point to the corresponding headline. The preferred match for a text link is
  2813. a @i{dedicated target}: the same string in double angular brackets. Targets
  2814. may be located anywhere; sometimes it is convenient to put them into a
  2815. comment line. For example
  2816. @example
  2817. # <<My Target>>
  2818. @end example
  2819. @noindent In HTML export (@pxref{HTML export}), such targets will become
  2820. named anchors for direct access through @samp{http} links@footnote{Note that
  2821. text before the first headline is usually not exported, so the first such
  2822. target should be after the first headline, or in the line directly before the
  2823. first headline.}.
  2824. If no dedicated target exists, Org will search for a headline that is exactly
  2825. the link text but may also include a TODO keyword and tags@footnote{To insert
  2826. a link targeting a headline, in-buffer completion can be used. Just type a
  2827. star followed by a few optional letters into the buffer and press
  2828. @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
  2829. completions.}. In non-Org files, the search will look for the words in the
  2830. link text. In the above example the search would be for @samp{my target}.
  2831. Following a link pushes a mark onto Org's own mark ring. You can
  2832. return to the previous position with @kbd{C-c &}. Using this command
  2833. several times in direct succession goes back to positions recorded
  2834. earlier.
  2835. @menu
  2836. * Radio targets:: Make targets trigger links in plain text
  2837. @end menu
  2838. @node Radio targets, , Internal links, Internal links
  2839. @subsection Radio targets
  2840. @cindex radio targets
  2841. @cindex targets, radio
  2842. @cindex links, radio targets
  2843. Org can automatically turn any occurrences of certain target names
  2844. in normal text into a link. So without explicitly creating a link, the
  2845. text connects to the target radioing its position. Radio targets are
  2846. enclosed by triple angular brackets. For example, a target @samp{<<<My
  2847. Target>>>} causes each occurrence of @samp{my target} in normal text to
  2848. become activated as a link. The Org file is scanned automatically
  2849. for radio targets only when the file is first loaded into Emacs. To
  2850. update the target list during editing, press @kbd{C-c C-c} with the
  2851. cursor on or at a target.
  2852. @node External links, Handling links, Internal links, Hyperlinks
  2853. @section External links
  2854. @cindex links, external
  2855. @cindex external links
  2856. @cindex links, external
  2857. @cindex Gnus links
  2858. @cindex BBDB links
  2859. @cindex IRC links
  2860. @cindex URL links
  2861. @cindex file links
  2862. @cindex VM links
  2863. @cindex RMAIL links
  2864. @cindex WANDERLUST links
  2865. @cindex MH-E links
  2866. @cindex USENET links
  2867. @cindex SHELL links
  2868. @cindex Info links
  2869. @cindex Elisp links
  2870. Org supports links to files, websites, Usenet and email messages,
  2871. BBDB database entries and links to both IRC conversations and their
  2872. logs. External links are URL-like locators. They start with a short
  2873. identifying string followed by a colon. There can be no space after
  2874. the colon. The following list shows examples for each link type.
  2875. @example
  2876. http://www.astro.uva.nl/~dominik @r{on the web}
  2877. doi:10.1000/182 @r{DOI for an electronic resource}
  2878. file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
  2879. /home/dominik/images/jupiter.jpg @r{same as above}
  2880. file:papers/last.pdf @r{file, relative path}
  2881. ./papers/last.pdf @r{same as above}
  2882. file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
  2883. /myself@@some.where:papers/last.pdf @r{same as above}
  2884. file:sometextfile::NNN @r{file, jump to line number}
  2885. file:projects.org @r{another Org file}
  2886. file:projects.org::some words @r{text search in Org file}@footnote{
  2887. The actual behavior of the search will depend on the value of
  2888. the variable @code{org-link-search-must-match-exact-headline}. If its value
  2889. is nil, then a fuzzy text search will be done. If it is t, then only the
  2890. exact headline will be matched. If the value is @code{'query-to-create},
  2891. then an exact headline will be searched; if it is not found, then the user
  2892. will be queried to create it.}
  2893. file:projects.org::*task title @r{heading search in Org file}
  2894. file+sys:/path/to/file @r{open via OS, like double-click}
  2895. file+emacs:/path/to/file @r{force opening by Emacs}
  2896. docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
  2897. id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
  2898. news:comp.emacs @r{Usenet link}
  2899. mailto:adent@@galaxy.net @r{Mail link}
  2900. vm:folder @r{VM folder link}
  2901. vm:folder#id @r{VM message link}
  2902. vm://myself@@some.where.org/folder#id @r{VM on remote machine}
  2903. vm-imap:account:folder @r{VM IMAP folder link}
  2904. vm-imap:account:folder#id @r{VM IMAP message link}
  2905. wl:folder @r{WANDERLUST folder link}
  2906. wl:folder#id @r{WANDERLUST message link}
  2907. mhe:folder @r{MH-E folder link}
  2908. mhe:folder#id @r{MH-E message link}
  2909. rmail:folder @r{RMAIL folder link}
  2910. rmail:folder#id @r{RMAIL message link}
  2911. gnus:group @r{Gnus group link}
  2912. gnus:group#id @r{Gnus article link}
  2913. bbdb:R.*Stallman @r{BBDB link (with regexp)}
  2914. irc:/irc.com/#emacs/bob @r{IRC link}
  2915. info:org#External links @r{Info node link}
  2916. shell:ls *.org @r{A shell command}
  2917. elisp:org-agenda @r{Interactive Elisp command}
  2918. elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
  2919. @end example
  2920. For customizing Org to add new link types @ref{Adding hyperlink types}.
  2921. A link should be enclosed in double brackets and may contain a
  2922. descriptive text to be displayed instead of the URL (@pxref{Link
  2923. format}), for example:
  2924. @example
  2925. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  2926. @end example
  2927. @noindent
  2928. If the description is a file name or URL that points to an image, HTML
  2929. export (@pxref{HTML export}) will inline the image as a clickable
  2930. button. If there is no description at all and the link points to an
  2931. image,
  2932. that image will be inlined into the exported HTML file.
  2933. @cindex square brackets, around links
  2934. @cindex plain text external links
  2935. Org also finds external links in the normal text and activates them
  2936. as links. If spaces must be part of the link (for example in
  2937. @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
  2938. about the end of the link, enclose them in square brackets.
  2939. @node Handling links, Using links outside Org, External links, Hyperlinks
  2940. @section Handling links
  2941. @cindex links, handling
  2942. Org provides methods to create a link in the correct syntax, to
  2943. insert it into an Org file, and to follow the link.
  2944. @table @kbd
  2945. @orgcmd{C-c l,org-store-link}
  2946. @cindex storing links
  2947. Store a link to the current location. This is a @emph{global} command (you
  2948. must create the key binding yourself) which can be used in any buffer to
  2949. create a link. The link will be stored for later insertion into an Org
  2950. buffer (see below). What kind of link will be created depends on the current
  2951. buffer:
  2952. @b{Org mode buffers}@*
  2953. For Org files, if there is a @samp{<<target>>} at the cursor, the link points
  2954. to the target. Otherwise it points to the current headline, which will also
  2955. be the description@footnote{If the headline contains a timestamp, it will be
  2956. removed from the link and result in a wrong link---you should avoid putting
  2957. timestamp in the headline.}.
  2958. @vindex org-id-link-to-org-use-id
  2959. @cindex property, CUSTOM_ID
  2960. @cindex property, ID
  2961. If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
  2962. will be stored. In addition or alternatively (depending on the value of
  2963. @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
  2964. be created and/or used to construct a link@footnote{The library @code{org-id}
  2965. must first be loaded, either through @code{org-customize} by enabling
  2966. @code{id} in @code{org-modules} , or by adding @code{(require 'org-id)} in
  2967. your @file{.emacs}.}. So using this command in Org
  2968. buffers will potentially create two links: a human-readable from the custom
  2969. ID, and one that is globally unique and works even if the entry is moved from
  2970. file to file. Later, when inserting the link, you need to decide which one
  2971. to use.
  2972. @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
  2973. Pretty much all Emacs mail clients are supported. The link will point to the
  2974. current article, or, in some GNUS buffers, to the group. The description is
  2975. constructed from the author and the subject.
  2976. @b{Web browsers: W3 and W3M}@*
  2977. Here the link will be the current URL, with the page title as description.
  2978. @b{Contacts: BBDB}@*
  2979. Links created in a BBDB buffer will point to the current entry.
  2980. @b{Chat: IRC}@*
  2981. @vindex org-irc-link-to-logs
  2982. For IRC links, if you set the variable @code{org-irc-link-to-logs} to
  2983. @code{t}, a @samp{file:/} style link to the relevant point in the logs for
  2984. the current conversation is created. Otherwise an @samp{irc:/} style link to
  2985. the user/channel/server under the point will be stored.
  2986. @b{Other files}@*
  2987. For any other files, the link will point to the file, with a search string
  2988. (@pxref{Search options}) pointing to the contents of the current line. If
  2989. there is an active region, the selected words will form the basis of the
  2990. search string. If the automatically created link is not working correctly or
  2991. accurately enough, you can write custom functions to select the search string
  2992. and to do the search for particular file types---see @ref{Custom searches}.
  2993. The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
  2994. @b{Agenda view}@*
  2995. When the cursor is in an agenda view, the created link points to the
  2996. entry referenced by the current line.
  2997. @c
  2998. @orgcmd{C-c C-l,org-insert-link}
  2999. @cindex link completion
  3000. @cindex completion, of links
  3001. @cindex inserting links
  3002. @vindex org-keep-stored-link-after-insertion
  3003. Insert a link@footnote{ Note that you don't have to use this command to
  3004. insert a link. Links in Org are plain text, and you can type or paste them
  3005. straight into the buffer. By using this command, the links are automatically
  3006. enclosed in double brackets, and you will be asked for the optional
  3007. descriptive text.}. This prompts for a link to be inserted into the buffer.
  3008. You can just type a link, using text for an internal link, or one of the link
  3009. type prefixes mentioned in the examples above. The link will be inserted
  3010. into the buffer@footnote{After insertion of a stored link, the link will be
  3011. removed from the list of stored links. To keep it in the list later use, use
  3012. a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
  3013. @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
  3014. If some text was selected when this command is called, the selected text
  3015. becomes the default description.
  3016. @b{Inserting stored links}@*
  3017. All links stored during the
  3018. current session are part of the history for this prompt, so you can access
  3019. them with @key{up} and @key{down} (or @kbd{M-p/n}).
  3020. @b{Completion support}@* Completion with @key{TAB} will help you to insert
  3021. valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
  3022. defined through link abbreviations (@pxref{Link abbreviations}). If you
  3023. press @key{RET} after inserting only the @var{prefix}, Org will offer
  3024. specific completion support for some link types@footnote{This works by
  3025. calling a special function @code{org-PREFIX-complete-link}.} For
  3026. example, if you type @kbd{file @key{RET}}, file name completion (alternative
  3027. access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
  3028. @key{RET}} you can complete contact names.
  3029. @orgkey C-u C-c C-l
  3030. @cindex file name completion
  3031. @cindex completion, of file names
  3032. When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
  3033. a file will be inserted and you may use file name completion to select
  3034. the name of the file. The path to the file is inserted relative to the
  3035. directory of the current Org file, if the linked file is in the current
  3036. directory or in a sub-directory of it, or if the path is written relative
  3037. to the current directory using @samp{../}. Otherwise an absolute path
  3038. is used, if possible with @samp{~/} for your home directory. You can
  3039. force an absolute path with two @kbd{C-u} prefixes.
  3040. @c
  3041. @item C-c C-l @ @r{(with cursor on existing link)}
  3042. When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
  3043. link and description parts of the link.
  3044. @c
  3045. @cindex following links
  3046. @orgcmd{C-c C-o,org-open-at-point}
  3047. @vindex org-file-apps
  3048. @vindex org-link-frame-setup
  3049. Open link at point. This will launch a web browser for URLs (using
  3050. @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
  3051. the corresponding links, and execute the command in a shell link. When the
  3052. cursor is on an internal link, this command runs the corresponding search.
  3053. When the cursor is on a TAG list in a headline, it creates the corresponding
  3054. TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
  3055. date. Furthermore, it will visit text and remote files in @samp{file:} links
  3056. with Emacs and select a suitable application for local non-text files.
  3057. Classification of files is based on file extension only. See option
  3058. @code{org-file-apps}. If you want to override the default application and
  3059. visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
  3060. opening in Emacs, use a @kbd{C-u C-u} prefix.@*
  3061. If the cursor is on a headline, but not on a link, offer all links in the
  3062. headline and entry text. If you want to setup the frame configuration for
  3063. following links, customize @code{org-link-frame-setup}.
  3064. @orgkey @key{RET}
  3065. @vindex org-return-follows-link
  3066. When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
  3067. the link at point.
  3068. @c
  3069. @kindex mouse-2
  3070. @kindex mouse-1
  3071. @item mouse-2
  3072. @itemx mouse-1
  3073. On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
  3074. would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
  3075. @c
  3076. @kindex mouse-3
  3077. @item mouse-3
  3078. @vindex org-display-internal-link-with-indirect-buffer
  3079. Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
  3080. internal links to be displayed in another window@footnote{See the
  3081. variable @code{org-display-internal-link-with-indirect-buffer}}.
  3082. @c
  3083. @orgcmd{C-c C-x C-v,org-toggle-inline-images}
  3084. @cindex inlining images
  3085. @cindex images, inlining
  3086. @vindex org-startup-with-inline-images
  3087. @cindex @code{inlineimages}, STARTUP keyword
  3088. @cindex @code{noinlineimages}, STARTUP keyword
  3089. Toggle the inline display of linked images. Normally this will only inline
  3090. images that have no description part in the link, i.e., images that will also
  3091. be inlined during export. When called with a prefix argument, also display
  3092. images that do have a link description. You can ask for inline images to be
  3093. displayed at startup by configuring the variable
  3094. @code{org-startup-with-inline-images}@footnote{with corresponding
  3095. @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
  3096. @orgcmd{C-c %,org-mark-ring-push}
  3097. @cindex mark ring
  3098. Push the current position onto the mark ring, to be able to return
  3099. easily. Commands following an internal link do this automatically.
  3100. @c
  3101. @orgcmd{C-c &,org-mark-ring-goto}
  3102. @cindex links, returning to
  3103. Jump back to a recorded position. A position is recorded by the
  3104. commands following internal links, and by @kbd{C-c %}. Using this
  3105. command several times in direct succession moves through a ring of
  3106. previously recorded positions.
  3107. @c
  3108. @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
  3109. @cindex links, finding next/previous
  3110. Move forward/backward to the next link in the buffer. At the limit of
  3111. the buffer, the search fails once, and then wraps around. The key
  3112. bindings for this are really too long; you might want to bind this also
  3113. to @kbd{C-n} and @kbd{C-p}
  3114. @lisp
  3115. (add-hook 'org-load-hook
  3116. (lambda ()
  3117. (define-key org-mode-map "\C-n" 'org-next-link)
  3118. (define-key org-mode-map "\C-p" 'org-previous-link)))
  3119. @end lisp
  3120. @end table
  3121. @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
  3122. @section Using links outside Org
  3123. You can insert and follow links that have Org syntax not only in
  3124. Org, but in any Emacs buffer. For this, you should create two
  3125. global commands, like this (please select suitable global keys
  3126. yourself):
  3127. @lisp
  3128. (global-set-key "\C-c L" 'org-insert-link-global)
  3129. (global-set-key "\C-c o" 'org-open-at-point-global)
  3130. @end lisp
  3131. @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
  3132. @section Link abbreviations
  3133. @cindex link abbreviations
  3134. @cindex abbreviation, links
  3135. Long URLs can be cumbersome to type, and often many similar links are
  3136. needed in a document. For this you can use link abbreviations. An
  3137. abbreviated link looks like this
  3138. @example
  3139. [[linkword:tag][description]]
  3140. @end example
  3141. @noindent
  3142. @vindex org-link-abbrev-alist
  3143. where the tag is optional.
  3144. The @i{linkword} must be a word, starting with a letter, followed by
  3145. letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
  3146. according to the information in the variable @code{org-link-abbrev-alist}
  3147. that relates the linkwords to replacement text. Here is an example:
  3148. @smalllisp
  3149. @group
  3150. (setq org-link-abbrev-alist
  3151. '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
  3152. ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
  3153. ("google" . "http://www.google.com/search?q=")
  3154. ("gmap" . "http://maps.google.com/maps?q=%s")
  3155. ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
  3156. ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
  3157. @end group
  3158. @end smalllisp
  3159. If the replacement text contains the string @samp{%s}, it will be
  3160. replaced with the tag. Using @samp{%h} instead of @samp{%s} will
  3161. url-encode the tag (see the example above, where we need to encode
  3162. the URL parameter.) Using @samp{%(my-function)} will pass the tag
  3163. to a custom function, and replace it by the resulting string.
  3164. If the replacement text don't contain any specifier, it will simply
  3165. be appended to the string in order to create the link.
  3166. Instead of a string, you may also specify a function that will be
  3167. called with the tag as the only argument to create the link.
  3168. With the above setting, you could link to a specific bug with
  3169. @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
  3170. @code{[[google:OrgMode]]}, show the map location of the Free Software
  3171. Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
  3172. @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
  3173. what the Org author is doing besides Emacs hacking with
  3174. @code{[[ads:Dominik,C]]}.
  3175. If you need special abbreviations just for a single Org buffer, you
  3176. can define them in the file with
  3177. @cindex #+LINK
  3178. @example
  3179. #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
  3180. #+LINK: google http://www.google.com/search?q=%s
  3181. @end example
  3182. @noindent
  3183. In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
  3184. complete link abbreviations. You may also define a function
  3185. @code{org-PREFIX-complete-link} that implements special (e.g., completion)
  3186. support for inserting such a link with @kbd{C-c C-l}. Such a function should
  3187. not accept any arguments, and return the full link with prefix.
  3188. @node Search options, Custom searches, Link abbreviations, Hyperlinks
  3189. @section Search options in file links
  3190. @cindex search option in file links
  3191. @cindex file links, searching
  3192. File links can contain additional information to make Emacs jump to a
  3193. particular location in the file when following a link. This can be a
  3194. line number or a search option after a double@footnote{For backward
  3195. compatibility, line numbers can also follow a single colon.} colon. For
  3196. example, when the command @kbd{C-c l} creates a link (@pxref{Handling
  3197. links}) to a file, it encodes the words in the current line as a search
  3198. string that can be used to find this line back later when following the
  3199. link with @kbd{C-c C-o}.
  3200. Here is the syntax of the different ways to attach a search to a file
  3201. link, together with an explanation:
  3202. @example
  3203. [[file:~/code/main.c::255]]
  3204. [[file:~/xx.org::My Target]]
  3205. [[file:~/xx.org::*My Target]]
  3206. [[file:~/xx.org::#my-custom-id]]
  3207. [[file:~/xx.org::/regexp/]]
  3208. @end example
  3209. @table @code
  3210. @item 255
  3211. Jump to line 255.
  3212. @item My Target
  3213. Search for a link target @samp{<<My Target>>}, or do a text search for
  3214. @samp{my target}, similar to the search in internal links, see
  3215. @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
  3216. link will become a HTML reference to the corresponding named anchor in
  3217. the linked file.
  3218. @item *My Target
  3219. In an Org file, restrict search to headlines.
  3220. @item #my-custom-id
  3221. Link to a heading with a @code{CUSTOM_ID} property
  3222. @item /regexp/
  3223. Do a regular expression search for @code{regexp}. This uses the Emacs
  3224. command @code{occur} to list all matches in a separate window. If the
  3225. target file is in Org mode, @code{org-occur} is used to create a
  3226. sparse tree with the matches.
  3227. @c If the target file is a directory,
  3228. @c @code{grep} will be used to search all files in the directory.
  3229. @end table
  3230. As a degenerate case, a file link with an empty file name can be used
  3231. to search the current file. For example, @code{[[file:::find me]]} does
  3232. a search for @samp{find me} in the current file, just as
  3233. @samp{[[find me]]} would.
  3234. @node Custom searches, , Search options, Hyperlinks
  3235. @section Custom Searches
  3236. @cindex custom search strings
  3237. @cindex search strings, custom
  3238. The default mechanism for creating search strings and for doing the
  3239. actual search related to a file link may not work correctly in all
  3240. cases. For example, Bib@TeX{} database files have many entries like
  3241. @samp{year="1993"} which would not result in good search strings,
  3242. because the only unique identification for a Bib@TeX{} entry is the
  3243. citation key.
  3244. @vindex org-create-file-search-functions
  3245. @vindex org-execute-file-search-functions
  3246. If you come across such a problem, you can write custom functions to set
  3247. the right search string for a particular file type, and to do the search
  3248. for the string in the file. Using @code{add-hook}, these functions need
  3249. to be added to the hook variables
  3250. @code{org-create-file-search-functions} and
  3251. @code{org-execute-file-search-functions}. See the docstring for these
  3252. variables for more information. Org actually uses this mechanism
  3253. for Bib@TeX{} database files, and you can use the corresponding code as
  3254. an implementation example. See the file @file{org-bibtex.el}.
  3255. @node TODO Items, Tags, Hyperlinks, Top
  3256. @chapter TODO items
  3257. @cindex TODO items
  3258. Org mode does not maintain TODO lists as separate documents@footnote{Of
  3259. course, you can make a document that contains only long lists of TODO items,
  3260. but this is not required.}. Instead, TODO items are an integral part of the
  3261. notes file, because TODO items usually come up while taking notes! With Org
  3262. mode, simply mark any entry in a tree as being a TODO item. In this way,
  3263. information is not duplicated, and the entire context from which the TODO
  3264. item emerged is always present.
  3265. Of course, this technique for managing TODO items scatters them
  3266. throughout your notes file. Org mode compensates for this by providing
  3267. methods to give you an overview of all the things that you have to do.
  3268. @menu
  3269. * TODO basics:: Marking and displaying TODO entries
  3270. * TODO extensions:: Workflow and assignments
  3271. * Progress logging:: Dates and notes for progress
  3272. * Priorities:: Some things are more important than others
  3273. * Breaking down tasks:: Splitting a task into manageable pieces
  3274. * Checkboxes:: Tick-off lists
  3275. @end menu
  3276. @node TODO basics, TODO extensions, TODO Items, TODO Items
  3277. @section Basic TODO functionality
  3278. Any headline becomes a TODO item when it starts with the word
  3279. @samp{TODO}, for example:
  3280. @example
  3281. *** TODO Write letter to Sam Fortune
  3282. @end example
  3283. @noindent
  3284. The most important commands to work with TODO entries are:
  3285. @table @kbd
  3286. @orgcmd{C-c C-t,org-todo}
  3287. @cindex cycling, of TODO states
  3288. @vindex org-use-fast-todo-selection
  3289. Rotate the TODO state of the current item among
  3290. @example
  3291. ,-> (unmarked) -> TODO -> DONE --.
  3292. '--------------------------------'
  3293. @end example
  3294. If TODO keywords have fast access keys (see @ref{Fast access to TODO
  3295. states}), you will be prompted for a TODO keyword through the fast selection
  3296. interface; this is the default behavior when
  3297. @var{org-use-fast-todo-selection} is @code{non-nil}.
  3298. The same rotation can also be done ``remotely'' from the timeline and agenda
  3299. buffers with the @kbd{t} command key (@pxref{Agenda commands}).
  3300. @orgkey{C-u C-c C-t}
  3301. When TODO keywords have no selection keys, select a specific keyword using
  3302. completion; otherwise force cycling through TODO states with no prompt. When
  3303. @var{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
  3304. selection interface.
  3305. @kindex S-@key{right}
  3306. @kindex S-@key{left}
  3307. @item S-@key{right} @ @r{/} @ S-@key{left}
  3308. @vindex org-treat-S-cursor-todo-selection-as-state-change
  3309. Select the following/preceding TODO state, similar to cycling. Useful
  3310. mostly if more than two TODO states are possible (@pxref{TODO
  3311. extensions}). See also @ref{Conflicts}, for a discussion of the interaction
  3312. with @code{shift-selection-mode}. See also the variable
  3313. @code{org-treat-S-cursor-todo-selection-as-state-change}.
  3314. @orgcmd{C-c / t,org-show-todo-tree}
  3315. @cindex sparse tree, for TODO
  3316. @vindex org-todo-keywords
  3317. View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
  3318. entire buffer, but shows all TODO items (with not-DONE state) and the
  3319. headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
  3320. / T}), search for a specific TODO@. You will be prompted for the keyword, and
  3321. you can also give a list of keywords like @code{KWD1|KWD2|...} to list
  3322. entries that match any one of these keywords. With a numeric prefix argument
  3323. N, show the tree for the Nth keyword in the variable
  3324. @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
  3325. both un-done and done.
  3326. @orgcmd{C-c a t,org-todo-list}
  3327. Show the global TODO list. Collects the TODO items (with not-DONE states)
  3328. from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
  3329. buffer will be in @code{agenda-mode}, which provides commands to examine and
  3330. manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
  3331. @xref{Global TODO list}, for more information.
  3332. @orgcmd{S-M-@key{RET},org-insert-todo-heading}
  3333. Insert a new TODO entry below the current one.
  3334. @end table
  3335. @noindent
  3336. @vindex org-todo-state-tags-triggers
  3337. Changing a TODO state can also trigger tag changes. See the docstring of the
  3338. option @code{org-todo-state-tags-triggers} for details.
  3339. @node TODO extensions, Progress logging, TODO basics, TODO Items
  3340. @section Extended use of TODO keywords
  3341. @cindex extended TODO keywords
  3342. @vindex org-todo-keywords
  3343. By default, marked TODO entries have one of only two states: TODO and
  3344. DONE@. Org mode allows you to classify TODO items in more complex ways
  3345. with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
  3346. special setup, the TODO keyword system can work differently in different
  3347. files.
  3348. Note that @i{tags} are another way to classify headlines in general and
  3349. TODO items in particular (@pxref{Tags}).
  3350. @menu
  3351. * Workflow states:: From TODO to DONE in steps
  3352. * TODO types:: I do this, Fred does the rest
  3353. * Multiple sets in one file:: Mixing it all, and still finding your way
  3354. * Fast access to TODO states:: Single letter selection of a state
  3355. * Per-file keywords:: Different files, different requirements
  3356. * Faces for TODO keywords:: Highlighting states
  3357. * TODO dependencies:: When one task needs to wait for others
  3358. @end menu
  3359. @node Workflow states, TODO types, TODO extensions, TODO extensions
  3360. @subsection TODO keywords as workflow states
  3361. @cindex TODO workflow
  3362. @cindex workflow states as TODO keywords
  3363. You can use TODO keywords to indicate different @emph{sequential} states
  3364. in the process of working on an item, for example@footnote{Changing
  3365. this variable only becomes effective after restarting Org mode in a
  3366. buffer.}:
  3367. @lisp
  3368. (setq org-todo-keywords
  3369. '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
  3370. @end lisp
  3371. The vertical bar separates the TODO keywords (states that @emph{need
  3372. action}) from the DONE states (which need @emph{no further action}). If
  3373. you don't provide the separator bar, the last state is used as the DONE
  3374. state.
  3375. @cindex completion, of TODO keywords
  3376. With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
  3377. to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
  3378. also use a numeric prefix argument to quickly select a specific state. For
  3379. example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
  3380. Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
  3381. define many keywords, you can use in-buffer completion
  3382. (@pxref{Completion}) or even a special one-key selection scheme
  3383. (@pxref{Fast access to TODO states}) to insert these words into the
  3384. buffer. Changing a TODO state can be logged with a timestamp, see
  3385. @ref{Tracking TODO state changes}, for more information.
  3386. @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
  3387. @subsection TODO keywords as types
  3388. @cindex TODO types
  3389. @cindex names as TODO keywords
  3390. @cindex types as TODO keywords
  3391. The second possibility is to use TODO keywords to indicate different
  3392. @emph{types} of action items. For example, you might want to indicate
  3393. that items are for ``work'' or ``home''. Or, when you work with several
  3394. people on a single project, you might want to assign action items
  3395. directly to persons, by using their names as TODO keywords. This would
  3396. be set up like this:
  3397. @lisp
  3398. (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
  3399. @end lisp
  3400. In this case, different keywords do not indicate a sequence, but rather
  3401. different types. So the normal work flow would be to assign a task to a
  3402. person, and later to mark it DONE@. Org mode supports this style by adapting
  3403. the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
  3404. @kbd{t} command in the timeline and agenda buffers.}. When used several
  3405. times in succession, it will still cycle through all names, in order to first
  3406. select the right type for a task. But when you return to the item after some
  3407. time and execute @kbd{C-c C-t} again, it will switch from any name directly
  3408. to DONE@. Use prefix arguments or completion to quickly select a specific
  3409. name. You can also review the items of a specific TODO type in a sparse tree
  3410. by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
  3411. Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
  3412. from all agenda files into a single buffer, you would use the numeric prefix
  3413. argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
  3414. @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
  3415. @subsection Multiple keyword sets in one file
  3416. @cindex TODO keyword sets
  3417. Sometimes you may want to use different sets of TODO keywords in
  3418. parallel. For example, you may want to have the basic
  3419. @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
  3420. separate state indicating that an item has been canceled (so it is not
  3421. DONE, but also does not require action). Your setup would then look
  3422. like this:
  3423. @lisp
  3424. (setq org-todo-keywords
  3425. '((sequence "TODO" "|" "DONE")
  3426. (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
  3427. (sequence "|" "CANCELED")))
  3428. @end lisp
  3429. The keywords should all be different, this helps Org mode to keep track
  3430. of which subsequence should be used for a given entry. In this setup,
  3431. @kbd{C-c C-t} only operates within a subsequence, so it switches from
  3432. @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
  3433. (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
  3434. select the correct sequence. Besides the obvious ways like typing a
  3435. keyword or using completion, you may also apply the following commands:
  3436. @table @kbd
  3437. @kindex C-S-@key{right}
  3438. @kindex C-S-@key{left}
  3439. @kindex C-u C-u C-c C-t
  3440. @item C-u C-u C-c C-t
  3441. @itemx C-S-@key{right}
  3442. @itemx C-S-@key{left}
  3443. These keys jump from one TODO subset to the next. In the above example,
  3444. @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
  3445. @code{DONE} to @code{REPORT}, and any of the words in the second row to
  3446. @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
  3447. @code{shift-selection-mode} (@pxref{Conflicts}).
  3448. @kindex S-@key{right}
  3449. @kindex S-@key{left}
  3450. @item S-@key{right}
  3451. @itemx S-@key{left}
  3452. @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
  3453. keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
  3454. from @code{DONE} to @code{REPORT} in the example above. See also
  3455. @ref{Conflicts}, for a discussion of the interaction with
  3456. @code{shift-selection-mode}.
  3457. @end table
  3458. @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
  3459. @subsection Fast access to TODO states
  3460. If you would like to quickly change an entry to an arbitrary TODO state
  3461. instead of cycling through the states, you can set up keys for single-letter
  3462. access to the states. This is done by adding the selection character after
  3463. each keyword, in parentheses@footnote{All characters are allowed except
  3464. @code{@@^!}, which have a special meaning here.}. For example:
  3465. @lisp
  3466. (setq org-todo-keywords
  3467. '((sequence "TODO(t)" "|" "DONE(d)")
  3468. (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
  3469. (sequence "|" "CANCELED(c)")))
  3470. @end lisp
  3471. @vindex org-fast-tag-selection-include-todo
  3472. If you then press @kbd{C-c C-t} followed by the selection key, the entry
  3473. will be switched to this state. @kbd{SPC} can be used to remove any TODO
  3474. keyword from an entry.@footnote{Check also the variable
  3475. @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
  3476. state through the tags interface (@pxref{Setting tags}), in case you like to
  3477. mingle the two concepts. Note that this means you need to come up with
  3478. unique keys across both sets of keywords.}
  3479. @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
  3480. @subsection Setting up keywords for individual files
  3481. @cindex keyword options
  3482. @cindex per-file keywords
  3483. @cindex #+TODO
  3484. @cindex #+TYP_TODO
  3485. @cindex #+SEQ_TODO
  3486. It can be very useful to use different aspects of the TODO mechanism in
  3487. different files. For file-local settings, you need to add special lines
  3488. to the file which set the keywords and interpretation for that file
  3489. only. For example, to set one of the two examples discussed above, you
  3490. need one of the following lines, starting in column zero anywhere in the
  3491. file:
  3492. @example
  3493. #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
  3494. @end example
  3495. @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
  3496. interpretation, but it means the same as @code{#+TODO}), or
  3497. @example
  3498. #+TYP_TODO: Fred Sara Lucy Mike | DONE
  3499. @end example
  3500. A setup for using several sets in parallel would be:
  3501. @example
  3502. #+TODO: TODO | DONE
  3503. #+TODO: REPORT BUG KNOWNCAUSE | FIXED
  3504. #+TODO: | CANCELED
  3505. @end example
  3506. @cindex completion, of option keywords
  3507. @kindex M-@key{TAB}
  3508. @noindent To make sure you are using the correct keyword, type
  3509. @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
  3510. @cindex DONE, final TODO keyword
  3511. Remember that the keywords after the vertical bar (or the last keyword
  3512. if no bar is there) must always mean that the item is DONE (although you
  3513. may use a different word). After changing one of these lines, use
  3514. @kbd{C-c C-c} with the cursor still in the line to make the changes
  3515. known to Org mode@footnote{Org mode parses these lines only when
  3516. Org mode is activated after visiting a file. @kbd{C-c C-c} with the
  3517. cursor in a line starting with @samp{#+} is simply restarting Org mode
  3518. for the current buffer.}.
  3519. @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
  3520. @subsection Faces for TODO keywords
  3521. @cindex faces, for TODO keywords
  3522. @vindex org-todo @r{(face)}
  3523. @vindex org-done @r{(face)}
  3524. @vindex org-todo-keyword-faces
  3525. Org mode highlights TODO keywords with special faces: @code{org-todo}
  3526. for keywords indicating that an item still has to be acted upon, and
  3527. @code{org-done} for keywords indicating that an item is finished. If
  3528. you are using more than 2 different states, you might want to use
  3529. special faces for some of them. This can be done using the variable
  3530. @code{org-todo-keyword-faces}. For example:
  3531. @lisp
  3532. @group
  3533. (setq org-todo-keyword-faces
  3534. '(("TODO" . org-warning) ("STARTED" . "yellow")
  3535. ("CANCELED" . (:foreground "blue" :weight bold))))
  3536. @end group
  3537. @end lisp
  3538. While using a list with face properties as shown for CANCELED @emph{should}
  3539. work, this does not always seem to be the case. If necessary, define a
  3540. special face and use that. A string is interpreted as a color. The variable
  3541. @code{org-faces-easy-properties} determines if that color is interpreted as a
  3542. foreground or a background color.
  3543. @node TODO dependencies, , Faces for TODO keywords, TODO extensions
  3544. @subsection TODO dependencies
  3545. @cindex TODO dependencies
  3546. @cindex dependencies, of TODO states
  3547. @vindex org-enforce-todo-dependencies
  3548. @cindex property, ORDERED
  3549. The structure of Org files (hierarchy and lists) makes it easy to define TODO
  3550. dependencies. Usually, a parent TODO task should not be marked DONE until
  3551. all subtasks (defined as children tasks) are marked as DONE@. And sometimes
  3552. there is a logical sequence to a number of (sub)tasks, so that one task
  3553. cannot be acted upon before all siblings above it are done. If you customize
  3554. the variable @code{org-enforce-todo-dependencies}, Org will block entries
  3555. from changing state to DONE while they have children that are not DONE@.
  3556. Furthermore, if an entry has a property @code{ORDERED}, each of its children
  3557. will be blocked until all earlier siblings are marked DONE@. Here is an
  3558. example:
  3559. @example
  3560. * TODO Blocked until (two) is done
  3561. ** DONE one
  3562. ** TODO two
  3563. * Parent
  3564. :PROPERTIES:
  3565. :ORDERED: t
  3566. :END:
  3567. ** TODO a
  3568. ** TODO b, needs to wait for (a)
  3569. ** TODO c, needs to wait for (a) and (b)
  3570. @end example
  3571. @table @kbd
  3572. @orgcmd{C-c C-x o,org-toggle-ordered-property}
  3573. @vindex org-track-ordered-property-with-tag
  3574. @cindex property, ORDERED
  3575. Toggle the @code{ORDERED} property of the current entry. A property is used
  3576. for this behavior because this should be local to the current entry, not
  3577. inherited like a tag. However, if you would like to @i{track} the value of
  3578. this property with a tag for better visibility, customize the variable
  3579. @code{org-track-ordered-property-with-tag}.
  3580. @orgkey{C-u C-u C-u C-c C-t}
  3581. Change TODO state, circumventing any state blocking.
  3582. @end table
  3583. @vindex org-agenda-dim-blocked-tasks
  3584. If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
  3585. that cannot be closed because of such dependencies will be shown in a dimmed
  3586. font or even made invisible in agenda views (@pxref{Agenda Views}).
  3587. @cindex checkboxes and TODO dependencies
  3588. @vindex org-enforce-todo-dependencies
  3589. You can also block changes of TODO states by looking at checkboxes
  3590. (@pxref{Checkboxes}). If you set the variable
  3591. @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
  3592. checkboxes will be blocked from switching to DONE.
  3593. If you need more complex dependency structures, for example dependencies
  3594. between entries in different trees or files, check out the contributed
  3595. module @file{org-depend.el}.
  3596. @page
  3597. @node Progress logging, Priorities, TODO extensions, TODO Items
  3598. @section Progress logging
  3599. @cindex progress logging
  3600. @cindex logging, of progress
  3601. Org mode can automatically record a timestamp and possibly a note when
  3602. you mark a TODO item as DONE, or even each time you change the state of
  3603. a TODO item. This system is highly configurable; settings can be on a
  3604. per-keyword basis and can be localized to a file or even a subtree. For
  3605. information on how to clock working time for a task, see @ref{Clocking
  3606. work time}.
  3607. @menu
  3608. * Closing items:: When was this entry marked DONE?
  3609. * Tracking TODO state changes:: When did the status change?
  3610. * Tracking your habits:: How consistent have you been?
  3611. @end menu
  3612. @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
  3613. @subsection Closing items
  3614. The most basic logging is to keep track of @emph{when} a certain TODO
  3615. item was finished. This is achieved with@footnote{The corresponding
  3616. in-buffer setting is: @code{#+STARTUP: logdone}}
  3617. @lisp
  3618. (setq org-log-done 'time)
  3619. @end lisp
  3620. @noindent
  3621. Then each time you turn an entry from a TODO (not-done) state into any
  3622. of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
  3623. just after the headline. If you turn the entry back into a TODO item
  3624. through further state cycling, that line will be removed again. If you
  3625. want to record a note along with the timestamp, use@footnote{The
  3626. corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
  3627. @lisp
  3628. (setq org-log-done 'note)
  3629. @end lisp
  3630. @noindent
  3631. You will then be prompted for a note, and that note will be stored below
  3632. the entry with a @samp{Closing Note} heading.
  3633. In the timeline (@pxref{Timeline}) and in the agenda
  3634. (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
  3635. display the TODO items with a @samp{CLOSED} timestamp on each day,
  3636. giving you an overview of what has been done.
  3637. @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
  3638. @subsection Tracking TODO state changes
  3639. @cindex drawer, for state change recording
  3640. @vindex org-log-states-order-reversed
  3641. @vindex org-log-into-drawer
  3642. @cindex property, LOG_INTO_DRAWER
  3643. When TODO keywords are used as workflow states (@pxref{Workflow states}), you
  3644. might want to keep track of when a state change occurred and maybe take a
  3645. note about this change. You can either record just a timestamp, or a
  3646. time-stamped note for a change. These records will be inserted after the
  3647. headline as an itemized list, newest first@footnote{See the variable
  3648. @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
  3649. want to get the notes out of the way into a drawer (@pxref{Drawers}).
  3650. Customize the variable @code{org-log-into-drawer} to get this behavior---the
  3651. recommended drawer for this is called @code{LOGBOOK}@footnote{Note that the
  3652. @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
  3653. show an entry---use @key{C-u SPC} to keep it folded here}. You can also
  3654. overrule the setting of this variable for a subtree by setting a
  3655. @code{LOG_INTO_DRAWER} property.
  3656. Since it is normally too much to record a note for every state, Org mode
  3657. expects configuration on a per-keyword basis for this. This is achieved by
  3658. adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
  3659. with timestamp) in parentheses after each keyword. For example, with the
  3660. setting
  3661. @lisp
  3662. (setq org-todo-keywords
  3663. '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
  3664. @end lisp
  3665. To record a timestamp without a note for TODO keywords configured with
  3666. @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
  3667. @noindent
  3668. @vindex org-log-done
  3669. you not only define global TODO keywords and fast access keys, but also
  3670. request that a time is recorded when the entry is set to
  3671. DONE@footnote{It is possible that Org mode will record two timestamps
  3672. when you are using both @code{org-log-done} and state change logging.
  3673. However, it will never prompt for two notes---if you have configured
  3674. both, the state change recording note will take precedence and cancel
  3675. the @samp{Closing Note}.}, and that a note is recorded when switching to
  3676. WAIT or CANCELED@. The setting for WAIT is even more special: the
  3677. @samp{!} after the slash means that in addition to the note taken when
  3678. entering the state, a timestamp should be recorded when @i{leaving} the
  3679. WAIT state, if and only if the @i{target} state does not configure
  3680. logging for entering it. So it has no effect when switching from WAIT
  3681. to DONE, because DONE is configured to record a timestamp only. But
  3682. when switching from WAIT back to TODO, the @samp{/!} in the WAIT
  3683. setting now triggers a timestamp even though TODO has no logging
  3684. configured.
  3685. You can use the exact same syntax for setting logging preferences local
  3686. to a buffer:
  3687. @example
  3688. #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
  3689. @end example
  3690. @cindex property, LOGGING
  3691. In order to define logging settings that are local to a subtree or a
  3692. single item, define a LOGGING property in this entry. Any non-empty
  3693. LOGGING property resets all logging settings to nil. You may then turn
  3694. on logging for this specific tree using STARTUP keywords like
  3695. @code{lognotedone} or @code{logrepeat}, as well as adding state specific
  3696. settings like @code{TODO(!)}. For example
  3697. @example
  3698. * TODO Log each state with only a time
  3699. :PROPERTIES:
  3700. :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
  3701. :END:
  3702. * TODO Only log when switching to WAIT, and when repeating
  3703. :PROPERTIES:
  3704. :LOGGING: WAIT(@@) logrepeat
  3705. :END:
  3706. * TODO No logging at all
  3707. :PROPERTIES:
  3708. :LOGGING: nil
  3709. :END:
  3710. @end example
  3711. @node Tracking your habits, , Tracking TODO state changes, Progress logging
  3712. @subsection Tracking your habits
  3713. @cindex habits
  3714. Org has the ability to track the consistency of a special category of TODOs,
  3715. called ``habits''. A habit has the following properties:
  3716. @enumerate
  3717. @item
  3718. You have enabled the @code{habits} module by customizing the variable
  3719. @code{org-modules}.
  3720. @item
  3721. The habit is a TODO item, with a TODO keyword representing an open state.
  3722. @item
  3723. The property @code{STYLE} is set to the value @code{habit}.
  3724. @item
  3725. The TODO has a scheduled date, usually with a @code{.+} style repeat
  3726. interval. A @code{++} style may be appropriate for habits with time
  3727. constraints, e.g., must be done on weekends, or a @code{+} style for an
  3728. unusual habit that can have a backlog, e.g., weekly reports.
  3729. @item
  3730. The TODO may also have minimum and maximum ranges specified by using the
  3731. syntax @samp{.+2d/3d}, which says that you want to do the task at least every
  3732. three days, but at most every two days.
  3733. @item
  3734. You must also have state logging for the @code{DONE} state enabled
  3735. (@pxref{Tracking TODO state changes}), in order for historical data to be
  3736. represented in the consistency graph. If it is not enabled it is not an
  3737. error, but the consistency graphs will be largely meaningless.
  3738. @end enumerate
  3739. To give you an idea of what the above rules look like in action, here's an
  3740. actual habit with some history:
  3741. @example
  3742. ** TODO Shave
  3743. SCHEDULED: <2009-10-17 Sat .+2d/4d>
  3744. - State "DONE" from "TODO" [2009-10-15 Thu]
  3745. - State "DONE" from "TODO" [2009-10-12 Mon]
  3746. - State "DONE" from "TODO" [2009-10-10 Sat]
  3747. - State "DONE" from "TODO" [2009-10-04 Sun]
  3748. - State "DONE" from "TODO" [2009-10-02 Fri]
  3749. - State "DONE" from "TODO" [2009-09-29 Tue]
  3750. - State "DONE" from "TODO" [2009-09-25 Fri]
  3751. - State "DONE" from "TODO" [2009-09-19 Sat]
  3752. - State "DONE" from "TODO" [2009-09-16 Wed]
  3753. - State "DONE" from "TODO" [2009-09-12 Sat]
  3754. :PROPERTIES:
  3755. :STYLE: habit
  3756. :LAST_REPEAT: [2009-10-19 Mon 00:36]
  3757. :END:
  3758. @end example
  3759. What this habit says is: I want to shave at most every 2 days (given by the
  3760. @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
  3761. today is the 15th, then the habit first appears in the agenda on Oct 17,
  3762. after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
  3763. after four days have elapsed.
  3764. What's really useful about habits is that they are displayed along with a
  3765. consistency graph, to show how consistent you've been at getting that task
  3766. done in the past. This graph shows every day that the task was done over the
  3767. past three weeks, with colors for each day. The colors used are:
  3768. @table @code
  3769. @item Blue
  3770. If the task wasn't to be done yet on that day.
  3771. @item Green
  3772. If the task could have been done on that day.
  3773. @item Yellow
  3774. If the task was going to be overdue the next day.
  3775. @item Red
  3776. If the task was overdue on that day.
  3777. @end table
  3778. In addition to coloring each day, the day is also marked with an asterisk if
  3779. the task was actually done that day, and an exclamation mark to show where
  3780. the current day falls in the graph.
  3781. There are several configuration variables that can be used to change the way
  3782. habits are displayed in the agenda.
  3783. @table @code
  3784. @item org-habit-graph-column
  3785. The buffer column at which the consistency graph should be drawn. This will
  3786. overwrite any text in that column, so it is a good idea to keep your habits'
  3787. titles brief and to the point.
  3788. @item org-habit-preceding-days
  3789. The amount of history, in days before today, to appear in consistency graphs.
  3790. @item org-habit-following-days
  3791. The number of days after today that will appear in consistency graphs.
  3792. @item org-habit-show-habits-only-for-today
  3793. If non-nil, only show habits in today's agenda view. This is set to true by
  3794. default.
  3795. @end table
  3796. Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
  3797. temporarily be disabled and they won't appear at all. Press @kbd{K} again to
  3798. bring them back. They are also subject to tag filtering, if you have habits
  3799. which should only be done in certain contexts, for example.
  3800. @node Priorities, Breaking down tasks, Progress logging, TODO Items
  3801. @section Priorities
  3802. @cindex priorities
  3803. If you use Org mode extensively, you may end up with enough TODO items that
  3804. it starts to make sense to prioritize them. Prioritizing can be done by
  3805. placing a @emph{priority cookie} into the headline of a TODO item, like this
  3806. @example
  3807. *** TODO [#A] Write letter to Sam Fortune
  3808. @end example
  3809. @noindent
  3810. @vindex org-priority-faces
  3811. By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
  3812. @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
  3813. treated just like priority @samp{B}. Priorities make a difference only for
  3814. sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
  3815. have no inherent meaning to Org mode. The cookies can be highlighted with
  3816. special faces by customizing the variable @code{org-priority-faces}.
  3817. Priorities can be attached to any outline node; they do not need to be TODO
  3818. items.
  3819. @table @kbd
  3820. @item @kbd{C-c ,}
  3821. @kindex @kbd{C-c ,}
  3822. @findex org-priority
  3823. Set the priority of the current headline (@command{org-priority}). The
  3824. command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
  3825. When you press @key{SPC} instead, the priority cookie is removed from the
  3826. headline. The priorities can also be changed ``remotely'' from the timeline
  3827. and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
  3828. @c
  3829. @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
  3830. @vindex org-priority-start-cycle-with-default
  3831. Increase/decrease priority of current headline@footnote{See also the option
  3832. @code{org-priority-start-cycle-with-default}.}. Note that these keys are
  3833. also used to modify timestamps (@pxref{Creating timestamps}). See also
  3834. @ref{Conflicts}, for a discussion of the interaction with
  3835. @code{shift-selection-mode}.
  3836. @end table
  3837. @vindex org-highest-priority
  3838. @vindex org-lowest-priority
  3839. @vindex org-default-priority
  3840. You can change the range of allowed priorities by setting the variables
  3841. @code{org-highest-priority}, @code{org-lowest-priority}, and
  3842. @code{org-default-priority}. For an individual buffer, you may set
  3843. these values (highest, lowest, default) like this (please make sure that
  3844. the highest priority is earlier in the alphabet than the lowest
  3845. priority):
  3846. @cindex #+PRIORITIES
  3847. @example
  3848. #+PRIORITIES: A C B
  3849. @end example
  3850. @node Breaking down tasks, Checkboxes, Priorities, TODO Items
  3851. @section Breaking tasks down into subtasks
  3852. @cindex tasks, breaking down
  3853. @cindex statistics, for TODO items
  3854. @vindex org-agenda-todo-list-sublevels
  3855. It is often advisable to break down large tasks into smaller, manageable
  3856. subtasks. You can do this by creating an outline tree below a TODO item,
  3857. with detailed subtasks on the tree@footnote{To keep subtasks out of the
  3858. global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
  3859. the overview over the fraction of subtasks that are already completed, insert
  3860. either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
  3861. be updated each time the TODO status of a child changes, or when pressing
  3862. @kbd{C-c C-c} on the cookie. For example:
  3863. @example
  3864. * Organize Party [33%]
  3865. ** TODO Call people [1/2]
  3866. *** TODO Peter
  3867. *** DONE Sarah
  3868. ** TODO Buy food
  3869. ** DONE Talk to neighbor
  3870. @end example
  3871. @cindex property, COOKIE_DATA
  3872. If a heading has both checkboxes and TODO children below it, the meaning of
  3873. the statistics cookie become ambiguous. Set the property
  3874. @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
  3875. this issue.
  3876. @vindex org-hierarchical-todo-statistics
  3877. If you would like to have the statistics cookie count any TODO entries in the
  3878. subtree (not just direct children), configure the variable
  3879. @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
  3880. include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
  3881. property.
  3882. @example
  3883. * Parent capturing statistics [2/20]
  3884. :PROPERTIES:
  3885. :COOKIE_DATA: todo recursive
  3886. :END:
  3887. @end example
  3888. If you would like a TODO entry to automatically change to DONE
  3889. when all children are done, you can use the following setup:
  3890. @example
  3891. (defun org-summary-todo (n-done n-not-done)
  3892. "Switch entry to DONE when all subentries are done, to TODO otherwise."
  3893. (let (org-log-done org-log-states) ; turn off logging
  3894. (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
  3895. (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
  3896. @end example
  3897. Another possibility is the use of checkboxes to identify (a hierarchy of) a
  3898. large number of subtasks (@pxref{Checkboxes}).
  3899. @node Checkboxes, , Breaking down tasks, TODO Items
  3900. @section Checkboxes
  3901. @cindex checkboxes
  3902. @vindex org-list-automatic-rules
  3903. Every item in a plain list@footnote{With the exception of description
  3904. lists. But you can allow it by modifying @code{org-list-automatic-rules}
  3905. accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
  3906. it with the string @samp{[ ]}. This feature is similar to TODO items
  3907. (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
  3908. in the global TODO list, so they are often great to split a task into a
  3909. number of simple steps. Or you can use them in a shopping list. To toggle a
  3910. checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
  3911. @file{org-mouse.el}).
  3912. Here is an example of a checkbox list.
  3913. @example
  3914. * TODO Organize party [2/4]
  3915. - [-] call people [1/3]
  3916. - [ ] Peter
  3917. - [X] Sarah
  3918. - [ ] Sam
  3919. - [X] order food
  3920. - [ ] think about what music to play
  3921. - [X] talk to the neighbors
  3922. @end example
  3923. Checkboxes work hierarchically, so if a checkbox item has children that
  3924. are checkboxes, toggling one of the children checkboxes will make the
  3925. parent checkbox reflect if none, some, or all of the children are
  3926. checked.
  3927. @cindex statistics, for checkboxes
  3928. @cindex checkbox statistics
  3929. @cindex property, COOKIE_DATA
  3930. @vindex org-hierarchical-checkbox-statistics
  3931. The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
  3932. indicating how many checkboxes present in this entry have been checked off,
  3933. and the total number of checkboxes present. This can give you an idea on how
  3934. many checkboxes remain, even without opening a folded entry. The cookies can
  3935. be placed into a headline or into (the first line of) a plain list item.
  3936. Each cookie covers checkboxes of direct children structurally below the
  3937. headline/item on which the cookie appears@footnote{Set the variable
  3938. @code{org-hierarchical-checkbox-statistics} if you want such cookies to
  3939. count all checkboxes below the cookie, not just those belonging to direct
  3940. children.}. You have to insert the cookie yourself by typing either
  3941. @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
  3942. result, as in the examples above. With @samp{[%]} you get information about
  3943. the percentage of checkboxes checked (in the above example, this would be
  3944. @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
  3945. count either checkboxes below the heading or TODO states of children, and it
  3946. will display whatever was changed last. Set the property @code{COOKIE_DATA}
  3947. to either @samp{checkbox} or @samp{todo} to resolve this issue.
  3948. @cindex blocking, of checkboxes
  3949. @cindex checkbox blocking
  3950. @cindex property, ORDERED
  3951. If the current outline node has an @code{ORDERED} property, checkboxes must
  3952. be checked off in sequence, and an error will be thrown if you try to check
  3953. off a box while there are unchecked boxes above it.
  3954. @noindent The following commands work with checkboxes:
  3955. @table @kbd
  3956. @orgcmd{C-c C-c,org-toggle-checkbox}
  3957. Toggle checkbox status or (with prefix arg) checkbox presence at point.
  3958. With a single prefix argument, add an empty checkbox or remove the current
  3959. one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
  3960. will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
  3961. considered to be an intermediate state.
  3962. @orgcmd{C-c C-x C-b,org-toggle-checkbox}
  3963. Toggle checkbox status or (with prefix arg) checkbox presence at point. With
  3964. double prefix argument, set it to @samp{[-]}, which is considered to be an
  3965. intermediate state.
  3966. @itemize @minus
  3967. @item
  3968. If there is an active region, toggle the first checkbox in the region
  3969. and set all remaining boxes to the same status as the first. With a prefix
  3970. arg, add or remove the checkbox for all items in the region.
  3971. @item
  3972. If the cursor is in a headline, toggle checkboxes in the region between
  3973. this headline and the next (so @emph{not} the entire subtree).
  3974. @item
  3975. If there is no active region, just toggle the checkbox at point.
  3976. @end itemize
  3977. @orgcmd{M-S-@key{RET},org-insert-todo-heading}
  3978. Insert a new item with a checkbox. This works only if the cursor is already
  3979. in a plain list item (@pxref{Plain lists}).
  3980. @orgcmd{C-c C-x o,org-toggle-ordered-property}
  3981. @vindex org-track-ordered-property-with-tag
  3982. @cindex property, ORDERED
  3983. Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
  3984. be checked off in sequence. A property is used for this behavior because
  3985. this should be local to the current entry, not inherited like a tag.
  3986. However, if you would like to @i{track} the value of this property with a tag
  3987. for better visibility, customize the variable
  3988. @code{org-track-ordered-property-with-tag}.
  3989. @orgcmd{C-c #,org-update-statistics-cookies}
  3990. Update the statistics cookie in the current outline entry. When called with
  3991. a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
  3992. updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
  3993. new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
  3994. changing TODO states. If you delete boxes/entries or add/change them by
  3995. hand, use this command to get things back into sync.
  3996. @end table
  3997. @node Tags, Properties and Columns, TODO Items, Top
  3998. @chapter Tags
  3999. @cindex tags
  4000. @cindex headline tagging
  4001. @cindex matching, tags
  4002. @cindex sparse tree, tag based
  4003. An excellent way to implement labels and contexts for cross-correlating
  4004. information is to assign @i{tags} to headlines. Org mode has extensive
  4005. support for tags.
  4006. @vindex org-tag-faces
  4007. Every headline can contain a list of tags; they occur at the end of the
  4008. headline. Tags are normal words containing letters, numbers, @samp{_}, and
  4009. @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
  4010. @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
  4011. Tags will by default be in bold face with the same color as the headline.
  4012. You may specify special faces for specific tags using the variable
  4013. @code{org-tag-faces}, in much the same way as you can for TODO keywords
  4014. (@pxref{Faces for TODO keywords}).
  4015. @menu
  4016. * Tag inheritance:: Tags use the tree structure of the outline
  4017. * Setting tags:: How to assign tags to a headline
  4018. * Tag searches:: Searching for combinations of tags
  4019. @end menu
  4020. @node Tag inheritance, Setting tags, Tags, Tags
  4021. @section Tag inheritance
  4022. @cindex tag inheritance
  4023. @cindex inheritance, of tags
  4024. @cindex sublevels, inclusion into tags match
  4025. @i{Tags} make use of the hierarchical structure of outline trees. If a
  4026. heading has a certain tag, all subheadings will inherit the tag as
  4027. well. For example, in the list
  4028. @example
  4029. * Meeting with the French group :work:
  4030. ** Summary by Frank :boss:notes:
  4031. *** TODO Prepare slides for him :action:
  4032. @end example
  4033. @noindent
  4034. the final heading will have the tags @samp{:work:}, @samp{:boss:},
  4035. @samp{:notes:}, and @samp{:action:} even though the final heading is not
  4036. explicitly marked with those tags. You can also set tags that all entries in
  4037. a file should inherit just as if these tags were defined in a hypothetical
  4038. level zero that surrounds the entire file. Use a line like this@footnote{As
  4039. with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
  4040. changes in the line.}:
  4041. @cindex #+FILETAGS
  4042. @example
  4043. #+FILETAGS: :Peter:Boss:Secret:
  4044. @end example
  4045. @noindent
  4046. @vindex org-use-tag-inheritance
  4047. @vindex org-tags-exclude-from-inheritance
  4048. To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
  4049. To turn it off entirely, use @code{org-use-tag-inheritance}.
  4050. @vindex org-tags-match-list-sublevels
  4051. When a headline matches during a tags search while tag inheritance is turned
  4052. on, all the sublevels in the same tree will (for a simple match form) match
  4053. as well@footnote{This is only true if the search does not involve more
  4054. complex tests including properties (@pxref{Property searches}).}. The list
  4055. of matches may then become very long. If you only want to see the first tags
  4056. match in a subtree, configure the variable
  4057. @code{org-tags-match-list-sublevels} (not recommended).
  4058. @vindex org-agenda-use-tag-inheritance
  4059. Tag inheritance is relevant when the agenda search tries to match a tag,
  4060. either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
  4061. types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
  4062. have your tags correctly set in the agenda, so that tag filtering works fine,
  4063. with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
  4064. this: the default value includes all agenda types, but setting this to nil
  4065. can really speed up agenda generation.
  4066. @node Setting tags, Tag searches, Tag inheritance, Tags
  4067. @section Setting tags
  4068. @cindex setting tags
  4069. @cindex tags, setting
  4070. @kindex M-@key{TAB}
  4071. Tags can simply be typed into the buffer at the end of a headline.
  4072. After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
  4073. also a special command for inserting tags:
  4074. @table @kbd
  4075. @orgcmd{C-c C-q,org-set-tags-command}
  4076. @cindex completion, of tags
  4077. @vindex org-tags-column
  4078. Enter new tags for the current headline. Org mode will either offer
  4079. completion or a special single-key interface for setting tags, see
  4080. below. After pressing @key{RET}, the tags will be inserted and aligned
  4081. to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
  4082. tags in the current buffer will be aligned to that column, just to make
  4083. things look nice. TAGS are automatically realigned after promotion,
  4084. demotion, and TODO state changes (@pxref{TODO basics}).
  4085. @orgcmd{C-c C-c,org-set-tags-command}
  4086. When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
  4087. @end table
  4088. @vindex org-tag-alist
  4089. Org supports tag insertion based on a @emph{list of tags}. By
  4090. default this list is constructed dynamically, containing all tags
  4091. currently used in the buffer. You may also globally specify a hard list
  4092. of tags with the variable @code{org-tag-alist}. Finally you can set
  4093. the default tags for a given file with lines like
  4094. @cindex #+TAGS
  4095. @example
  4096. #+TAGS: @@work @@home @@tennisclub
  4097. #+TAGS: laptop car pc sailboat
  4098. @end example
  4099. If you have globally defined your preferred set of tags using the
  4100. variable @code{org-tag-alist}, but would like to use a dynamic tag list
  4101. in a specific file, add an empty TAGS option line to that file:
  4102. @example
  4103. #+TAGS:
  4104. @end example
  4105. @vindex org-tag-persistent-alist
  4106. If you have a preferred set of tags that you would like to use in every file,
  4107. in addition to those defined on a per-file basis by TAGS option lines, then
  4108. you may specify a list of tags with the variable
  4109. @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
  4110. by adding a STARTUP option line to that file:
  4111. @example
  4112. #+STARTUP: noptag
  4113. @end example
  4114. By default Org mode uses the standard minibuffer completion facilities for
  4115. entering tags. However, it also implements another, quicker, tag selection
  4116. method called @emph{fast tag selection}. This allows you to select and
  4117. deselect tags with just a single key press. For this to work well you should
  4118. assign unique letters to most of your commonly used tags. You can do this
  4119. globally by configuring the variable @code{org-tag-alist} in your
  4120. @file{.emacs} file. For example, you may find the need to tag many items in
  4121. different files with @samp{:@@home:}. In this case you can set something
  4122. like:
  4123. @lisp
  4124. (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
  4125. @end lisp
  4126. @noindent If the tag is only relevant to the file you are working on, then you
  4127. can instead set the TAGS option line as:
  4128. @example
  4129. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
  4130. @end example
  4131. @noindent The tags interface will show the available tags in a splash
  4132. window. If you want to start a new line after a specific tag, insert
  4133. @samp{\n} into the tag list
  4134. @example
  4135. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
  4136. @end example
  4137. @noindent or write them in two lines:
  4138. @example
  4139. #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
  4140. #+TAGS: laptop(l) pc(p)
  4141. @end example
  4142. @noindent
  4143. You can also group together tags that are mutually exclusive by using
  4144. braces, as in:
  4145. @example
  4146. #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
  4147. @end example
  4148. @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
  4149. and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
  4150. @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
  4151. these lines to activate any changes.
  4152. @noindent
  4153. To set these mutually exclusive groups in the variable @code{org-tags-alist},
  4154. you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
  4155. of the braces. Similarly, you can use @code{:newline} to indicate a line
  4156. break. The previous example would be set globally by the following
  4157. configuration:
  4158. @lisp
  4159. (setq org-tag-alist '((:startgroup . nil)
  4160. ("@@work" . ?w) ("@@home" . ?h)
  4161. ("@@tennisclub" . ?t)
  4162. (:endgroup . nil)
  4163. ("laptop" . ?l) ("pc" . ?p)))
  4164. @end lisp
  4165. If at least one tag has a selection key then pressing @kbd{C-c C-c} will
  4166. automatically present you with a special interface, listing inherited tags,
  4167. the tags of the current headline, and a list of all valid tags with
  4168. corresponding keys@footnote{Keys will automatically be assigned to tags which
  4169. have no configured keys.}. In this interface, you can use the following
  4170. keys:
  4171. @table @kbd
  4172. @item a-z...
  4173. Pressing keys assigned to tags will add or remove them from the list of
  4174. tags in the current line. Selecting a tag in a group of mutually
  4175. exclusive tags will turn off any other tags from that group.
  4176. @kindex @key{TAB}
  4177. @item @key{TAB}
  4178. Enter a tag in the minibuffer, even if the tag is not in the predefined
  4179. list. You will be able to complete on all tags present in the buffer.
  4180. You can also add several tags: just separate them with a comma.
  4181. @kindex @key{SPC}
  4182. @item @key{SPC}
  4183. Clear all tags for this line.
  4184. @kindex @key{RET}
  4185. @item @key{RET}
  4186. Accept the modified set.
  4187. @item C-g
  4188. Abort without installing changes.
  4189. @item q
  4190. If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
  4191. @item !
  4192. Turn off groups of mutually exclusive tags. Use this to (as an
  4193. exception) assign several tags from such a group.
  4194. @item C-c
  4195. Toggle auto-exit after the next change (see below).
  4196. If you are using expert mode, the first @kbd{C-c} will display the
  4197. selection window.
  4198. @end table
  4199. @noindent
  4200. This method lets you assign tags to a headline with very few keys. With
  4201. the above setup, you could clear the current tags and set @samp{@@home},
  4202. @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
  4203. C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
  4204. @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
  4205. alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
  4206. @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
  4207. @key{RET} @key{RET}}.
  4208. @vindex org-fast-tag-selection-single-key
  4209. If you find that most of the time you need only a single key press to
  4210. modify your list of tags, set the variable
  4211. @code{org-fast-tag-selection-single-key}. Then you no longer have to
  4212. press @key{RET} to exit fast tag selection---it will immediately exit
  4213. after the first change. If you then occasionally need more keys, press
  4214. @kbd{C-c} to turn off auto-exit for the current tag selection process
  4215. (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
  4216. C-c}). If you set the variable to the value @code{expert}, the special
  4217. window is not even shown for single-key tag selection, it comes up only
  4218. when you press an extra @kbd{C-c}.
  4219. @node Tag searches, , Setting tags, Tags
  4220. @section Tag searches
  4221. @cindex tag searches
  4222. @cindex searching for tags
  4223. Once a system of tags has been set up, it can be used to collect related
  4224. information into special lists.
  4225. @table @kbd
  4226. @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
  4227. Create a sparse tree with all headlines matching a tags search. With a
  4228. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  4229. @orgcmd{C-c a m,org-tags-view}
  4230. Create a global list of tag matches from all agenda files.
  4231. @xref{Matching tags and properties}.
  4232. @orgcmd{C-c a M,org-tags-view}
  4233. @vindex org-tags-match-list-sublevels
  4234. Create a global list of tag matches from all agenda files, but check
  4235. only TODO items and force checking subitems (see variable
  4236. @code{org-tags-match-list-sublevels}).
  4237. @end table
  4238. These commands all prompt for a match string which allows basic Boolean logic
  4239. like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
  4240. @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
  4241. which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
  4242. string is rich and allows also matching against TODO keywords, entry levels
  4243. and properties. For a complete description with many examples, see
  4244. @ref{Matching tags and properties}.
  4245. @node Properties and Columns, Dates and Times, Tags, Top
  4246. @chapter Properties and columns
  4247. @cindex properties
  4248. A property is a key-value pair associated with an entry. Properties can be
  4249. set so they are associated with a single entry, with every entry in a tree,
  4250. or with every entry in an Org mode file.
  4251. There are two main applications for properties in Org mode. First,
  4252. properties are like tags, but with a value. Imagine maintaining a file where
  4253. you document bugs and plan releases for a piece of software. Instead of
  4254. using tags like @code{:release_1:}, @code{:release_2:}, you can use a
  4255. property, say @code{:Release:}, that in different subtrees has different
  4256. values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
  4257. implement (very basic) database capabilities in an Org buffer. Imagine
  4258. keeping track of your music CDs, where properties could be things such as the
  4259. album, artist, date of release, number of tracks, and so on.
  4260. Properties can be conveniently edited and viewed in column view
  4261. (@pxref{Column view}).
  4262. @menu
  4263. * Property syntax:: How properties are spelled out
  4264. * Special properties:: Access to other Org mode features
  4265. * Property searches:: Matching property values
  4266. * Property inheritance:: Passing values down the tree
  4267. * Column view:: Tabular viewing and editing
  4268. * Property API:: Properties for Lisp programmers
  4269. @end menu
  4270. @node Property syntax, Special properties, Properties and Columns, Properties and Columns
  4271. @section Property syntax
  4272. @cindex property syntax
  4273. @cindex drawer, for properties
  4274. Properties are key-value pairs. When they are associated with a single entry
  4275. or with a tree they need to be inserted into a special
  4276. drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
  4277. is specified on a single line, with the key (surrounded by colons)
  4278. first, and the value after it. Here is an example:
  4279. @example
  4280. * CD collection
  4281. ** Classic
  4282. *** Goldberg Variations
  4283. :PROPERTIES:
  4284. :Title: Goldberg Variations
  4285. :Composer: J.S. Bach
  4286. :Artist: Glen Gould
  4287. :Publisher: Deutsche Grammophon
  4288. :NDisks: 1
  4289. :END:
  4290. @end example
  4291. Depending on the value of @code{org-use-property-inheritance}, a property set
  4292. this way will either be associated with a single entry, or the sub-tree
  4293. defined by the entry, see @ref{Property inheritance}.
  4294. You may define the allowed values for a particular property @samp{:Xyz:}
  4295. by setting a property @samp{:Xyz_ALL:}. This special property is
  4296. @emph{inherited}, so if you set it in a level 1 entry, it will apply to
  4297. the entire tree. When allowed values are defined, setting the
  4298. corresponding property becomes easier and is less prone to typing
  4299. errors. For the example with the CD collection, we can predefine
  4300. publishers and the number of disks in a box like this:
  4301. @example
  4302. * CD collection
  4303. :PROPERTIES:
  4304. :NDisks_ALL: 1 2 3 4
  4305. :Publisher_ALL: "Deutsche Grammophon" Philips EMI
  4306. :END:
  4307. @end example
  4308. If you want to set properties that can be inherited by any entry in a
  4309. file, use a line like
  4310. @cindex property, _ALL
  4311. @cindex #+PROPERTY
  4312. @example
  4313. #+PROPERTY: NDisks_ALL 1 2 3 4
  4314. @end example
  4315. If you want to add to the value of an existing property, append a @code{+} to
  4316. the property name. The following results in the property @code{var} having
  4317. the value ``foo=1 bar=2''.
  4318. @cindex property, +
  4319. @example
  4320. #+PROPERTY: var foo=1
  4321. #+PROPERTY: var+ bar=2
  4322. @end example
  4323. It is also possible to add to the values of inherited properties. The
  4324. following results in the @code{genres} property having the value ``Classic
  4325. Baroque'' under the @code{Goldberg Variations} subtree.
  4326. @cindex property, +
  4327. @example
  4328. * CD collection
  4329. ** Classic
  4330. :PROPERTIES:
  4331. :GENRES: Classic
  4332. :END:
  4333. *** Goldberg Variations
  4334. :PROPERTIES:
  4335. :Title: Goldberg Variations
  4336. :Composer: J.S. Bach
  4337. :Artist: Glen Gould
  4338. :Publisher: Deutsche Grammophon
  4339. :NDisks: 1
  4340. :GENRES+: Baroque
  4341. :END:
  4342. @end example
  4343. Note that a property can only have one entry per Drawer.
  4344. @vindex org-global-properties
  4345. Property values set with the global variable
  4346. @code{org-global-properties} can be inherited by all entries in all
  4347. Org files.
  4348. @noindent
  4349. The following commands help to work with properties:
  4350. @table @kbd
  4351. @orgcmd{M-@key{TAB},pcomplete}
  4352. After an initial colon in a line, complete property keys. All keys used
  4353. in the current file will be offered as possible completions.
  4354. @orgcmd{C-c C-x p,org-set-property}
  4355. Set a property. This prompts for a property name and a value. If
  4356. necessary, the property drawer is created as well.
  4357. @item C-u M-x org-insert-drawer
  4358. @cindex org-insert-drawer
  4359. Insert a property drawer into the current entry. The drawer will be
  4360. inserted early in the entry, but after the lines with planning
  4361. information like deadlines.
  4362. @orgcmd{C-c C-c,org-property-action}
  4363. With the cursor in a property drawer, this executes property commands.
  4364. @orgcmd{C-c C-c s,org-set-property}
  4365. Set a property in the current entry. Both the property and the value
  4366. can be inserted using completion.
  4367. @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
  4368. Switch property at point to the next/previous allowed value.
  4369. @orgcmd{C-c C-c d,org-delete-property}
  4370. Remove a property from the current entry.
  4371. @orgcmd{C-c C-c D,org-delete-property-globally}
  4372. Globally remove a property, from all entries in the current file.
  4373. @orgcmd{C-c C-c c,org-compute-property-at-point}
  4374. Compute the property at point, using the operator and scope from the
  4375. nearest column format definition.
  4376. @end table
  4377. @node Special properties, Property searches, Property syntax, Properties and Columns
  4378. @section Special properties
  4379. @cindex properties, special
  4380. Special properties provide an alternative access method to Org mode features,
  4381. like the TODO state or the priority of an entry, discussed in the previous
  4382. chapters. This interface exists so that you can include these states in a
  4383. column view (@pxref{Column view}), or to use them in queries. The following
  4384. property names are special and (except for @code{:CATEGORY:}) should not be
  4385. used as keys in the properties drawer:
  4386. @cindex property, special, ID
  4387. @cindex property, special, TODO
  4388. @cindex property, special, TAGS
  4389. @cindex property, special, ALLTAGS
  4390. @cindex property, special, CATEGORY
  4391. @cindex property, special, PRIORITY
  4392. @cindex property, special, DEADLINE
  4393. @cindex property, special, SCHEDULED
  4394. @cindex property, special, CLOSED
  4395. @cindex property, special, TIMESTAMP
  4396. @cindex property, special, TIMESTAMP_IA
  4397. @cindex property, special, CLOCKSUM
  4398. @cindex property, special, CLOCKSUM_T
  4399. @cindex property, special, BLOCKED
  4400. @c guessing that ITEM is needed in this area; also, should this list be sorted?
  4401. @cindex property, special, ITEM
  4402. @cindex property, special, FILE
  4403. @example
  4404. ID @r{A globally unique ID used for synchronization during}
  4405. @r{iCalendar or MobileOrg export.}
  4406. TODO @r{The TODO keyword of the entry.}
  4407. TAGS @r{The tags defined directly in the headline.}
  4408. ALLTAGS @r{All tags, including inherited ones.}
  4409. CATEGORY @r{The category of an entry.}
  4410. PRIORITY @r{The priority of the entry, a string with a single letter.}
  4411. DEADLINE @r{The deadline time string, without the angular brackets.}
  4412. SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
  4413. CLOSED @r{When was this entry closed?}
  4414. TIMESTAMP @r{The first keyword-less timestamp in the entry.}
  4415. TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
  4416. CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
  4417. @r{must be run first to compute the values in the current buffer.}
  4418. CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
  4419. @r{@code{org-clock-sum-today} must be run first to compute the}
  4420. @r{values in the current buffer.}
  4421. BLOCKED @r{"t" if task is currently blocked by children or siblings}
  4422. ITEM @r{The headline of the entry.}
  4423. FILE @r{The filename the entry is located in.}
  4424. @end example
  4425. @node Property searches, Property inheritance, Special properties, Properties and Columns
  4426. @section Property searches
  4427. @cindex properties, searching
  4428. @cindex searching, of properties
  4429. To create sparse trees and special lists with selection based on properties,
  4430. the same commands are used as for tag searches (@pxref{Tag searches}).
  4431. @table @kbd
  4432. @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
  4433. Create a sparse tree with all matching entries. With a
  4434. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  4435. @orgcmd{C-c a m,org-tags-view}
  4436. Create a global list of tag/property matches from all agenda files.
  4437. @xref{Matching tags and properties}.
  4438. @orgcmd{C-c a M,org-tags-view}
  4439. @vindex org-tags-match-list-sublevels
  4440. Create a global list of tag matches from all agenda files, but check
  4441. only TODO items and force checking of subitems (see variable
  4442. @code{org-tags-match-list-sublevels}).
  4443. @end table
  4444. The syntax for the search string is described in @ref{Matching tags and
  4445. properties}.
  4446. There is also a special command for creating sparse trees based on a
  4447. single property:
  4448. @table @kbd
  4449. @orgkey{C-c / p}
  4450. Create a sparse tree based on the value of a property. This first
  4451. prompts for the name of a property, and then for a value. A sparse tree
  4452. is created with all entries that define this property with the given
  4453. value. If you enclose the value in curly braces, it is interpreted as
  4454. a regular expression and matched against the property values.
  4455. @end table
  4456. @node Property inheritance, Column view, Property searches, Properties and Columns
  4457. @section Property Inheritance
  4458. @cindex properties, inheritance
  4459. @cindex inheritance, of properties
  4460. @vindex org-use-property-inheritance
  4461. The outline structure of Org mode documents lends itself to an
  4462. inheritance model of properties: if the parent in a tree has a certain
  4463. property, the children can inherit this property. Org mode does not
  4464. turn this on by default, because it can slow down property searches
  4465. significantly and is often not needed. However, if you find inheritance
  4466. useful, you can turn it on by setting the variable
  4467. @code{org-use-property-inheritance}. It may be set to @code{t} to make
  4468. all properties inherited from the parent, to a list of properties
  4469. that should be inherited, or to a regular expression that matches
  4470. inherited properties. If a property has the value @samp{nil}, this is
  4471. interpreted as an explicit undefine of the property, so that inheritance
  4472. search will stop at this value and return @code{nil}.
  4473. Org mode has a few properties for which inheritance is hard-coded, at
  4474. least for the special applications for which they are used:
  4475. @cindex property, COLUMNS
  4476. @table @code
  4477. @item COLUMNS
  4478. The @code{:COLUMNS:} property defines the format of column view
  4479. (@pxref{Column view}). It is inherited in the sense that the level
  4480. where a @code{:COLUMNS:} property is defined is used as the starting
  4481. point for a column view table, independently of the location in the
  4482. subtree from where columns view is turned on.
  4483. @item CATEGORY
  4484. @cindex property, CATEGORY
  4485. For agenda view, a category set through a @code{:CATEGORY:} property
  4486. applies to the entire subtree.
  4487. @item ARCHIVE
  4488. @cindex property, ARCHIVE
  4489. For archiving, the @code{:ARCHIVE:} property may define the archive
  4490. location for the entire subtree (@pxref{Moving subtrees}).
  4491. @item LOGGING
  4492. @cindex property, LOGGING
  4493. The LOGGING property may define logging settings for an entry or a
  4494. subtree (@pxref{Tracking TODO state changes}).
  4495. @end table
  4496. @node Column view, Property API, Property inheritance, Properties and Columns
  4497. @section Column view
  4498. A great way to view and edit properties in an outline tree is
  4499. @emph{column view}. In column view, each outline node is turned into a
  4500. table row. Columns in this table provide access to properties of the
  4501. entries. Org mode implements columns by overlaying a tabular structure
  4502. over the headline of each item. While the headlines have been turned
  4503. into a table row, you can still change the visibility of the outline
  4504. tree. For example, you get a compact table by switching to CONTENTS
  4505. view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
  4506. is active), but you can still open, read, and edit the entry below each
  4507. headline. Or, you can switch to column view after executing a sparse
  4508. tree command and in this way get a table only for the selected items.
  4509. Column view also works in agenda buffers (@pxref{Agenda Views}) where
  4510. queries have collected selected items, possibly from a number of files.
  4511. @menu
  4512. * Defining columns:: The COLUMNS format property
  4513. * Using column view:: How to create and use column view
  4514. * Capturing column view:: A dynamic block for column view
  4515. @end menu
  4516. @node Defining columns, Using column view, Column view, Column view
  4517. @subsection Defining columns
  4518. @cindex column view, for properties
  4519. @cindex properties, column view
  4520. Setting up a column view first requires defining the columns. This is
  4521. done by defining a column format line.
  4522. @menu
  4523. * Scope of column definitions:: Where defined, where valid?
  4524. * Column attributes:: Appearance and content of a column
  4525. @end menu
  4526. @node Scope of column definitions, Column attributes, Defining columns, Defining columns
  4527. @subsubsection Scope of column definitions
  4528. To define a column format for an entire file, use a line like
  4529. @cindex #+COLUMNS
  4530. @example
  4531. #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  4532. @end example
  4533. To specify a format that only applies to a specific tree, add a
  4534. @code{:COLUMNS:} property to the top node of that tree, for example:
  4535. @example
  4536. ** Top node for columns view
  4537. :PROPERTIES:
  4538. :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  4539. :END:
  4540. @end example
  4541. If a @code{:COLUMNS:} property is present in an entry, it defines columns
  4542. for the entry itself, and for the entire subtree below it. Since the
  4543. column definition is part of the hierarchical structure of the document,
  4544. you can define columns on level 1 that are general enough for all
  4545. sublevels, and more specific columns further down, when you edit a
  4546. deeper part of the tree.
  4547. @node Column attributes, , Scope of column definitions, Defining columns
  4548. @subsubsection Column attributes
  4549. A column definition sets the attributes of a column. The general
  4550. definition looks like this:
  4551. @example
  4552. %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
  4553. @end example
  4554. @noindent
  4555. Except for the percent sign and the property name, all items are
  4556. optional. The individual parts have the following meaning:
  4557. @example
  4558. @var{width} @r{An integer specifying the width of the column in characters.}
  4559. @r{If omitted, the width will be determined automatically.}
  4560. @var{property} @r{The property that should be edited in this column.}
  4561. @r{Special properties representing meta data are allowed here}
  4562. @r{as well (@pxref{Special properties})}
  4563. @var{title} @r{The header text for the column. If omitted, the property}
  4564. @r{name is used.}
  4565. @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
  4566. @r{parent nodes are computed from the children.}
  4567. @r{Supported summary types are:}
  4568. @{+@} @r{Sum numbers in this column.}
  4569. @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
  4570. @{$@} @r{Currency, short for @samp{+;%.2f}.}
  4571. @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
  4572. @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
  4573. @{X/@} @r{Checkbox status, @samp{[n/m]}.}
  4574. @{X%@} @r{Checkbox status, @samp{[n%]}.}
  4575. @{min@} @r{Smallest number in column.}
  4576. @{max@} @r{Largest number.}
  4577. @{mean@} @r{Arithmetic mean of numbers.}
  4578. @{:min@} @r{Smallest time value in column.}
  4579. @{:max@} @r{Largest time value.}
  4580. @{:mean@} @r{Arithmetic mean of time values.}
  4581. @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
  4582. @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
  4583. @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
  4584. @{est+@} @r{Add low-high estimates.}
  4585. @end example
  4586. @noindent
  4587. Be aware that you can only have one summary type for any property you
  4588. include. Subsequent columns referencing the same property will all display the
  4589. same summary information.
  4590. The @code{est+} summary type requires further explanation. It is used for
  4591. combining estimates, expressed as low-high ranges. For example, instead
  4592. of estimating a particular task will take 5 days, you might estimate it as
  4593. 5--6 days if you're fairly confident you know how much work is required, or
  4594. 1--10 days if you don't really know what needs to be done. Both ranges
  4595. average at 5.5 days, but the first represents a more predictable delivery.
  4596. When combining a set of such estimates, simply adding the lows and highs
  4597. produces an unrealistically wide result. Instead, @code{est+} adds the
  4598. statistical mean and variance of the sub-tasks, generating a final estimate
  4599. from the sum. For example, suppose you had ten tasks, each of which was
  4600. estimated at 0.5 to 2 days of work. Straight addition produces an estimate
  4601. of 5 to 20 days, representing what to expect if everything goes either
  4602. extremely well or extremely poorly. In contrast, @code{est+} estimates the
  4603. full job more realistically, at 10--15 days.
  4604. Here is an example for a complete columns definition, along with allowed
  4605. values.
  4606. @example
  4607. :COLUMNS: %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.}
  4608. %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
  4609. :Owner_ALL: Tammy Mark Karl Lisa Don
  4610. :Status_ALL: "In progress" "Not started yet" "Finished" ""
  4611. :Approved_ALL: "[ ]" "[X]"
  4612. @end example
  4613. @noindent
  4614. The first column, @samp{%25ITEM}, means the first 25 characters of the
  4615. item itself, i.e., of the headline. You probably always should start the
  4616. column definition with the @samp{ITEM} specifier. The other specifiers
  4617. create columns @samp{Owner} with a list of names as allowed values, for
  4618. @samp{Status} with four different possible values, and for a checkbox
  4619. field @samp{Approved}. When no width is given after the @samp{%}
  4620. character, the column will be exactly as wide as it needs to be in order
  4621. to fully display all values. The @samp{Approved} column does have a
  4622. modified title (@samp{Approved?}, with a question mark). Summaries will
  4623. be created for the @samp{Time_Estimate} column by adding time duration
  4624. expressions like HH:MM, and for the @samp{Approved} column, by providing
  4625. an @samp{[X]} status if all children have been checked. The
  4626. @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
  4627. sums of CLOCK intervals in the subtree, either for all clocks or just for
  4628. today.
  4629. @node Using column view, Capturing column view, Defining columns, Column view
  4630. @subsection Using column view
  4631. @table @kbd
  4632. @tsubheading{Turning column view on and off}
  4633. @orgcmd{C-c C-x C-c,org-columns}
  4634. @vindex org-columns-default-format
  4635. Turn on column view. If the cursor is before the first headline in the file,
  4636. column view is turned on for the entire file, using the @code{#+COLUMNS}
  4637. definition. If the cursor is somewhere inside the outline, this command
  4638. searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
  4639. defines a format. When one is found, the column view table is established
  4640. for the tree starting at the entry that contains the @code{:COLUMNS:}
  4641. property. If no such property is found, the format is taken from the
  4642. @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
  4643. and column view is established for the current entry and its subtree.
  4644. @orgcmd{r,org-columns-redo}
  4645. Recreate the column view, to include recent changes made in the buffer.
  4646. @orgcmd{g,org-columns-redo}
  4647. Same as @kbd{r}.
  4648. @orgcmd{q,org-columns-quit}
  4649. Exit column view.
  4650. @tsubheading{Editing values}
  4651. @item @key{left} @key{right} @key{up} @key{down}
  4652. Move through the column view from field to field.
  4653. @kindex S-@key{left}
  4654. @kindex S-@key{right}
  4655. @item S-@key{left}/@key{right}
  4656. Switch to the next/previous allowed value of the field. For this, you
  4657. have to have specified allowed values for a property.
  4658. @item 1..9,0
  4659. Directly select the Nth allowed value, @kbd{0} selects the 10th value.
  4660. @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
  4661. Same as @kbd{S-@key{left}/@key{right}}
  4662. @orgcmd{e,org-columns-edit-value}
  4663. Edit the property at point. For the special properties, this will
  4664. invoke the same interface that you normally use to change that
  4665. property. For example, when editing a TAGS property, the tag completion
  4666. or fast selection interface will pop up.
  4667. @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
  4668. When there is a checkbox at point, toggle it.
  4669. @orgcmd{v,org-columns-show-value}
  4670. View the full value of this property. This is useful if the width of
  4671. the column is smaller than that of the value.
  4672. @orgcmd{a,org-columns-edit-allowed}
  4673. Edit the list of allowed values for this property. If the list is found
  4674. in the hierarchy, the modified values is stored there. If no list is
  4675. found, the new value is stored in the first entry that is part of the
  4676. current column view.
  4677. @tsubheading{Modifying the table structure}
  4678. @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
  4679. Make the column narrower/wider by one character.
  4680. @orgcmd{S-M-@key{right},org-columns-new}
  4681. Insert a new column, to the left of the current column.
  4682. @orgcmd{S-M-@key{left},org-columns-delete}
  4683. Delete the current column.
  4684. @end table
  4685. @node Capturing column view, , Using column view, Column view
  4686. @subsection Capturing column view
  4687. Since column view is just an overlay over a buffer, it cannot be
  4688. exported or printed directly. If you want to capture a column view, use
  4689. a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
  4690. of this block looks like this:
  4691. @cindex #+BEGIN, columnview
  4692. @example
  4693. * The column view
  4694. #+BEGIN: columnview :hlines 1 :id "label"
  4695. #+END:
  4696. @end example
  4697. @noindent This dynamic block has the following parameters:
  4698. @table @code
  4699. @item :id
  4700. This is the most important parameter. Column view is a feature that is
  4701. often localized to a certain (sub)tree, and the capture block might be
  4702. at a different location in the file. To identify the tree whose view to
  4703. capture, you can use 4 values:
  4704. @cindex property, ID
  4705. @example
  4706. local @r{use the tree in which the capture block is located}
  4707. global @r{make a global view, including all headings in the file}
  4708. "file:@var{path-to-file}"
  4709. @r{run column view at the top of this file}
  4710. "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
  4711. @r{property with the value @i{label}. You can use}
  4712. @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
  4713. @r{the current entry and copy it to the kill-ring.}
  4714. @end example
  4715. @item :hlines
  4716. When @code{t}, insert an hline after every line. When a number @var{N}, insert
  4717. an hline before each headline with level @code{<= @var{N}}.
  4718. @item :vlines
  4719. When set to @code{t}, force column groups to get vertical lines.
  4720. @item :maxlevel
  4721. When set to a number, don't capture entries below this level.
  4722. @item :skip-empty-rows
  4723. When set to @code{t}, skip rows where the only non-empty specifier of the
  4724. column view is @code{ITEM}.
  4725. @end table
  4726. @noindent
  4727. The following commands insert or update the dynamic block:
  4728. @table @kbd
  4729. @orgcmd{C-c C-x i,org-insert-columns-dblock}
  4730. Insert a dynamic block capturing a column view. You will be prompted
  4731. for the scope or ID of the view.
  4732. @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
  4733. Update dynamic block at point. The cursor needs to be in the
  4734. @code{#+BEGIN} line of the dynamic block.
  4735. @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
  4736. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  4737. you have several clock table blocks, column-capturing blocks or other dynamic
  4738. blocks in a buffer.
  4739. @end table
  4740. You can add formulas to the column view table and you may add plotting
  4741. instructions in front of the table---these will survive an update of the
  4742. block. If there is a @code{#+TBLFM:} after the table, the table will
  4743. actually be recalculated automatically after an update.
  4744. An alternative way to capture and process property values into a table is
  4745. provided by Eric Schulte's @file{org-collector.el} which is a contributed
  4746. package@footnote{Contributed packages are not part of Emacs, but are
  4747. distributed with the main distribution of Org (visit
  4748. @uref{http://orgmode.org}).}. It provides a general API to collect
  4749. properties from entries in a certain scope, and arbitrary Lisp expressions to
  4750. process these values before inserting them into a table or a dynamic block.
  4751. @node Property API, , Column view, Properties and Columns
  4752. @section The Property API
  4753. @cindex properties, API
  4754. @cindex API, for properties
  4755. There is a full API for accessing and changing properties. This API can
  4756. be used by Emacs Lisp programs to work with properties and to implement
  4757. features based on them. For more information see @ref{Using the
  4758. property API}.
  4759. @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
  4760. @chapter Dates and times
  4761. @cindex dates
  4762. @cindex times
  4763. @cindex timestamp
  4764. @cindex date stamp
  4765. To assist project planning, TODO items can be labeled with a date and/or
  4766. a time. The specially formatted string carrying the date and time
  4767. information is called a @emph{timestamp} in Org mode. This may be a
  4768. little confusing because timestamp is often used as indicating when
  4769. something was created or last changed. However, in Org mode this term
  4770. is used in a much wider sense.
  4771. @menu
  4772. * Timestamps:: Assigning a time to a tree entry
  4773. * Creating timestamps:: Commands which insert timestamps
  4774. * Deadlines and scheduling:: Planning your work
  4775. * Clocking work time:: Tracking how long you spend on a task
  4776. * Effort estimates:: Planning work effort in advance
  4777. * Relative timer:: Notes with a running timer
  4778. * Countdown timer:: Starting a countdown timer for a task
  4779. @end menu
  4780. @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
  4781. @section Timestamps, deadlines, and scheduling
  4782. @cindex timestamps
  4783. @cindex ranges, time
  4784. @cindex date stamps
  4785. @cindex deadlines
  4786. @cindex scheduling
  4787. A timestamp is a specification of a date (possibly with a time or a range of
  4788. times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
  4789. simplest form, the day name is optional when you type the date yourself.
  4790. However, any dates inserted or modified by Org will add that day name, for
  4791. reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
  4792. Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
  4793. date/time format. To use an alternative format, see @ref{Custom time
  4794. format}.}. A timestamp can appear anywhere in the headline or body of an Org
  4795. tree entry. Its presence causes entries to be shown on specific dates in the
  4796. agenda (@pxref{Weekly/daily agenda}). We distinguish:
  4797. @table @var
  4798. @item Plain timestamp; Event; Appointment
  4799. @cindex timestamp
  4800. @cindex appointment
  4801. A simple timestamp just assigns a date/time to an item. This is just
  4802. like writing down an appointment or event in a paper agenda. In the
  4803. timeline and agenda displays, the headline of an entry associated with a
  4804. plain timestamp will be shown exactly on that date.
  4805. @example
  4806. * Meet Peter at the movies
  4807. <2006-11-01 Wed 19:15>
  4808. * Discussion on climate change
  4809. <2006-11-02 Thu 20:00-22:00>
  4810. @end example
  4811. @item Timestamp with repeater interval
  4812. @cindex timestamp, with repeater interval
  4813. A timestamp may contain a @emph{repeater interval}, indicating that it
  4814. applies not only on the given date, but again and again after a certain
  4815. interval of N days (d), weeks (w), months (m), or years (y). The
  4816. following will show up in the agenda every Wednesday:
  4817. @example
  4818. * Pick up Sam at school
  4819. <2007-05-16 Wed 12:30 +1w>
  4820. @end example
  4821. @item Diary-style sexp entries
  4822. For more complex date specifications, Org mode supports using the special
  4823. sexp diary entries implemented in the Emacs calendar/diary
  4824. package@footnote{When working with the standard diary sexp functions, you
  4825. need to be very careful with the order of the arguments. That order depend
  4826. evilly on the variable @code{calendar-date-style} (or, for older Emacs
  4827. versions, @code{european-calendar-style}). For example, to specify a date
  4828. December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
  4829. @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
  4830. the settings. This has been the source of much confusion. Org mode users
  4831. can resort to special versions of these functions like @code{org-date} or
  4832. @code{org-anniversary}. These work just like the corresponding @code{diary-}
  4833. functions, but with stable ISO order of arguments (year, month, day) wherever
  4834. applicable, independent of the value of @code{calendar-date-style}.}. For
  4835. example with optional time
  4836. @example
  4837. * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
  4838. <%%(diary-float t 4 2)>
  4839. @end example
  4840. @item Time/Date range
  4841. @cindex timerange
  4842. @cindex date range
  4843. Two timestamps connected by @samp{--} denote a range. The headline
  4844. will be shown on the first and last day of the range, and on any dates
  4845. that are displayed and fall in the range. Here is an example:
  4846. @example
  4847. ** Meeting in Amsterdam
  4848. <2004-08-23 Mon>--<2004-08-26 Thu>
  4849. @end example
  4850. @item Inactive timestamp
  4851. @cindex timestamp, inactive
  4852. @cindex inactive timestamp
  4853. Just like a plain timestamp, but with square brackets instead of
  4854. angular ones. These timestamps are inactive in the sense that they do
  4855. @emph{not} trigger an entry to show up in the agenda.
  4856. @example
  4857. * Gillian comes late for the fifth time
  4858. [2006-11-01 Wed]
  4859. @end example
  4860. @end table
  4861. @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
  4862. @section Creating timestamps
  4863. @cindex creating timestamps
  4864. @cindex timestamps, creating
  4865. For Org mode to recognize timestamps, they need to be in the specific
  4866. format. All commands listed below produce timestamps in the correct
  4867. format.
  4868. @table @kbd
  4869. @orgcmd{C-c .,org-time-stamp}
  4870. Prompt for a date and insert a corresponding timestamp. When the cursor is
  4871. at an existing timestamp in the buffer, the command is used to modify this
  4872. timestamp instead of inserting a new one. When this command is used twice in
  4873. succession, a time range is inserted.
  4874. @c
  4875. @orgcmd{C-c !,org-time-stamp-inactive}
  4876. Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
  4877. an agenda entry.
  4878. @c
  4879. @kindex C-u C-c .
  4880. @kindex C-u C-c !
  4881. @item C-u C-c .
  4882. @itemx C-u C-c !
  4883. @vindex org-time-stamp-rounding-minutes
  4884. Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
  4885. contains date and time. The default time can be rounded to multiples of 5
  4886. minutes, see the option @code{org-time-stamp-rounding-minutes}.
  4887. @c
  4888. @orgkey{C-c C-c}
  4889. Normalize timestamp, insert/fix day name if missing or wrong.
  4890. @c
  4891. @orgcmd{C-c <,org-date-from-calendar}
  4892. Insert a timestamp corresponding to the cursor date in the Calendar.
  4893. @c
  4894. @orgcmd{C-c >,org-goto-calendar}
  4895. Access the Emacs calendar for the current date. If there is a
  4896. timestamp in the current line, go to the corresponding date
  4897. instead.
  4898. @c
  4899. @orgcmd{C-c C-o,org-open-at-point}
  4900. Access the agenda for the date given by the timestamp or -range at
  4901. point (@pxref{Weekly/daily agenda}).
  4902. @c
  4903. @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
  4904. Change date at cursor by one day. These key bindings conflict with
  4905. shift-selection and related modes (@pxref{Conflicts}).
  4906. @c
  4907. @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
  4908. Change the item under the cursor in a timestamp. The cursor can be on a
  4909. year, month, day, hour or minute. When the timestamp contains a time range
  4910. like @samp{15:30-16:30}, modifying the first time will also shift the second,
  4911. shifting the time block with constant length. To change the length, modify
  4912. the second time. Note that if the cursor is in a headline and not at a
  4913. timestamp, these same keys modify the priority of an item.
  4914. (@pxref{Priorities}). The key bindings also conflict with shift-selection and
  4915. related modes (@pxref{Conflicts}).
  4916. @c
  4917. @orgcmd{C-c C-y,org-evaluate-time-range}
  4918. @cindex evaluate time range
  4919. Evaluate a time range by computing the difference between start and end.
  4920. With a prefix argument, insert result after the time range (in a table: into
  4921. the following column).
  4922. @end table
  4923. @menu
  4924. * The date/time prompt:: How Org mode helps you entering date and time
  4925. * Custom time format:: Making dates look different
  4926. @end menu
  4927. @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
  4928. @subsection The date/time prompt
  4929. @cindex date, reading in minibuffer
  4930. @cindex time, reading in minibuffer
  4931. @vindex org-read-date-prefer-future
  4932. When Org mode prompts for a date/time, the default is shown in default
  4933. date/time format, and the prompt therefore seems to ask for a specific
  4934. format. But it will in fact accept date/time information in a variety of
  4935. formats. Generally, the information should start at the beginning of the
  4936. string. Org mode will find whatever information is in
  4937. there and derive anything you have not specified from the @emph{default date
  4938. and time}. The default is usually the current date and time, but when
  4939. modifying an existing timestamp, or when entering the second stamp of a
  4940. range, it is taken from the stamp in the buffer. When filling in
  4941. information, Org mode assumes that most of the time you will want to enter a
  4942. date in the future: if you omit the month/year and the given day/month is
  4943. @i{before} today, it will assume that you mean a future date@footnote{See the
  4944. variable @code{org-read-date-prefer-future}. You may set that variable to
  4945. the symbol @code{time} to even make a time before now shift the date to
  4946. tomorrow.}. If the date has been automatically shifted into the future, the
  4947. time prompt will show this with @samp{(=>F).}
  4948. For example, let's assume that today is @b{June 13, 2006}. Here is how
  4949. various inputs will be interpreted, the items filled in by Org mode are
  4950. in @b{bold}.
  4951. @example
  4952. 3-2-5 @result{} 2003-02-05
  4953. 2/5/3 @result{} 2003-02-05
  4954. 14 @result{} @b{2006}-@b{06}-14
  4955. 12 @result{} @b{2006}-@b{07}-12
  4956. 2/5 @result{} @b{2007}-02-05
  4957. Fri @result{} nearest Friday (default date or later)
  4958. sep 15 @result{} @b{2006}-09-15
  4959. feb 15 @result{} @b{2007}-02-15
  4960. sep 12 9 @result{} 2009-09-12
  4961. 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
  4962. 22 sept 0:34 @result{} @b{2006}-09-22 0:34
  4963. w4 @result{} ISO week for of the current year @b{2006}
  4964. 2012 w4 fri @result{} Friday of ISO week 4 in 2012
  4965. 2012-w04-5 @result{} Same as above
  4966. @end example
  4967. Furthermore you can specify a relative date by giving, as the
  4968. @emph{first} thing in the input: a plus/minus sign, a number and a
  4969. letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
  4970. single plus or minus, the date is always relative to today. With a
  4971. double plus or minus, it is relative to the default date. If instead of
  4972. a single letter, you use the abbreviation of day name, the date will be
  4973. the Nth such day, e.g.:
  4974. @example
  4975. +0 @result{} today
  4976. . @result{} today
  4977. +4d @result{} four days from today
  4978. +4 @result{} same as above
  4979. +2w @result{} two weeks from today
  4980. ++5 @result{} five days from default date
  4981. +2tue @result{} second Tuesday from now.
  4982. @end example
  4983. @vindex parse-time-months
  4984. @vindex parse-time-weekdays
  4985. The function understands English month and weekday abbreviations. If
  4986. you want to use unabbreviated names and/or other languages, configure
  4987. the variables @code{parse-time-months} and @code{parse-time-weekdays}.
  4988. @vindex org-read-date-force-compatible-dates
  4989. Not all dates can be represented in a given Emacs implementation. By default
  4990. Org mode forces dates into the compatibility range 1970--2037 which works on
  4991. all Emacs implementations. If you want to use dates outside of this range,
  4992. read the docstring of the variable
  4993. @code{org-read-date-force-compatible-dates}.
  4994. You can specify a time range by giving start and end times or by giving a
  4995. start time and a duration (in HH:MM format). Use one or two dash(es) as the
  4996. separator in the former case and use '+' as the separator in the latter
  4997. case, e.g.:
  4998. @example
  4999. 11am-1:15pm @result{} 11:00-13:15
  5000. 11am--1:15pm @result{} same as above
  5001. 11am+2:15 @result{} same as above
  5002. @end example
  5003. @cindex calendar, for selecting date
  5004. @vindex org-popup-calendar-for-date-prompt
  5005. Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
  5006. you don't need/want the calendar, configure the variable
  5007. @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
  5008. prompt, either by clicking on a date in the calendar, or by pressing
  5009. @key{RET}, the date selected in the calendar will be combined with the
  5010. information entered at the prompt. You can control the calendar fully
  5011. from the minibuffer:
  5012. @kindex <
  5013. @kindex >
  5014. @kindex M-v
  5015. @kindex C-v
  5016. @kindex mouse-1
  5017. @kindex S-@key{right}
  5018. @kindex S-@key{left}
  5019. @kindex S-@key{down}
  5020. @kindex S-@key{up}
  5021. @kindex M-S-@key{right}
  5022. @kindex M-S-@key{left}
  5023. @kindex @key{RET}
  5024. @example
  5025. @key{RET} @r{Choose date at cursor in calendar.}
  5026. mouse-1 @r{Select date by clicking on it.}
  5027. S-@key{right}/@key{left} @r{One day forward/backward.}
  5028. S-@key{down}/@key{up} @r{One week forward/backward.}
  5029. M-S-@key{right}/@key{left} @r{One month forward/backward.}
  5030. > / < @r{Scroll calendar forward/backward by one month.}
  5031. M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
  5032. @end example
  5033. @vindex org-read-date-display-live
  5034. The actions of the date/time prompt may seem complex, but I assure you they
  5035. will grow on you, and you will start getting annoyed by pretty much any other
  5036. way of entering a date/time out there. To help you understand what is going
  5037. on, the current interpretation of your input will be displayed live in the
  5038. minibuffer@footnote{If you find this distracting, turn the display of with
  5039. @code{org-read-date-display-live}.}.
  5040. @node Custom time format, , The date/time prompt, Creating timestamps
  5041. @subsection Custom time format
  5042. @cindex custom date/time format
  5043. @cindex time format, custom
  5044. @cindex date format, custom
  5045. @vindex org-display-custom-times
  5046. @vindex org-time-stamp-custom-formats
  5047. Org mode uses the standard ISO notation for dates and times as it is
  5048. defined in ISO 8601. If you cannot get used to this and require another
  5049. representation of date and time to keep you happy, you can get it by
  5050. customizing the variables @code{org-display-custom-times} and
  5051. @code{org-time-stamp-custom-formats}.
  5052. @table @kbd
  5053. @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
  5054. Toggle the display of custom formats for dates and times.
  5055. @end table
  5056. @noindent
  5057. Org mode needs the default format for scanning, so the custom date/time
  5058. format does not @emph{replace} the default format---instead it is put
  5059. @emph{over} the default format using text properties. This has the
  5060. following consequences:
  5061. @itemize @bullet
  5062. @item
  5063. You cannot place the cursor onto a timestamp anymore, only before or
  5064. after.
  5065. @item
  5066. The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
  5067. each component of a timestamp. If the cursor is at the beginning of
  5068. the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
  5069. just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
  5070. time will be changed by one minute.
  5071. @item
  5072. If the timestamp contains a range of clock times or a repeater, these
  5073. will not be overlaid, but remain in the buffer as they were.
  5074. @item
  5075. When you delete a timestamp character-by-character, it will only
  5076. disappear from the buffer after @emph{all} (invisible) characters
  5077. belonging to the ISO timestamp have been removed.
  5078. @item
  5079. If the custom timestamp format is longer than the default and you are
  5080. using dates in tables, table alignment will be messed up. If the custom
  5081. format is shorter, things do work as expected.
  5082. @end itemize
  5083. @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
  5084. @section Deadlines and scheduling
  5085. A timestamp may be preceded by special keywords to facilitate planning:
  5086. @table @var
  5087. @item DEADLINE
  5088. @cindex DEADLINE keyword
  5089. Meaning: the task (most likely a TODO item, though not necessarily) is supposed
  5090. to be finished on that date.
  5091. @vindex org-deadline-warning-days
  5092. On the deadline date, the task will be listed in the agenda. In
  5093. addition, the agenda for @emph{today} will carry a warning about the
  5094. approaching or missed deadline, starting
  5095. @code{org-deadline-warning-days} before the due date, and continuing
  5096. until the entry is marked DONE@. An example:
  5097. @example
  5098. *** TODO write article about the Earth for the Guide
  5099. DEADLINE: <2004-02-29 Sun>
  5100. The editor in charge is [[bbdb:Ford Prefect]]
  5101. @end example
  5102. You can specify a different lead time for warnings for a specific
  5103. deadlines using the following syntax. Here is an example with a warning
  5104. period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
  5105. @item SCHEDULED
  5106. @cindex SCHEDULED keyword
  5107. Meaning: you are planning to start working on that task on the given
  5108. date.
  5109. @vindex org-agenda-skip-scheduled-if-done
  5110. The headline will be listed under the given date@footnote{It will still
  5111. be listed on that date after it has been marked DONE@. If you don't like
  5112. this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
  5113. addition, a reminder that the scheduled date has passed will be present
  5114. in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
  5115. the task will automatically be forwarded until completed.
  5116. @example
  5117. *** TODO Call Trillian for a date on New Years Eve.
  5118. SCHEDULED: <2004-12-25 Sat>
  5119. @end example
  5120. @noindent
  5121. @b{Important:} Scheduling an item in Org mode should @i{not} be
  5122. understood in the same way that we understand @i{scheduling a meeting}.
  5123. Setting a date for a meeting is just a simple appointment, you should
  5124. mark this entry with a simple plain timestamp, to get this item shown
  5125. on the date where it applies. This is a frequent misunderstanding by
  5126. Org users. In Org mode, @i{scheduling} means setting a date when you
  5127. want to start working on an action item.
  5128. @end table
  5129. You may use timestamps with repeaters in scheduling and deadline
  5130. entries. Org mode will issue early and late warnings based on the
  5131. assumption that the timestamp represents the @i{nearest instance} of
  5132. the repeater. However, the use of diary sexp entries like
  5133. @c
  5134. @code{<%%(diary-float t 42)>}
  5135. @c
  5136. in scheduling and deadline timestamps is limited. Org mode does not
  5137. know enough about the internals of each sexp function to issue early and
  5138. late warnings. However, it will show the item on each day where the
  5139. sexp entry matches.
  5140. @menu
  5141. * Inserting deadline/schedule:: Planning items
  5142. * Repeated tasks:: Items that show up again and again
  5143. @end menu
  5144. @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
  5145. @subsection Inserting deadlines or schedules
  5146. The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
  5147. @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
  5148. any text between this line and the headline.} a deadline or to schedule
  5149. an item:
  5150. @table @kbd
  5151. @c
  5152. @orgcmd{C-c C-d,org-deadline}
  5153. Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
  5154. in the line directly following the headline. Any CLOSED timestamp will be
  5155. removed. When called with a prefix arg, an existing deadline will be removed
  5156. from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
  5157. @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
  5158. and @code{nologredeadline}}, a note will be taken when changing an existing
  5159. deadline.
  5160. @orgcmd{C-c C-s,org-schedule}
  5161. Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
  5162. happen in the line directly following the headline. Any CLOSED timestamp
  5163. will be removed. When called with a prefix argument, remove the scheduling
  5164. date from the entry. Depending on the variable
  5165. @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
  5166. keywords @code{logreschedule}, @code{lognotereschedule}, and
  5167. @code{nologreschedule}}, a note will be taken when changing an existing
  5168. scheduling time.
  5169. @c
  5170. @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
  5171. @kindex k a
  5172. @kindex k s
  5173. Mark the current entry for agenda action. After you have marked the entry
  5174. like this, you can open the agenda or the calendar to find an appropriate
  5175. date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
  5176. schedule the marked item.
  5177. @c
  5178. @orgcmd{C-c / d,org-check-deadlines}
  5179. @cindex sparse tree, for deadlines
  5180. @vindex org-deadline-warning-days
  5181. Create a sparse tree with all deadlines that are either past-due, or
  5182. which will become due within @code{org-deadline-warning-days}.
  5183. With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
  5184. prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
  5185. all deadlines due tomorrow.
  5186. @c
  5187. @orgcmd{C-c / b,org-check-before-date}
  5188. Sparse tree for deadlines and scheduled items before a given date.
  5189. @c
  5190. @orgcmd{C-c / a,org-check-after-date}
  5191. Sparse tree for deadlines and scheduled items after a given date.
  5192. @end table
  5193. Note that @code{org-schedule} and @code{org-deadline} supports
  5194. setting the date by indicating a relative time: e.g., +1d will set
  5195. the date to the next day after today, and --1w will set the date
  5196. to the previous week before any current timestamp.
  5197. @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
  5198. @subsection Repeated tasks
  5199. @cindex tasks, repeated
  5200. @cindex repeated tasks
  5201. Some tasks need to be repeated again and again. Org mode helps to
  5202. organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
  5203. or plain timestamp. In the following example
  5204. @example
  5205. ** TODO Pay the rent
  5206. DEADLINE: <2005-10-01 Sat +1m>
  5207. @end example
  5208. @noindent
  5209. the @code{+1m} is a repeater; the intended interpretation is that the task
  5210. has a deadline on <2005-10-01> and repeats itself every (one) month starting
  5211. from that time. You can use yearly, monthly, weekly, daily and hourly repeat
  5212. cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
  5213. and a special warning period in a deadline entry, the repeater should come
  5214. first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
  5215. @vindex org-todo-repeat-to-state
  5216. Deadlines and scheduled items produce entries in the agenda when they are
  5217. over-due, so it is important to be able to mark such an entry as completed
  5218. once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
  5219. keyword DONE, it will no longer produce entries in the agenda. The problem
  5220. with this is, however, that then also the @emph{next} instance of the
  5221. repeated entry will not be active. Org mode deals with this in the following
  5222. way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
  5223. shift the base date of the repeating timestamp by the repeater interval, and
  5224. immediately set the entry state back to TODO@footnote{In fact, the target
  5225. state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
  5226. the variable @code{org-todo-repeat-to-state}. If neither of these is
  5227. specified, the target state defaults to the first state of the TODO state
  5228. sequence.}. In the example above, setting the state to DONE would actually
  5229. switch the date like this:
  5230. @example
  5231. ** TODO Pay the rent
  5232. DEADLINE: <2005-11-01 Tue +1m>
  5233. @end example
  5234. @vindex org-log-repeat
  5235. A timestamp@footnote{You can change this using the option
  5236. @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
  5237. @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
  5238. will also be prompted for a note.} will be added under the deadline, to keep
  5239. a record that you actually acted on the previous instance of this deadline.
  5240. As a consequence of shifting the base date, this entry will no longer be
  5241. visible in the agenda when checking past dates, but all future instances
  5242. will be visible.
  5243. With the @samp{+1m} cookie, the date shift will always be exactly one
  5244. month. So if you have not paid the rent for three months, marking this
  5245. entry DONE will still keep it as an overdue deadline. Depending on the
  5246. task, this may not be the best way to handle it. For example, if you
  5247. forgot to call your father for 3 weeks, it does not make sense to call
  5248. him 3 times in a single day to make up for it. Finally, there are tasks
  5249. like changing batteries which should always repeat a certain time
  5250. @i{after} the last time you did it. For these tasks, Org mode has
  5251. special repeaters @samp{++} and @samp{.+}. For example:
  5252. @example
  5253. ** TODO Call Father
  5254. DEADLINE: <2008-02-10 Sun ++1w>
  5255. Marking this DONE will shift the date by at least one week,
  5256. but also by as many weeks as it takes to get this date into
  5257. the future. However, it stays on a Sunday, even if you called
  5258. and marked it done on Saturday.
  5259. ** TODO Check the batteries in the smoke detectors
  5260. DEADLINE: <2005-11-01 Tue .+1m>
  5261. Marking this DONE will shift the date to one month after
  5262. today.
  5263. @end example
  5264. You may have both scheduling and deadline information for a specific
  5265. task---just make sure that the repeater intervals on both are the same.
  5266. An alternative to using a repeater is to create a number of copies of a task
  5267. subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
  5268. created for this purpose, it is described in @ref{Structure editing}.
  5269. @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
  5270. @section Clocking work time
  5271. @cindex clocking time
  5272. @cindex time clocking
  5273. Org mode allows you to clock the time you spend on specific tasks in a
  5274. project. When you start working on an item, you can start the clock. When
  5275. you stop working on that task, or when you mark the task done, the clock is
  5276. stopped and the corresponding time interval is recorded. It also computes
  5277. the total time spent on each subtree@footnote{Clocking only works if all
  5278. headings are indented with less than 30 stars. This is a hardcoded
  5279. limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
  5280. history or tasks recently clocked, to that you can jump quickly between a
  5281. number of tasks absorbing your time.
  5282. To save the clock history across Emacs sessions, use
  5283. @lisp
  5284. (setq org-clock-persist 'history)
  5285. (org-clock-persistence-insinuate)
  5286. @end lisp
  5287. When you clock into a new task after resuming Emacs, the incomplete
  5288. clock@footnote{To resume the clock under the assumption that you have worked
  5289. on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
  5290. will be found (@pxref{Resolving idle time}) and you will be prompted about
  5291. what to do with it.
  5292. @menu
  5293. * Clocking commands:: Starting and stopping a clock
  5294. * The clock table:: Detailed reports
  5295. * Resolving idle time:: Resolving time when you've been idle
  5296. @end menu
  5297. @node Clocking commands, The clock table, Clocking work time, Clocking work time
  5298. @subsection Clocking commands
  5299. @table @kbd
  5300. @orgcmd{C-c C-x C-i,org-clock-in}
  5301. @vindex org-clock-into-drawer
  5302. @vindex org-clock-continuously
  5303. @cindex property, LOG_INTO_DRAWER
  5304. Start the clock on the current item (clock-in). This inserts the CLOCK
  5305. keyword together with a timestamp. If this is not the first clocking of
  5306. this item, the multiple CLOCK lines will be wrapped into a
  5307. @code{:LOGBOOK:} drawer (see also the variable
  5308. @code{org-clock-into-drawer}). You can also overrule
  5309. the setting of this variable for a subtree by setting a
  5310. @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
  5311. When called with a @kbd{C-u} prefix argument,
  5312. select the task from a list of recently clocked tasks. With two @kbd{C-u
  5313. C-u} prefixes, clock into the task at point and mark it as the default task;
  5314. the default task will then always be available with letter @kbd{d} when
  5315. selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
  5316. continuous clocking by starting the clock when the last clock stopped.@*
  5317. @cindex property: CLOCK_MODELINE_TOTAL
  5318. @cindex property: LAST_REPEAT
  5319. @vindex org-clock-modeline-total
  5320. While the clock is running, the current clocking time is shown in the mode
  5321. line, along with the title of the task. The clock time shown will be all
  5322. time ever clocked for this task and its children. If the task has an effort
  5323. estimate (@pxref{Effort estimates}), the mode line displays the current
  5324. clocking time against it@footnote{To add an effort estimate ``on the fly'',
  5325. hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
  5326. is a repeating one (@pxref{Repeated tasks}), only the time since the last
  5327. reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
  5328. will be shown. More control over what time is shown can be exercised with
  5329. the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
  5330. @code{current} to show only the current clocking instance, @code{today} to
  5331. show all time clocked on this tasks today (see also the variable
  5332. @code{org-extend-today-until}), @code{all} to include all time, or
  5333. @code{auto} which is the default@footnote{See also the variable
  5334. @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
  5335. mode line entry will pop up a menu with clocking options.
  5336. @c
  5337. @orgcmd{C-c C-x C-o,org-clock-out}
  5338. @vindex org-log-note-clock-out
  5339. Stop the clock (clock-out). This inserts another timestamp at the same
  5340. location where the clock was last started. It also directly computes
  5341. the resulting time in inserts it after the time range as @samp{=>
  5342. HH:MM}. See the variable @code{org-log-note-clock-out} for the
  5343. possibility to record an additional note together with the clock-out
  5344. timestamp@footnote{The corresponding in-buffer setting is:
  5345. @code{#+STARTUP: lognoteclock-out}}.
  5346. @orgcmd{C-c C-x C-x,org-clock-in-last}
  5347. @vindex org-clock-continuously
  5348. Reclock the last clocked task. With one @kbd{C-u} prefix argument,
  5349. select the task from the clock history. With two @kbd{C-u} prefixes,
  5350. force continuous clocking by starting the clock when the last clock
  5351. stopped.
  5352. @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
  5353. Update the effort estimate for the current clock task.
  5354. @kindex C-c C-y
  5355. @kindex C-c C-c
  5356. @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
  5357. Recompute the time interval after changing one of the timestamps. This
  5358. is only necessary if you edit the timestamps directly. If you change
  5359. them with @kbd{S-@key{cursor}} keys, the update is automatic.
  5360. @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
  5361. On @code{CLOCK} log lines, increase/decrease both timestamps so that the
  5362. clock duration keeps the same.
  5363. @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
  5364. On @code{CLOCK} log lines, increase/decrease the timestamp at point and
  5365. the one of the previous (or the next clock) timestamp by the same duration.
  5366. For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
  5367. by five minutes, then the clocked-in timestamp of the next clock will be
  5368. increased by five minutes.
  5369. @orgcmd{C-c C-t,org-todo}
  5370. Changing the TODO state of an item to DONE automatically stops the clock
  5371. if it is running in this same item.
  5372. @orgcmd{C-c C-x C-q,org-clock-cancel}
  5373. Cancel the current clock. This is useful if a clock was started by
  5374. mistake, or if you ended up working on something else.
  5375. @orgcmd{C-c C-x C-j,org-clock-goto}
  5376. Jump to the headline of the currently clocked in task. With a @kbd{C-u}
  5377. prefix arg, select the target task from a list of recently clocked tasks.
  5378. @orgcmd{C-c C-x C-d,org-clock-display}
  5379. @vindex org-remove-highlights-with-change
  5380. Display time summaries for each subtree in the current buffer. This puts
  5381. overlays at the end of each headline, showing the total time recorded under
  5382. that heading, including the time of any subheadings. You can use visibility
  5383. cycling to study the tree, but the overlays disappear when you change the
  5384. buffer (see variable @code{org-remove-highlights-with-change}) or press
  5385. @kbd{C-c C-c}.
  5386. @end table
  5387. The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
  5388. the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
  5389. worked on or closed during a day.
  5390. @strong{Important:} note that both @code{org-clock-out} and
  5391. @code{org-clock-in-last} can have a global keybinding and will not
  5392. modify the window disposition.
  5393. @node The clock table, Resolving idle time, Clocking commands, Clocking work time
  5394. @subsection The clock table
  5395. @cindex clocktable, dynamic block
  5396. @cindex report, of clocked time
  5397. Org mode can produce quite complex reports based on the time clocking
  5398. information. Such a report is called a @emph{clock table}, because it is
  5399. formatted as one or several Org tables.
  5400. @table @kbd
  5401. @orgcmd{C-c C-x C-r,org-clock-report}
  5402. Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
  5403. report as an Org mode table into the current file. When the cursor is
  5404. at an existing clock table, just update it. When called with a prefix
  5405. argument, jump to the first clock report in the current document and
  5406. update it. The clock table always includes also trees with
  5407. @code{:ARCHIVE:} tag.
  5408. @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
  5409. Update dynamic block at point. The cursor needs to be in the
  5410. @code{#+BEGIN} line of the dynamic block.
  5411. @orgkey{C-u C-c C-x C-u}
  5412. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  5413. you have several clock table blocks in a buffer.
  5414. @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
  5415. Shift the current @code{:block} interval and update the table. The cursor
  5416. needs to be in the @code{#+BEGIN: clocktable} line for this command. If
  5417. @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
  5418. @end table
  5419. Here is an example of the frame for a clock table as it is inserted into the
  5420. buffer with the @kbd{C-c C-x C-r} command:
  5421. @cindex #+BEGIN, clocktable
  5422. @example
  5423. #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
  5424. #+END: clocktable
  5425. @end example
  5426. @noindent
  5427. @vindex org-clocktable-defaults
  5428. The @samp{BEGIN} line and specify a number of options to define the scope,
  5429. structure, and formatting of the report. Defaults for all these options can
  5430. be configured in the variable @code{org-clocktable-defaults}.
  5431. @noindent First there are options that determine which clock entries are to
  5432. be selected:
  5433. @example
  5434. :maxlevel @r{Maximum level depth to which times are listed in the table.}
  5435. @r{Clocks at deeper levels will be summed into the upper level.}
  5436. :scope @r{The scope to consider. This can be any of the following:}
  5437. nil @r{the current buffer or narrowed region}
  5438. file @r{the full current buffer}
  5439. subtree @r{the subtree where the clocktable is located}
  5440. tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
  5441. tree @r{the surrounding level 1 tree}
  5442. agenda @r{all agenda files}
  5443. ("file"..) @r{scan these files}
  5444. file-with-archives @r{current file and its archives}
  5445. agenda-with-archives @r{all agenda files, including archives}
  5446. :block @r{The time block to consider. This block is specified either}
  5447. @r{absolute, or relative to the current time and may be any of}
  5448. @r{these formats:}
  5449. 2007-12-31 @r{New year eve 2007}
  5450. 2007-12 @r{December 2007}
  5451. 2007-W50 @r{ISO-week 50 in 2007}
  5452. 2007-Q2 @r{2nd quarter in 2007}
  5453. 2007 @r{the year 2007}
  5454. today, yesterday, today-@var{N} @r{a relative day}
  5455. thisweek, lastweek, thisweek-@var{N} @r{a relative week}
  5456. thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
  5457. thisyear, lastyear, thisyear-@var{N} @r{a relative year}
  5458. @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
  5459. :tstart @r{A time string specifying when to start considering times.}
  5460. @r{Relative times like @code{"<-2w>"} can also be used. See}
  5461. @r{@ref{Matching tags and properties} for relative time syntax.}
  5462. :tend @r{A time string specifying when to stop considering times.}
  5463. @r{Relative times like @code{"<now>"} can also be used. See}
  5464. @r{@ref{Matching tags and properties} for relative time syntax.}
  5465. :wstart @r{The starting day of the week. The default is 1 for monday.}
  5466. :step @r{@code{week} or @code{day}, to split the table into chunks.}
  5467. @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
  5468. :stepskip0 @r{Do not show steps that have zero time.}
  5469. :fileskip0 @r{Do not show table sections from files which did not contribute.}
  5470. :tags @r{A tags match to select entries that should contribute. See}
  5471. @r{@ref{Matching tags and properties} for the match syntax.}
  5472. @end example
  5473. Then there are options which determine the formatting of the table. There
  5474. options are interpreted by the function @code{org-clocktable-write-default},
  5475. but you can specify your own function using the @code{:formatter} parameter.
  5476. @example
  5477. :emphasize @r{When @code{t}, emphasize level one and level two items.}
  5478. :lang @r{Language@footnote{Language terms can be set through the variable @code{org-clock-clocktable-language-setup}.} to use for descriptive cells like "Task".}
  5479. :link @r{Link the item headlines in the table to their origins.}
  5480. :narrow @r{An integer to limit the width of the headline column in}
  5481. @r{the org table. If you write it like @samp{50!}, then the}
  5482. @r{headline will also be shortened in export.}
  5483. :indent @r{Indent each headline field according to its level.}
  5484. :tcolumns @r{Number of columns to be used for times. If this is smaller}
  5485. @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
  5486. :level @r{Should a level number column be included?}
  5487. :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
  5488. @r{All are overwritten except if there is an explicit @code{:narrow}}
  5489. :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
  5490. @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
  5491. :properties @r{List of properties that should be shown in the table. Each}
  5492. @r{property will get its own column.}
  5493. :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
  5494. :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
  5495. @r{As a special case, @samp{:formula %} adds a column with % time.}
  5496. @r{If you do not specify a formula here, any existing formula}
  5497. @r{below the clock table will survive updates and be evaluated.}
  5498. :formatter @r{A function to format clock data and insert it into the buffer.}
  5499. @end example
  5500. To get a clock summary of the current level 1 tree, for the current
  5501. day, you could write
  5502. @example
  5503. #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
  5504. #+END: clocktable
  5505. @end example
  5506. @noindent
  5507. and to use a specific time range you could write@footnote{Note that all
  5508. parameters must be specified in a single line---the line is broken here
  5509. only to fit it into the manual.}
  5510. @example
  5511. #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
  5512. :tend "<2006-08-10 Thu 12:00>"
  5513. #+END: clocktable
  5514. @end example
  5515. A range starting a week ago and ending right now could be written as
  5516. @example
  5517. #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
  5518. #+END: clocktable
  5519. @end example
  5520. A summary of the current subtree with % times would be
  5521. @example
  5522. #+BEGIN: clocktable :scope subtree :link t :formula %
  5523. #+END: clocktable
  5524. @end example
  5525. A horizontally compact representation of everything clocked during last week
  5526. would be
  5527. @example
  5528. #+BEGIN: clocktable :scope agenda :block lastweek :compact t
  5529. #+END: clocktable
  5530. @end example
  5531. @node Resolving idle time, , The clock table, Clocking work time
  5532. @subsection Resolving idle time and continuous clocking
  5533. @subsubheading Resolving idle time
  5534. @cindex resolve idle time
  5535. @vindex org-clock-x11idle-program-name
  5536. @cindex idle, resolve, dangling
  5537. If you clock in on a work item, and then walk away from your
  5538. computer---perhaps to take a phone call---you often need to ``resolve'' the
  5539. time you were away by either subtracting it from the current clock, or
  5540. applying it to another one.
  5541. @vindex org-clock-idle-time
  5542. By customizing the variable @code{org-clock-idle-time} to some integer, such
  5543. as 10 or 15, Emacs can alert you when you get back to your computer after
  5544. being idle for that many minutes@footnote{On computers using Mac OS X,
  5545. idleness is based on actual user idleness, not just Emacs' idle time. For
  5546. X11, you can install a utility program @file{x11idle.c}, available in the
  5547. @code{contrib/scripts} directory of the Org git distribution, or install the
  5548. @file{xprintidle} package and set it to the variable
  5549. @code{org-clock-x11idle-program-name} if you are running Debian, to get the
  5550. same general treatment of idleness. On other systems, idle time refers to
  5551. Emacs idle time only.}, and ask what you want to do with the idle time.
  5552. There will be a question waiting for you when you get back, indicating how
  5553. much idle time has passed (constantly updated with the current amount), as
  5554. well as a set of choices to correct the discrepancy:
  5555. @table @kbd
  5556. @item k
  5557. To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
  5558. will ask how many of the minutes to keep. Press @key{RET} to keep them all,
  5559. effectively changing nothing, or enter a number to keep that many minutes.
  5560. @item K
  5561. If you use the shift key and press @kbd{K}, it will keep however many minutes
  5562. you request and then immediately clock out of that task. If you keep all of
  5563. the minutes, this is the same as just clocking out of the current task.
  5564. @item s
  5565. To keep none of the minutes, use @kbd{s} to subtract all the away time from
  5566. the clock, and then check back in from the moment you returned.
  5567. @item S
  5568. To keep none of the minutes and just clock out at the start of the away time,
  5569. use the shift key and press @kbd{S}. Remember that using shift will always
  5570. leave you clocked out, no matter which option you choose.
  5571. @item C
  5572. To cancel the clock altogether, use @kbd{C}. Note that if instead of
  5573. canceling you subtract the away time, and the resulting clock amount is less
  5574. than a minute, the clock will still be canceled rather than clutter up the
  5575. log with an empty entry.
  5576. @end table
  5577. What if you subtracted those away minutes from the current clock, and now
  5578. want to apply them to a new clock? Simply clock in to any task immediately
  5579. after the subtraction. Org will notice that you have subtracted time ``on
  5580. the books'', so to speak, and will ask if you want to apply those minutes to
  5581. the next task you clock in on.
  5582. There is one other instance when this clock resolution magic occurs. Say you
  5583. were clocked in and hacking away, and suddenly your cat chased a mouse who
  5584. scared a hamster that crashed into your UPS's power button! You suddenly
  5585. lose all your buffers, but thanks to auto-save you still have your recent Org
  5586. mode changes, including your last clock in.
  5587. If you restart Emacs and clock into any task, Org will notice that you have a
  5588. dangling clock which was never clocked out from your last session. Using
  5589. that clock's starting time as the beginning of the unaccounted-for period,
  5590. Org will ask how you want to resolve that time. The logic and behavior is
  5591. identical to dealing with away time due to idleness; it is just happening due
  5592. to a recovery event rather than a set amount of idle time.
  5593. You can also check all the files visited by your Org agenda for dangling
  5594. clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
  5595. @subsubheading Continuous clocking
  5596. @cindex continuous clocking
  5597. @vindex org-clock-continuously
  5598. You may want to start clocking from the time when you clocked out the
  5599. previous task. To enable this systematically, set @code{org-clock-continuously}
  5600. to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
  5601. last clocked entry for this session, and start the new clock from there.
  5602. If you only want this from time to time, use three universal prefix arguments
  5603. with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
  5604. @node Effort estimates, Relative timer, Clocking work time, Dates and Times
  5605. @section Effort estimates
  5606. @cindex effort estimates
  5607. @cindex property, Effort
  5608. @vindex org-effort-property
  5609. If you want to plan your work in a very detailed way, or if you need to
  5610. produce offers with quotations of the estimated work effort, you may want to
  5611. assign effort estimates to entries. If you are also clocking your work, you
  5612. may later want to compare the planned effort with the actual working time, a
  5613. great way to improve planning estimates. Effort estimates are stored in a
  5614. special property @samp{Effort}@footnote{You may change the property being
  5615. used with the variable @code{org-effort-property}.}. You can set the effort
  5616. for an entry with the following commands:
  5617. @table @kbd
  5618. @orgcmd{C-c C-x e,org-set-effort}
  5619. Set the effort estimate for the current entry. With a numeric prefix
  5620. argument, set it to the Nth allowed value (see below). This command is also
  5621. accessible from the agenda with the @kbd{e} key.
  5622. @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
  5623. Modify the effort estimate of the item currently being clocked.
  5624. @end table
  5625. Clearly the best way to work with effort estimates is through column view
  5626. (@pxref{Column view}). You should start by setting up discrete values for
  5627. effort estimates, and a @code{COLUMNS} format that displays these values
  5628. together with clock sums (if you want to clock your time). For a specific
  5629. buffer you can use
  5630. @example
  5631. #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
  5632. #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
  5633. @end example
  5634. @noindent
  5635. @vindex org-global-properties
  5636. @vindex org-columns-default-format
  5637. or, even better, you can set up these values globally by customizing the
  5638. variables @code{org-global-properties} and @code{org-columns-default-format}.
  5639. In particular if you want to use this setup also in the agenda, a global
  5640. setup may be advised.
  5641. The way to assign estimates to individual items is then to switch to column
  5642. mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
  5643. value. The values you enter will immediately be summed up in the hierarchy.
  5644. In the column next to it, any clocked time will be displayed.
  5645. @vindex org-agenda-columns-add-appointments-to-effort-sum
  5646. If you switch to column view in the daily/weekly agenda, the effort column
  5647. will summarize the estimated work effort for each day@footnote{Please note
  5648. the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
  5649. column view}).}, and you can use this to find space in your schedule. To get
  5650. an overview of the entire part of the day that is committed, you can set the
  5651. option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
  5652. appointments on a day that take place over a specified time interval will
  5653. then also be added to the load estimate of the day.
  5654. Effort estimates can be used in secondary agenda filtering that is triggered
  5655. with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
  5656. these estimates defined consistently, two or three key presses will narrow
  5657. down the list to stuff that fits into an available time slot.
  5658. @node Relative timer, Countdown timer, Effort estimates, Dates and Times
  5659. @section Taking notes with a relative timer
  5660. @cindex relative timer
  5661. When taking notes during, for example, a meeting or a video viewing, it can
  5662. be useful to have access to times relative to a starting time. Org provides
  5663. such a relative timer and make it easy to create timed notes.
  5664. @table @kbd
  5665. @orgcmd{C-c C-x .,org-timer}
  5666. Insert a relative time into the buffer. The first time you use this, the
  5667. timer will be started. When called with a prefix argument, the timer is
  5668. restarted.
  5669. @orgcmd{C-c C-x -,org-timer-item}
  5670. Insert a description list item with the current relative time. With a prefix
  5671. argument, first reset the timer to 0.
  5672. @orgcmd{M-@key{RET},org-insert-heading}
  5673. Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
  5674. new timer items.
  5675. @c for key sequences with a comma, command name macros fail :(
  5676. @kindex C-c C-x ,
  5677. @item C-c C-x ,
  5678. Pause the timer, or continue it if it is already paused
  5679. (@command{org-timer-pause-or-continue}).
  5680. @c removed the sentence because it is redundant to the following item
  5681. @kindex C-u C-c C-x ,
  5682. @item C-u C-c C-x ,
  5683. Stop the timer. After this, you can only start a new timer, not continue the
  5684. old one. This command also removes the timer from the mode line.
  5685. @orgcmd{C-c C-x 0,org-timer-start}
  5686. Reset the timer without inserting anything into the buffer. By default, the
  5687. timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
  5688. specific starting offset. The user is prompted for the offset, with a
  5689. default taken from a timer string at point, if any, So this can be used to
  5690. restart taking notes after a break in the process. When called with a double
  5691. prefix argument @kbd{C-u C-u}, change all timer strings in the active region
  5692. by a certain amount. This can be used to fix timer strings if the timer was
  5693. not started at exactly the right moment.
  5694. @end table
  5695. @node Countdown timer, , Relative timer, Dates and Times
  5696. @section Countdown timer
  5697. @cindex Countdown timer
  5698. @kindex C-c C-x ;
  5699. @kindex ;
  5700. Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
  5701. timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
  5702. @code{org-timer-set-timer} prompts the user for a duration and displays a
  5703. countdown timer in the modeline. @code{org-timer-default-timer} sets the
  5704. default countdown value. Giving a prefix numeric argument overrides this
  5705. default value.
  5706. @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
  5707. @chapter Capture - Refile - Archive
  5708. @cindex capture
  5709. An important part of any organization system is the ability to quickly
  5710. capture new ideas and tasks, and to associate reference material with them.
  5711. Org does this using a process called @i{capture}. It also can store files
  5712. related to a task (@i{attachments}) in a special directory. Once in the
  5713. system, tasks and projects need to be moved around. Moving completed project
  5714. trees to an archive file keeps the system compact and fast.
  5715. @menu
  5716. * Capture:: Capturing new stuff
  5717. * Attachments:: Add files to tasks
  5718. * RSS Feeds:: Getting input from RSS feeds
  5719. * Protocols:: External (e.g., Browser) access to Emacs and Org
  5720. * Refile and copy:: Moving/copying a tree from one place to another
  5721. * Archiving:: What to do with finished projects
  5722. @end menu
  5723. @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
  5724. @section Capture
  5725. @cindex capture
  5726. Org's method for capturing new items is heavily inspired by John Wiegley
  5727. excellent remember package. Up to version 6.36 Org used a special setup
  5728. for @file{remember.el}. @file{org-remember.el} is still part of Org mode for
  5729. backward compatibility with existing setups. You can find the documentation
  5730. for org-remember at @url{http://orgmode.org/org-remember.pdf}.
  5731. The new capturing setup described here is preferred and should be used by new
  5732. users. To convert your @code{org-remember-templates}, run the command
  5733. @example
  5734. @kbd{M-x org-capture-import-remember-templates @key{RET}}
  5735. @end example
  5736. @noindent and then customize the new variable with @kbd{M-x
  5737. customize-variable org-capture-templates}, check the result, and save the
  5738. customization. You can then use both remember and capture until
  5739. you are familiar with the new mechanism.
  5740. Capture lets you quickly store notes with little interruption of your work
  5741. flow. The basic process of capturing is very similar to remember, but Org
  5742. does enhance it with templates and more.
  5743. @menu
  5744. * Setting up capture:: Where notes will be stored
  5745. * Using capture:: Commands to invoke and terminate capture
  5746. * Capture templates:: Define the outline of different note types
  5747. @end menu
  5748. @node Setting up capture, Using capture, Capture, Capture
  5749. @subsection Setting up capture
  5750. The following customization sets a default target file for notes, and defines
  5751. a global key@footnote{Please select your own key, @kbd{C-c c} is only a
  5752. suggestion.} for capturing new material.
  5753. @vindex org-default-notes-file
  5754. @example
  5755. (setq org-default-notes-file (concat org-directory "/notes.org"))
  5756. (define-key global-map "\C-cc" 'org-capture)
  5757. @end example
  5758. @node Using capture, Capture templates, Setting up capture, Capture
  5759. @subsection Using capture
  5760. @table @kbd
  5761. @orgcmd{C-c c,org-capture}
  5762. Call the command @code{org-capture}. Note that this keybinding is global and
  5763. not active by default: you need to install it. If you have templates
  5764. @cindex date tree
  5765. defined @pxref{Capture templates}, it will offer these templates for
  5766. selection or use a new Org outline node as the default template. It will
  5767. insert the template into the target file and switch to an indirect buffer
  5768. narrowed to this new node. You may then insert the information you want.
  5769. @orgcmd{C-c C-c,org-capture-finalize}
  5770. Once you have finished entering information into the capture buffer, @kbd{C-c
  5771. C-c} will return you to the window configuration before the capture process,
  5772. so that you can resume your work without further distraction. When called
  5773. with a prefix arg, finalize and then jump to the captured item.
  5774. @orgcmd{C-c C-w,org-capture-refile}
  5775. Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
  5776. a different place. Please realize that this is a normal refiling command
  5777. that will be executed---so the cursor position at the moment you run this
  5778. command is important. If you have inserted a tree with a parent and
  5779. children, first move the cursor back to the parent. Any prefix argument
  5780. given to this command will be passed on to the @code{org-refile} command.
  5781. @orgcmd{C-c C-k,org-capture-kill}
  5782. Abort the capture process and return to the previous state.
  5783. @end table
  5784. You can also call @code{org-capture} in a special way from the agenda, using
  5785. the @kbd{k c} key combination. With this access, any timestamps inserted by
  5786. the selected capture template will default to the cursor date in the agenda,
  5787. rather than to the current date.
  5788. To find the locations of the last stored capture, use @code{org-capture} with
  5789. prefix commands:
  5790. @table @kbd
  5791. @orgkey{C-u C-c c}
  5792. Visit the target location of a capture template. You get to select the
  5793. template in the usual way.
  5794. @orgkey{C-u C-u C-c c}
  5795. Visit the last stored capture item in its buffer.
  5796. @end table
  5797. @vindex org-capture-bookmark
  5798. @cindex org-capture-last-stored
  5799. You can also jump to the bookmark @code{org-capture-last-stored}, which will
  5800. automatically be created unless you set @code{org-capture-bookmark} to
  5801. @code{nil}.
  5802. To insert the capture at point in an Org buffer, call @code{org-capture} with
  5803. a @code{C-0} prefix argument.
  5804. @node Capture templates, , Using capture, Capture
  5805. @subsection Capture templates
  5806. @cindex templates, for Capture
  5807. You can use templates for different types of capture items, and
  5808. for different target locations. The easiest way to create such templates is
  5809. through the customize interface.
  5810. @table @kbd
  5811. @orgkey{C-c c C}
  5812. Customize the variable @code{org-capture-templates}.
  5813. @end table
  5814. Before we give the formal description of template definitions, let's look at
  5815. an example. Say you would like to use one template to create general TODO
  5816. entries, and you want to put these entries under the heading @samp{Tasks} in
  5817. your file @file{~/org/gtd.org}. Also, a date tree in the file
  5818. @file{journal.org} should capture journal entries. A possible configuration
  5819. would look like:
  5820. @example
  5821. (setq org-capture-templates
  5822. '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
  5823. "* TODO %?\n %i\n %a")
  5824. ("j" "Journal" entry (file+datetree "~/org/journal.org")
  5825. "* %?\nEntered on %U\n %i\n %a")))
  5826. @end example
  5827. @noindent If you then press @kbd{C-c c t}, Org will prepare the template
  5828. for you like this:
  5829. @example
  5830. * TODO
  5831. [[file:@var{link to where you initiated capture}]]
  5832. @end example
  5833. @noindent
  5834. During expansion of the template, @code{%a} has been replaced by a link to
  5835. the location from where you called the capture command. This can be
  5836. extremely useful for deriving tasks from emails, for example. You fill in
  5837. the task definition, press @code{C-c C-c} and Org returns you to the same
  5838. place where you started the capture process.
  5839. To define special keys to capture to a particular template without going
  5840. through the interactive template selection, you can create your key binding
  5841. like this:
  5842. @lisp
  5843. (define-key global-map "\C-cx"
  5844. (lambda () (interactive) (org-capture nil "x")))
  5845. @end lisp
  5846. @menu
  5847. * Template elements:: What is needed for a complete template entry
  5848. * Template expansion:: Filling in information about time and context
  5849. * Templates in contexts:: Only show a template in a specific context
  5850. @end menu
  5851. @node Template elements, Template expansion, Capture templates, Capture templates
  5852. @subsubsection Template elements
  5853. Now lets look at the elements of a template definition. Each entry in
  5854. @code{org-capture-templates} is a list with the following items:
  5855. @table @var
  5856. @item keys
  5857. The keys that will select the template, as a string, characters
  5858. only, for example @code{"a"} for a template to be selected with a
  5859. single key, or @code{"bt"} for selection with two keys. When using
  5860. several keys, keys using the same prefix key must be sequential
  5861. in the list and preceded by a 2-element entry explaining the
  5862. prefix key, for example
  5863. @example
  5864. ("b" "Templates for marking stuff to buy")
  5865. @end example
  5866. @noindent If you do not define a template for the @kbd{C} key, this key will
  5867. be used to open the customize buffer for this complex variable.
  5868. @item description
  5869. A short string describing the template, which will be shown during
  5870. selection.
  5871. @item type
  5872. The type of entry, a symbol. Valid values are:
  5873. @table @code
  5874. @item entry
  5875. An Org mode node, with a headline. Will be filed as the child of the target
  5876. entry or as a top-level entry. The target file should be an Org mode file.
  5877. @item item
  5878. A plain list item, placed in the first plain list at the target
  5879. location. Again the target file should be an Org file.
  5880. @item checkitem
  5881. A checkbox item. This only differs from the plain list item by the
  5882. default template.
  5883. @item table-line
  5884. a new line in the first table at the target location. Where exactly the
  5885. line will be inserted depends on the properties @code{:prepend} and
  5886. @code{:table-line-pos} (see below).
  5887. @item plain
  5888. Text to be inserted as it is.
  5889. @end table
  5890. @item target
  5891. @vindex org-default-notes-file
  5892. Specification of where the captured item should be placed. In Org mode
  5893. files, targets usually define a node. Entries will become children of this
  5894. node. Other types will be added to the table or list in the body of this
  5895. node. Most target specifications contain a file name. If that file name is
  5896. the empty string, it defaults to @code{org-default-notes-file}. A file can
  5897. also be given as a variable, function, or Emacs Lisp form.
  5898. Valid values are:
  5899. @table @code
  5900. @item (file "path/to/file")
  5901. Text will be placed at the beginning or end of that file.
  5902. @item (id "id of existing org entry")
  5903. Filing as child of this entry, or in the body of the entry.
  5904. @item (file+headline "path/to/file" "node headline")
  5905. Fast configuration if the target heading is unique in the file.
  5906. @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
  5907. For non-unique headings, the full path is safer.
  5908. @item (file+regexp "path/to/file" "regexp to find location")
  5909. Use a regular expression to position the cursor.
  5910. @item (file+datetree "path/to/file")
  5911. Will create a heading in a date tree for today's date.
  5912. @item (file+datetree+prompt "path/to/file")
  5913. Will create a heading in a date tree, but will prompt for the date.
  5914. @item (file+function "path/to/file" function-finding-location)
  5915. A function to find the right location in the file.
  5916. @item (clock)
  5917. File to the entry that is currently being clocked.
  5918. @item (function function-finding-location)
  5919. Most general way, write your own function to find both
  5920. file and location.
  5921. @end table
  5922. @item template
  5923. The template for creating the capture item. If you leave this empty, an
  5924. appropriate default template will be used. Otherwise this is a string with
  5925. escape codes, which will be replaced depending on time and context of the
  5926. capture call. The string with escapes may be loaded from a template file,
  5927. using the special syntax @code{(file "path/to/template")}. See below for
  5928. more details.
  5929. @item properties
  5930. The rest of the entry is a property list of additional options.
  5931. Recognized properties are:
  5932. @table @code
  5933. @item :prepend
  5934. Normally new captured information will be appended at
  5935. the target location (last child, last table line, last list item...).
  5936. Setting this property will change that.
  5937. @item :immediate-finish
  5938. When set, do not offer to edit the information, just
  5939. file it away immediately. This makes sense if the template only needs
  5940. information that can be added automatically.
  5941. @item :empty-lines
  5942. Set this to the number of lines to insert
  5943. before and after the new item. Default 0, only common other value is 1.
  5944. @item :clock-in
  5945. Start the clock in this item.
  5946. @item :clock-keep
  5947. Keep the clock running when filing the captured entry.
  5948. @item :clock-resume
  5949. If starting the capture interrupted a clock, restart that clock when finished
  5950. with the capture. Note that @code{:clock-keep} has precedence over
  5951. @code{:clock-resume}. When setting both to @code{t}, the current clock will
  5952. run and the previous one will not be resumed.
  5953. @item :unnarrowed
  5954. Do not narrow the target buffer, simply show the full buffer. Default is to
  5955. narrow it so that you only see the new material.
  5956. @item :table-line-pos
  5957. Specification of the location in the table where the new line should be
  5958. inserted. It should be a string like @code{"II-3"} meaning that the new
  5959. line should become the third line before the second horizontal separator
  5960. line.
  5961. @item :kill-buffer
  5962. If the target file was not yet visited when capture was invoked, kill the
  5963. buffer again after capture is completed.
  5964. @end table
  5965. @end table
  5966. @node Template expansion, Templates in contexts, Template elements, Capture templates
  5967. @subsubsection Template expansion
  5968. In the template itself, special @kbd{%}-escapes@footnote{If you need one of
  5969. these sequences literally, escape the @kbd{%} with a backslash.} allow
  5970. dynamic insertion of content. The templates are expanded in the order given here:
  5971. @smallexample
  5972. %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
  5973. %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
  5974. @r{For convenience, %:keyword (see below) placeholders}
  5975. @r{within the expression will be expanded prior to this.}
  5976. @r{The sexp must return a string.}
  5977. %<...> @r{The result of format-time-string on the ... format specification.}
  5978. %t @r{Timestamp, date only.}
  5979. %T @r{Timestamp, with date and time.}
  5980. %u, %U @r{Like the above, but inactive timestamps.}
  5981. %i @r{Initial content, the region when capture is called while the}
  5982. @r{region is active.}
  5983. @r{The entire text will be indented like @code{%i} itself.}
  5984. %a @r{Annotation, normally the link created with @code{org-store-link}.}
  5985. %A @r{Like @code{%a}, but prompt for the description part.}
  5986. %l @r{Like %a, but only insert the literal link.}
  5987. %c @r{Current kill ring head.}
  5988. %x @r{Content of the X clipboard.}
  5989. %k @r{Title of the currently clocked task.}
  5990. %K @r{Link to the currently clocked task.}
  5991. %n @r{User name (taken from @code{user-full-name}).}
  5992. %f @r{File visited by current buffer when org-capture was called.}
  5993. %F @r{Full path of the file or directory visited by current buffer.}
  5994. %:keyword @r{Specific information for certain link types, see below.}
  5995. %^g @r{Prompt for tags, with completion on tags in target file.}
  5996. %^G @r{Prompt for tags, with completion all tags in all agenda files.}
  5997. %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
  5998. @r{You may define a prompt like @code{%^@{Birthday@}t}.}
  5999. %^C @r{Interactive selection of which kill or clip to use.}
  6000. %^L @r{Like @code{%^C}, but insert as link.}
  6001. %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
  6002. %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
  6003. @r{You may specify a default value and a completion table with}
  6004. @r{%^@{prompt|default|completion2|completion3...@}.}
  6005. @r{The arrow keys access a prompt-specific history.}
  6006. %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
  6007. @r{a number, starting from 1.}
  6008. %? @r{After completing the template, position cursor here.}
  6009. @end smallexample
  6010. @noindent
  6011. For specific link types, the following keywords will be
  6012. defined@footnote{If you define your own link types (@pxref{Adding
  6013. hyperlink types}), any property you store with
  6014. @code{org-store-link-props} can be accessed in capture templates in a
  6015. similar way.}:
  6016. @vindex org-from-is-user-regexp
  6017. @smallexample
  6018. Link type | Available keywords
  6019. ---------------------------------+----------------------------------------------
  6020. bbdb | %:name %:company
  6021. irc | %:server %:port %:nick
  6022. vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
  6023. | %:from %:fromname %:fromaddress
  6024. | %:to %:toname %:toaddress
  6025. | %:date @r{(message date header field)}
  6026. | %:date-timestamp @r{(date as active timestamp)}
  6027. | %:date-timestamp-inactive @r{(date as inactive timestamp)}
  6028. | %: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}.}}
  6029. gnus | %:group, @r{for messages also all email fields}
  6030. w3, w3m | %:url
  6031. info | %:file %:node
  6032. calendar | %:date
  6033. @end smallexample
  6034. @noindent
  6035. To place the cursor after template expansion use:
  6036. @smallexample
  6037. %? @r{After completing the template, position cursor here.}
  6038. @end smallexample
  6039. @node Templates in contexts, , Template expansion, Capture templates
  6040. @subsubsection Templates in contexts
  6041. @vindex org-capture-templates-contexts
  6042. To control whether a capture template should be accessible from a specific
  6043. context, you can customize @var{org-capture-templates-contexts}. Let's say
  6044. for example that you have a capture template @code{"p"} for storing Gnus
  6045. emails containing patches. Then you would configure this option like this:
  6046. @example
  6047. (setq org-capture-templates-contexts
  6048. '(("p" (in-mode . "message-mode"))))
  6049. @end example
  6050. You can also tell that the command key @code{"p"} should refer to another
  6051. template. In that case, add this command key like this:
  6052. @example
  6053. (setq org-capture-templates-contexts
  6054. '(("p" "q" (in-mode . "message-mode"))))
  6055. @end example
  6056. See the docstring of the variable for more information.
  6057. @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
  6058. @section Attachments
  6059. @cindex attachments
  6060. @vindex org-attach-directory
  6061. It is often useful to associate reference material with an outline node/task.
  6062. Small chunks of plain text can simply be stored in the subtree of a project.
  6063. Hyperlinks (@pxref{Hyperlinks}) can establish associations with
  6064. files that live elsewhere on your computer or in the cloud, like emails or
  6065. source code files belonging to a project. Another method is @i{attachments},
  6066. which are files located in a directory belonging to an outline node. Org
  6067. uses directories named by the unique ID of each entry. These directories are
  6068. located in the @file{data} directory which lives in the same directory where
  6069. your Org file lives@footnote{If you move entries or Org files from one
  6070. directory to another, you may want to configure @code{org-attach-directory}
  6071. to contain an absolute path.}. If you initialize this directory with
  6072. @code{git init}, Org will automatically commit changes when it sees them.
  6073. The attachment system has been contributed to Org by John Wiegley.
  6074. In cases where it seems better to do so, you can also attach a directory of your
  6075. choice to an entry. You can also make children inherit the attachment
  6076. directory from a parent, so that an entire subtree uses the same attached
  6077. directory.
  6078. @noindent The following commands deal with attachments:
  6079. @table @kbd
  6080. @orgcmd{C-c C-a,org-attach}
  6081. The dispatcher for commands related to the attachment system. After these
  6082. keys, a list of commands is displayed and you must press an additional key
  6083. to select a command:
  6084. @table @kbd
  6085. @orgcmdtkc{a,C-c C-a a,org-attach-attach}
  6086. @vindex org-attach-method
  6087. Select a file and move it into the task's attachment directory. The file
  6088. will be copied, moved, or linked, depending on @code{org-attach-method}.
  6089. Note that hard links are not supported on all systems.
  6090. @kindex C-c C-a c
  6091. @kindex C-c C-a m
  6092. @kindex C-c C-a l
  6093. @item c/m/l
  6094. Attach a file using the copy/move/link method.
  6095. Note that hard links are not supported on all systems.
  6096. @orgcmdtkc{n,C-c C-a n,org-attach-new}
  6097. Create a new attachment as an Emacs buffer.
  6098. @orgcmdtkc{z,C-c C-a z,org-attach-sync}
  6099. Synchronize the current task with its attachment directory, in case you added
  6100. attachments yourself.
  6101. @orgcmdtkc{o,C-c C-a o,org-attach-open}
  6102. @vindex org-file-apps
  6103. Open current task's attachment. If there is more than one, prompt for a
  6104. file name first. Opening will follow the rules set by @code{org-file-apps}.
  6105. For more details, see the information on following hyperlinks
  6106. (@pxref{Handling links}).
  6107. @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
  6108. Also open the attachment, but force opening the file in Emacs.
  6109. @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
  6110. Open the current task's attachment directory.
  6111. @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
  6112. Also open the directory, but force using @command{dired} in Emacs.
  6113. @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
  6114. Select and delete a single attachment.
  6115. @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
  6116. Delete all of a task's attachments. A safer way is to open the directory in
  6117. @command{dired} and delete from there.
  6118. @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
  6119. @cindex property, ATTACH_DIR
  6120. Set a specific directory as the entry's attachment directory. This works by
  6121. putting the directory path into the @code{ATTACH_DIR} property.
  6122. @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
  6123. @cindex property, ATTACH_DIR_INHERIT
  6124. Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
  6125. same directory for attachments as the parent does.
  6126. @end table
  6127. @end table
  6128. @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
  6129. @section RSS feeds
  6130. @cindex RSS feeds
  6131. @cindex Atom feeds
  6132. Org can add and change entries based on information found in RSS feeds and
  6133. Atom feeds. You could use this to make a task out of each new podcast in a
  6134. podcast feed. Or you could use a phone-based note-creating service on the
  6135. web to import tasks into Org. To access feeds, configure the variable
  6136. @code{org-feed-alist}. The docstring of this variable has detailed
  6137. information. Here is just an example:
  6138. @example
  6139. (setq org-feed-alist
  6140. '(("Slashdot"
  6141. "http://rss.slashdot.org/Slashdot/slashdot"
  6142. "~/txt/org/feeds.org" "Slashdot Entries")))
  6143. @end example
  6144. @noindent
  6145. will configure that new items from the feed provided by
  6146. @code{rss.slashdot.org} will result in new entries in the file
  6147. @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
  6148. the following command is used:
  6149. @table @kbd
  6150. @orgcmd{C-c C-x g,org-feed-update-all}
  6151. @item C-c C-x g
  6152. Collect items from the feeds configured in @code{org-feed-alist} and act upon
  6153. them.
  6154. @orgcmd{C-c C-x G,org-feed-goto-inbox}
  6155. Prompt for a feed name and go to the inbox configured for this feed.
  6156. @end table
  6157. Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
  6158. it will store information about the status of items in the feed, to avoid
  6159. adding the same item several times. You should add @samp{FEEDSTATUS} to the
  6160. list of drawers in that file:
  6161. @example
  6162. #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
  6163. @end example
  6164. For more information, including how to read atom feeds, see
  6165. @file{org-feed.el} and the docstring of @code{org-feed-alist}.
  6166. @node Protocols, Refile and copy, RSS Feeds, Capture - Refile - Archive
  6167. @section Protocols for external access
  6168. @cindex protocols, for external access
  6169. @cindex emacsserver
  6170. You can set up Org for handling protocol calls from outside applications that
  6171. are passed to Emacs through the @file{emacsserver}. For example, you can
  6172. configure bookmarks in your web browser to send a link to the current page to
  6173. Org and create a note from it using capture (@pxref{Capture}). Or you
  6174. could create a bookmark that will tell Emacs to open the local source file of
  6175. a remote website you are looking at with the browser. See
  6176. @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
  6177. documentation and setup instructions.
  6178. @node Refile and copy, Archiving, Protocols, Capture - Refile - Archive
  6179. @section Refile and copy
  6180. @cindex refiling notes
  6181. @cindex copying notes
  6182. When reviewing the captured data, you may want to refile or to copy some of
  6183. the entries into a different list, for example into a project. Cutting,
  6184. finding the right location, and then pasting the note is cumbersome. To
  6185. simplify this process, you can use the following special command:
  6186. @table @kbd
  6187. @orgcmd{C-c M-w,org-copy}
  6188. @findex org-copy
  6189. Copying works like refiling, except that the original note is not deleted.
  6190. @orgcmd{C-c C-w,org-refile}
  6191. @findex org-refile
  6192. @vindex org-reverse-note-order
  6193. @vindex org-refile-targets
  6194. @vindex org-refile-use-outline-path
  6195. @vindex org-outline-path-complete-in-steps
  6196. @vindex org-refile-allow-creating-parent-nodes
  6197. @vindex org-log-refile
  6198. @vindex org-refile-use-cache
  6199. Refile the entry or region at point. This command offers possible locations
  6200. for refiling the entry and lets you select one with completion. The item (or
  6201. all items in the region) is filed below the target heading as a subitem.
  6202. Depending on @code{org-reverse-note-order}, it will be either the first or
  6203. last subitem.@*
  6204. By default, all level 1 headlines in the current buffer are considered to be
  6205. targets, but you can have more complex definitions across a number of files.
  6206. See the variable @code{org-refile-targets} for details. If you would like to
  6207. select a location via a file-path-like completion along the outline path, see
  6208. the variables @code{org-refile-use-outline-path} and
  6209. @code{org-outline-path-complete-in-steps}. If you would like to be able to
  6210. create new nodes as new parents for refiling on the fly, check the
  6211. variable @code{org-refile-allow-creating-parent-nodes}.
  6212. When the variable @code{org-log-refile}@footnote{with corresponding
  6213. @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
  6214. and @code{nologrefile}} is set, a timestamp or a note will be
  6215. recorded when an entry has been refiled.
  6216. @orgkey{C-u C-c C-w}
  6217. Use the refile interface to jump to a heading.
  6218. @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
  6219. Jump to the location where @code{org-refile} last moved a tree to.
  6220. @item C-2 C-c C-w
  6221. Refile as the child of the item currently being clocked.
  6222. @orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C-w,org-refile-cache-clear}
  6223. Clear the target cache. Caching of refile targets can be turned on by
  6224. setting @code{org-refile-use-cache}. To make the command see new possible
  6225. targets, you have to clear the cache with this command.
  6226. @end table
  6227. @node Archiving, , Refile and copy, Capture - Refile - Archive
  6228. @section Archiving
  6229. @cindex archiving
  6230. When a project represented by a (sub)tree is finished, you may want
  6231. to move the tree out of the way and to stop it from contributing to the
  6232. agenda. Archiving is important to keep your working files compact and global
  6233. searches like the construction of agenda views fast.
  6234. @table @kbd
  6235. @orgcmd{C-c C-x C-a,org-archive-subtree-default}
  6236. @vindex org-archive-default-command
  6237. Archive the current entry using the command specified in the variable
  6238. @code{org-archive-default-command}.
  6239. @end table
  6240. @menu
  6241. * Moving subtrees:: Moving a tree to an archive file
  6242. * Internal archiving:: Switch off a tree but keep it in the file
  6243. @end menu
  6244. @node Moving subtrees, Internal archiving, Archiving, Archiving
  6245. @subsection Moving a tree to the archive file
  6246. @cindex external archiving
  6247. The most common archiving action is to move a project tree to another file,
  6248. the archive file.
  6249. @table @kbd
  6250. @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
  6251. @vindex org-archive-location
  6252. Archive the subtree starting at the cursor position to the location
  6253. given by @code{org-archive-location}.
  6254. @orgkey{C-u C-c C-x C-s}
  6255. Check if any direct children of the current headline could be moved to
  6256. the archive. To do this, each subtree is checked for open TODO entries.
  6257. If none are found, the command offers to move it to the archive
  6258. location. If the cursor is @emph{not} on a headline when this command
  6259. is invoked, the level 1 trees will be checked.
  6260. @end table
  6261. @cindex archive locations
  6262. The default archive location is a file in the same directory as the
  6263. current file, with the name derived by appending @file{_archive} to the
  6264. current file name. You can also choose what heading to file archived
  6265. items under, with the possibility to add them to a datetree in a file.
  6266. For information and examples on how to specify the file and the heading,
  6267. see the documentation string of the variable
  6268. @code{org-archive-location}.
  6269. There is also an in-buffer option for setting this variable, for
  6270. example@footnote{For backward compatibility, the following also works:
  6271. If there are several such lines in a file, each specifies the archive
  6272. location for the text below it. The first such line also applies to any
  6273. text before its definition. However, using this method is
  6274. @emph{strongly} deprecated as it is incompatible with the outline
  6275. structure of the document. The correct method for setting multiple
  6276. archive locations in a buffer is using properties.}:
  6277. @cindex #+ARCHIVE
  6278. @example
  6279. #+ARCHIVE: %s_done::
  6280. @end example
  6281. @cindex property, ARCHIVE
  6282. @noindent
  6283. If you would like to have a special ARCHIVE location for a single entry
  6284. or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
  6285. location as the value (@pxref{Properties and Columns}).
  6286. @vindex org-archive-save-context-info
  6287. When a subtree is moved, it receives a number of special properties that
  6288. record context information like the file from where the entry came, its
  6289. outline path the archiving time etc. Configure the variable
  6290. @code{org-archive-save-context-info} to adjust the amount of information
  6291. added.
  6292. @node Internal archiving, , Moving subtrees, Archiving
  6293. @subsection Internal archiving
  6294. If you want to just switch off (for agenda views) certain subtrees without
  6295. moving them to a different file, you can use the @code{ARCHIVE tag}.
  6296. A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
  6297. its location in the outline tree, but behaves in the following way:
  6298. @itemize @minus
  6299. @item
  6300. @vindex org-cycle-open-archived-trees
  6301. It does not open when you attempt to do so with a visibility cycling
  6302. command (@pxref{Visibility cycling}). You can force cycling archived
  6303. subtrees with @kbd{C-@key{TAB}}, or by setting the option
  6304. @code{org-cycle-open-archived-trees}. Also normal outline commands like
  6305. @code{show-all} will open archived subtrees.
  6306. @item
  6307. @vindex org-sparse-tree-open-archived-trees
  6308. During sparse tree construction (@pxref{Sparse trees}), matches in
  6309. archived subtrees are not exposed, unless you configure the option
  6310. @code{org-sparse-tree-open-archived-trees}.
  6311. @item
  6312. @vindex org-agenda-skip-archived-trees
  6313. During agenda view construction (@pxref{Agenda Views}), the content of
  6314. archived trees is ignored unless you configure the option
  6315. @code{org-agenda-skip-archived-trees}, in which case these trees will always
  6316. be included. In the agenda you can press @kbd{v a} to get archives
  6317. temporarily included.
  6318. @item
  6319. @vindex org-export-with-archived-trees
  6320. Archived trees are not exported (@pxref{Exporting}), only the headline
  6321. is. Configure the details using the variable
  6322. @code{org-export-with-archived-trees}.
  6323. @item
  6324. @vindex org-columns-skip-archived-trees
  6325. Archived trees are excluded from column view unless the variable
  6326. @code{org-columns-skip-archived-trees} is configured to @code{nil}.
  6327. @end itemize
  6328. The following commands help manage the ARCHIVE tag:
  6329. @table @kbd
  6330. @orgcmd{C-c C-x a,org-toggle-archive-tag}
  6331. Toggle the ARCHIVE tag for the current headline. When the tag is set,
  6332. the headline changes to a shadowed face, and the subtree below it is
  6333. hidden.
  6334. @orgkey{C-u C-c C-x a}
  6335. Check if any direct children of the current headline should be archived.
  6336. To do this, each subtree is checked for open TODO entries. If none are
  6337. found, the command offers to set the ARCHIVE tag for the child. If the
  6338. cursor is @emph{not} on a headline when this command is invoked, the
  6339. level 1 trees will be checked.
  6340. @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
  6341. Cycle a tree even if it is tagged with ARCHIVE.
  6342. @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
  6343. Move the current entry to the @emph{Archive Sibling}. This is a sibling of
  6344. the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
  6345. entry becomes a child of that sibling and in this way retains a lot of its
  6346. original context, including inherited tags and approximate position in the
  6347. outline.
  6348. @end table
  6349. @node Agenda Views, Markup, Capture - Refile - Archive, Top
  6350. @chapter Agenda views
  6351. @cindex agenda views
  6352. Due to the way Org works, TODO items, time-stamped items, and
  6353. tagged headlines can be scattered throughout a file or even a number of
  6354. files. To get an overview of open action items, or of events that are
  6355. important for a particular date, this information must be collected,
  6356. sorted and displayed in an organized way.
  6357. Org can select items based on various criteria and display them
  6358. in a separate buffer. Seven different view types are provided:
  6359. @itemize @bullet
  6360. @item
  6361. an @emph{agenda} that is like a calendar and shows information
  6362. for specific dates,
  6363. @item
  6364. a @emph{TODO list} that covers all unfinished
  6365. action items,
  6366. @item
  6367. a @emph{match view}, showings headlines based on the tags, properties, and
  6368. TODO state associated with them,
  6369. @item
  6370. a @emph{timeline view} that shows all events in a single Org file,
  6371. in time-sorted view,
  6372. @item
  6373. a @emph{text search view} that shows all entries from multiple files
  6374. that contain specified keywords,
  6375. @item
  6376. a @emph{stuck projects view} showing projects that currently don't move
  6377. along, and
  6378. @item
  6379. @emph{custom views} that are special searches and combinations of different
  6380. views.
  6381. @end itemize
  6382. @noindent
  6383. The extracted information is displayed in a special @emph{agenda
  6384. buffer}. This buffer is read-only, but provides commands to visit the
  6385. corresponding locations in the original Org files, and even to
  6386. edit these files remotely.
  6387. @vindex org-agenda-window-setup
  6388. @vindex org-agenda-restore-windows-after-quit
  6389. Two variables control how the agenda buffer is displayed and whether the
  6390. window configuration is restored when the agenda exits:
  6391. @code{org-agenda-window-setup} and
  6392. @code{org-agenda-restore-windows-after-quit}.
  6393. @menu
  6394. * Agenda files:: Files being searched for agenda information
  6395. * Agenda dispatcher:: Keyboard access to agenda views
  6396. * Built-in agenda views:: What is available out of the box?
  6397. * Presentation and sorting:: How agenda items are prepared for display
  6398. * Agenda commands:: Remote editing of Org trees
  6399. * Custom agenda views:: Defining special searches and views
  6400. * Exporting Agenda Views:: Writing a view to a file
  6401. * Agenda column view:: Using column view for collected entries
  6402. @end menu
  6403. @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
  6404. @section Agenda files
  6405. @cindex agenda files
  6406. @cindex files for agenda
  6407. @vindex org-agenda-files
  6408. The information to be shown is normally collected from all @emph{agenda
  6409. files}, the files listed in the variable
  6410. @code{org-agenda-files}@footnote{If the value of that variable is not a
  6411. list, but a single file name, then the list of agenda files will be
  6412. maintained in that external file.}. If a directory is part of this list,
  6413. all files with the extension @file{.org} in this directory will be part
  6414. of the list.
  6415. Thus, even if you only work with a single Org file, that file should
  6416. be put into the list@footnote{When using the dispatcher, pressing
  6417. @kbd{<} before selecting a command will actually limit the command to
  6418. the current file, and ignore @code{org-agenda-files} until the next
  6419. dispatcher command.}. You can customize @code{org-agenda-files}, but
  6420. the easiest way to maintain it is through the following commands
  6421. @cindex files, adding to agenda list
  6422. @table @kbd
  6423. @orgcmd{C-c [,org-agenda-file-to-front}
  6424. Add current file to the list of agenda files. The file is added to
  6425. the front of the list. If it was already in the list, it is moved to
  6426. the front. With a prefix argument, file is added/moved to the end.
  6427. @orgcmd{C-c ],org-remove-file}
  6428. Remove current file from the list of agenda files.
  6429. @kindex C-,
  6430. @cindex cycling, of agenda files
  6431. @orgcmd{C-',org-cycle-agenda-files}
  6432. @itemx C-,
  6433. Cycle through agenda file list, visiting one file after the other.
  6434. @kindex M-x org-iswitchb
  6435. @item M-x org-iswitchb
  6436. Command to use an @code{iswitchb}-like interface to switch to and between Org
  6437. buffers.
  6438. @end table
  6439. @noindent
  6440. The Org menu contains the current list of files and can be used
  6441. to visit any of them.
  6442. If you would like to focus the agenda temporarily on a file not in
  6443. this list, or on just one file in the list, or even on only a subtree in a
  6444. file, then this can be done in different ways. For a single agenda command,
  6445. you may press @kbd{<} once or several times in the dispatcher
  6446. (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
  6447. extended period, use the following commands:
  6448. @table @kbd
  6449. @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
  6450. Permanently restrict the agenda to the current subtree. When with a
  6451. prefix argument, or with the cursor before the first headline in a file,
  6452. the agenda scope is set to the entire file. This restriction remains in
  6453. effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
  6454. or @kbd{>} in the agenda dispatcher. If there is a window displaying an
  6455. agenda view, the new restriction takes effect immediately.
  6456. @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
  6457. Remove the permanent restriction created by @kbd{C-c C-x <}.
  6458. @end table
  6459. @noindent
  6460. When working with @file{speedbar.el}, you can use the following commands in
  6461. the Speedbar frame:
  6462. @table @kbd
  6463. @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
  6464. Permanently restrict the agenda to the item---either an Org file or a subtree
  6465. in such a file---at the cursor in the Speedbar frame.
  6466. If there is a window displaying an agenda view, the new restriction takes
  6467. effect immediately.
  6468. @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
  6469. Lift the restriction.
  6470. @end table
  6471. @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
  6472. @section The agenda dispatcher
  6473. @cindex agenda dispatcher
  6474. @cindex dispatching agenda commands
  6475. The views are created through a dispatcher, which should be bound to a
  6476. global key---for example @kbd{C-c a} (@pxref{Activation}). In the
  6477. following we will assume that @kbd{C-c a} is indeed how the dispatcher
  6478. is accessed and list keyboard access to commands accordingly. After
  6479. pressing @kbd{C-c a}, an additional letter is required to execute a
  6480. command. The dispatcher offers the following default commands:
  6481. @table @kbd
  6482. @item a
  6483. Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
  6484. @item t @r{/} T
  6485. Create a list of all TODO items (@pxref{Global TODO list}).
  6486. @item m @r{/} M
  6487. Create a list of headlines matching a TAGS expression (@pxref{Matching
  6488. tags and properties}).
  6489. @item L
  6490. Create the timeline view for the current buffer (@pxref{Timeline}).
  6491. @item s
  6492. Create a list of entries selected by a boolean expression of keywords
  6493. and/or regular expressions that must or must not occur in the entry.
  6494. @item /
  6495. @vindex org-agenda-text-search-extra-files
  6496. Search for a regular expression in all agenda files and additionally in
  6497. the files listed in @code{org-agenda-text-search-extra-files}. This
  6498. uses the Emacs command @code{multi-occur}. A prefix argument can be
  6499. used to specify the number of context lines for each match, default is
  6500. 1.
  6501. @item # @r{/} !
  6502. Create a list of stuck projects (@pxref{Stuck projects}).
  6503. @item <
  6504. Restrict an agenda command to the current buffer@footnote{For backward
  6505. compatibility, you can also press @kbd{1} to restrict to the current
  6506. buffer.}. After pressing @kbd{<}, you still need to press the character
  6507. selecting the command.
  6508. @item < <
  6509. If there is an active region, restrict the following agenda command to
  6510. the region. Otherwise, restrict it to the current subtree@footnote{For
  6511. backward compatibility, you can also press @kbd{0} to restrict to the
  6512. current region/subtree.}. After pressing @kbd{< <}, you still need to press the
  6513. character selecting the command.
  6514. @item *
  6515. @vindex org-agenda-sticky
  6516. Toggle sticky agenda views. By default, Org maintains only a single agenda
  6517. buffer and rebuilds it each time you change the view, to make sure everything
  6518. is always up to date. If you switch between views often and the build time
  6519. bothers you, you can turn on sticky agenda buffers (make this the default by
  6520. customizing the variable @code{org-agenda-sticky}). With sticky agendas, the
  6521. dispatcher only switches to the selected view, you need to update it by hand
  6522. with @kbd{r} or @kbd{g}. You can toggle sticky agenda view any time with
  6523. @code{org-toggle-sticky-agenda}.
  6524. @end table
  6525. You can also define custom commands that will be accessible through the
  6526. dispatcher, just like the default commands. This includes the
  6527. possibility to create extended agenda buffers that contain several
  6528. blocks together, for example the weekly agenda, the global TODO list and
  6529. a number of special tags matches. @xref{Custom agenda views}.
  6530. @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
  6531. @section The built-in agenda views
  6532. In this section we describe the built-in views.
  6533. @menu
  6534. * Weekly/daily agenda:: The calendar page with current tasks
  6535. * Global TODO list:: All unfinished action items
  6536. * Matching tags and properties:: Structured information with fine-tuned search
  6537. * Timeline:: Time-sorted view for single file
  6538. * Search view:: Find entries by searching for text
  6539. * Stuck projects:: Find projects you need to review
  6540. @end menu
  6541. @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
  6542. @subsection The weekly/daily agenda
  6543. @cindex agenda
  6544. @cindex weekly agenda
  6545. @cindex daily agenda
  6546. The purpose of the weekly/daily @emph{agenda} is to act like a page of a
  6547. paper agenda, showing all the tasks for the current week or day.
  6548. @table @kbd
  6549. @cindex org-agenda, command
  6550. @orgcmd{C-c a a,org-agenda-list}
  6551. Compile an agenda for the current week from a list of Org files. The agenda
  6552. shows the entries for each day. With a numeric prefix@footnote{For backward
  6553. compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
  6554. listed before the agenda. This feature is deprecated, use the dedicated TODO
  6555. list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
  6556. C-c a a}) you may set the number of days to be displayed.
  6557. @end table
  6558. @vindex org-agenda-span
  6559. @vindex org-agenda-ndays
  6560. The default number of days displayed in the agenda is set by the variable
  6561. @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
  6562. variable can be set to any number of days you want to see by default in the
  6563. agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
  6564. @code{year}.
  6565. Remote editing from the agenda buffer means, for example, that you can
  6566. change the dates of deadlines and appointments from the agenda buffer.
  6567. The commands available in the Agenda buffer are listed in @ref{Agenda
  6568. commands}.
  6569. @subsubheading Calendar/Diary integration
  6570. @cindex calendar integration
  6571. @cindex diary integration
  6572. Emacs contains the calendar and diary by Edward M. Reingold. The
  6573. calendar displays a three-month calendar with holidays from different
  6574. countries and cultures. The diary allows you to keep track of
  6575. anniversaries, lunar phases, sunrise/set, recurrent appointments
  6576. (weekly, monthly) and more. In this way, it is quite complementary to
  6577. Org. It can be very useful to combine output from Org with
  6578. the diary.
  6579. In order to include entries from the Emacs diary into Org mode's
  6580. agenda, you only need to customize the variable
  6581. @lisp
  6582. (setq org-agenda-include-diary t)
  6583. @end lisp
  6584. @noindent After that, everything will happen automatically. All diary
  6585. entries including holidays, anniversaries, etc., will be included in the
  6586. agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
  6587. @key{RET} can be used from the agenda buffer to jump to the diary
  6588. file in order to edit existing diary entries. The @kbd{i} command to
  6589. insert new entries for the current date works in the agenda buffer, as
  6590. well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
  6591. Sunrise/Sunset times, show lunar phases and to convert to other
  6592. calendars, respectively. @kbd{c} can be used to switch back and forth
  6593. between calendar and agenda.
  6594. If you are using the diary only for sexp entries and holidays, it is
  6595. faster to not use the above setting, but instead to copy or even move
  6596. the entries into an Org file. Org mode evaluates diary-style sexp
  6597. entries, and does it faster because there is no overhead for first
  6598. creating the diary display. Note that the sexp entries must start at
  6599. the left margin, no whitespace is allowed before them. For example,
  6600. the following segment of an Org file will be processed and entries
  6601. will be made in the agenda:
  6602. @example
  6603. * Birthdays and similar stuff
  6604. #+CATEGORY: Holiday
  6605. %%(org-calendar-holiday) ; special function for holiday names
  6606. #+CATEGORY: Ann
  6607. %%(org-anniversary 1956 5 14)@footnote{@code{org-anniversary} is just like @code{diary-anniversary}, but the argument order is always according to ISO and therefore independent of the value of @code{calendar-date-style}.} Arthur Dent is %d years old
  6608. %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
  6609. @end example
  6610. @subsubheading Anniversaries from BBDB
  6611. @cindex BBDB, anniversaries
  6612. @cindex anniversaries, from BBDB
  6613. If you are using the Big Brothers Database to store your contacts, you will
  6614. very likely prefer to store anniversaries in BBDB rather than in a
  6615. separate Org or diary file. Org supports this and will show BBDB
  6616. anniversaries as part of the agenda. All you need to do is to add the
  6617. following to one of your agenda files:
  6618. @example
  6619. * Anniversaries
  6620. :PROPERTIES:
  6621. :CATEGORY: Anniv
  6622. :END:
  6623. %%(org-bbdb-anniversaries)
  6624. @end example
  6625. You can then go ahead and define anniversaries for a BBDB record. Basically,
  6626. you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
  6627. record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
  6628. followed by a space and the class of the anniversary (@samp{birthday} or
  6629. @samp{wedding}, or a format string). If you omit the class, it will default to
  6630. @samp{birthday}. Here are a few examples, the header for the file
  6631. @file{org-bbdb.el} contains more detailed information.
  6632. @example
  6633. 1973-06-22
  6634. 06-22
  6635. 1955-08-02 wedding
  6636. 2008-04-14 %s released version 6.01 of org mode, %d years ago
  6637. @end example
  6638. After a change to BBDB, or for the first agenda display during an Emacs
  6639. session, the agenda display will suffer a short delay as Org updates its
  6640. hash with anniversaries. However, from then on things will be very fast---much
  6641. faster in fact than a long list of @samp{%%(diary-anniversary)} entries
  6642. in an Org or Diary file.
  6643. @subsubheading Appointment reminders
  6644. @cindex @file{appt.el}
  6645. @cindex appointment reminders
  6646. @cindex appointment
  6647. @cindex reminders
  6648. Org can interact with Emacs appointments notification facility. To add the
  6649. appointments of your agenda files, use the command @code{org-agenda-to-appt}.
  6650. This command lets you filter through the list of your appointments and add
  6651. only those belonging to a specific category or matching a regular expression.
  6652. It also reads a @code{APPT_WARNTIME} property which will then override the
  6653. value of @code{appt-message-warning-time} for this appointment. See the
  6654. docstring for details.
  6655. @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
  6656. @subsection The global TODO list
  6657. @cindex global TODO list
  6658. @cindex TODO list, global
  6659. The global TODO list contains all unfinished TODO items formatted and
  6660. collected into a single place.
  6661. @table @kbd
  6662. @orgcmd{C-c a t,org-todo-list}
  6663. Show the global TODO list. This collects the TODO items from all agenda
  6664. files (@pxref{Agenda Views}) into a single buffer. By default, this lists
  6665. items with a state the is not a DONE state. The buffer is in
  6666. @code{agenda-mode}, so there are commands to examine and manipulate the TODO
  6667. entries directly from that buffer (@pxref{Agenda commands}).
  6668. @orgcmd{C-c a T,org-todo-list}
  6669. @cindex TODO keyword matching
  6670. @vindex org-todo-keywords
  6671. Like the above, but allows selection of a specific TODO keyword. You can
  6672. also do this by specifying a prefix argument to @kbd{C-c a t}. You are
  6673. prompted for a keyword, and you may also specify several keywords by
  6674. separating them with @samp{|} as the boolean OR operator. With a numeric
  6675. prefix, the Nth keyword in @code{org-todo-keywords} is selected.
  6676. @kindex r
  6677. The @kbd{r} key in the agenda buffer regenerates it, and you can give
  6678. a prefix argument to this command to change the selected TODO keyword,
  6679. for example @kbd{3 r}. If you often need a search for a specific
  6680. keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
  6681. Matching specific TODO keywords can also be done as part of a tags
  6682. search (@pxref{Tag searches}).
  6683. @end table
  6684. Remote editing of TODO items means that you can change the state of a
  6685. TODO entry with a single key press. The commands available in the
  6686. TODO list are described in @ref{Agenda commands}.
  6687. @cindex sublevels, inclusion into TODO list
  6688. Normally the global TODO list simply shows all headlines with TODO
  6689. keywords. This list can become very long. There are two ways to keep
  6690. it more compact:
  6691. @itemize @minus
  6692. @item
  6693. @vindex org-agenda-todo-ignore-scheduled
  6694. @vindex org-agenda-todo-ignore-deadlines
  6695. @vindex org-agenda-todo-ignore-timestamp
  6696. @vindex org-agenda-todo-ignore-with-date
  6697. Some people view a TODO item that has been @emph{scheduled} for execution or
  6698. have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
  6699. Configure the variables @code{org-agenda-todo-ignore-scheduled},
  6700. @code{org-agenda-todo-ignore-deadlines},
  6701. @code{org-agenda-todo-ignore-timestamp} and/or
  6702. @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
  6703. TODO list.
  6704. @item
  6705. @vindex org-agenda-todo-list-sublevels
  6706. TODO items may have sublevels to break up the task into subtasks. In
  6707. such cases it may be enough to list only the highest level TODO headline
  6708. and omit the sublevels from the global list. Configure the variable
  6709. @code{org-agenda-todo-list-sublevels} to get this behavior.
  6710. @end itemize
  6711. @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
  6712. @subsection Matching tags and properties
  6713. @cindex matching, of tags
  6714. @cindex matching, of properties
  6715. @cindex tags view
  6716. @cindex match view
  6717. If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
  6718. or have properties (@pxref{Properties and Columns}), you can select headlines
  6719. based on this metadata and collect them into an agenda buffer. The match
  6720. syntax described here also applies when creating sparse trees with @kbd{C-c /
  6721. m}.
  6722. @table @kbd
  6723. @orgcmd{C-c a m,org-tags-view}
  6724. Produce a list of all headlines that match a given set of tags. The
  6725. command prompts for a selection criterion, which is a boolean logic
  6726. expression with tags, like @samp{+work+urgent-withboss} or
  6727. @samp{work|home} (@pxref{Tags}). If you often need a specific search,
  6728. define a custom command for it (@pxref{Agenda dispatcher}).
  6729. @orgcmd{C-c a M,org-tags-view}
  6730. @vindex org-tags-match-list-sublevels
  6731. @vindex org-agenda-tags-todo-honor-ignore-options
  6732. Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
  6733. not-DONE state and force checking subitems (see variable
  6734. @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
  6735. see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
  6736. specific TODO keywords together with a tags match is also possible, see
  6737. @ref{Tag searches}.
  6738. @end table
  6739. The commands available in the tags list are described in @ref{Agenda
  6740. commands}.
  6741. @subsubheading Match syntax
  6742. @cindex Boolean logic, for tag/property searches
  6743. A search string can use Boolean operators @samp{&} for AND and @samp{|} for
  6744. OR@. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
  6745. not implemented. Each element in the search is either a tag, a regular
  6746. expression matching tags, or an expression like @code{PROPERTY OPERATOR
  6747. VALUE} with a comparison operator, accessing a property value. Each element
  6748. may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
  6749. sugar for positive selection. The AND operator @samp{&} is optional when
  6750. @samp{+} or @samp{-} is present. Here are some examples, using only tags.
  6751. @table @samp
  6752. @item +work-boss
  6753. Select headlines tagged @samp{:work:}, but discard those also tagged
  6754. @samp{:boss:}.
  6755. @item work|laptop
  6756. Selects lines tagged @samp{:work:} or @samp{:laptop:}.
  6757. @item work|laptop+night
  6758. Like before, but require the @samp{:laptop:} lines to be tagged also
  6759. @samp{:night:}.
  6760. @end table
  6761. @cindex regular expressions, with tags search
  6762. Instead of a tag, you may also specify a regular expression enclosed in curly
  6763. braces. For example,
  6764. @samp{work+@{^boss.*@}} matches headlines that contain the tag
  6765. @samp{:work:} and any tag @i{starting} with @samp{boss}.
  6766. @cindex TODO keyword matching, with tags search
  6767. @cindex level, require for tags/property match
  6768. @cindex category, require for tags/property match
  6769. @vindex org-odd-levels-only
  6770. You may also test for properties (@pxref{Properties and Columns}) at the same
  6771. time as matching tags. The properties may be real properties, or special
  6772. properties that represent other metadata (@pxref{Special properties}). For
  6773. example, the ``property'' @code{TODO} represents the TODO keyword of the
  6774. entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
  6775. So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
  6776. that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
  6777. DONE@. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
  6778. count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
  6779. The ITEM special property cannot currently be used in tags/property
  6780. searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
  6781. ,skipping entries based on regexp}.}.
  6782. Here are more examples:
  6783. @table @samp
  6784. @item work+TODO="WAITING"
  6785. Select @samp{:work:}-tagged TODO lines with the specific TODO
  6786. keyword @samp{WAITING}.
  6787. @item work+TODO="WAITING"|home+TODO="WAITING"
  6788. Waiting tasks both at work and at home.
  6789. @end table
  6790. When matching properties, a number of different operators can be used to test
  6791. the value of a property. Here is a complex example:
  6792. @example
  6793. +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
  6794. +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
  6795. @end example
  6796. @noindent
  6797. The type of comparison will depend on how the comparison value is written:
  6798. @itemize @minus
  6799. @item
  6800. If the comparison value is a plain number, a numerical comparison is done,
  6801. and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
  6802. @samp{>=}, and @samp{<>}.
  6803. @item
  6804. If the comparison value is enclosed in double-quotes,
  6805. a string comparison is done, and the same operators are allowed.
  6806. @item
  6807. If the comparison value is enclosed in double-quotes @emph{and} angular
  6808. brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
  6809. assumed to be date/time specifications in the standard Org way, and the
  6810. comparison will be done accordingly. Special values that will be recognized
  6811. are @code{"<now>"} for now (including time), and @code{"<today>"}, and
  6812. @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
  6813. specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
  6814. @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
  6815. respectively, can be used.
  6816. @item
  6817. If the comparison value is enclosed
  6818. in curly braces, a regexp match is performed, with @samp{=} meaning that the
  6819. regexp matches the property value, and @samp{<>} meaning that it does not
  6820. match.
  6821. @end itemize
  6822. So the search string in the example finds entries tagged @samp{:work:} but
  6823. not @samp{:boss:}, which also have a priority value @samp{A}, a
  6824. @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
  6825. property that is numerically smaller than 2, a @samp{:With:} property that is
  6826. matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
  6827. on or after October 11, 2008.
  6828. Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
  6829. other properties will slow down the search. However, once you have paid the
  6830. price by accessing one property, testing additional properties is cheap
  6831. again.
  6832. You can configure Org mode to use property inheritance during a search, but
  6833. beware that this can slow down searches considerably. See @ref{Property
  6834. inheritance}, for details.
  6835. For backward compatibility, and also for typing speed, there is also a
  6836. different way to test TODO states in a search. For this, terminate the
  6837. tags/property part of the search string (which may include several terms
  6838. connected with @samp{|}) with a @samp{/} and then specify a Boolean
  6839. expression just for TODO keywords. The syntax is then similar to that for
  6840. tags, but should be applied with care: for example, a positive selection on
  6841. several TODO keywords cannot meaningfully be combined with boolean AND@.
  6842. However, @emph{negative selection} combined with AND can be meaningful. To
  6843. make sure that only lines are checked that actually have any TODO keyword
  6844. (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
  6845. part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
  6846. not match TODO keywords in a DONE state. Examples:
  6847. @table @samp
  6848. @item work/WAITING
  6849. Same as @samp{work+TODO="WAITING"}
  6850. @item work/!-WAITING-NEXT
  6851. Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
  6852. nor @samp{NEXT}
  6853. @item work/!+WAITING|+NEXT
  6854. Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
  6855. @samp{NEXT}.
  6856. @end table
  6857. @node Timeline, Search view, Matching tags and properties, Built-in agenda views
  6858. @subsection Timeline for a single file
  6859. @cindex timeline, single file
  6860. @cindex time-sorted view
  6861. The timeline summarizes all time-stamped items from a single Org mode
  6862. file in a @emph{time-sorted view}. The main purpose of this command is
  6863. to give an overview over events in a project.
  6864. @table @kbd
  6865. @orgcmd{C-c a L,org-timeline}
  6866. Show a time-sorted view of the Org file, with all time-stamped items.
  6867. When called with a @kbd{C-u} prefix, all unfinished TODO entries
  6868. (scheduled or not) are also listed under the current date.
  6869. @end table
  6870. @noindent
  6871. The commands available in the timeline buffer are listed in
  6872. @ref{Agenda commands}.
  6873. @node Search view, Stuck projects, Timeline, Built-in agenda views
  6874. @subsection Search view
  6875. @cindex search view
  6876. @cindex text search
  6877. @cindex searching, for text
  6878. This agenda view is a general text search facility for Org mode entries.
  6879. It is particularly useful to find notes.
  6880. @table @kbd
  6881. @orgcmd{C-c a s,org-search-view}
  6882. This is a special search that lets you select entries by matching a substring
  6883. or specific words using a boolean logic.
  6884. @end table
  6885. For example, the search string @samp{computer equipment} will find entries
  6886. that contain @samp{computer equipment} as a substring. If the two words are
  6887. separated by more space or a line break, the search will still match.
  6888. Search view can also search for specific keywords in the entry, using Boolean
  6889. logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
  6890. will search for note entries that contain the keywords @code{computer}
  6891. and @code{wifi}, but not the keyword @code{ethernet}, and which are also
  6892. not matched by the regular expression @code{8\.11[bg]}, meaning to
  6893. exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
  6894. word search, other @samp{+} characters are optional. For more details, see
  6895. the docstring of the command @code{org-search-view}.
  6896. @vindex org-agenda-text-search-extra-files
  6897. Note that in addition to the agenda files, this command will also search
  6898. the files listed in @code{org-agenda-text-search-extra-files}.
  6899. @node Stuck projects, , Search view, Built-in agenda views
  6900. @subsection Stuck projects
  6901. @pindex GTD, Getting Things Done
  6902. If you are following a system like David Allen's GTD to organize your
  6903. work, one of the ``duties'' you have is a regular review to make sure
  6904. that all projects move along. A @emph{stuck} project is a project that
  6905. has no defined next actions, so it will never show up in the TODO lists
  6906. Org mode produces. During the review, you need to identify such
  6907. projects and define next actions for them.
  6908. @table @kbd
  6909. @orgcmd{C-c a #,org-agenda-list-stuck-projects}
  6910. List projects that are stuck.
  6911. @kindex C-c a !
  6912. @item C-c a !
  6913. @vindex org-stuck-projects
  6914. Customize the variable @code{org-stuck-projects} to define what a stuck
  6915. project is and how to find it.
  6916. @end table
  6917. You almost certainly will have to configure this view before it will
  6918. work for you. The built-in default assumes that all your projects are
  6919. level-2 headlines, and that a project is not stuck if it has at least
  6920. one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
  6921. Let's assume that you, in your own way of using Org mode, identify
  6922. projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
  6923. indicate a project that should not be considered yet. Let's further
  6924. assume that the TODO keyword DONE marks finished projects, and that NEXT
  6925. and TODO indicate next actions. The tag @@SHOP indicates shopping and
  6926. is a next action even without the NEXT tag. Finally, if the project
  6927. contains the special word IGNORE anywhere, it should not be listed
  6928. either. In this case you would start by identifying eligible projects
  6929. with a tags/todo match@footnote{@xref{Tag searches}.}
  6930. @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
  6931. IGNORE in the subtree to identify projects that are not stuck. The
  6932. correct customization for this is
  6933. @lisp
  6934. (setq org-stuck-projects
  6935. '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
  6936. "\\<IGNORE\\>"))
  6937. @end lisp
  6938. Note that if a project is identified as non-stuck, the subtree of this entry
  6939. will still be searched for stuck projects.
  6940. @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
  6941. @section Presentation and sorting
  6942. @cindex presentation, of agenda items
  6943. @vindex org-agenda-prefix-format
  6944. @vindex org-agenda-tags-column
  6945. Before displaying items in an agenda view, Org mode visually prepares the
  6946. items and sorts them. Each item occupies a single line. The line starts
  6947. with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
  6948. of the item and other important information. You can customize in which
  6949. column tags will be displayed through @code{org-agenda-tags-column}. You can
  6950. also customize the prefix using the option @code{org-agenda-prefix-format}.
  6951. This prefix is followed by a cleaned-up version of the outline headline
  6952. associated with the item.
  6953. @menu
  6954. * Categories:: Not all tasks are equal
  6955. * Time-of-day specifications:: How the agenda knows the time
  6956. * Sorting of agenda items:: The order of things
  6957. @end menu
  6958. @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
  6959. @subsection Categories
  6960. @cindex category
  6961. @cindex #+CATEGORY
  6962. The category is a broad label assigned to each agenda item. By default,
  6963. the category is simply derived from the file name, but you can also
  6964. specify it with a special line in the buffer, like this@footnote{For
  6965. backward compatibility, the following also works: if there are several
  6966. such lines in a file, each specifies the category for the text below it.
  6967. The first category also applies to any text before the first CATEGORY
  6968. line. However, using this method is @emph{strongly} deprecated as it is
  6969. incompatible with the outline structure of the document. The correct
  6970. method for setting multiple categories in a buffer is using a
  6971. property.}:
  6972. @example
  6973. #+CATEGORY: Thesis
  6974. @end example
  6975. @noindent
  6976. @cindex property, CATEGORY
  6977. If you would like to have a special CATEGORY for a single entry or a
  6978. (sub)tree, give the entry a @code{:CATEGORY:} property with the
  6979. special category you want to apply as the value.
  6980. @noindent
  6981. The display in the agenda buffer looks best if the category is not
  6982. longer than 10 characters.
  6983. @noindent
  6984. You can set up icons for category by customizing the
  6985. @code{org-agenda-category-icon-alist} variable.
  6986. @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
  6987. @subsection Time-of-day specifications
  6988. @cindex time-of-day specification
  6989. Org mode checks each agenda item for a time-of-day specification. The
  6990. time can be part of the timestamp that triggered inclusion into the
  6991. agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
  6992. ranges can be specified with two timestamps, like
  6993. @c
  6994. @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
  6995. In the headline of the entry itself, a time(range) may also appear as
  6996. plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
  6997. integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
  6998. specifications in diary entries are recognized as well.
  6999. For agenda display, Org mode extracts the time and displays it in a
  7000. standard 24 hour format as part of the prefix. The example times in
  7001. the previous paragraphs would end up in the agenda like this:
  7002. @example
  7003. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  7004. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  7005. 19:00...... The Vogon reads his poem
  7006. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  7007. @end example
  7008. @cindex time grid
  7009. If the agenda is in single-day mode, or for the display of today, the
  7010. timed entries are embedded in a time grid, like
  7011. @example
  7012. 8:00...... ------------------
  7013. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  7014. 10:00...... ------------------
  7015. 12:00...... ------------------
  7016. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  7017. 14:00...... ------------------
  7018. 16:00...... ------------------
  7019. 18:00...... ------------------
  7020. 19:00...... The Vogon reads his poem
  7021. 20:00...... ------------------
  7022. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  7023. @end example
  7024. @vindex org-agenda-use-time-grid
  7025. @vindex org-agenda-time-grid
  7026. The time grid can be turned on and off with the variable
  7027. @code{org-agenda-use-time-grid}, and can be configured with
  7028. @code{org-agenda-time-grid}.
  7029. @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
  7030. @subsection Sorting of agenda items
  7031. @cindex sorting, of agenda items
  7032. @cindex priorities, of agenda items
  7033. Before being inserted into a view, the items are sorted. How this is
  7034. done depends on the type of view.
  7035. @itemize @bullet
  7036. @item
  7037. @vindex org-agenda-files
  7038. For the daily/weekly agenda, the items for each day are sorted. The
  7039. default order is to first collect all items containing an explicit
  7040. time-of-day specification. These entries will be shown at the beginning
  7041. of the list, as a @emph{schedule} for the day. After that, items remain
  7042. grouped in categories, in the sequence given by @code{org-agenda-files}.
  7043. Within each category, items are sorted by priority (@pxref{Priorities}),
  7044. which is composed of the base priority (2000 for priority @samp{A}, 1000
  7045. for @samp{B}, and 0 for @samp{C}), plus additional increments for
  7046. overdue scheduled or deadline items.
  7047. @item
  7048. For the TODO list, items remain in the order of categories, but within
  7049. each category, sorting takes place according to priority
  7050. (@pxref{Priorities}). The priority used for sorting derives from the
  7051. priority cookie, with additions depending on how close an item is to its due
  7052. or scheduled date.
  7053. @item
  7054. For tags matches, items are not sorted at all, but just appear in the
  7055. sequence in which they are found in the agenda files.
  7056. @end itemize
  7057. @vindex org-agenda-sorting-strategy
  7058. Sorting can be customized using the variable
  7059. @code{org-agenda-sorting-strategy}, and may also include criteria based on
  7060. the estimated effort of an entry (@pxref{Effort estimates}).
  7061. @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
  7062. @section Commands in the agenda buffer
  7063. @cindex commands, in agenda buffer
  7064. Entries in the agenda buffer are linked back to the Org file or diary
  7065. file where they originate. You are not allowed to edit the agenda
  7066. buffer itself, but commands are provided to show and jump to the
  7067. original entry location, and to edit the Org files ``remotely'' from
  7068. the agenda buffer. In this way, all information is stored only once,
  7069. removing the risk that your agenda and note files may diverge.
  7070. Some commands can be executed with mouse clicks on agenda lines. For
  7071. the other commands, the cursor needs to be in the desired line.
  7072. @table @kbd
  7073. @tsubheading{Motion}
  7074. @cindex motion commands in agenda
  7075. @orgcmd{n,org-agenda-next-line}
  7076. Next line (same as @key{down} and @kbd{C-n}).
  7077. @orgcmd{p,org-agenda-previous-line}
  7078. Previous line (same as @key{up} and @kbd{C-p}).
  7079. @tsubheading{View/Go to Org file}
  7080. @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
  7081. Display the original location of the item in another window.
  7082. With prefix arg, make sure that the entire entry is made visible in the
  7083. outline, not only the heading.
  7084. @c
  7085. @orgcmd{L,org-agenda-recenter}
  7086. Display original location and recenter that window.
  7087. @c
  7088. @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
  7089. Go to the original location of the item in another window.
  7090. @c
  7091. @orgcmd{@key{RET},org-agenda-switch-to}
  7092. Go to the original location of the item and delete other windows.
  7093. @c
  7094. @orgcmd{F,org-agenda-follow-mode}
  7095. @vindex org-agenda-start-with-follow-mode
  7096. Toggle Follow mode. In Follow mode, as you move the cursor through
  7097. the agenda buffer, the other window always shows the corresponding
  7098. location in the Org file. The initial setting for this mode in new
  7099. agenda buffers can be set with the variable
  7100. @code{org-agenda-start-with-follow-mode}.
  7101. @c
  7102. @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
  7103. Display the entire subtree of the current item in an indirect buffer. With a
  7104. numeric prefix argument N, go up to level N and then take that tree. If N is
  7105. negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
  7106. previously used indirect buffer.
  7107. @orgcmd{C-c C-o,org-agenda-open-link}
  7108. Follow a link in the entry. This will offer a selection of any links in the
  7109. text belonging to the referenced Org node. If there is only one link, it
  7110. will be followed without a selection prompt.
  7111. @tsubheading{Change display}
  7112. @cindex display changing, in agenda
  7113. @kindex A
  7114. @item A
  7115. Interactively select another agenda view and append it to the current view.
  7116. @c
  7117. @kindex o
  7118. @item o
  7119. Delete other windows.
  7120. @c
  7121. @orgcmdkskc{v d,d,org-agenda-day-view}
  7122. @xorgcmdkskc{v w,w,org-agenda-week-view}
  7123. @xorgcmd{v m,org-agenda-month-view}
  7124. @xorgcmd{v y,org-agenda-year-view}
  7125. @xorgcmd{v SPC,org-agenda-reset-view}
  7126. @vindex org-agenda-span
  7127. Switch to day/week/month/year view. When switching to day or week view, this
  7128. setting becomes the default for subsequent agenda refreshes. Since month and
  7129. year views are slow to create, they do not become the default. A numeric
  7130. prefix argument may be used to jump directly to a specific day of the year,
  7131. ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
  7132. February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
  7133. month view, a year may be encoded in the prefix argument as well. For
  7134. example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
  7135. specification has only one or two digits, it will be mapped to the interval
  7136. 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
  7137. @code{org-agenda-span}.
  7138. @c
  7139. @orgcmd{f,org-agenda-later}
  7140. Go forward in time to display the following @code{org-agenda-current-span} days.
  7141. For example, if the display covers a week, switch to the following week.
  7142. With prefix arg, go forward that many times @code{org-agenda-current-span} days.
  7143. @c
  7144. @orgcmd{b,org-agenda-earlier}
  7145. Go backward in time to display earlier dates.
  7146. @c
  7147. @orgcmd{.,org-agenda-goto-today}
  7148. Go to today.
  7149. @c
  7150. @orgcmd{j,org-agenda-goto-date}
  7151. Prompt for a date and go there.
  7152. @c
  7153. @orgcmd{J,org-agenda-clock-goto}
  7154. Go to the currently clocked-in task @i{in the agenda buffer}.
  7155. @c
  7156. @orgcmd{D,org-agenda-toggle-diary}
  7157. Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
  7158. @c
  7159. @orgcmdkskc{v l,l,org-agenda-log-mode}
  7160. @kindex v L
  7161. @vindex org-log-done
  7162. @vindex org-agenda-log-mode-items
  7163. Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
  7164. logging was on (variable @code{org-log-done}) are shown in the agenda, as are
  7165. entries that have been clocked on that day. You can configure the entry
  7166. types that should be included in log mode using the variable
  7167. @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
  7168. all possible logbook entries, including state changes. When called with two
  7169. prefix args @kbd{C-u C-u}, show only logging information, nothing else.
  7170. @kbd{v L} is equivalent to @kbd{C-u v l}.
  7171. @c
  7172. @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
  7173. Include inactive timestamps into the current view. Only for weekly/daily
  7174. agenda and timeline views.
  7175. @c
  7176. @orgcmd{v a,org-agenda-archives-mode}
  7177. @xorgcmd{v A,org-agenda-archives-mode 'files}
  7178. Toggle Archives mode. In Archives mode, trees that are marked
  7179. @code{ARCHIVED} are also scanned when producing the agenda. When you use the
  7180. capital @kbd{A}, even all archive files are included. To exit archives mode,
  7181. press @kbd{v a} again.
  7182. @c
  7183. @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
  7184. @vindex org-agenda-start-with-clockreport-mode
  7185. @vindex org-clock-report-include-clocking-task
  7186. Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
  7187. always show a table with the clocked times for the timespan and file scope
  7188. covered by the current agenda view. The initial setting for this mode in new
  7189. agenda buffers can be set with the variable
  7190. @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
  7191. when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
  7192. contributions from entries that are hidden by agenda filtering@footnote{Only
  7193. tags filtering will be respected here, effort filtering is ignored.}. See
  7194. also the variable @code{org-clock-report-include-clocking-task}.
  7195. @c
  7196. @orgkey{v c}
  7197. @vindex org-agenda-clock-consistency-checks
  7198. Show overlapping clock entries, clocking gaps, and other clocking problems in
  7199. the current agenda range. You can then visit clocking lines and fix them
  7200. manually. See the variable @code{org-agenda-clock-consistency-checks} for
  7201. information on how to customize the definition of what constituted a clocking
  7202. problem. To return to normal agenda display, press @kbd{l} to exit Logbook
  7203. mode.
  7204. @c
  7205. @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
  7206. @vindex org-agenda-start-with-entry-text-mode
  7207. @vindex org-agenda-entry-text-maxlines
  7208. Toggle entry text mode. In entry text mode, a number of lines from the Org
  7209. outline node referenced by an agenda line will be displayed below the line.
  7210. The maximum number of lines is given by the variable
  7211. @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
  7212. prefix argument will temporarily modify that number to the prefix value.
  7213. @c
  7214. @orgcmd{G,org-agenda-toggle-time-grid}
  7215. @vindex org-agenda-use-time-grid
  7216. @vindex org-agenda-time-grid
  7217. Toggle the time grid on and off. See also the variables
  7218. @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
  7219. @c
  7220. @orgcmd{r,org-agenda-redo}
  7221. Recreate the agenda buffer, for example to reflect the changes after
  7222. modification of the timestamps of items with @kbd{S-@key{left}} and
  7223. @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
  7224. argument is interpreted to create a selective list for a specific TODO
  7225. keyword.
  7226. @orgcmd{g,org-agenda-redo}
  7227. Same as @kbd{r}.
  7228. @c
  7229. @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
  7230. Save all Org buffers in the current Emacs session, and also the locations of
  7231. IDs.
  7232. @c
  7233. @orgcmd{C-c C-x C-c,org-agenda-columns}
  7234. @vindex org-columns-default-format
  7235. Invoke column view (@pxref{Column view}) in the agenda buffer. The column
  7236. view format is taken from the entry at point, or (if there is no entry at
  7237. point), from the first entry in the agenda view. So whatever the format for
  7238. that entry would be in the original buffer (taken from a property, from a
  7239. @code{#+COLUMNS} line, or from the default variable
  7240. @code{org-columns-default-format}), will be used in the agenda.
  7241. @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
  7242. Remove the restriction lock on the agenda, if it is currently restricted to a
  7243. file or subtree (@pxref{Agenda files}).
  7244. @tsubheading{Secondary filtering and query editing}
  7245. @cindex filtering, by tag category and effort, in agenda
  7246. @cindex tag filtering, in agenda
  7247. @cindex category filtering, in agenda
  7248. @cindex effort filtering, in agenda
  7249. @cindex query editing, in agenda
  7250. @orgcmd{<,org-agenda-filter-by-category}
  7251. @vindex org-agenda-category-filter-preset
  7252. Filter the current agenda view with respect to the category of the item at
  7253. point. Pressing @code{<} another time will remove this filter. You can add
  7254. a filter preset through the option @code{org-agenda-category-filter-preset}
  7255. (see below.)
  7256. @orgcmd{/,org-agenda-filter-by-tag}
  7257. @vindex org-agenda-tag-filter-preset
  7258. Filter the current agenda view with respect to a tag and/or effort estimates.
  7259. The difference between this and a custom agenda command is that filtering is
  7260. very fast, so that you can switch quickly between different filters without
  7261. having to recreate the agenda.@footnote{Custom commands can preset a filter by
  7262. binding the variable @code{org-agenda-tag-filter-preset} as an option. This
  7263. filter will then be applied to the view and persist as a basic filter through
  7264. refreshes and more secondary filtering. The filter is a global property of
  7265. the entire agenda view---in a block agenda, you should only set this in the
  7266. global options section, not in the section of an individual block.}
  7267. You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
  7268. all. Pressing @key{TAB} at that prompt will offer use completion to select a
  7269. tag (including any tags that do not have a selection character). The command
  7270. then hides all entries that do not contain or inherit this tag. When called
  7271. with prefix arg, remove the entries that @emph{do} have the tag. A second
  7272. @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
  7273. If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
  7274. will be narrowed by requiring or forbidding the selected additional tag.
  7275. Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
  7276. immediately use the @kbd{\} command.
  7277. @vindex org-sort-agenda-noeffort-is-high
  7278. In order to filter for effort estimates, you should set up allowed
  7279. efforts globally, for example
  7280. @lisp
  7281. (setq org-global-properties
  7282. '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
  7283. @end lisp
  7284. You can then filter for an effort by first typing an operator, one of
  7285. @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
  7286. estimate in your array of allowed values, where @kbd{0} means the 10th value.
  7287. The filter will then restrict to entries with effort smaller-or-equal, equal,
  7288. or larger-or-equal than the selected value. If the digits 0--9 are not used
  7289. as fast access keys to tags, you can also simply press the index digit
  7290. directly without an operator. In this case, @kbd{<} will be assumed. For
  7291. application of the operator, entries without a defined effort will be treated
  7292. according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
  7293. for tasks without effort definition, press @kbd{?} as the operator.
  7294. Org also supports automatic, context-aware tag filtering. If the variable
  7295. @code{org-agenda-auto-exclude-function} is set to a user-defined function,
  7296. that function can decide which tags should be excluded from the agenda
  7297. automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
  7298. as a sub-option key and runs the auto exclusion logic. For example, let's
  7299. say you use a @code{Net} tag to identify tasks which need network access, an
  7300. @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
  7301. calls. You could auto-exclude these tags based on the availability of the
  7302. Internet, and outside of business hours, with something like this:
  7303. @lisp
  7304. @group
  7305. (defun org-my-auto-exclude-function (tag)
  7306. (and (cond
  7307. ((string= tag "Net")
  7308. (/= 0 (call-process "/sbin/ping" nil nil nil
  7309. "-c1" "-q" "-t1" "mail.gnu.org")))
  7310. ((or (string= tag "Errand") (string= tag "Call"))
  7311. (let ((hour (nth 2 (decode-time))))
  7312. (or (< hour 8) (> hour 21)))))
  7313. (concat "-" tag)))
  7314. (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
  7315. @end group
  7316. @end lisp
  7317. @orgcmd{\\,org-agenda-filter-by-tag-refine}
  7318. Narrow the current agenda filter by an additional condition. When called with
  7319. prefix arg, remove the entries that @emph{do} have the tag, or that do match
  7320. the effort criterion. You can achieve the same effect by pressing @kbd{+} or
  7321. @kbd{-} as the first key after the @kbd{/} command.
  7322. @c
  7323. @kindex [
  7324. @kindex ]
  7325. @kindex @{
  7326. @kindex @}
  7327. @item [ ] @{ @}
  7328. @table @i
  7329. @item @r{in} search view
  7330. add new search words (@kbd{[} and @kbd{]}) or new regular expressions
  7331. (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
  7332. add a positive search term prefixed by @samp{+}, indicating that this search
  7333. term @i{must} occur/match in the entry. The closing bracket/brace will add a
  7334. negative search term which @i{must not} occur/match in the entry for it to be
  7335. selected.
  7336. @end table
  7337. @tsubheading{Remote editing}
  7338. @cindex remote editing, from agenda
  7339. @item 0--9
  7340. Digit argument.
  7341. @c
  7342. @cindex undoing remote-editing events
  7343. @cindex remote editing, undo
  7344. @orgcmd{C-_,org-agenda-undo}
  7345. Undo a change due to a remote editing command. The change is undone
  7346. both in the agenda buffer and in the remote buffer.
  7347. @c
  7348. @orgcmd{t,org-agenda-todo}
  7349. Change the TODO state of the item, both in the agenda and in the
  7350. original org file.
  7351. @c
  7352. @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
  7353. @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
  7354. Switch to the next/previous set of TODO keywords.
  7355. @c
  7356. @orgcmd{C-k,org-agenda-kill}
  7357. @vindex org-agenda-confirm-kill
  7358. Delete the current agenda item along with the entire subtree belonging
  7359. to it in the original Org file. If the text to be deleted remotely
  7360. is longer than one line, the kill needs to be confirmed by the user. See
  7361. variable @code{org-agenda-confirm-kill}.
  7362. @c
  7363. @orgcmd{C-c C-w,org-agenda-refile}
  7364. Refile the entry at point.
  7365. @c
  7366. @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
  7367. @vindex org-archive-default-command
  7368. Archive the subtree corresponding to the entry at point using the default
  7369. archiving command set in @code{org-archive-default-command}. When using the
  7370. @code{a} key, confirmation will be required.
  7371. @c
  7372. @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
  7373. Toggle the ARCHIVE tag for the current headline.
  7374. @c
  7375. @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
  7376. Move the subtree corresponding to the current entry to its @emph{archive
  7377. sibling}.
  7378. @c
  7379. @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
  7380. Archive the subtree corresponding to the current headline. This means the
  7381. entry will be moved to the configured archive location, most likely a
  7382. different file.
  7383. @c
  7384. @orgcmd{T,org-agenda-show-tags}
  7385. @vindex org-agenda-show-inherited-tags
  7386. Show all tags associated with the current item. This is useful if you have
  7387. turned off @code{org-agenda-show-inherited-tags}, but still want to see all
  7388. tags of a headline occasionally.
  7389. @c
  7390. @orgcmd{:,org-agenda-set-tags}
  7391. Set tags for the current headline. If there is an active region in the
  7392. agenda, change a tag for all headings in the region.
  7393. @c
  7394. @kindex ,
  7395. @item ,
  7396. Set the priority for the current item (@command{org-agenda-priority}).
  7397. Org mode prompts for the priority character. If you reply with @key{SPC},
  7398. the priority cookie is removed from the entry.
  7399. @c
  7400. @orgcmd{P,org-agenda-show-priority}
  7401. Display weighted priority of current item.
  7402. @c
  7403. @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
  7404. Increase the priority of the current item. The priority is changed in
  7405. the original buffer, but the agenda is not resorted. Use the @kbd{r}
  7406. key for this.
  7407. @c
  7408. @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
  7409. Decrease the priority of the current item.
  7410. @c
  7411. @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
  7412. @vindex org-log-into-drawer
  7413. Add a note to the entry. This note will be recorded, and then filed to the
  7414. same location where state change notes are put. Depending on
  7415. @code{org-log-into-drawer}, this may be inside a drawer.
  7416. @c
  7417. @orgcmd{C-c C-a,org-attach}
  7418. Dispatcher for all command related to attachments.
  7419. @c
  7420. @orgcmd{C-c C-s,org-agenda-schedule}
  7421. Schedule this item. With prefix arg remove the scheduling timestamp
  7422. @c
  7423. @orgcmd{C-c C-d,org-agenda-deadline}
  7424. Set a deadline for this item. With prefix arg remove the deadline.
  7425. @c
  7426. @orgcmd{S-@key{right},org-agenda-do-date-later}
  7427. Change the timestamp associated with the current line by one day into the
  7428. future. If the date is in the past, the first call to this command will move
  7429. it to today.@*
  7430. With a numeric prefix argument, change it by that many days. For example,
  7431. @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
  7432. change the time by one hour. If you immediately repeat the command, it will
  7433. continue to change hours even without the prefix arg. With a double @kbd{C-u
  7434. C-u} prefix, do the same for changing minutes.@*
  7435. The stamp is changed in the original Org file, but the change is not directly
  7436. reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
  7437. @c
  7438. @orgcmd{S-@key{left},org-agenda-do-date-earlier}
  7439. Change the timestamp associated with the current line by one day
  7440. into the past.
  7441. @c
  7442. @orgcmd{>,org-agenda-date-prompt}
  7443. Change the timestamp associated with the current line. The key @kbd{>} has
  7444. been chosen, because it is the same as @kbd{S-.} on my keyboard.
  7445. @c
  7446. @orgcmd{I,org-agenda-clock-in}
  7447. Start the clock on the current item. If a clock is running already, it
  7448. is stopped first.
  7449. @c
  7450. @orgcmd{O,org-agenda-clock-out}
  7451. Stop the previously started clock.
  7452. @c
  7453. @orgcmd{X,org-agenda-clock-cancel}
  7454. Cancel the currently running clock.
  7455. @c
  7456. @orgcmd{J,org-agenda-clock-goto}
  7457. Jump to the running clock in another window.
  7458. @c
  7459. @orgcmd{k,org-agenda-capture}
  7460. Like @code{org-capture}, but use the date at point as the default date for
  7461. the capture template. See @var{org-capture-use-agenda-date} to make this
  7462. the default behavior of @code{org-capture}.
  7463. @cindex capturing, from agenda
  7464. @vindex org-capture-use-agenda-date
  7465. @tsubheading{Bulk remote editing selected entries}
  7466. @cindex remote editing, bulk, from agenda
  7467. @vindex org-agenda-bulk-persistent-marks
  7468. @vindex org-agenda-bulk-custom-functions
  7469. @orgcmd{m,org-agenda-bulk-mark}
  7470. Mark the entry at point for bulk action. With prefix arg, mark that many
  7471. successive entries.
  7472. @c
  7473. @orgcmd{%,org-agenda-bulk-mark-regexp}
  7474. Mark entries matching a regular expression for bulk action.
  7475. @c
  7476. @orgcmd{u,org-agenda-bulk-unmark}
  7477. Unmark entry for bulk action.
  7478. @c
  7479. @orgcmd{U,org-agenda-bulk-remove-all-marks}
  7480. Unmark all marked entries for bulk action.
  7481. @c
  7482. @orgcmd{B,org-agenda-bulk-action}
  7483. Bulk action: act on all marked entries in the agenda. This will prompt for
  7484. another key to select the action to be applied. The prefix arg to @kbd{B}
  7485. will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
  7486. these special timestamps. By default, marks are removed after the bulk. If
  7487. you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
  7488. @code{t} or hit @kbd{p} at the prompt.
  7489. @example
  7490. * @r{Toggle persistent marks.}
  7491. $ @r{Archive all selected entries.}
  7492. A @r{Archive entries by moving them to their respective archive siblings.}
  7493. t @r{Change TODO state. This prompts for a single TODO keyword and}
  7494. @r{changes the state of all selected entries, bypassing blocking and}
  7495. @r{suppressing logging notes (but not timestamps).}
  7496. + @r{Add a tag to all selected entries.}
  7497. - @r{Remove a tag from all selected entries.}
  7498. s @r{Schedule all items to a new date. To shift existing schedule dates}
  7499. @r{by a fixed number of days, use something starting with double plus}
  7500. @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
  7501. d @r{Set deadline to a specific date.}
  7502. r @r{Prompt for a single refile target and move all entries. The entries}
  7503. @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
  7504. S @r{Reschedule randomly into the coming N days. N will be prompted for.}
  7505. @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
  7506. f @r{Apply a function@footnote{You can also create persistent custom functions through@code{org-agenda-bulk-custom-functions}.} to marked entries.}
  7507. @r{For example, the function below sets the CATEGORY property of the}
  7508. @r{entries to web.}
  7509. @r{(defun set-category ()}
  7510. @r{ (interactive "P")}
  7511. @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
  7512. @r{ (org-agenda-error)))}
  7513. @r{ (buffer (marker-buffer marker)))}
  7514. @r{ (with-current-buffer buffer}
  7515. @r{ (save-excursion}
  7516. @r{ (save-restriction}
  7517. @r{ (widen)}
  7518. @r{ (goto-char marker)}
  7519. @r{ (org-back-to-heading t)}
  7520. @r{ (org-set-property "CATEGORY" "web"))))))}
  7521. @end example
  7522. @tsubheading{Calendar commands}
  7523. @cindex calendar commands, from agenda
  7524. @orgcmd{c,org-agenda-goto-calendar}
  7525. Open the Emacs calendar and move to the date at the agenda cursor.
  7526. @c
  7527. @orgcmd{c,org-calendar-goto-agenda}
  7528. When in the calendar, compute and show the Org mode agenda for the
  7529. date at the cursor.
  7530. @c
  7531. @cindex diary entries, creating from agenda
  7532. @orgcmd{i,org-agenda-diary-entry}
  7533. @vindex org-agenda-diary-file
  7534. Insert a new entry into the diary, using the date at the cursor and (for
  7535. block entries) the date at the mark. This will add to the Emacs diary
  7536. file@footnote{This file is parsed for the agenda when
  7537. @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
  7538. command in the calendar. The diary file will pop up in another window, where
  7539. you can add the entry.
  7540. If you configure @code{org-agenda-diary-file} to point to an Org mode file,
  7541. Org will create entries (in Org mode syntax) in that file instead. Most
  7542. entries will be stored in a date-based outline tree that will later make it
  7543. easy to archive appointments from previous months/years. The tree will be
  7544. built under an entry with a @code{DATE_TREE} property, or else with years as
  7545. top-level entries. Emacs will prompt you for the entry text---if you specify
  7546. it, the entry will be created in @code{org-agenda-diary-file} without further
  7547. interaction. If you directly press @key{RET} at the prompt without typing
  7548. text, the target file will be shown in another window for you to finish the
  7549. entry there. See also the @kbd{k r} command.
  7550. @c
  7551. @orgcmd{M,org-agenda-phases-of-moon}
  7552. Show the phases of the moon for the three months around current date.
  7553. @c
  7554. @orgcmd{S,org-agenda-sunrise-sunset}
  7555. Show sunrise and sunset times. The geographical location must be set
  7556. with calendar variables, see the documentation for the Emacs calendar.
  7557. @c
  7558. @orgcmd{C,org-agenda-convert-date}
  7559. Convert the date at cursor into many other cultural and historic
  7560. calendars.
  7561. @c
  7562. @orgcmd{H,org-agenda-holidays}
  7563. Show holidays for three months around the cursor date.
  7564. @item M-x org-export-icalendar-combine-agenda-files
  7565. Export a single iCalendar file containing entries from all agenda files.
  7566. This is a globally available command, and also available in the agenda menu.
  7567. @tsubheading{Exporting to a file}
  7568. @orgcmd{C-x C-w,org-agenda-write}
  7569. @cindex exporting agenda views
  7570. @cindex agenda views, exporting
  7571. @vindex org-agenda-exporter-settings
  7572. Write the agenda view to a file. Depending on the extension of the selected
  7573. file name, the view will be exported as HTML (extension @file{.html} or
  7574. @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
  7575. and plain text (any other extension). When called with a @kbd{C-u} prefix
  7576. argument, immediately open the newly created file. Use the variable
  7577. @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
  7578. for @file{htmlize} to be used during export.
  7579. @tsubheading{Quit and Exit}
  7580. @orgcmd{q,org-agenda-quit}
  7581. Quit agenda, remove the agenda buffer.
  7582. @c
  7583. @cindex agenda files, removing buffers
  7584. @orgcmd{x,org-agenda-exit}
  7585. Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
  7586. for the compilation of the agenda. Buffers created by the user to
  7587. visit Org files will not be removed.
  7588. @end table
  7589. @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
  7590. @section Custom agenda views
  7591. @cindex custom agenda views
  7592. @cindex agenda views, custom
  7593. Custom agenda commands serve two purposes: to store and quickly access
  7594. frequently used TODO and tags searches, and to create special composite
  7595. agenda buffers. Custom agenda commands will be accessible through the
  7596. dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
  7597. @menu
  7598. * Storing searches:: Type once, use often
  7599. * Block agenda:: All the stuff you need in a single buffer
  7600. * Setting Options:: Changing the rules
  7601. @end menu
  7602. @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
  7603. @subsection Storing searches
  7604. The first application of custom searches is the definition of keyboard
  7605. shortcuts for frequently used searches, either creating an agenda
  7606. buffer, or a sparse tree (the latter covering of course only the current
  7607. buffer).
  7608. @kindex C-c a C
  7609. @vindex org-agenda-custom-commands
  7610. @cindex agenda views, main example
  7611. @cindex tags, as an agenda view
  7612. @cindex todo, as an agenda view
  7613. @cindex tags-todo
  7614. @cindex todo-tree
  7615. @cindex occur-tree
  7616. @cindex tags-tree
  7617. Custom commands are configured in the variable
  7618. @code{org-agenda-custom-commands}. You can customize this variable, for
  7619. example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
  7620. Lisp in @file{.emacs}. The following example contains all valid search
  7621. types:
  7622. @lisp
  7623. @group
  7624. (setq org-agenda-custom-commands
  7625. '(("w" todo "WAITING")
  7626. ("W" todo-tree "WAITING")
  7627. ("u" tags "+boss-urgent")
  7628. ("v" tags-todo "+boss-urgent")
  7629. ("U" tags-tree "+boss-urgent")
  7630. ("f" occur-tree "\\<FIXME\\>")
  7631. ("h" . "HOME+Name tags searches") ; description for "h" prefix
  7632. ("hl" tags "+home+Lisa")
  7633. ("hp" tags "+home+Peter")
  7634. ("hk" tags "+home+Kim")))
  7635. @end group
  7636. @end lisp
  7637. @noindent
  7638. The initial string in each entry defines the keys you have to press
  7639. after the dispatcher command @kbd{C-c a} in order to access the command.
  7640. Usually this will be just a single character, but if you have many
  7641. similar commands, you can also define two-letter combinations where the
  7642. first character is the same in several combinations and serves as a
  7643. prefix key@footnote{You can provide a description for a prefix key by
  7644. inserting a cons cell with the prefix and the description.}. The second
  7645. parameter is the search type, followed by the string or regular
  7646. expression to be used for the matching. The example above will
  7647. therefore define:
  7648. @table @kbd
  7649. @item C-c a w
  7650. as a global search for TODO entries with @samp{WAITING} as the TODO
  7651. keyword
  7652. @item C-c a W
  7653. as the same search, but only in the current buffer and displaying the
  7654. results as a sparse tree
  7655. @item C-c a u
  7656. as a global tags search for headlines marked @samp{:boss:} but not
  7657. @samp{:urgent:}
  7658. @item C-c a v
  7659. as the same search as @kbd{C-c a u}, but limiting the search to
  7660. headlines that are also TODO items
  7661. @item C-c a U
  7662. as the same search as @kbd{C-c a u}, but only in the current buffer and
  7663. displaying the result as a sparse tree
  7664. @item C-c a f
  7665. to create a sparse tree (again: current buffer only) with all entries
  7666. containing the word @samp{FIXME}
  7667. @item C-c a h
  7668. as a prefix command for a HOME tags search where you have to press an
  7669. additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
  7670. Peter, or Kim) as additional tag to match.
  7671. @end table
  7672. Note that the @code{*-tree} agenda views need to be called from an
  7673. Org buffer as they operate on the current buffer only.
  7674. @node Block agenda, Setting Options, Storing searches, Custom agenda views
  7675. @subsection Block agenda
  7676. @cindex block agenda
  7677. @cindex agenda, with block views
  7678. Another possibility is the construction of agenda views that comprise
  7679. the results of @emph{several} commands, each of which creates a block in
  7680. the agenda buffer. The available commands include @code{agenda} for the
  7681. daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
  7682. for the global TODO list (as constructed with @kbd{C-c a t}), and the
  7683. matching commands discussed above: @code{todo}, @code{tags}, and
  7684. @code{tags-todo}. Here are two examples:
  7685. @lisp
  7686. @group
  7687. (setq org-agenda-custom-commands
  7688. '(("h" "Agenda and Home-related tasks"
  7689. ((agenda "")
  7690. (tags-todo "home")
  7691. (tags "garden")))
  7692. ("o" "Agenda and Office-related tasks"
  7693. ((agenda "")
  7694. (tags-todo "work")
  7695. (tags "office")))))
  7696. @end group
  7697. @end lisp
  7698. @noindent
  7699. This will define @kbd{C-c a h} to create a multi-block view for stuff
  7700. you need to attend to at home. The resulting agenda buffer will contain
  7701. your agenda for the current week, all TODO items that carry the tag
  7702. @samp{home}, and also all lines tagged with @samp{garden}. Finally the
  7703. command @kbd{C-c a o} provides a similar view for office tasks.
  7704. @node Setting Options, , Block agenda, Custom agenda views
  7705. @subsection Setting options for custom commands
  7706. @cindex options, for custom agenda views
  7707. @vindex org-agenda-custom-commands
  7708. Org mode contains a number of variables regulating agenda construction
  7709. and display. The global variables define the behavior for all agenda
  7710. commands, including the custom commands. However, if you want to change
  7711. some settings just for a single custom view, you can do so. Setting
  7712. options requires inserting a list of variable names and values at the
  7713. right spot in @code{org-agenda-custom-commands}. For example:
  7714. @lisp
  7715. @group
  7716. (setq org-agenda-custom-commands
  7717. '(("w" todo "WAITING"
  7718. ((org-agenda-sorting-strategy '(priority-down))
  7719. (org-agenda-prefix-format " Mixed: ")))
  7720. ("U" tags-tree "+boss-urgent"
  7721. ((org-show-following-heading nil)
  7722. (org-show-hierarchy-above nil)))
  7723. ("N" search ""
  7724. ((org-agenda-files '("~org/notes.org"))
  7725. (org-agenda-text-search-extra-files nil)))))
  7726. @end group
  7727. @end lisp
  7728. @noindent
  7729. Now the @kbd{C-c a w} command will sort the collected entries only by
  7730. priority, and the prefix format is modified to just say @samp{ Mixed: }
  7731. instead of giving the category of the entry. The sparse tags tree of
  7732. @kbd{C-c a U} will now turn out ultra-compact, because neither the
  7733. headline hierarchy above the match, nor the headline following the match
  7734. will be shown. The command @kbd{C-c a N} will do a text search limited
  7735. to only a single file.
  7736. @vindex org-agenda-custom-commands
  7737. For command sets creating a block agenda,
  7738. @code{org-agenda-custom-commands} has two separate spots for setting
  7739. options. You can add options that should be valid for just a single
  7740. command in the set, and options that should be valid for all commands in
  7741. the set. The former are just added to the command entry; the latter
  7742. must come after the list of command entries. Going back to the block
  7743. agenda example (@pxref{Block agenda}), let's change the sorting strategy
  7744. for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
  7745. the results for GARDEN tags query in the opposite order,
  7746. @code{priority-up}. This would look like this:
  7747. @lisp
  7748. @group
  7749. (setq org-agenda-custom-commands
  7750. '(("h" "Agenda and Home-related tasks"
  7751. ((agenda)
  7752. (tags-todo "home")
  7753. (tags "garden"
  7754. ((org-agenda-sorting-strategy '(priority-up)))))
  7755. ((org-agenda-sorting-strategy '(priority-down))))
  7756. ("o" "Agenda and Office-related tasks"
  7757. ((agenda)
  7758. (tags-todo "work")
  7759. (tags "office")))))
  7760. @end group
  7761. @end lisp
  7762. As you see, the values and parentheses setting is a little complex.
  7763. When in doubt, use the customize interface to set this variable---it
  7764. fully supports its structure. Just one caveat: when setting options in
  7765. this interface, the @emph{values} are just Lisp expressions. So if the
  7766. value is a string, you need to add the double-quotes around the value
  7767. yourself.
  7768. @vindex org-agenda-custom-commands-contexts
  7769. To control whether an agenda command should be accessible from a specific
  7770. context, you can customize @var{org-agenda-custom-commands-contexts}. Let's
  7771. say for example that you have an agenda commands @code{"o"} displaying a view
  7772. that you only need when reading emails. Then you would configure this option
  7773. like this:
  7774. @example
  7775. (setq org-agenda-custom-commands-contexts
  7776. '(("o" (in-mode . "message-mode"))))
  7777. @end example
  7778. You can also tell that the command key @code{"o"} should refer to another
  7779. command key @code{"r"}. In that case, add this command key like this:
  7780. @example
  7781. (setq org-agenda-custom-commands-contexts
  7782. '(("o" "r" (in-mode . "message-mode"))))
  7783. @end example
  7784. See the docstring of the variable for more information.
  7785. @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
  7786. @section Exporting Agenda Views
  7787. @cindex agenda views, exporting
  7788. If you are away from your computer, it can be very useful to have a printed
  7789. version of some agenda views to carry around. Org mode can export custom
  7790. agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
  7791. @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
  7792. ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
  7793. a PDF file will also create the postscript file.}, and iCalendar files. If
  7794. you want to do this only occasionally, use the command
  7795. @table @kbd
  7796. @orgcmd{C-x C-w,org-agenda-write}
  7797. @cindex exporting agenda views
  7798. @cindex agenda views, exporting
  7799. @vindex org-agenda-exporter-settings
  7800. Write the agenda view to a file. Depending on the extension of the selected
  7801. file name, the view will be exported as HTML (extension @file{.html} or
  7802. @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
  7803. @file{.ics}), or plain text (any other extension). Use the variable
  7804. @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
  7805. for @file{htmlize} to be used during export, for example
  7806. @vindex org-agenda-add-entry-text-maxlines
  7807. @vindex htmlize-output-type
  7808. @vindex ps-number-of-columns
  7809. @vindex ps-landscape-mode
  7810. @lisp
  7811. (setq org-agenda-exporter-settings
  7812. '((ps-number-of-columns 2)
  7813. (ps-landscape-mode t)
  7814. (org-agenda-add-entry-text-maxlines 5)
  7815. (htmlize-output-type 'css)))
  7816. @end lisp
  7817. @end table
  7818. If you need to export certain agenda views frequently, you can associate
  7819. any custom agenda command with a list of output file names
  7820. @footnote{If you want to store standard views like the weekly agenda
  7821. or the global TODO list as well, you need to define custom commands for
  7822. them in order to be able to specify file names.}. Here is an example
  7823. that first defines custom commands for the agenda and the global
  7824. TODO list, together with a number of files to which to export them.
  7825. Then we define two block agenda commands and specify file names for them
  7826. as well. File names can be relative to the current working directory,
  7827. or absolute.
  7828. @lisp
  7829. @group
  7830. (setq org-agenda-custom-commands
  7831. '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
  7832. ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
  7833. ("h" "Agenda and Home-related tasks"
  7834. ((agenda "")
  7835. (tags-todo "home")
  7836. (tags "garden"))
  7837. nil
  7838. ("~/views/home.html"))
  7839. ("o" "Agenda and Office-related tasks"
  7840. ((agenda)
  7841. (tags-todo "work")
  7842. (tags "office"))
  7843. nil
  7844. ("~/views/office.ps" "~/calendars/office.ics"))))
  7845. @end group
  7846. @end lisp
  7847. The extension of the file name determines the type of export. If it is
  7848. @file{.html}, Org mode will use the @file{htmlize.el} package to convert
  7849. the buffer to HTML and save it to this file name. If the extension is
  7850. @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
  7851. Postscript output. If the extension is @file{.ics}, iCalendar export is
  7852. run export over all files that were used to construct the agenda, and
  7853. limit the export to entries listed in the agenda. Any other
  7854. extension produces a plain ASCII file.
  7855. The export files are @emph{not} created when you use one of those
  7856. commands interactively because this might use too much overhead.
  7857. Instead, there is a special command to produce @emph{all} specified
  7858. files in one step:
  7859. @table @kbd
  7860. @orgcmd{C-c a e,org-store-agenda-views}
  7861. Export all agenda views that have export file names associated with
  7862. them.
  7863. @end table
  7864. You can use the options section of the custom agenda commands to also
  7865. set options for the export commands. For example:
  7866. @lisp
  7867. (setq org-agenda-custom-commands
  7868. '(("X" agenda ""
  7869. ((ps-number-of-columns 2)
  7870. (ps-landscape-mode t)
  7871. (org-agenda-prefix-format " [ ] ")
  7872. (org-agenda-with-colors nil)
  7873. (org-agenda-remove-tags t))
  7874. ("theagenda.ps"))))
  7875. @end lisp
  7876. @noindent
  7877. This command sets two options for the Postscript exporter, to make it
  7878. print in two columns in landscape format---the resulting page can be cut
  7879. in two and then used in a paper agenda. The remaining settings modify
  7880. the agenda prefix to omit category and scheduling information, and
  7881. instead include a checkbox to check off items. We also remove the tags
  7882. to make the lines compact, and we don't want to use colors for the
  7883. black-and-white printer. Settings specified in
  7884. @code{org-agenda-exporter-settings} will also apply, but the settings
  7885. in @code{org-agenda-custom-commands} take precedence.
  7886. @noindent
  7887. From the command line you may also use
  7888. @example
  7889. emacs -eval (org-batch-store-agenda-views) -kill
  7890. @end example
  7891. @noindent
  7892. or, if you need to modify some parameters@footnote{Quoting depends on the
  7893. system you use, please check the FAQ for examples.}
  7894. @example
  7895. emacs -eval '(org-batch-store-agenda-views \
  7896. org-agenda-span (quote month) \
  7897. org-agenda-start-day "2007-11-01" \
  7898. org-agenda-include-diary nil \
  7899. org-agenda-files (quote ("~/org/project.org")))' \
  7900. -kill
  7901. @end example
  7902. @noindent
  7903. which will create the agenda views restricted to the file
  7904. @file{~/org/project.org}, without diary entries and with a 30-day
  7905. extent.
  7906. You can also extract agenda information in a way that allows further
  7907. processing by other programs. See @ref{Extracting agenda information}, for
  7908. more information.
  7909. @node Agenda column view, , Exporting Agenda Views, Agenda Views
  7910. @section Using column view in the agenda
  7911. @cindex column view, in agenda
  7912. @cindex agenda, column view
  7913. Column view (@pxref{Column view}) is normally used to view and edit
  7914. properties embedded in the hierarchical structure of an Org file. It can be
  7915. quite useful to use column view also from the agenda, where entries are
  7916. collected by certain criteria.
  7917. @table @kbd
  7918. @orgcmd{C-c C-x C-c,org-agenda-columns}
  7919. Turn on column view in the agenda.
  7920. @end table
  7921. To understand how to use this properly, it is important to realize that the
  7922. entries in the agenda are no longer in their proper outline environment.
  7923. This causes the following issues:
  7924. @enumerate
  7925. @item
  7926. @vindex org-columns-default-format
  7927. @vindex org-overriding-columns-format
  7928. Org needs to make a decision which @code{COLUMNS} format to use. Since the
  7929. entries in the agenda are collected from different files, and different files
  7930. may have different @code{COLUMNS} formats, this is a non-trivial problem.
  7931. Org first checks if the variable @code{org-agenda-overriding-columns-format} is
  7932. currently set, and if so, takes the format from there. Otherwise it takes
  7933. the format associated with the first item in the agenda, or, if that item
  7934. does not have a specific format (defined in a property, or in its file), it
  7935. uses @code{org-columns-default-format}.
  7936. @item
  7937. @cindex property, special, CLOCKSUM
  7938. If any of the columns has a summary type defined (@pxref{Column attributes}),
  7939. turning on column view in the agenda will visit all relevant agenda files and
  7940. make sure that the computations of this property are up to date. This is
  7941. also true for the special @code{CLOCKSUM} property. Org will then sum the
  7942. values displayed in the agenda. In the daily/weekly agenda, the sums will
  7943. cover a single day; in all other views they cover the entire block. It is
  7944. vital to realize that the agenda may show the same entry @emph{twice} (for
  7945. example as scheduled and as a deadline), and it may show two entries from the
  7946. same hierarchy (for example a @emph{parent} and its @emph{child}). In these
  7947. cases, the summation in the agenda will lead to incorrect results because
  7948. some values will count double.
  7949. @item
  7950. When the column view in the agenda shows the @code{CLOCKSUM}, that is always
  7951. the entire clocked time for this item. So even in the daily/weekly agenda,
  7952. the clocksum listed in column view may originate from times outside the
  7953. current view. This has the advantage that you can compare these values with
  7954. a column listing the planned total effort for a task---one of the major
  7955. applications for column view in the agenda. If you want information about
  7956. clocked time in the displayed period use clock table mode (press @kbd{R} in
  7957. the agenda).
  7958. @item
  7959. @cindex property, special, CLOCKSUM_T
  7960. When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
  7961. always today's clocked time for this item. So even in the weekly agenda,
  7962. the clocksum listed in column view only originates from today. This lets
  7963. you compare the time you spent on a task for today, with the time already
  7964. spent (via @code{CLOCKSUM}) and with the planned total effort for it.
  7965. @end enumerate
  7966. @node Markup, Exporting, Agenda Views, Top
  7967. @chapter Markup for rich export
  7968. When exporting Org mode documents, the exporter tries to reflect the
  7969. structure of the document as accurately as possible in the backend. Since
  7970. export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
  7971. Org mode has rules on how to prepare text for rich export. This section
  7972. summarizes the markup rules used in an Org mode buffer.
  7973. @menu
  7974. * Structural markup elements:: The basic structure as seen by the exporter
  7975. * Images and tables:: Tables and Images will be included
  7976. * Literal examples:: Source code examples with special formatting
  7977. * Include files:: Include additional files into a document
  7978. * Index entries:: Making an index
  7979. * Macro replacement:: Use macros to create complex output
  7980. * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
  7981. @end menu
  7982. @node Structural markup elements, Images and tables, Markup, Markup
  7983. @section Structural markup elements
  7984. @menu
  7985. * Document title:: Where the title is taken from
  7986. * Headings and sections:: The document structure as seen by the exporter
  7987. * Table of contents:: The if and where of the table of contents
  7988. * Initial text:: Text before the first heading?
  7989. * Lists:: Lists
  7990. * Paragraphs:: Paragraphs
  7991. * Footnote markup:: Footnotes
  7992. * Emphasis and monospace:: Bold, italic, etc.
  7993. * Horizontal rules:: Make a line
  7994. * Comment lines:: What will *not* be exported
  7995. @end menu
  7996. @node Document title, Headings and sections, Structural markup elements, Structural markup elements
  7997. @subheading Document title
  7998. @cindex document title, markup rules
  7999. @noindent
  8000. The title of the exported document is taken from the special line
  8001. @cindex #+TITLE
  8002. @example
  8003. #+TITLE: This is the title of the document
  8004. @end example
  8005. @noindent
  8006. If this line does not exist, the title is derived from the first non-empty,
  8007. non-comment line in the buffer. If no such line exists, or if you have
  8008. turned off exporting of the text before the first headline (see below), the
  8009. title will be the file name without extension.
  8010. @cindex property, EXPORT_TITLE
  8011. If you are exporting only a subtree by marking is as the region, the heading
  8012. of the subtree will become the title of the document. If the subtree has a
  8013. property @code{EXPORT_TITLE}, that will take precedence.
  8014. @node Headings and sections, Table of contents, Document title, Structural markup elements
  8015. @subheading Headings and sections
  8016. @cindex headings and sections, markup rules
  8017. @vindex org-export-headline-levels
  8018. The outline structure of the document as described in @ref{Document
  8019. Structure}, forms the basis for defining sections of the exported document.
  8020. However, since the outline structure is also used for (for example) lists of
  8021. tasks, only the first three outline levels will be used as headings. Deeper
  8022. levels will become itemized lists. You can change the location of this
  8023. switch globally by setting the variable @code{org-export-headline-levels}, or on a
  8024. per-file basis with a line
  8025. @cindex #+OPTIONS
  8026. @example
  8027. #+OPTIONS: H:4
  8028. @end example
  8029. @node Table of contents, Initial text, Headings and sections, Structural markup elements
  8030. @subheading Table of contents
  8031. @cindex table of contents, markup rules
  8032. @vindex org-export-with-toc
  8033. The table of contents is normally inserted directly before the first headline
  8034. of the file. If you would like to get it to a different location, insert the
  8035. string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
  8036. location. The depth of the table of contents is by default the same as the
  8037. number of headline levels, but you can choose a smaller number, or turn off
  8038. the table of contents entirely, by configuring the variable
  8039. @code{org-export-with-toc}, or on a per-file basis with a line like
  8040. @example
  8041. #+OPTIONS: toc:2 (only to two levels in TOC)
  8042. #+OPTIONS: toc:nil (no TOC at all)
  8043. @end example
  8044. @node Initial text, Lists, Table of contents, Structural markup elements
  8045. @subheading Text before the first headline
  8046. @cindex text before first headline, markup rules
  8047. @cindex #+TEXT
  8048. Org mode normally exports the text before the first headline, and even uses
  8049. the first line as the document title. The text will be fully marked up. If
  8050. you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
  8051. constructs described below in the sections for the individual exporters.
  8052. @vindex org-export-skip-text-before-1st-heading
  8053. Some people like to use the space before the first headline for setup and
  8054. internal links and therefore would like to control the exported text before
  8055. the first headline in a different way. You can do so by setting the variable
  8056. @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
  8057. basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
  8058. @noindent
  8059. If you still want to have some text before the first headline, use the
  8060. @code{#+TEXT} construct:
  8061. @example
  8062. #+OPTIONS: skip:t
  8063. #+TEXT: This text will go before the *first* headline.
  8064. #+TEXT: [TABLE-OF-CONTENTS]
  8065. #+TEXT: This goes between the table of contents and the *first* headline
  8066. @end example
  8067. @node Lists, Paragraphs, Initial text, Structural markup elements
  8068. @subheading Lists
  8069. @cindex lists, markup rules
  8070. Plain lists as described in @ref{Plain lists}, are translated to the backend's
  8071. syntax for such lists. Most backends support unordered, ordered, and
  8072. description lists.
  8073. @node Paragraphs, Footnote markup, Lists, Structural markup elements
  8074. @subheading Paragraphs, line breaks, and quoting
  8075. @cindex paragraphs, markup rules
  8076. Paragraphs are separated by at least one empty line. If you need to enforce
  8077. a line break within a paragraph, use @samp{\\} at the end of a line.
  8078. To keep the line breaks in a region, but otherwise use normal formatting, you
  8079. can use this construct, which can also be used to format poetry.
  8080. @cindex #+BEGIN_VERSE
  8081. @example
  8082. #+BEGIN_VERSE
  8083. Great clouds overhead
  8084. Tiny black birds rise and fall
  8085. Snow covers Emacs
  8086. -- AlexSchroeder
  8087. #+END_VERSE
  8088. @end example
  8089. When quoting a passage from another document, it is customary to format this
  8090. as a paragraph that is indented on both the left and the right margin. You
  8091. can include quotations in Org mode documents like this:
  8092. @cindex #+BEGIN_QUOTE
  8093. @example
  8094. #+BEGIN_QUOTE
  8095. Everything should be made as simple as possible,
  8096. but not any simpler -- Albert Einstein
  8097. #+END_QUOTE
  8098. @end example
  8099. If you would like to center some text, do it like this:
  8100. @cindex #+BEGIN_CENTER
  8101. @example
  8102. #+BEGIN_CENTER
  8103. Everything should be made as simple as possible, \\
  8104. but not any simpler
  8105. #+END_CENTER
  8106. @end example
  8107. @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
  8108. @subheading Footnote markup
  8109. @cindex footnotes, markup rules
  8110. @cindex @file{footnote.el}
  8111. Footnotes defined in the way described in @ref{Footnotes}, will be exported
  8112. by all backends. Org allows multiple references to the same note, and
  8113. multiple footnotes side by side.
  8114. @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
  8115. @subheading Emphasis and monospace
  8116. @cindex underlined text, markup rules
  8117. @cindex bold text, markup rules
  8118. @cindex italic text, markup rules
  8119. @cindex verbatim text, markup rules
  8120. @cindex code text, markup rules
  8121. @cindex strike-through text, markup rules
  8122. @vindex org-fontify-emphasized-text
  8123. @vindex org-emphasis-regexp-components
  8124. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
  8125. and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
  8126. in the code and verbatim string is not processed for Org mode specific
  8127. syntax; it is exported verbatim.
  8128. To turn off fontification for marked up text, you can set
  8129. @code{org-fontify-emphasized-text} to @code{nil}. To fine tune what
  8130. characters are allowed before and after the special characters, see
  8131. @code{org-emphasis-regexp-components}.
  8132. @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
  8133. @subheading Horizontal rules
  8134. @cindex horizontal rules, markup rules
  8135. A line consisting of only dashes, and at least 5 of them, will be exported as
  8136. a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
  8137. @node Comment lines, , Horizontal rules, Structural markup elements
  8138. @subheading Comment lines
  8139. @cindex comment lines
  8140. @cindex exporting, not
  8141. @cindex #+BEGIN_COMMENT
  8142. Lines starting with zero or more whitespace characters followed by one
  8143. @samp{#} and a whitespace are treated as comments and will never be exported.
  8144. Also entire subtrees starting with the word @samp{COMMENT} will never be
  8145. exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
  8146. ... @samp{#+END_COMMENT} will not be exported.
  8147. @table @kbd
  8148. @kindex C-c ;
  8149. @item C-c ;
  8150. Toggle the COMMENT keyword at the beginning of an entry.
  8151. @end table
  8152. @node Images and tables, Literal examples, Structural markup elements, Markup
  8153. @section Images and Tables
  8154. @cindex tables, markup rules
  8155. @cindex #+CAPTION
  8156. @cindex #+LABEL
  8157. Both the native Org mode tables (@pxref{Tables}) and tables formatted with
  8158. the @file{table.el} package will be exported properly. For Org mode tables,
  8159. the lines before the first horizontal separator line will become table header
  8160. lines. You can use the following lines somewhere before the table to assign
  8161. a caption and a label for cross references, and in the text you can refer to
  8162. the object with @code{\ref@{tab:basic-data@}}:
  8163. @example
  8164. #+CAPTION: This is the caption for the next table (or link)
  8165. #+LABEL: tab:basic-data
  8166. | ... | ...|
  8167. |-----|----|
  8168. @end example
  8169. Optionally, the caption can take the form:
  8170. @example
  8171. #+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
  8172. @end example
  8173. @cindex inlined images, markup rules
  8174. Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
  8175. images into the exported document. Org does this, if a link to an image
  8176. files does not have a description part, for example @code{[[./img/a.jpg]]}.
  8177. If you wish to define a caption for the image and maybe a label for internal
  8178. cross references, make sure that the link is on a line by itself and precede
  8179. it with @code{#+CAPTION} and @code{#+LABEL} as follows:
  8180. @example
  8181. #+CAPTION: This is the caption for the next figure link (or table)
  8182. #+LABEL: fig:SED-HR4049
  8183. [[./img/a.jpg]]
  8184. @end example
  8185. You may also define additional attributes for the figure. As this is
  8186. backend-specific, see the sections about the individual backends for more
  8187. information.
  8188. @xref{Handling links,the discussion of image links}.
  8189. @node Literal examples, Include files, Images and tables, Markup
  8190. @section Literal examples
  8191. @cindex literal examples, markup rules
  8192. @cindex code line references, markup rules
  8193. You can include literal examples that should not be subjected to
  8194. markup. Such examples will be typeset in monospace, so this is well suited
  8195. for source code and similar examples.
  8196. @cindex #+BEGIN_EXAMPLE
  8197. @example
  8198. #+BEGIN_EXAMPLE
  8199. Some example from a text file.
  8200. #+END_EXAMPLE
  8201. @end example
  8202. Note that such blocks may be @i{indented} in order to align nicely with
  8203. indented text and in particular with plain list structure (@pxref{Plain
  8204. lists}). For simplicity when using small examples, you can also start the
  8205. example lines with a colon followed by a space. There may also be additional
  8206. whitespace before the colon:
  8207. @example
  8208. Here is an example
  8209. : Some example from a text file.
  8210. @end example
  8211. @cindex formatting source code, markup rules
  8212. If the example is source code from a programming language, or any other text
  8213. that can be marked up by font-lock in Emacs, you can ask for the example to
  8214. look like the fontified Emacs buffer@footnote{This works automatically for
  8215. the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
  8216. which is distributed with Org). Fontified code chunks in @LaTeX{} can be
  8217. achieved using either the listings or the
  8218. @url{http://code.google.com/p/minted, minted,} package. Refer to
  8219. @code{org-export-latex-listings} documentation for details.}. This is done
  8220. with the @samp{src} block, where you also need to specify the name of the
  8221. major mode that should be used to fontify the example@footnote{Code in
  8222. @samp{src} blocks may also be evaluated either interactively or on export.
  8223. See @pxref{Working With Source Code} for more information on evaluating code
  8224. blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code
  8225. blocks.
  8226. @cindex #+BEGIN_SRC
  8227. @example
  8228. #+BEGIN_SRC emacs-lisp
  8229. (defun org-xor (a b)
  8230. "Exclusive or."
  8231. (if a (not b) b))
  8232. #+END_SRC
  8233. @end example
  8234. Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
  8235. switch to the end of the @code{BEGIN} line, to get the lines of the example
  8236. numbered. If you use a @code{+n} switch, the numbering from the previous
  8237. numbered snippet will be continued in the current one. In literal examples,
  8238. Org will interpret strings like @samp{(ref:name)} as labels, and use them as
  8239. targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
  8240. enclosed in single parenthesis). In HTML, hovering the mouse over such a
  8241. link will remote-highlight the corresponding code line, which is kind of
  8242. cool.
  8243. You can also add a @code{-r} switch which @i{removes} the labels from the
  8244. source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
  8245. labels in the source code while using line numbers for the links, which might
  8246. be useful to explain those in an Org mode example code.}. With the @code{-n}
  8247. switch, links to these references will be labeled by the line numbers from
  8248. the code listing, otherwise links will use the labels with no parentheses.
  8249. Here is an example:
  8250. @example
  8251. #+BEGIN_SRC emacs-lisp -n -r
  8252. (save-excursion (ref:sc)
  8253. (goto-char (point-min)) (ref:jump)
  8254. #+END_SRC
  8255. In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
  8256. jumps to point-min.
  8257. @end example
  8258. @vindex org-coderef-label-format
  8259. If the syntax for the label format conflicts with the language syntax, use a
  8260. @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
  8261. -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
  8262. HTML export also allows examples to be published as text areas (@pxref{Text
  8263. areas in HTML export}).
  8264. Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
  8265. so often, shortcuts are provided using the Easy Templates facility
  8266. (@pxref{Easy Templates}).
  8267. @table @kbd
  8268. @kindex C-c '
  8269. @item C-c '
  8270. Edit the source code example at point in its native mode. This works by
  8271. switching to a temporary buffer with the source code. You need to exit by
  8272. pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
  8273. @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
  8274. from being interpreted by Org as outline nodes or special syntax. These
  8275. commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
  8276. The edited version will then replace the old version in the Org buffer.
  8277. Fixed-width regions (where each line starts with a colon followed by a space)
  8278. will be edited using @code{artist-mode}@footnote{You may select
  8279. a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
  8280. to allow creating ASCII drawings easily. Using this command in an empty line
  8281. will create a new fixed-width region.
  8282. @kindex C-c l
  8283. @item C-c l
  8284. Calling @code{org-store-link} while editing a source code example in a
  8285. temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
  8286. that it is unique in the current buffer, and insert it with the proper
  8287. formatting like @samp{(ref:label)} at the end of the current line. Then the
  8288. label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
  8289. @end table
  8290. @node Include files, Index entries, Literal examples, Markup
  8291. @section Include files
  8292. @cindex include files, markup rules
  8293. During export, you can include the content of another file. For example, to
  8294. include your @file{.emacs} file, you could use:
  8295. @cindex #+INCLUDE
  8296. @example
  8297. #+INCLUDE: "~/.emacs" src emacs-lisp
  8298. @end example
  8299. @noindent
  8300. The optional second and third parameter are the markup (e.g., @samp{quote},
  8301. @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
  8302. language for formatting the contents. The markup is optional; if it is not
  8303. given, the text will be assumed to be in Org mode format and will be
  8304. processed normally. The include line will also allow additional keyword
  8305. parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
  8306. first line and for each following line, @code{:minlevel} in order to get
  8307. Org mode content demoted to a specified level, as well as any options
  8308. accepted by the selected markup. For example, to include a file as an item,
  8309. use
  8310. @example
  8311. #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
  8312. @end example
  8313. You can also include a portion of a file by specifying a lines range using
  8314. the @code{:lines} parameter. The line at the upper end of the range will not
  8315. be included. The start and/or the end of the range may be omitted to use the
  8316. obvious defaults.
  8317. @example
  8318. #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
  8319. #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
  8320. #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
  8321. @end example
  8322. @table @kbd
  8323. @kindex C-c '
  8324. @item C-c '
  8325. Visit the include file at point.
  8326. @end table
  8327. @node Index entries, Macro replacement, Include files, Markup
  8328. @section Index entries
  8329. @cindex index entries, for publishing
  8330. You can specify entries that will be used for generating an index during
  8331. publishing. This is done by lines starting with @code{#+INDEX}. An entry
  8332. the contains an exclamation mark will create a sub item. See @ref{Generating
  8333. an index} for more information.
  8334. @example
  8335. * Curriculum Vitae
  8336. #+INDEX: CV
  8337. #+INDEX: Application!CV
  8338. @end example
  8339. @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
  8340. @section Macro replacement
  8341. @cindex macro replacement, during export
  8342. @cindex #+MACRO
  8343. You can define text snippets with
  8344. @example
  8345. #+MACRO: name replacement text $1, $2 are arguments
  8346. @end example
  8347. @noindent which can be referenced anywhere in the document (even in
  8348. code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
  8349. defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
  8350. will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
  8351. similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
  8352. @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
  8353. and to the modification time of the file being exported, respectively.
  8354. @var{FORMAT} should be a format string understood by
  8355. @code{format-time-string}.
  8356. Macro expansion takes place during export, and some people use it to
  8357. construct complex HTML code.
  8358. @node Embedded @LaTeX{}, , Macro replacement, Markup
  8359. @section Embedded @LaTeX{}
  8360. @cindex @TeX{} interpretation
  8361. @cindex @LaTeX{} interpretation
  8362. Plain ASCII is normally sufficient for almost all note taking. Exceptions
  8363. include scientific notes, which often require mathematical symbols and the
  8364. occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
  8365. Donald E. Knuth's @TeX{} system. Many of the features described here as
  8366. ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
  8367. distinction.} is widely used to typeset scientific documents. Org mode
  8368. supports embedding @LaTeX{} code into its files, because many academics are
  8369. used to writing and reading @LaTeX{} source code, and because it can be
  8370. readily processed to produce pretty output for a number of export backends.
  8371. @menu
  8372. * Special symbols:: Greek letters and other symbols
  8373. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  8374. * @LaTeX{} fragments:: Complex formulas made easy
  8375. * Previewing @LaTeX{} fragments:: What will this snippet look like?
  8376. * CDLaTeX mode:: Speed up entering of formulas
  8377. @end menu
  8378. @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
  8379. @subsection Special symbols
  8380. @cindex math symbols
  8381. @cindex special symbols
  8382. @cindex @TeX{} macros
  8383. @cindex @LaTeX{} fragments, markup rules
  8384. @cindex HTML entities
  8385. @cindex @LaTeX{} entities
  8386. You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
  8387. indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
  8388. for these macros is available, just type @samp{\} and maybe a few letters,
  8389. and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
  8390. code, Org mode allows these macros to be present without surrounding math
  8391. delimiters, for example:
  8392. @example
  8393. Angles are written as Greek letters \alpha, \beta and \gamma.
  8394. @end example
  8395. @vindex org-entities
  8396. During export, these symbols will be transformed into the native format of
  8397. the exporter backend. Strings like @code{\alpha} will be exported as
  8398. @code{&alpha;} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
  8399. output. Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
  8400. @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
  8401. like this: @samp{\Aacute@{@}stor}.
  8402. A large number of entities is provided, with names taken from both HTML and
  8403. @LaTeX{}; see the variable @code{org-entities} for the complete list.
  8404. @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
  8405. @samp{...} are all converted into special commands creating hyphens of
  8406. different lengths or a compact set of dots.
  8407. If you would like to see entities displayed as UTF8 characters, use the
  8408. following command@footnote{You can turn this on by default by setting the
  8409. variable @code{org-pretty-entities}, or on a per-file base with the
  8410. @code{#+STARTUP} option @code{entitiespretty}.}:
  8411. @table @kbd
  8412. @kindex C-c C-x \
  8413. @item C-c C-x \
  8414. Toggle display of entities as UTF-8 characters. This does not change the
  8415. buffer content which remains plain ASCII, but it overlays the UTF-8 character
  8416. for display purposes only.
  8417. @end table
  8418. @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
  8419. @subsection Subscripts and superscripts
  8420. @cindex subscript
  8421. @cindex superscript
  8422. Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
  8423. and subscripts. Again, these can be used without embedding them in
  8424. math-mode delimiters. To increase the readability of ASCII text, it is
  8425. not necessary (but OK) to surround multi-character sub- and superscripts
  8426. with curly braces. For example
  8427. @example
  8428. The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
  8429. the sun is R_@{sun@} = 6.96 x 10^8 m.
  8430. @end example
  8431. @vindex org-export-with-sub-superscripts
  8432. To avoid interpretation as raised or lowered text, you can quote @samp{^} and
  8433. @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
  8434. where the underscore is often used in a different context, Org's convention
  8435. to always interpret these as subscripts can get in your way. Configure the
  8436. variable @code{org-export-with-sub-superscripts} to globally change this
  8437. convention, or use, on a per-file basis:
  8438. @example
  8439. #+OPTIONS: ^:@{@}
  8440. @end example
  8441. @noindent With this setting, @samp{a_b} will not be interpreted as a
  8442. subscript, but @samp{a_@{b@}} will.
  8443. @table @kbd
  8444. @kindex C-c C-x \
  8445. @item C-c C-x \
  8446. In addition to showing entities as UTF-8 characters, this command will also
  8447. format sub- and superscripts in a WYSIWYM way.
  8448. @end table
  8449. @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
  8450. @subsection @LaTeX{} fragments
  8451. @cindex @LaTeX{} fragments
  8452. @vindex org-format-latex-header
  8453. Going beyond symbols and sub- and superscripts, a full formula language is
  8454. needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
  8455. to process these for several export backends. When exporting to @LaTeX{},
  8456. the code is obviously left as it is. When exporting to HTML, Org invokes the
  8457. @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
  8458. HTML export}) to process and display the math@footnote{If you plan to use
  8459. this regularly or on pages with significant page views, you should install
  8460. @file{MathJax} on your own
  8461. server in order to limit the load of our server.}. Finally, it can also
  8462. process the mathematical expressions into images@footnote{For this to work
  8463. you need to be on a system with a working @LaTeX{} installation. You also
  8464. need the @file{dvipng} program or the @file{convert}, respectively available
  8465. at @url{http://sourceforge.net/projects/dvipng/} and from the
  8466. @file{imagemagick} suite. The @LaTeX{} header that will be used when
  8467. processing a fragment can be configured with the variable
  8468. @code{org-format-latex-header}.} that can be displayed in a browser or in
  8469. DocBook documents.
  8470. @LaTeX{} fragments don't need any special marking at all. The following
  8471. snippets will be identified as @LaTeX{} source code:
  8472. @itemize @bullet
  8473. @item
  8474. Environments of any kind@footnote{When @file{MathJax} is used, only the
  8475. environment recognized by @file{MathJax} will be processed. When
  8476. @file{dvipng} is used to create images, any @LaTeX{} environments will be
  8477. handled.}. The only requirement is that the @code{\begin} statement appears
  8478. on a new line, preceded by only whitespace.
  8479. @item
  8480. Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
  8481. currency specifications, single @samp{$} characters are only recognized as
  8482. math delimiters if the enclosed text contains at most two line breaks, is
  8483. directly attached to the @samp{$} characters with no whitespace in between,
  8484. and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
  8485. For the other delimiters, there is no such restriction, so when in doubt, use
  8486. @samp{\(...\)} as inline math delimiters.
  8487. @end itemize
  8488. @noindent For example:
  8489. @example
  8490. \begin@{equation@} % arbitrary environments,
  8491. x=\sqrt@{b@} % even tables, figures
  8492. \end@{equation@} % etc
  8493. If $a^2=b$ and \( b=2 \), then the solution must be
  8494. either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
  8495. @end example
  8496. @noindent
  8497. @vindex org-format-latex-options
  8498. If you need any of the delimiter ASCII sequences for other purposes, you
  8499. can configure the option @code{org-format-latex-options} to deselect the
  8500. ones you do not wish to have interpreted by the @LaTeX{} converter.
  8501. @vindex org-export-with-LaTeX-fragments
  8502. @LaTeX{} processing can be configured with the variable
  8503. @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
  8504. which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
  8505. @LaTeX{} backends. You can also set this variable on a per-file basis using one
  8506. of these lines:
  8507. @example
  8508. #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
  8509. #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
  8510. #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
  8511. #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
  8512. @end example
  8513. @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
  8514. @subsection Previewing @LaTeX{} fragments
  8515. @cindex @LaTeX{} fragments, preview
  8516. If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
  8517. produce preview images of the typeset expressions:
  8518. @table @kbd
  8519. @kindex C-c C-x C-l
  8520. @item C-c C-x C-l
  8521. Produce a preview image of the @LaTeX{} fragment at point and overlay it
  8522. over the source code. If there is no fragment at point, process all
  8523. fragments in the current entry (between two headlines). When called
  8524. with a prefix argument, process the entire subtree. When called with
  8525. two prefix arguments, or when the cursor is before the first headline,
  8526. process the entire buffer.
  8527. @kindex C-c C-c
  8528. @item C-c C-c
  8529. Remove the overlay preview images.
  8530. @end table
  8531. @vindex org-format-latex-options
  8532. You can customize the variable @code{org-format-latex-options} to influence
  8533. some aspects of the preview. In particular, the @code{:scale} (and for HTML
  8534. export, @code{:html-scale}) property can be used to adjust the size of the
  8535. preview images.
  8536. @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
  8537. @subsection Using CD@LaTeX{} to enter math
  8538. @cindex CD@LaTeX{}
  8539. CD@LaTeX{} mode is a minor mode that is normally used in combination with a
  8540. major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
  8541. environments and math templates. Inside Org mode, you can make use of
  8542. some of the features of CD@LaTeX{} mode. You need to install
  8543. @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
  8544. AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
  8545. Don't use CD@LaTeX{} mode itself under Org mode, but use the light
  8546. version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
  8547. on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
  8548. Org files with
  8549. @lisp
  8550. (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
  8551. @end lisp
  8552. When this mode is enabled, the following features are present (for more
  8553. details see the documentation of CD@LaTeX{} mode):
  8554. @itemize @bullet
  8555. @kindex C-c @{
  8556. @item
  8557. Environment templates can be inserted with @kbd{C-c @{}.
  8558. @item
  8559. @kindex @key{TAB}
  8560. The @key{TAB} key will do template expansion if the cursor is inside a
  8561. @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
  8562. inside such a fragment, see the documentation of the function
  8563. @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
  8564. expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
  8565. correctly inside the first brace. Another @key{TAB} will get you into
  8566. the second brace. Even outside fragments, @key{TAB} will expand
  8567. environment abbreviations at the beginning of a line. For example, if
  8568. you write @samp{equ} at the beginning of a line and press @key{TAB},
  8569. this abbreviation will be expanded to an @code{equation} environment.
  8570. To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
  8571. @item
  8572. @kindex _
  8573. @kindex ^
  8574. @vindex cdlatex-simplify-sub-super-scripts
  8575. Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
  8576. characters together with a pair of braces. If you use @key{TAB} to move
  8577. out of the braces, and if the braces surround only a single character or
  8578. macro, they are removed again (depending on the variable
  8579. @code{cdlatex-simplify-sub-super-scripts}).
  8580. @item
  8581. @kindex `
  8582. Pressing the backquote @kbd{`} followed by a character inserts math
  8583. macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
  8584. after the backquote, a help window will pop up.
  8585. @item
  8586. @kindex '
  8587. Pressing the single-quote @kbd{'} followed by another character modifies
  8588. the symbol before point with an accent or a font. If you wait more than
  8589. 1.5 seconds after the single-quote, a help window will pop up. Character
  8590. modification will work only inside @LaTeX{} fragments; outside the quote
  8591. is normal.
  8592. @end itemize
  8593. @node Exporting, Publishing, Markup, Top
  8594. @chapter Exporting
  8595. @cindex exporting
  8596. Org mode documents can be exported into a variety of other formats. For
  8597. printing and sharing of notes, ASCII export produces a readable and simple
  8598. version of an Org file. HTML export allows you to publish a notes file on
  8599. the web, while the XOXO format provides a solid base for exchange with a
  8600. broad range of other applications. @LaTeX{} export lets you use Org mode and
  8601. its structured editing functions to easily create @LaTeX{} files. DocBook
  8602. export makes it possible to convert Org files to many other formats using
  8603. DocBook tools. OpenDocument Text (ODT) export allows seamless
  8604. collaboration across organizational boundaries. For project management you
  8605. can create gantt and resource charts by using TaskJuggler export. To
  8606. incorporate entries with associated times like deadlines or appointments into
  8607. a desktop calendar program like iCal, Org mode can also produce extracts in
  8608. the iCalendar format. Currently, Org mode only supports export, not import of
  8609. these different formats.
  8610. Org supports export of selected regions when @code{transient-mark-mode} is
  8611. enabled (default in Emacs 23).
  8612. @menu
  8613. * Selective export:: Using tags to select and exclude trees
  8614. * Export options:: Per-file export settings
  8615. * The export dispatcher:: How to access exporter commands
  8616. * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
  8617. * HTML export:: Exporting to HTML
  8618. * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
  8619. * DocBook export:: Exporting to DocBook
  8620. * OpenDocument Text export:: Exporting to OpenDocument Text
  8621. * TaskJuggler export:: Exporting to TaskJuggler
  8622. * Freemind export:: Exporting to Freemind mind maps
  8623. * XOXO export:: Exporting to XOXO
  8624. * iCalendar export:: Exporting in iCalendar format
  8625. @end menu
  8626. @node Selective export, Export options, Exporting, Exporting
  8627. @section Selective export
  8628. @cindex export, selective by tags or TODO keyword
  8629. @vindex org-export-select-tags
  8630. @vindex org-export-exclude-tags
  8631. @cindex org-export-with-tasks
  8632. You may use tags to select the parts of a document that should be exported,
  8633. or to exclude parts from export. This behavior is governed by two variables:
  8634. @code{org-export-select-tags} and @code{org-export-exclude-tags},
  8635. respectively defaulting to @code{'(:export:)} and @code{'(:noexport:)}.
  8636. @enumerate
  8637. @item
  8638. Org first checks if any of the @emph{select} tags is present in the
  8639. buffer. If yes, all trees that do not carry one of these tags will be
  8640. excluded. If a selected tree is a subtree, the heading hierarchy above it
  8641. will also be selected for export, but not the text below those headings.
  8642. @item
  8643. If none of the select tags is found, the whole buffer will be selected for
  8644. export.
  8645. @item
  8646. Finally, all subtrees that are marked by any of the @emph{exclude} tags will
  8647. be removed from the export buffer.
  8648. @end enumerate
  8649. The variable @code{org-export-with-tasks} can be configured to select which
  8650. kind of tasks should be included for export. See the docstring of the
  8651. variable for more information.
  8652. @node Export options, The export dispatcher, Selective export, Exporting
  8653. @section Export options
  8654. @cindex options, for export
  8655. @cindex completion, of option keywords
  8656. The exporter recognizes special lines in the buffer which provide
  8657. additional information. These lines may be put anywhere in the file.
  8658. The whole set of lines can be inserted into the buffer with @kbd{C-c
  8659. C-e t}. For individual lines, a good way to make sure the keyword is
  8660. correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
  8661. (@pxref{Completion}). For a summary of other in-buffer settings not
  8662. specifically related to export, see @ref{In-buffer settings}.
  8663. In particular, note that you can place commonly-used (export) options in
  8664. a separate file which can be included using @code{#+SETUPFILE}.
  8665. @table @kbd
  8666. @orgcmd{C-c C-e t,org-insert-export-options-template}
  8667. Insert template with export options, see example below.
  8668. @end table
  8669. @cindex #+TITLE
  8670. @cindex #+AUTHOR
  8671. @cindex #+DATE
  8672. @cindex #+EMAIL
  8673. @cindex #+DESCRIPTION
  8674. @cindex #+KEYWORDS
  8675. @cindex #+LANGUAGE
  8676. @cindex #+TEXT
  8677. @cindex #+OPTIONS
  8678. @cindex #+BIND
  8679. @cindex #+LINK_UP
  8680. @cindex #+LINK_HOME
  8681. @cindex #+EXPORT_SELECT_TAGS
  8682. @cindex #+EXPORT_EXCLUDE_TAGS
  8683. @cindex #+XSLT
  8684. @cindex #+LaTeX_HEADER
  8685. @vindex user-full-name
  8686. @vindex user-mail-address
  8687. @vindex org-export-default-language
  8688. @vindex org-export-date-timestamp-format
  8689. @example
  8690. #+TITLE: the title to be shown (default is the buffer name)
  8691. #+AUTHOR: the author (default taken from @code{user-full-name})
  8692. #+DATE: a date, an Org timestamp@footnote{@code{org-export-date-timestamp-format} defines how this timestamp will be exported.}, or a format string for @code{format-time-string}
  8693. #+EMAIL: his/her email address (default from @code{user-mail-address})
  8694. #+DESCRIPTION: the page description, e.g., for the XHTML meta tag
  8695. #+KEYWORDS: the page keywords, e.g., for the XHTML meta tag
  8696. #+LANGUAGE: language for HTML, e.g., @samp{en} (@code{org-export-default-language})
  8697. #+TEXT: Some descriptive text to be inserted at the beginning.
  8698. #+TEXT: Several lines may be given.
  8699. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
  8700. #+BIND: lisp-var lisp-val, e.g., @code{org-export-latex-low-levels itemize}
  8701. @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
  8702. #+LINK_UP: the ``up'' link of an exported page
  8703. #+LINK_HOME: the ``home'' link of an exported page
  8704. #+LaTeX_HEADER: extra line(s) for the @LaTeX{} header, like \usepackage@{xyz@}
  8705. #+EXPORT_SELECT_TAGS: Tags that select a tree for export
  8706. #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
  8707. #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
  8708. @end example
  8709. @noindent
  8710. The @code{#+OPTIONS} line is a compact@footnote{If you want to configure many options
  8711. this way, you can use several @code{#+OPTIONS} lines.} form to specify export
  8712. settings. Here you can:
  8713. @cindex headline levels
  8714. @cindex section-numbers
  8715. @cindex table of contents
  8716. @cindex line-break preservation
  8717. @cindex quoted HTML tags
  8718. @cindex fixed-width sections
  8719. @cindex tables
  8720. @cindex @TeX{}-like syntax for sub- and superscripts
  8721. @cindex footnotes
  8722. @cindex special strings
  8723. @cindex emphasized text
  8724. @cindex @TeX{} macros
  8725. @cindex @LaTeX{} fragments
  8726. @cindex author info, in export
  8727. @cindex time info, in export
  8728. @vindex org-export-plist-vars
  8729. @vindex org-export-author-info
  8730. @vindex org-export-creator-info
  8731. @vindex org-export-email-info
  8732. @vindex org-export-time-stamp-file
  8733. @example
  8734. H: @r{set the number of headline levels for export}
  8735. num: @r{turn on/off section-numbers}
  8736. toc: @r{turn on/off table of contents, or set level limit (integer)}
  8737. \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
  8738. @@: @r{turn on/off quoted HTML tags}
  8739. :: @r{turn on/off fixed-width sections}
  8740. |: @r{turn on/off tables}
  8741. ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
  8742. @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
  8743. @r{the simple @code{a_b} will be left as it is.}
  8744. -: @r{turn on/off conversion of special strings.}
  8745. f: @r{turn on/off footnotes like this[1].}
  8746. todo: @r{turn on/off inclusion of TODO keywords into exported text}
  8747. tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
  8748. @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
  8749. pri: @r{turn on/off priority cookies}
  8750. tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
  8751. <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
  8752. *: @r{turn on/off emphasized text (bold, italic, underlined)}
  8753. TeX: @r{turn on/off simple @TeX{} macros in plain text}
  8754. LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
  8755. skip: @r{turn on/off skipping the text before the first heading}
  8756. author: @r{turn on/off inclusion of author name/email into exported file}
  8757. email: @r{turn on/off inclusion of author email into exported file}
  8758. creator: @r{turn on/off inclusion of creator info into exported file}
  8759. timestamp: @r{turn on/off inclusion creation time into exported file}
  8760. d: @r{turn on/off inclusion of drawers, or list drawers to include}
  8761. @end example
  8762. @noindent
  8763. These options take effect in both the HTML and @LaTeX{} export, except for
  8764. @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
  8765. @code{nil} for the @LaTeX{} export.
  8766. The default values for these and many other options are given by a set of
  8767. variables. For a list of such variables, the corresponding OPTIONS keys and
  8768. also the publishing keys (@pxref{Project alist}), see the constant
  8769. @code{org-export-plist-vars}.
  8770. When exporting only a single subtree by selecting it with @kbd{C-c @@} before
  8771. calling an export command, the subtree can overrule some of the file's export
  8772. settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
  8773. @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
  8774. @code{EXPORT_OPTIONS}.
  8775. @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
  8776. @section The export dispatcher
  8777. @cindex dispatcher, for export commands
  8778. All export commands can be reached using the export dispatcher, which is a
  8779. prefix key that prompts for an additional key specifying the command.
  8780. Normally the entire file is exported, but if there is an active region that
  8781. contains one outline tree, the first heading is used as document title and
  8782. the subtrees are exported.
  8783. @table @kbd
  8784. @orgcmd{C-c C-e,org-export}
  8785. @vindex org-export-run-in-background
  8786. Dispatcher for export and publishing commands. Displays a help-window
  8787. listing the additional key(s) needed to launch an export or publishing
  8788. command. The prefix arg is passed through to the exporter. A double prefix
  8789. @kbd{C-u C-u} causes most commands to be executed in the background, in a
  8790. separate Emacs process@footnote{To make this behavior the default, customize
  8791. the variable @code{org-export-run-in-background}.}.
  8792. @orgcmd{C-c C-e v,org-export-visible}
  8793. Like @kbd{C-c C-e}, but only export the text that is currently visible
  8794. (i.e., not hidden by outline visibility).
  8795. @orgcmd{C-u C-u C-c C-e,org-export}
  8796. @vindex org-export-run-in-background
  8797. Call the exporter, but reverse the setting of
  8798. @code{org-export-run-in-background}, i.e., request background processing if
  8799. not set, or force processing in the current Emacs process if set.
  8800. @end table
  8801. @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
  8802. @section ASCII/Latin-1/UTF-8 export
  8803. @cindex ASCII export
  8804. @cindex Latin-1 export
  8805. @cindex UTF-8 export
  8806. ASCII export produces a simple and very readable version of an Org mode
  8807. file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
  8808. with special characters and symbols available in these encodings.
  8809. @cindex region, active
  8810. @cindex active region
  8811. @cindex transient-mark-mode
  8812. @table @kbd
  8813. @orgcmd{C-c C-e a,org-export-as-ascii}
  8814. @cindex property, EXPORT_FILE_NAME
  8815. Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
  8816. will be @file{myfile.txt}. The file will be overwritten without
  8817. warning. If there is an active region@footnote{This requires
  8818. @code{transient-mark-mode} be turned on.}, only the region will be
  8819. exported. If the selected region is a single tree@footnote{To select the
  8820. current subtree, use @kbd{C-c @@}.}, the tree head will
  8821. become the document title. If the tree head entry has or inherits an
  8822. @code{EXPORT_FILE_NAME} property, that name will be used for the
  8823. export.
  8824. @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
  8825. Export to a temporary buffer. Do not create a file.
  8826. @orgcmd{C-c C-e n,org-export-as-latin1}
  8827. @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
  8828. Like the above commands, but use Latin-1 encoding.
  8829. @orgcmd{C-c C-e u,org-export-as-utf8}
  8830. @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
  8831. Like the above commands, but use UTF-8 encoding.
  8832. @item C-c C-e v a/n/u
  8833. Export only the visible part of the document.
  8834. @end table
  8835. @cindex headline levels, for exporting
  8836. In the exported version, the first 3 outline levels will become
  8837. headlines, defining a general document structure. Additional levels
  8838. will be exported as itemized lists. If you want that transition to occur
  8839. at a different level, specify it with a prefix argument. For example,
  8840. @example
  8841. @kbd{C-1 C-c C-e a}
  8842. @end example
  8843. @noindent
  8844. creates only top level headlines and exports the rest as items. When
  8845. headlines are converted to items, the indentation of the text following
  8846. the headline is changed to fit nicely under the item. This is done with
  8847. the assumption that the first body line indicates the base indentation of
  8848. the body text. Any indentation larger than this is adjusted to preserve
  8849. the layout relative to the first line. Should there be lines with less
  8850. indentation than the first one, these are left alone.
  8851. @vindex org-export-ascii-links-to-notes
  8852. Links will be exported in a footnote-like style, with the descriptive part in
  8853. the text and the link in a note before the next heading. See the variable
  8854. @code{org-export-ascii-links-to-notes} for details and other options.
  8855. @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
  8856. @section HTML export
  8857. @cindex HTML export
  8858. Org mode contains a HTML (XHTML 1.0 strict) exporter with extensive
  8859. HTML formatting, in ways similar to John Gruber's @emph{markdown}
  8860. language, but with additional support for tables.
  8861. @menu
  8862. * HTML Export commands:: How to invoke HTML export
  8863. * HTML preamble and postamble:: How to insert a preamble and a postamble
  8864. * Quoting HTML tags:: Using direct HTML in Org mode
  8865. * Links in HTML export:: How links will be interpreted and formatted
  8866. * Tables in HTML export:: How to modify the formatting of tables
  8867. * Images in HTML export:: How to insert figures into HTML output
  8868. * Math formatting in HTML export:: Beautiful math also on the web
  8869. * Text areas in HTML export:: An alternative way to show an example
  8870. * CSS support:: Changing the appearance of the output
  8871. * JavaScript support:: Info and Folding in a web browser
  8872. @end menu
  8873. @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
  8874. @subsection HTML export commands
  8875. @cindex region, active
  8876. @cindex active region
  8877. @cindex transient-mark-mode
  8878. @table @kbd
  8879. @orgcmd{C-c C-e h,org-export-as-html}
  8880. @cindex property, EXPORT_FILE_NAME
  8881. Export as a HTML file. For an Org file @file{myfile.org},
  8882. the HTML file will be @file{myfile.html}. The file will be overwritten
  8883. without warning. If there is an active region@footnote{This requires
  8884. @code{transient-mark-mode} be turned on.}, only the region will be
  8885. exported. If the selected region is a single tree@footnote{To select the
  8886. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  8887. title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
  8888. property, that name will be used for the export.
  8889. @orgcmd{C-c C-e b,org-export-as-html-and-open}
  8890. Export as a HTML file and immediately open it with a browser.
  8891. @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
  8892. Export to a temporary buffer. Do not create a file.
  8893. @orgcmd{C-c C-e R,org-export-region-as-html}
  8894. Export the active region to a temporary buffer. With a prefix argument, do
  8895. not produce the file header and footer, but just the plain HTML section for
  8896. the region. This is good for cut-and-paste operations.
  8897. @item C-c C-e v h/b/H/R
  8898. Export only the visible part of the document.
  8899. @item M-x org-export-region-as-html
  8900. Convert the region to HTML under the assumption that it was in Org mode
  8901. syntax before. This is a global command that can be invoked in any
  8902. buffer.
  8903. @item M-x org-replace-region-by-HTML
  8904. Replace the active region (assumed to be in Org mode syntax) by HTML
  8905. code.
  8906. @end table
  8907. @cindex headline levels, for exporting
  8908. In the exported version, the first 3 outline levels will become headlines,
  8909. defining a general document structure. Additional levels will be exported as
  8910. itemized lists. If you want that transition to occur at a different level,
  8911. specify it with a numeric prefix argument. For example,
  8912. @example
  8913. @kbd{C-2 C-c C-e b}
  8914. @end example
  8915. @noindent
  8916. creates two levels of headings and does the rest as items.
  8917. @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
  8918. @subsection HTML preamble and postamble
  8919. @vindex org-export-html-preamble
  8920. @vindex org-export-html-postamble
  8921. @vindex org-export-html-preamble-format
  8922. @vindex org-export-html-postamble-format
  8923. @vindex org-export-html-validation-link
  8924. @vindex org-export-author-info
  8925. @vindex org-export-email-info
  8926. @vindex org-export-creator-info
  8927. @vindex org-export-time-stamp-file
  8928. The HTML exporter lets you define a preamble and a postamble.
  8929. The default value for @code{org-export-html-preamble} is @code{t}, which
  8930. means that the preamble is inserted depending on the relevant format string
  8931. in @code{org-export-html-preamble-format}.
  8932. Setting @code{org-export-html-preamble} to a string will override the default
  8933. format string. Setting it to a function, will insert the output of the
  8934. function, which must be a string; such a function takes no argument but you
  8935. can check against the value of @code{opt-plist}, which contains the list of
  8936. publishing properties for the current file. Setting to @code{nil} will not
  8937. insert any preamble.
  8938. The default value for @code{org-export-html-postamble} is @code{'auto}, which
  8939. means that the HTML exporter will look for the value of
  8940. @code{org-export-author-info}, @code{org-export-email-info},
  8941. @code{org-export-creator-info} and @code{org-export-time-stamp-file},
  8942. @code{org-export-html-validation-link} and build the postamble from these
  8943. values. Setting @code{org-export-html-postamble} to @code{t} will insert the
  8944. postamble from the relevant format string found in
  8945. @code{org-export-html-postamble-format}. Setting it to @code{nil} will not
  8946. insert any postamble.
  8947. @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
  8948. @subsection Quoting HTML tags
  8949. Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
  8950. @samp{&gt;} in HTML export. If you want to include simple HTML tags
  8951. which should be interpreted as such, mark them with @samp{@@} as in
  8952. @samp{@@<b>bold text@@</b>}. Note that this really works only for
  8953. simple tags. For more extensive HTML that should be copied verbatim to
  8954. the exported file use either
  8955. @cindex #+HTML
  8956. @cindex #+BEGIN_HTML
  8957. @example
  8958. #+HTML: Literal HTML code for export
  8959. @end example
  8960. @noindent or
  8961. @cindex #+BEGIN_HTML
  8962. @example
  8963. #+BEGIN_HTML
  8964. All lines between these markers are exported literally
  8965. #+END_HTML
  8966. @end example
  8967. @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
  8968. @subsection Links in HTML export
  8969. @cindex links, in HTML export
  8970. @cindex internal links, in HTML export
  8971. @cindex external links, in HTML export
  8972. Internal links (@pxref{Internal links}) will continue to work in HTML@. This
  8973. includes automatic links created by radio targets (@pxref{Radio
  8974. targets}). Links to external files will still work if the target file is on
  8975. the same @i{relative} path as the published Org file. Links to other
  8976. @file{.org} files will be translated into HTML links under the assumption
  8977. that a HTML version also exists of the linked file, at the same relative
  8978. path. @samp{id:} links can then be used to jump to specific entries across
  8979. files. For information related to linking files while publishing them to a
  8980. publishing directory see @ref{Publishing links}.
  8981. If you want to specify attributes for links, you can do so using a special
  8982. @code{#+ATTR_HTML} line to define attributes that will be added to the
  8983. @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
  8984. and @code{style} attributes for a link:
  8985. @cindex #+ATTR_HTML
  8986. @example
  8987. #+ATTR_HTML: title="The Org mode homepage" style="color:red;"
  8988. [[http://orgmode.org]]
  8989. @end example
  8990. @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
  8991. @subsection Tables
  8992. @cindex tables, in HTML
  8993. @vindex org-export-html-table-tag
  8994. Org mode tables are exported to HTML using the table tag defined in
  8995. @code{org-export-html-table-tag}. The default setting makes tables without
  8996. cell borders and frame. If you would like to change this for individual
  8997. tables, place something like the following before the table:
  8998. @cindex #+CAPTION
  8999. @cindex #+ATTR_HTML
  9000. @example
  9001. #+CAPTION: This is a table with lines around and between cells
  9002. #+ATTR_HTML: border="2" rules="all" frame="border"
  9003. @end example
  9004. @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
  9005. @subsection Images in HTML export
  9006. @cindex images, inline in HTML
  9007. @cindex inlining images in HTML
  9008. @vindex org-export-html-inline-images
  9009. HTML export can inline images given as links in the Org file, and
  9010. it can make an image the clickable part of a link. By
  9011. default@footnote{But see the variable
  9012. @code{org-export-html-inline-images}.}, images are inlined if a link does
  9013. not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
  9014. while @samp{[[file:myimg.jpg][the image]]} will just produce a link
  9015. @samp{the image} that points to the image. If the description part
  9016. itself is a @code{file:} link or a @code{http:} URL pointing to an
  9017. image, this image will be inlined and activated so that clicking on the
  9018. image will activate the link. For example, to include a thumbnail that
  9019. will link to a high resolution version of the image, you could use:
  9020. @example
  9021. [[file:highres.jpg][file:thumb.jpg]]
  9022. @end example
  9023. If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
  9024. In the example below we specify the @code{alt} and @code{title} attributes to
  9025. support text viewers and accessibility, and align it to the right.
  9026. @cindex #+CAPTION
  9027. @cindex #+ATTR_HTML
  9028. @example
  9029. #+CAPTION: A black cat stalking a spider
  9030. #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
  9031. [[./img/a.jpg]]
  9032. @end example
  9033. @noindent
  9034. You could use @code{http} addresses just as well.
  9035. @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
  9036. @subsection Math formatting in HTML export
  9037. @cindex MathJax
  9038. @cindex dvipng
  9039. @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
  9040. different ways on HTML pages. The default is to use the
  9041. @uref{http://www.mathjax.org, MathJax system} which should work out of the
  9042. box with Org mode installation because @code{http://orgmode.org} serves
  9043. @file{MathJax} for Org mode users for small applications and for testing
  9044. purposes. @b{If you plan to use this regularly or on pages with significant
  9045. page views, you should install@footnote{Installation instructions can be
  9046. found on the MathJax website, see
  9047. @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
  9048. your own server in order to limit the load of our server.} To configure
  9049. @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
  9050. insert something like the following into the buffer:
  9051. @example
  9052. #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
  9053. @end example
  9054. @noindent See the docstring of the variable
  9055. @code{org-export-html-mathjax-options} for the meaning of the parameters in
  9056. this line.
  9057. If you prefer, you can also request that @LaTeX{} fragments are processed
  9058. into small images that will be inserted into the browser page. Before the
  9059. availability of MathJax, this was the default method for Org files. This
  9060. method requires that the @file{dvipng} program is available on your system.
  9061. You can still get this processing with
  9062. @example
  9063. #+OPTIONS: LaTeX:dvipng
  9064. @end example
  9065. @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
  9066. @subsection Text areas in HTML export
  9067. @cindex text areas, in HTML
  9068. An alternative way to publish literal code examples in HTML is to use text
  9069. areas, where the example can even be edited before pasting it into an
  9070. application. It is triggered by a @code{-t} switch at an @code{example} or
  9071. @code{src} block. Using this switch disables any options for syntax and
  9072. label highlighting, and line numbering, which may be present. You may also
  9073. use @code{-h} and @code{-w} switches to specify the height and width of the
  9074. text area, which default to the number of lines in the example, and 80,
  9075. respectively. For example
  9076. @example
  9077. #+BEGIN_EXAMPLE -t -w 40
  9078. (defun org-xor (a b)
  9079. "Exclusive or."
  9080. (if a (not b) b))
  9081. #+END_EXAMPLE
  9082. @end example
  9083. @node CSS support, JavaScript support, Text areas in HTML export, HTML export
  9084. @subsection CSS support
  9085. @cindex CSS, for HTML export
  9086. @cindex HTML export, CSS
  9087. @vindex org-export-html-todo-kwd-class-prefix
  9088. @vindex org-export-html-tag-class-prefix
  9089. You can also give style information for the exported file. The HTML exporter
  9090. assigns the following special CSS classes@footnote{If the classes on TODO
  9091. keywords and tags lead to conflicts, use the variables
  9092. @code{org-export-html-todo-kwd-class-prefix} and
  9093. @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
  9094. parts of the document---your style specifications may change these, in
  9095. addition to any of the standard classes like for headlines, tables, etc.
  9096. @example
  9097. p.author @r{author information, including email}
  9098. p.date @r{publishing date}
  9099. p.creator @r{creator info, about org mode version}
  9100. .title @r{document title}
  9101. .todo @r{TODO keywords, all not-done states}
  9102. .done @r{the DONE keywords, all states that count as done}
  9103. .WAITING @r{each TODO keyword also uses a class named after itself}
  9104. .timestamp @r{timestamp}
  9105. .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
  9106. .timestamp-wrapper @r{span around keyword plus timestamp}
  9107. .tag @r{tag in a headline}
  9108. ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
  9109. .target @r{target for links}
  9110. .linenr @r{the line number in a code example}
  9111. .code-highlighted @r{for highlighting referenced code lines}
  9112. div.outline-N @r{div for outline level N (headline plus text))}
  9113. div.outline-text-N @r{extra div for text at outline level N}
  9114. .section-number-N @r{section number in headlines, different for each level}
  9115. div.figure @r{how to format an inlined image}
  9116. pre.src @r{formatted source code}
  9117. pre.example @r{normal example}
  9118. p.verse @r{verse paragraph}
  9119. div.footnotes @r{footnote section headline}
  9120. p.footnote @r{footnote definition paragraph, containing a footnote}
  9121. .footref @r{a footnote reference number (always a <sup>)}
  9122. .footnum @r{footnote number in footnote definition (always <sup>)}
  9123. @end example
  9124. @vindex org-export-html-style-default
  9125. @vindex org-export-html-style-include-default
  9126. @vindex org-export-html-style
  9127. @vindex org-export-html-extra
  9128. @vindex org-export-html-style-default
  9129. Each exported file contains a compact default style that defines these
  9130. classes in a basic way@footnote{This style is defined in the constant
  9131. @code{org-export-html-style-default}, which you should not modify. To turn
  9132. inclusion of these defaults off, customize
  9133. @code{org-export-html-style-include-default}}. You may overwrite these
  9134. settings, or add to them by using the variables @code{org-export-html-style}
  9135. (for Org-wide settings) and @code{org-export-html-style-extra} (for more
  9136. fine-grained settings, like file-local settings). To set the latter variable
  9137. individually for each file, you can use
  9138. @cindex #+STYLE
  9139. @example
  9140. #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  9141. @end example
  9142. @noindent
  9143. For longer style definitions, you can use several such lines. You could also
  9144. directly write a @code{<style>} @code{</style>} section in this way, without
  9145. referring to an external file.
  9146. In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
  9147. property to assign a class to the tree. In order to specify CSS styles for a
  9148. particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
  9149. property.
  9150. @c FIXME: More about header and footer styles
  9151. @c FIXME: Talk about links and targets.
  9152. @node JavaScript support, , CSS support, HTML export
  9153. @subsection JavaScript supported display of web pages
  9154. @cindex Rose, Sebastian
  9155. Sebastian Rose has written a JavaScript program especially designed to
  9156. enhance the web viewing experience of HTML files created with Org. This
  9157. program allows you to view large files in two different ways. The first one
  9158. is an @emph{Info}-like mode where each section is displayed separately and
  9159. navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
  9160. as well, press @kbd{?} for an overview of the available keys). The second
  9161. view type is a @emph{folding} view much like Org provides inside Emacs. The
  9162. script is available at @url{http://orgmode.org/org-info.js} and you can find
  9163. the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
  9164. We host the script at our site, but if you use it a lot, you might
  9165. not want to be dependent on @url{orgmode.org} and prefer to install a local
  9166. copy on your own web server.
  9167. To use the script, you need to make sure that the @file{org-jsinfo.el} module
  9168. gets loaded. It should be loaded by default, but you can try @kbd{M-x
  9169. customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
  9170. this is indeed the case. All it then takes to make use of the program is
  9171. adding a single line to the Org file:
  9172. @cindex #+INFOJS_OPT
  9173. @example
  9174. #+INFOJS_OPT: view:info toc:nil
  9175. @end example
  9176. @noindent
  9177. If this line is found, the HTML header will automatically contain the code
  9178. needed to invoke the script. Using the line above, you can set the following
  9179. viewing options:
  9180. @example
  9181. path: @r{The path to the script. The default is to grab the script from}
  9182. @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
  9183. @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
  9184. view: @r{Initial view when the website is first shown. Possible values are:}
  9185. info @r{Info-like interface with one section per page.}
  9186. overview @r{Folding interface, initially showing only top-level.}
  9187. content @r{Folding interface, starting with all headlines visible.}
  9188. showall @r{Folding interface, all headlines and text visible.}
  9189. sdepth: @r{Maximum headline level that will still become an independent}
  9190. @r{section for info and folding modes. The default is taken from}
  9191. @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
  9192. @r{If this is smaller than in @code{org-export-headline-levels}, each}
  9193. @r{info/folding section can still contain child headlines.}
  9194. toc: @r{Should the table of contents @emph{initially} be visible?}
  9195. @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
  9196. tdepth: @r{The depth of the table of contents. The defaults are taken from}
  9197. @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
  9198. ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
  9199. @r{If yes, the toc will never be displayed as a section.}
  9200. ltoc: @r{Should there be short contents (children) in each section?}
  9201. @r{Make this @code{above} if the section should be above initial text.}
  9202. mouse: @r{Headings are highlighted when the mouse is over them. Should be}
  9203. @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
  9204. buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
  9205. @r{default), only one such button will be present.}
  9206. @end example
  9207. @noindent
  9208. @vindex org-infojs-options
  9209. @vindex org-export-html-use-infojs
  9210. You can choose default values for these options by customizing the variable
  9211. @code{org-infojs-options}. If you always want to apply the script to your
  9212. pages, configure the variable @code{org-export-html-use-infojs}.
  9213. @node @LaTeX{} and PDF export, DocBook export, HTML export, Exporting
  9214. @section @LaTeX{} and PDF export
  9215. @cindex @LaTeX{} export
  9216. @cindex PDF export
  9217. @cindex Guerry, Bastien
  9218. Org mode contains a @LaTeX{} exporter written by Bastien Guerry. With
  9219. further processing@footnote{The default @LaTeX{} output is designed for
  9220. processing with @code{pdftex} or @LaTeX{}. It includes packages that are not
  9221. compatible with @code{xetex} and possibly @code{luatex}. See the variables
  9222. @code{org-export-latex-default-packages-alist} and
  9223. @code{org-export-latex-packages-alist}.}, this backend is also used to
  9224. produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
  9225. implement links and cross references, the PDF output file will be fully
  9226. linked. Beware of the fact that your @code{org} file has to be properly
  9227. structured in order to be correctly exported: respect the hierarchy of
  9228. sections.
  9229. @menu
  9230. * @LaTeX{}/PDF export commands::
  9231. * Header and sectioning:: Setting up the export file structure
  9232. * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
  9233. * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
  9234. * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
  9235. * Beamer class export:: Turning the file into a presentation
  9236. @end menu
  9237. @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
  9238. @subsection @LaTeX{} export commands
  9239. @cindex region, active
  9240. @cindex active region
  9241. @cindex transient-mark-mode
  9242. @table @kbd
  9243. @orgcmd{C-c C-e l,org-export-as-latex}
  9244. @cindex property EXPORT_FILE_NAME
  9245. Export as a @LaTeX{} file. For an Org file
  9246. @file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will
  9247. be overwritten without warning. If there is an active region@footnote{This
  9248. requires @code{transient-mark-mode} be turned on.}, only the region will be
  9249. exported. If the selected region is a single tree@footnote{To select the
  9250. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  9251. title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
  9252. property, that name will be used for the export.
  9253. @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
  9254. Export to a temporary buffer. Do not create a file.
  9255. @item C-c C-e v l/L
  9256. Export only the visible part of the document.
  9257. @item M-x org-export-region-as-latex
  9258. Convert the region to @LaTeX{} under the assumption that it was in Org mode
  9259. syntax before. This is a global command that can be invoked in any
  9260. buffer.
  9261. @item M-x org-replace-region-by-latex
  9262. Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
  9263. code.
  9264. @orgcmd{C-c C-e p,org-export-as-pdf}
  9265. Export as @LaTeX{} and then process to PDF.
  9266. @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
  9267. Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
  9268. @end table
  9269. @cindex headline levels, for exporting
  9270. @vindex org-latex-low-levels
  9271. In the exported version, the first 3 outline levels will become
  9272. headlines, defining a general document structure. Additional levels
  9273. will be exported as description lists. The exporter can ignore them or
  9274. convert them to a custom string depending on
  9275. @code{org-latex-low-levels}.
  9276. If you want that transition to occur at a different level, specify it
  9277. with a numeric prefix argument. For example,
  9278. @example
  9279. @kbd{C-2 C-c C-e l}
  9280. @end example
  9281. @noindent
  9282. creates two levels of headings and does the rest as items.
  9283. @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
  9284. @subsection Header and sectioning structure
  9285. @cindex @LaTeX{} class
  9286. @cindex @LaTeX{} sectioning structure
  9287. @cindex @LaTeX{} header
  9288. @cindex header, for @LaTeX{} files
  9289. @cindex sectioning structure, for @LaTeX{} export
  9290. By default, the @LaTeX{} output uses the class @code{article}.
  9291. @vindex org-export-latex-default-class
  9292. @vindex org-export-latex-classes
  9293. @vindex org-export-latex-default-packages-alist
  9294. @vindex org-export-latex-packages-alist
  9295. @cindex #+LaTeX_HEADER
  9296. @cindex #+LaTeX_CLASS
  9297. @cindex #+LaTeX_CLASS_OPTIONS
  9298. @cindex property, LaTeX_CLASS
  9299. @cindex property, LaTeX_CLASS_OPTIONS
  9300. You can change this globally by setting a different value for
  9301. @code{org-export-latex-default-class} or locally by adding an option like
  9302. @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
  9303. property that applies when exporting a region containing only this (sub)tree.
  9304. The class must be listed in @code{org-export-latex-classes}. This variable
  9305. defines a header template for each class@footnote{Into which the values of
  9306. @code{org-export-latex-default-packages-alist} and
  9307. @code{org-export-latex-packages-alist} are spliced.}, and allows you to
  9308. define the sectioning structure for each class. You can also define your own
  9309. classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{:LaTeX_CLASS_OPTIONS:}
  9310. property can specify the options for the @code{\documentclass} macro. The
  9311. options to documentclass have to be provided, as expected by @LaTeX{}, within
  9312. square brackets. You can also use @code{#+LaTeX_HEADER: \usepackage@{xyz@}}
  9313. to add lines to the header. See the docstring of
  9314. @code{org-export-latex-classes} for more information. An example is shown
  9315. below.
  9316. @example
  9317. #+LaTeX_CLASS: article
  9318. #+LaTeX_CLASS_OPTIONS: [a4paper]
  9319. #+LaTeX_HEADER: \usepackage@{xyz@}
  9320. * Headline 1
  9321. some text
  9322. @end example
  9323. @node Quoting @LaTeX{} code, Tables in @LaTeX{} export, Header and sectioning, @LaTeX{} and PDF export
  9324. @subsection Quoting @LaTeX{} code
  9325. Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
  9326. inserted into the @LaTeX{} file. This includes simple macros like
  9327. @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
  9328. you can add special code that should only be present in @LaTeX{} export with
  9329. the following constructs:
  9330. @cindex #+LaTeX
  9331. @cindex #+BEGIN_LaTeX
  9332. @example
  9333. #+LaTeX: Literal @LaTeX{} code for export
  9334. @end example
  9335. @noindent or
  9336. @cindex #+BEGIN_LaTeX
  9337. @example
  9338. #+BEGIN_LaTeX
  9339. All lines between these markers are exported literally
  9340. #+END_LaTeX
  9341. @end example
  9342. @node Tables in @LaTeX{} export, Images in @LaTeX{} export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
  9343. @subsection Tables in @LaTeX{} export
  9344. @cindex tables, in @LaTeX{} export
  9345. For @LaTeX{} export of a table, you can specify a label, a caption and
  9346. placement options (@pxref{Images and tables}). You can also use the
  9347. @code{ATTR_LaTeX} line to request a @code{longtable} environment for the
  9348. table, so that it may span several pages, or to change the default table
  9349. environment from @code{table} to @code{table*} or to change the default inner
  9350. tabular environment to @code{tabularx} or @code{tabulary}. Finally, you can
  9351. set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
  9352. width:
  9353. @cindex #+CAPTION
  9354. @cindex #+LABEL
  9355. @cindex #+ATTR_LaTeX
  9356. @example
  9357. #+CAPTION: A long table
  9358. #+LABEL: tbl:long
  9359. #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
  9360. | ..... | ..... |
  9361. | ..... | ..... |
  9362. @end example
  9363. or to specify a multicolumn table with @code{tabulary}
  9364. @cindex #+CAPTION
  9365. @cindex #+LABEL
  9366. @cindex #+ATTR_LaTeX
  9367. @example
  9368. #+CAPTION: A wide table with tabulary
  9369. #+LABEL: tbl:wide
  9370. #+ATTR_LaTeX: table* tabulary width=\textwidth
  9371. | ..... | ..... |
  9372. | ..... | ..... |
  9373. @end example
  9374. @node Images in @LaTeX{} export, Beamer class export, Tables in @LaTeX{} export, @LaTeX{} and PDF export
  9375. @subsection Images in @LaTeX{} export
  9376. @cindex images, inline in @LaTeX{}
  9377. @cindex inlining images in @LaTeX{}
  9378. Images that are linked to without a description part in the link, like
  9379. @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
  9380. output file resulting from @LaTeX{} processing. Org will use an
  9381. @code{\includegraphics} macro to insert the image. If you have specified a
  9382. caption and/or a label as described in @ref{Images and tables}, the figure
  9383. will be wrapped into a @code{figure} environment and thus become a floating
  9384. element. You can use an @code{#+ATTR_LaTeX:} line to specify various other
  9385. options. You can ask org to export an image as a float without specifying
  9386. a label or a caption by using the keyword @code{float} in this line. Various
  9387. optional arguments to the @code{\includegraphics} macro can also be specified
  9388. in this fashion. To modify the placement option of the floating environment,
  9389. add something like @samp{placement=[h!]} to the attributes. It is to be noted
  9390. this option can be used with tables as well@footnote{One can also take
  9391. advantage of this option to pass other, unrelated options into the figure or
  9392. table environment. For an example see the section ``Exporting org files'' in
  9393. @url{http://orgmode.org/worg/org-hacks.html}}.
  9394. If you would like to let text flow around the image, add the word @samp{wrap}
  9395. to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
  9396. half of the page. To fine-tune, the @code{placement} field will be the set
  9397. of additional arguments needed by the @code{wrapfigure} environment. Note
  9398. that if you change the size of the image, you need to use compatible settings
  9399. for @code{\includegraphics} and @code{wrapfigure}.
  9400. @cindex #+CAPTION
  9401. @cindex #+LABEL
  9402. @cindex #+ATTR_LaTeX
  9403. @example
  9404. #+CAPTION: The black-body emission of the disk around HR 4049
  9405. #+LABEL: fig:SED-HR4049
  9406. #+ATTR_LaTeX: width=5cm,angle=90
  9407. [[./img/sed-hr4049.pdf]]
  9408. #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
  9409. [[./img/hst.png]]
  9410. @end example
  9411. If you wish to include an image which spans multiple columns in a page, you
  9412. can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line. This
  9413. will export the image wrapped in a @code{figure*} environment.
  9414. If you need references to a label created in this way, write
  9415. @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
  9416. @node Beamer class export, , Images in @LaTeX{} export, @LaTeX{} and PDF export
  9417. @subsection Beamer class export
  9418. The @LaTeX{} class @file{beamer} allows production of high quality presentations
  9419. using @LaTeX{} and pdf processing. Org mode has special support for turning an
  9420. Org mode file or tree into a @file{beamer} presentation.
  9421. When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
  9422. beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
  9423. @code{beamer}, a special export mode will turn the file or tree into a beamer
  9424. presentation. Any tree with not-too-deep level nesting should in principle be
  9425. exportable as a beamer presentation. By default, the top-level entries (or
  9426. the first level below the selected subtree heading) will be turned into
  9427. frames, and the outline structure below this level will become itemize lists.
  9428. You can also configure the variable @code{org-beamer-frame-level} to a
  9429. different level---then the hierarchy above frames will produce the sectioning
  9430. structure of the presentation.
  9431. A template for useful in-buffer settings or properties can be inserted into
  9432. the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
  9433. things, this will install a column view format which is very handy for
  9434. editing special properties used by beamer.
  9435. You can influence the structure of the presentation using the following
  9436. properties:
  9437. @table @code
  9438. @item BEAMER_env
  9439. The environment that should be used to format this entry. Valid environments
  9440. are defined in the constant @code{org-beamer-environments-default}, and you
  9441. can define more in @code{org-beamer-environments-extra}. If this property is
  9442. set, the entry will also get a @code{:B_environment:} tag to make this
  9443. visible. This tag has no semantic meaning, it is only a visual aid.
  9444. @item BEAMER_envargs
  9445. The beamer-special arguments that should be used for the environment, like
  9446. @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
  9447. property is also set, something like @code{C[t]} can be added here as well to
  9448. set an options argument for the implied @code{columns} environment.
  9449. @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
  9450. environment.
  9451. @item BEAMER_col
  9452. The width of a column that should start with this entry. If this property is
  9453. set, the entry will also get a @code{:BMCOL:} property to make this visible.
  9454. Also this tag is only a visual aid. When this is a plain number, it will be
  9455. interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
  9456. that you have specified the units, like @samp{3cm}. The first such property
  9457. in a frame will start a @code{columns} environment to surround the columns.
  9458. This environment is closed when an entry has a @code{BEAMER_col} property
  9459. with value 0 or 1, or automatically at the end of the frame.
  9460. @item BEAMER_extra
  9461. Additional commands that should be inserted after the environment has been
  9462. opened. For example, when creating a frame, this can be used to specify
  9463. transitions.
  9464. @end table
  9465. Frames will automatically receive a @code{fragile} option if they contain
  9466. source code that uses the verbatim environment. Special @file{beamer}
  9467. specific code can be inserted using @code{#+BEAMER:} and
  9468. @code{#+BEGIN_BEAMER...#+END_BEAMER} constructs, similar to other export
  9469. backends, but with the difference that @code{#+LaTeX:} stuff will be included
  9470. in the presentation as well.
  9471. Outline nodes with @code{BEAMER_env} property value @samp{note} or
  9472. @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
  9473. into @code{\note@{...@}}. The former will include the heading as part of the
  9474. note text, the latter will ignore the heading of that node. To simplify note
  9475. generation, it is actually enough to mark the note with a @emph{tag} (either
  9476. @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
  9477. @code{BEAMER_env} property.
  9478. You can turn on a special minor mode @code{org-beamer-mode} for editing
  9479. support with
  9480. @example
  9481. #+STARTUP: beamer
  9482. @end example
  9483. @table @kbd
  9484. @orgcmd{C-c C-b,org-beamer-select-environment}
  9485. In @code{org-beamer-mode}, this key offers fast selection of a beamer
  9486. environment or the @code{BEAMER_col} property.
  9487. @end table
  9488. Column view provides a great way to set the environment of a node and other
  9489. important parameters. Make sure you are using a COLUMN format that is geared
  9490. toward this special purpose. The command @kbd{M-x
  9491. org-insert-beamer-options-template} defines such a format.
  9492. Here is a simple example Org document that is intended for beamer export.
  9493. @smallexample
  9494. #+LaTeX_CLASS: beamer
  9495. #+TITLE: Example Presentation
  9496. #+AUTHOR: Carsten Dominik
  9497. #+LaTeX_CLASS_OPTIONS: [presentation]
  9498. #+BEAMER_FRAME_LEVEL: 2
  9499. #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
  9500. #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
  9501. * This is the first structural section
  9502. ** Frame 1 \\ with a subtitle
  9503. *** Thanks to Eric Fraga :BMCOL:B_block:
  9504. :PROPERTIES:
  9505. :BEAMER_env: block
  9506. :BEAMER_envargs: C[t]
  9507. :BEAMER_col: 0.5
  9508. :END:
  9509. for the first viable beamer setup in Org
  9510. *** Thanks to everyone else :BMCOL:B_block:
  9511. :PROPERTIES:
  9512. :BEAMER_col: 0.5
  9513. :BEAMER_env: block
  9514. :BEAMER_envargs: <2->
  9515. :END:
  9516. for contributing to the discussion
  9517. **** This will be formatted as a beamer note :B_note:
  9518. ** Frame 2 \\ where we will not use columns
  9519. *** Request :B_block:
  9520. Please test this stuff!
  9521. :PROPERTIES:
  9522. :BEAMER_env: block
  9523. :END:
  9524. @end smallexample
  9525. For more information, see the documentation on Worg.
  9526. @node DocBook export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
  9527. @section DocBook export
  9528. @cindex DocBook export
  9529. @cindex PDF export
  9530. @cindex Cui, Baoqiu
  9531. Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
  9532. exported to DocBook format, it can be further processed to produce other
  9533. formats, including PDF, HTML, man pages, etc., using many available DocBook
  9534. tools and stylesheets.
  9535. Currently DocBook exporter only supports DocBook V5.0.
  9536. @menu
  9537. * DocBook export commands:: How to invoke DocBook export
  9538. * Quoting DocBook code:: Incorporating DocBook code in Org files
  9539. * Recursive sections:: Recursive sections in DocBook
  9540. * Tables in DocBook export:: Tables are exported as HTML tables
  9541. * Images in DocBook export:: How to insert figures into DocBook output
  9542. * Special characters:: How to handle special characters
  9543. @end menu
  9544. @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
  9545. @subsection DocBook export commands
  9546. @cindex region, active
  9547. @cindex active region
  9548. @cindex transient-mark-mode
  9549. @table @kbd
  9550. @orgcmd{C-c C-e D,org-export-as-docbook}
  9551. @cindex property EXPORT_FILE_NAME
  9552. Export as a DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
  9553. file will be @file{myfile.xml}. The file will be overwritten without
  9554. warning. If there is an active region@footnote{This requires
  9555. @code{transient-mark-mode} to be turned on}, only the region will be
  9556. exported. If the selected region is a single tree@footnote{To select the
  9557. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  9558. title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
  9559. property, that name will be used for the export.
  9560. @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
  9561. Export as a DocBook file, process to PDF, then open the resulting PDF file.
  9562. @vindex org-export-docbook-xslt-proc-command
  9563. @vindex org-export-docbook-xsl-fo-proc-command
  9564. Note that, in order to produce PDF output based on an exported DocBook file,
  9565. you need to have XSLT processor and XSL-FO processor software installed on your
  9566. system. Check variables @code{org-export-docbook-xslt-proc-command} and
  9567. @code{org-export-docbook-xsl-fo-proc-command}.
  9568. @vindex org-export-docbook-xslt-stylesheet
  9569. The stylesheet argument @code{%s} in variable
  9570. @code{org-export-docbook-xslt-proc-command} is replaced by the value of
  9571. variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
  9572. the user. You can also overrule this global setting on a per-file basis by
  9573. adding an in-buffer setting @code{#+XSLT:} to the Org file.
  9574. @orgkey{C-c C-e v D}
  9575. Export only the visible part of the document.
  9576. @end table
  9577. @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
  9578. @subsection Quoting DocBook code
  9579. You can quote DocBook code in Org files and copy it verbatim into exported
  9580. DocBook file with the following constructs:
  9581. @cindex #+DOCBOOK
  9582. @cindex #+BEGIN_DOCBOOK
  9583. @example
  9584. #+DOCBOOK: Literal DocBook code for export
  9585. @end example
  9586. @noindent or
  9587. @cindex #+BEGIN_DOCBOOK
  9588. @example
  9589. #+BEGIN_DOCBOOK
  9590. All lines between these markers are exported by DocBook exporter
  9591. literally.
  9592. #+END_DOCBOOK
  9593. @end example
  9594. For example, you can use the following lines to include a DocBook warning
  9595. admonition. As to what this warning says, you should pay attention to the
  9596. document context when quoting DocBook code in Org files. You may make
  9597. exported DocBook XML files invalid by not quoting DocBook code correctly.
  9598. @example
  9599. #+BEGIN_DOCBOOK
  9600. <warning>
  9601. <para>You should know what you are doing when quoting DocBook XML code
  9602. in your Org file. Invalid DocBook XML may be generated by
  9603. DocBook exporter if you are not careful!</para>
  9604. </warning>
  9605. #+END_DOCBOOK
  9606. @end example
  9607. @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
  9608. @subsection Recursive sections
  9609. @cindex DocBook recursive sections
  9610. DocBook exporter exports Org files as articles using the @code{article}
  9611. element in DocBook. Recursive sections, i.e., @code{section} elements, are
  9612. used in exported articles. Top level headlines in Org files are exported as
  9613. top level sections, and lower level headlines are exported as nested
  9614. sections. The entire structure of Org files will be exported completely, no
  9615. matter how many nested levels of headlines there are.
  9616. Using recursive sections makes it easy to port and reuse exported DocBook
  9617. code in other DocBook document types like @code{book} or @code{set}.
  9618. @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
  9619. @subsection Tables in DocBook export
  9620. @cindex tables, in DocBook export
  9621. Tables in Org files are exported as HTML tables, which have been supported since
  9622. DocBook V4.3.
  9623. If a table does not have a caption, an informal table is generated using the
  9624. @code{informaltable} element; otherwise, a formal table will be generated
  9625. using the @code{table} element.
  9626. @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
  9627. @subsection Images in DocBook export
  9628. @cindex images, inline in DocBook
  9629. @cindex inlining images in DocBook
  9630. Images that are linked to without a description part in the link, like
  9631. @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
  9632. using @code{mediaobject} elements. Each @code{mediaobject} element contains
  9633. an @code{imageobject} that wraps an @code{imagedata} element. If you have
  9634. specified a caption for an image as described in @ref{Images and tables}, a
  9635. @code{caption} element will be added in @code{mediaobject}. If a label is
  9636. also specified, it will be exported as an @code{xml:id} attribute of the
  9637. @code{mediaobject} element.
  9638. @vindex org-export-docbook-default-image-attributes
  9639. Image attributes supported by the @code{imagedata} element, like @code{align}
  9640. or @code{width}, can be specified in two ways: you can either customize
  9641. variable @code{org-export-docbook-default-image-attributes} or use the
  9642. @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
  9643. @code{org-export-docbook-default-image-attributes} are applied to all inline
  9644. images in the Org file to be exported (unless they are overridden by image
  9645. attributes specified in @code{#+ATTR_DOCBOOK:} lines).
  9646. The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
  9647. attributes or override default image attributes for individual images. If
  9648. the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
  9649. variable @code{org-export-docbook-default-image-attributes}, the former
  9650. takes precedence. Here is an example about how image attributes can be
  9651. set:
  9652. @cindex #+CAPTION
  9653. @cindex #+LABEL
  9654. @cindex #+ATTR_DOCBOOK
  9655. @example
  9656. #+CAPTION: The logo of Org mode
  9657. #+LABEL: unicorn-svg
  9658. #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
  9659. [[./img/org-mode-unicorn.svg]]
  9660. @end example
  9661. @vindex org-export-docbook-inline-image-extensions
  9662. By default, DocBook exporter recognizes the following image file types:
  9663. @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
  9664. customize variable @code{org-export-docbook-inline-image-extensions} to add
  9665. more types to this list as long as DocBook supports them.
  9666. @node Special characters, , Images in DocBook export, DocBook export
  9667. @subsection Special characters in DocBook export
  9668. @cindex Special characters in DocBook export
  9669. @vindex org-export-docbook-doctype
  9670. @vindex org-entities
  9671. Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
  9672. @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
  9673. characters are rewritten to XML entities, like @code{&alpha;},
  9674. @code{&Gamma;}, and @code{&Zeta;}, based on the list saved in variable
  9675. @code{org-entities}. As long as the generated DocBook file includes the
  9676. corresponding entities, these special characters are recognized.
  9677. You can customize variable @code{org-export-docbook-doctype} to include the
  9678. entities you need. For example, you can set variable
  9679. @code{org-export-docbook-doctype} to the following value to recognize all
  9680. special characters included in XHTML entities:
  9681. @example
  9682. "<!DOCTYPE article [
  9683. <!ENTITY % xhtml1-symbol PUBLIC
  9684. \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
  9685. \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
  9686. >
  9687. %xhtml1-symbol;
  9688. ]>
  9689. "
  9690. @end example
  9691. @c begin opendocument
  9692. @node OpenDocument Text export, TaskJuggler export, DocBook export, Exporting
  9693. @section OpenDocument Text export
  9694. @cindex K, Jambunathan
  9695. @cindex ODT
  9696. @cindex OpenDocument
  9697. @cindex export, OpenDocument
  9698. @cindex LibreOffice
  9699. @cindex org-odt.el
  9700. @cindex org-modules
  9701. Org Mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
  9702. (ODT) format using the @file{org-odt.el} module. Documents created
  9703. by this exporter use the @cite{OpenDocument-v1.2
  9704. specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
  9705. Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
  9706. are compatible with LibreOffice 3.4.
  9707. @menu
  9708. * Pre-requisites for ODT export:: What packages ODT exporter relies on
  9709. * ODT export commands:: How to invoke ODT export
  9710. * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
  9711. * Applying custom styles:: How to apply custom styles to the output
  9712. * Links in ODT export:: How links will be interpreted and formatted
  9713. * Tables in ODT export:: How Tables are exported
  9714. * Images in ODT export:: How to insert images
  9715. * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
  9716. * Labels and captions in ODT export:: How captions are rendered
  9717. * Literal examples in ODT export:: How source and example blocks are formatted
  9718. * Advanced topics in ODT export:: Read this if you are a power user
  9719. @end menu
  9720. @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
  9721. @subsection Pre-requisites for ODT export
  9722. @cindex zip
  9723. The ODT exporter relies on the @file{zip} program to create the final
  9724. output. Check the availability of this program before proceeding further.
  9725. @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
  9726. @subsection ODT export commands
  9727. @subsubheading Exporting to ODT
  9728. @anchor{x-export-to-odt}
  9729. @cindex region, active
  9730. @cindex active region
  9731. @cindex transient-mark-mode
  9732. @table @kbd
  9733. @orgcmd{C-c C-e o,org-export-as-odt}
  9734. @cindex property EXPORT_FILE_NAME
  9735. Export as OpenDocument Text file.
  9736. @vindex org-export-odt-preferred-output-format
  9737. If @code{org-export-odt-preferred-output-format} is specified, automatically
  9738. convert the exported file to that format. @xref{x-export-to-other-formats, ,
  9739. Automatically exporting to other formats}.
  9740. For an Org file @file{myfile.org}, the ODT file will be
  9741. @file{myfile.odt}. The file will be overwritten without warning. If there
  9742. is an active region,@footnote{This requires @code{transient-mark-mode} to be
  9743. turned on} only the region will be exported. If the selected region is a
  9744. single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
  9745. tree head will become the document title. If the tree head entry has, or
  9746. inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
  9747. export.
  9748. @orgcmd{C-c C-e O,org-export-as-odt-and-open}
  9749. Export as an OpenDocument Text file and open the resulting file.
  9750. @vindex org-export-odt-preferred-output-format
  9751. If @code{org-export-odt-preferred-output-format} is specified, open the
  9752. converted file instead. @xref{x-export-to-other-formats, , Automatically
  9753. exporting to other formats}.
  9754. @end table
  9755. @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
  9756. @subsection Extending ODT export
  9757. The ODT exporter can interface with a variety of document
  9758. converters and supports popular converters out of the box. As a result, you
  9759. can use it to export to formats like @samp{doc} or convert a document from
  9760. one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
  9761. @cindex @file{unoconv}
  9762. @cindex LibreOffice
  9763. If you have a working installation of LibreOffice, a document converter is
  9764. pre-configured for you and you can use it right away. If you would like to
  9765. use @file{unoconv} as your preferred converter, customize the variable
  9766. @code{org-export-odt-convert-process} to point to @code{unoconv}. You can
  9767. also use your own favorite converter or tweak the default settings of the
  9768. @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
  9769. document converter}.
  9770. @subsubsection Automatically exporting to other formats
  9771. @anchor{x-export-to-other-formats}
  9772. @vindex org-export-odt-preferred-output-format
  9773. Very often, you will find yourself exporting to ODT format, only to
  9774. immediately save the exported document to other formats like @samp{doc},
  9775. @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
  9776. preferred output format by customizing the variable
  9777. @code{org-export-odt-preferred-output-format}. This way, the export commands
  9778. (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
  9779. format that is of immediate interest to you.
  9780. @subsubsection Converting between document formats
  9781. @anchor{x-convert-to-other-formats}
  9782. There are many document converters in the wild which support conversion to
  9783. and from various file formats, including, but not limited to the
  9784. ODT format. LibreOffice converter, mentioned above, is one such
  9785. converter. Once a converter is configured, you can interact with it using
  9786. the following command.
  9787. @vindex org-export-odt-convert
  9788. @table @kbd
  9789. @item M-x org-export-odt-convert
  9790. Convert an existing document from one format to another. With a prefix
  9791. argument, also open the newly produced file.
  9792. @end table
  9793. @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
  9794. @subsection Applying custom styles
  9795. @cindex styles, custom
  9796. @cindex template, custom
  9797. The ODT exporter ships with a set of OpenDocument styles
  9798. (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
  9799. output. These factory styles, however, may not cater to your specific
  9800. tastes. To customize the output, you can either modify the above styles
  9801. files directly, or generate the required styles using an application like
  9802. LibreOffice. The latter method is suitable for expert and non-expert
  9803. users alike, and is described here.
  9804. @subsubsection Applying custom styles: the easy way
  9805. @enumerate
  9806. @item
  9807. Create a sample @file{example.org} file with the below settings and export it
  9808. to ODT format.
  9809. @example
  9810. #+OPTIONS: H:10 num:t
  9811. @end example
  9812. @item
  9813. Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
  9814. to locate the target styles---these typically have the @samp{Org} prefix---and
  9815. modify those to your taste. Save the modified file either as an
  9816. OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
  9817. @item
  9818. @cindex #+ODT_STYLES_FILE
  9819. @vindex org-export-odt-styles-file
  9820. Customize the variable @code{org-export-odt-styles-file} and point it to the
  9821. newly created file. For additional configuration options
  9822. @pxref{x-overriding-factory-styles,,Overriding factory styles}.
  9823. If you would like to choose a style on a per-file basis, you can use the
  9824. @code{#+ODT_STYLES_FILE} option. A typical setting will look like
  9825. @example
  9826. #+ODT_STYLES_FILE: "/path/to/example.ott"
  9827. @end example
  9828. or
  9829. @example
  9830. #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
  9831. @end example
  9832. @end enumerate
  9833. @subsubsection Using third-party styles and templates
  9834. You can use third-party styles and templates for customizing your output.
  9835. This will produce the desired output only if the template provides all
  9836. style names that the @samp{ODT} exporter relies on. Unless this condition is
  9837. met, the output is going to be less than satisfactory. So it is highly
  9838. recommended that you only work with templates that are directly derived from
  9839. the factory settings.
  9840. @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
  9841. @subsection Links in ODT export
  9842. @cindex tables, in DocBook export
  9843. ODT exporter creates native cross-references for internal links. It creates
  9844. Internet-style links for all other links.
  9845. A link with no description and destined to a regular (un-itemized) outline
  9846. heading is replaced with a cross-reference and section number of the heading.
  9847. A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
  9848. with a cross-reference and sequence number of the labeled entity.
  9849. @xref{Labels and captions in ODT export}.
  9850. @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
  9851. @subsection Tables in ODT export
  9852. @cindex tables, in DocBook export
  9853. Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
  9854. tables is supported. However, export of complex @file{table.el} tables---tables
  9855. that have column or row spans---is not supported. Such tables are
  9856. stripped from the exported document.
  9857. By default, a table is exported with top and bottom frames and with rules
  9858. separating row and column groups (@pxref{Column groups}). Furthermore, all
  9859. tables are typeset to occupy the same width. If the table specifies
  9860. alignment and relative width for its columns (@pxref{Column width and
  9861. alignment}) then these are honored on export.@footnote{The column widths are
  9862. interpreted as weighted ratios with the default weight being 1}
  9863. @cindex #+ATTR_ODT
  9864. You can control the width of the table by specifying @code{:rel-width}
  9865. property using an @code{#+ATTR_ODT} line.
  9866. For example, consider the following table which makes use of all the rules
  9867. mentioned above.
  9868. @example
  9869. #+ATTR_ODT: :rel-width 50
  9870. | Area/Month | Jan | Feb | Mar | Sum |
  9871. |---------------+-------+-------+-------+-------|
  9872. | / | < | | | < |
  9873. | <l13> | <r5> | <r5> | <r5> | <r6> |
  9874. | North America | 1 | 21 | 926 | 948 |
  9875. | Middle East | 6 | 75 | 844 | 925 |
  9876. | Asia Pacific | 9 | 27 | 790 | 826 |
  9877. |---------------+-------+-------+-------+-------|
  9878. | Sum | 16 | 123 | 2560 | 2699 |
  9879. @end example
  9880. On export, the table will occupy 50% of text area. The columns will be sized
  9881. (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
  9882. and rest of the columns will be right-aligned. There will be vertical rules
  9883. after separating the header and last columns from other columns. There will
  9884. be horizontal rules separating the header and last rows from other rows.
  9885. If you are not satisfied with the above formatting options, you can create
  9886. custom table styles and associate them with a table using the
  9887. @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
  9888. @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
  9889. @subsection Images in ODT export
  9890. @cindex images, embedding in ODT
  9891. @cindex embedding images in ODT
  9892. @subsubheading Embedding images
  9893. You can embed images within the exported document by providing a link to the
  9894. desired image file with no link description. For example, to embed
  9895. @samp{img.png} do either of the following:
  9896. @example
  9897. [[file:img.png]]
  9898. @end example
  9899. @example
  9900. [[./img.png]]
  9901. @end example
  9902. @subsubheading Embedding clickable images
  9903. You can create clickable images by providing a link whose description is a
  9904. link to an image file. For example, to embed a image
  9905. @file{org-mode-unicorn.png} which when clicked jumps to
  9906. @uref{http://Orgmode.org} website, do the following
  9907. @example
  9908. [[http://orgmode.org][./org-mode-unicorn.png]]
  9909. @end example
  9910. @subsubheading Sizing and scaling of embedded images
  9911. @cindex #+ATTR_ODT
  9912. You can control the size and scale of the embedded images using the
  9913. @code{#+ATTR_ODT} attribute.
  9914. @cindex identify, ImageMagick
  9915. @vindex org-export-odt-pixels-per-inch
  9916. The exporter specifies the desired size of the image in the final document in
  9917. units of centimeters. In order to scale the embedded images, the exporter
  9918. queries for pixel dimensions of the images using one of a) ImageMagick's
  9919. @file{identify} program or b) Emacs `create-image' and `image-size'
  9920. APIs.@footnote{Use of @file{ImageMagick} is only desirable. However, if you
  9921. routinely produce documents that have large images or you export your Org
  9922. files that has images using a Emacs batch script, then the use of
  9923. @file{ImageMagick} is mandatory.} The pixel dimensions are subsequently
  9924. converted in to units of centimeters using
  9925. @code{org-export-odt-pixels-per-inch}. The default value of this variable is
  9926. set to @code{display-pixels-per-inch}. You can tweak this variable to
  9927. achieve the best results.
  9928. The examples below illustrate the various possibilities.
  9929. @table @asis
  9930. @item Explicitly size the image
  9931. To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
  9932. @example
  9933. #+ATTR_ODT: :width 10 :height 10
  9934. [[./img.png]]
  9935. @end example
  9936. @item Scale the image
  9937. To embed @file{img.png} at half its size, do the following:
  9938. @example
  9939. #+ATTR_ODT: :scale 0.5
  9940. [[./img.png]]
  9941. @end example
  9942. @item Scale the image to a specific width
  9943. To embed @file{img.png} with a width of 10 cm while retaining the original
  9944. height:width ratio, do the following:
  9945. @example
  9946. #+ATTR_ODT: :width 10
  9947. [[./img.png]]
  9948. @end example
  9949. @item Scale the image to a specific height
  9950. To embed @file{img.png} with a height of 10 cm while retaining the original
  9951. height:width ratio, do the following
  9952. @example
  9953. #+ATTR_ODT: :height 10
  9954. [[./img.png]]
  9955. @end example
  9956. @end table
  9957. @subsubheading Anchoring of images
  9958. @cindex #+ATTR_ODT
  9959. You can control the manner in which an image is anchored by setting the
  9960. @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
  9961. of the the following three values for the @code{:anchor} property:
  9962. @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
  9963. To create an image that is anchored to a page, do the following:
  9964. @example
  9965. #+ATTR_ODT: :anchor "page"
  9966. [[./img.png]]
  9967. @end example
  9968. @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
  9969. @subsection Math formatting in ODT export
  9970. The ODT exporter has special support for handling math.
  9971. @menu
  9972. * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
  9973. * Working with MathML or OpenDocument formula files:: How to embed equations in native format
  9974. @end menu
  9975. @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
  9976. @subsubsection Working with @LaTeX{} math snippets
  9977. @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
  9978. document in one of the following ways:
  9979. @cindex MathML
  9980. @enumerate
  9981. @item MathML
  9982. This option is activated on a per-file basis with
  9983. @example
  9984. #+OPTIONS: LaTeX:t
  9985. @end example
  9986. With this option, @LaTeX{} fragments are first converted into MathML
  9987. fragments using an external @LaTeX{}-to-MathML converter program. The
  9988. resulting MathML fragments are then embedded as an OpenDocument Formula in
  9989. the exported document.
  9990. @vindex org-latex-to-mathml-convert-command
  9991. @vindex org-latex-to-mathml-jar-file
  9992. You can specify the @LaTeX{}-to-MathML converter by customizing the variables
  9993. @code{org-latex-to-mathml-convert-command} and
  9994. @code{org-latex-to-mathml-jar-file}.
  9995. If you prefer to use @file{MathToWeb}@footnote{See
  9996. @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
  9997. converter, you can configure the above variables as shown below.
  9998. @lisp
  9999. (setq org-latex-to-mathml-convert-command
  10000. "java -jar %j -unicode -force -df %o %I"
  10001. org-latex-to-mathml-jar-file
  10002. "/path/to/mathtoweb.jar")
  10003. @end lisp
  10004. You can use the following commands to quickly verify the reliability of
  10005. the @LaTeX{}-to-MathML converter.
  10006. @table @kbd
  10007. @item M-x org-export-as-odf
  10008. Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
  10009. @item M-x org-export-as-odf-and-open
  10010. Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
  10011. and open the formula file with the system-registered application.
  10012. @end table
  10013. @cindex dvipng
  10014. @item PNG images
  10015. This option is activated on a per-file basis with
  10016. @example
  10017. #+OPTIONS: LaTeX:dvipng
  10018. @end example
  10019. With this option, @LaTeX{} fragments are processed into PNG images and the
  10020. resulting images are embedded in the exported document. This method requires
  10021. that the @file{dvipng} program be available on your system.
  10022. @end enumerate
  10023. @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in ODT export
  10024. @subsubsection Working with MathML or OpenDocument formula files
  10025. For various reasons, you may find embedding @LaTeX{} math snippets in an
  10026. ODT document less than reliable. In that case, you can embed a
  10027. math equation by linking to its MathML (@file{.mml}) source or its
  10028. OpenDocument formula (@file{.odf}) file as shown below:
  10029. @example
  10030. [[./equation.mml]]
  10031. @end example
  10032. or
  10033. @example
  10034. [[./equation.odf]]
  10035. @end example
  10036. @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
  10037. @subsection Labels and captions in ODT export
  10038. You can label and caption various category of objects---an inline image, a
  10039. table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
  10040. @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
  10041. each labeled or captioned object of a given category separately. As a
  10042. result, each such object is assigned a sequence number based on order of it's
  10043. appearance in the Org file.
  10044. In the exported document, a user-provided caption is augmented with the
  10045. category and sequence number. Consider the following inline image in an Org
  10046. file.
  10047. @example
  10048. #+CAPTION: Bell curve
  10049. #+LABEL: fig:SED-HR4049
  10050. [[./img/a.png]]
  10051. @end example
  10052. It could be rendered as shown below in the exported document.
  10053. @example
  10054. Figure 2: Bell curve
  10055. @end example
  10056. @vindex org-export-odt-category-strings
  10057. You can modify the category component of the caption by customizing the
  10058. variable @code{org-export-odt-category-strings}. For example, to tag all
  10059. embedded images with the string @samp{Illustration} (instead of the default
  10060. @samp{Figure}) use the following setting.
  10061. @lisp
  10062. (setq org-export-odt-category-strings
  10063. '(("en" "Table" "Illustration" "Equation" "Equation")))
  10064. @end lisp
  10065. With this, previous image will be captioned as below in the exported
  10066. document.
  10067. @example
  10068. Illustration 2: Bell curve
  10069. @end example
  10070. @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
  10071. @subsection Literal examples in ODT export
  10072. Export of literal examples (@pxref{Literal examples}) with full fontification
  10073. is supported. Internally, the exporter relies on @file{htmlfontify.el} to
  10074. generate all style definitions needed for a fancy listing.@footnote{Your
  10075. @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
  10076. fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
  10077. as prefix and inherit their color from the faces used by Emacs
  10078. @code{font-lock} library for the source language.
  10079. @vindex org-export-odt-fontify-srcblocks
  10080. If you prefer to use your own custom styles for fontification, you can do so
  10081. by customizing the variable
  10082. @code{org-export-odt-create-custom-styles-for-srcblocks}.
  10083. @vindex org-export-odt-create-custom-styles-for-srcblocks
  10084. You can turn off fontification of literal examples by customizing the
  10085. variable @code{org-export-odt-fontify-srcblocks}.
  10086. @node Advanced topics in ODT export, , Literal examples in ODT export, OpenDocument Text export
  10087. @subsection Advanced topics in ODT export
  10088. If you rely heavily on ODT export, you may want to exploit the full
  10089. set of features that the exporter offers. This section describes features
  10090. that would be of interest to power users.
  10091. @menu
  10092. * Configuring a document converter:: How to register a document converter
  10093. * Working with OpenDocument style files:: Explore the internals
  10094. * Creating one-off styles:: How to produce custom highlighting etc
  10095. * Customizing tables in ODT export:: How to define and use Table templates
  10096. * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
  10097. @end menu
  10098. @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
  10099. @subsubsection Configuring a document converter
  10100. @cindex convert
  10101. @cindex doc, docx, rtf
  10102. @cindex converter
  10103. The ODT exporter can work with popular converters with little or no
  10104. extra configuration from your side. @xref{Extending ODT export}.
  10105. If you are using a converter that is not supported by default or if you would
  10106. like to tweak the default converter settings, proceed as below.
  10107. @enumerate
  10108. @item Register the converter
  10109. @vindex org-export-odt-convert-processes
  10110. Name your converter and add it to the list of known converters by customizing
  10111. the variable @code{org-export-odt-convert-processes}. Also specify how the
  10112. converter can be invoked via command-line to effect the conversion.
  10113. @item Configure its capabilities
  10114. @vindex org-export-odt-convert-capabilities
  10115. @anchor{x-odt-converter-capabilities}
  10116. Specify the set of formats the converter can handle by customizing the
  10117. variable @code{org-export-odt-convert-capabilities}. Use the default value
  10118. for this variable as a guide for configuring your converter. As suggested by
  10119. the default setting, you can specify the full set of formats supported by the
  10120. converter and not limit yourself to specifying formats that are related to
  10121. just the OpenDocument Text format.
  10122. @item Choose the converter
  10123. @vindex org-export-odt-convert-process
  10124. Select the newly added converter as the preferred one by customizing the
  10125. variable @code{org-export-odt-convert-process}.
  10126. @end enumerate
  10127. @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
  10128. @subsubsection Working with OpenDocument style files
  10129. @cindex styles, custom
  10130. @cindex template, custom
  10131. This section explores the internals of the ODT exporter and the
  10132. means by which it produces styled documents. Read this section if you are
  10133. interested in exploring the automatic and custom OpenDocument styles used by
  10134. the exporter.
  10135. @anchor{x-factory-styles}
  10136. @subsubheading Factory styles
  10137. The ODT exporter relies on two files for generating its output.
  10138. These files are bundled with the distribution under the directory pointed to
  10139. by the variable @code{org-odt-styles-dir}. The two files are:
  10140. @itemize
  10141. @anchor{x-orgodtstyles-xml}
  10142. @item
  10143. @file{OrgOdtStyles.xml}
  10144. This file contributes to the @file{styles.xml} file of the final @samp{ODT}
  10145. document. This file gets modified for the following purposes:
  10146. @enumerate
  10147. @item
  10148. To control outline numbering based on user settings.
  10149. @item
  10150. To add styles generated by @file{htmlfontify.el} for fontification of code
  10151. blocks.
  10152. @end enumerate
  10153. @anchor{x-orgodtcontenttemplate-xml}
  10154. @item
  10155. @file{OrgOdtContentTemplate.xml}
  10156. This file contributes to the @file{content.xml} file of the final @samp{ODT}
  10157. document. The contents of the Org outline are inserted between the
  10158. @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
  10159. Apart from serving as a template file for the final @file{content.xml}, the
  10160. file serves the following purposes:
  10161. @enumerate
  10162. @item
  10163. It contains automatic styles for formatting of tables which are referenced by
  10164. the exporter.
  10165. @item
  10166. It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
  10167. elements that control how various entities---tables, images, equations,
  10168. etc.---are numbered.
  10169. @end enumerate
  10170. @end itemize
  10171. @anchor{x-overriding-factory-styles}
  10172. @subsubheading Overriding factory styles
  10173. The following two variables control the location from which the ODT
  10174. exporter picks up the custom styles and content template files. You can
  10175. customize these variables to override the factory styles used by the
  10176. exporter.
  10177. @itemize
  10178. @anchor{x-org-export-odt-styles-file}
  10179. @item
  10180. @code{org-export-odt-styles-file}
  10181. Use this variable to specify the @file{styles.xml} that will be used in the
  10182. final output. You can specify one of the following values:
  10183. @enumerate
  10184. @item A @file{styles.xml} file
  10185. Use this file instead of the default @file{styles.xml}
  10186. @item A @file{.odt} or @file{.ott} file
  10187. Use the @file{styles.xml} contained in the specified OpenDocument Text or
  10188. Template file
  10189. @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
  10190. Use the @file{styles.xml} contained in the specified OpenDocument Text or
  10191. Template file. Additionally extract the specified member files and embed
  10192. those within the final @samp{ODT} document.
  10193. Use this option if the @file{styles.xml} file references additional files
  10194. like header and footer images.
  10195. @item @code{nil}
  10196. Use the default @file{styles.xml}
  10197. @end enumerate
  10198. @anchor{x-org-export-odt-content-template-file}
  10199. @item
  10200. @code{org-export-odt-content-template-file}
  10201. Use this variable to specify the blank @file{content.xml} that will be used
  10202. in the final output.
  10203. @end itemize
  10204. @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
  10205. @subsubsection Creating one-off styles
  10206. There are times when you would want one-off formatting in the exported
  10207. document. You can achieve this by embedding raw OpenDocument XML in the Org
  10208. file. The use of this feature is better illustrated with couple of examples.
  10209. @enumerate
  10210. @item Embedding ODT tags as part of regular text
  10211. You can include simple OpenDocument tags by prefixing them with
  10212. @samp{@@}. For example, to highlight a region of text do the following:
  10213. @example
  10214. @@<text:span text:style-name="Highlight">This is a
  10215. highlighted text@@</text:span>. But this is a
  10216. regular text.
  10217. @end example
  10218. @strong{Hint:} To see the above example in action, edit your
  10219. @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
  10220. custom @samp{Highlight} style as shown below.
  10221. @example
  10222. <style:style style:name="Highlight" style:family="text">
  10223. <style:text-properties fo:background-color="#ff0000"/>
  10224. </style:style>
  10225. @end example
  10226. @item Embedding a one-line OpenDocument XML
  10227. You can add a simple OpenDocument one-liner using the @code{#+ODT:}
  10228. directive. For example, to force a page break do the following:
  10229. @example
  10230. #+ODT: <text:p text:style-name="PageBreak"/>
  10231. @end example
  10232. @strong{Hint:} To see the above example in action, edit your
  10233. @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
  10234. custom @samp{PageBreak} style as shown below.
  10235. @example
  10236. <style:style style:name="PageBreak" style:family="paragraph"
  10237. style:parent-style-name="Text_20_body">
  10238. <style:paragraph-properties fo:break-before="page"/>
  10239. </style:style>
  10240. @end example
  10241. @item Embedding a block of OpenDocument XML
  10242. You can add a large block of OpenDocument XML using the
  10243. @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
  10244. For example, to create a one-off paragraph that uses bold text, do the
  10245. following:
  10246. @example
  10247. #+BEGIN_ODT
  10248. <text:p text:style-name="Text_20_body_20_bold">
  10249. This paragraph is specially formatted and uses bold text.
  10250. </text:p>
  10251. #+END_ODT
  10252. @end example
  10253. @end enumerate
  10254. @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
  10255. @subsubsection Customizing tables in ODT export
  10256. @cindex tables, in ODT export
  10257. @cindex #+ATTR_ODT
  10258. You can override the default formatting of the table by specifying a custom
  10259. table style with the @code{#+ATTR_ODT} line. For a discussion on default
  10260. formatting of tables @pxref{Tables in ODT export}.
  10261. This feature closely mimics the way table templates are defined in the
  10262. OpenDocument-v1.2
  10263. specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
  10264. OpenDocument-v1.2 Specification}}
  10265. @subsubheading Custom table styles: an illustration
  10266. To have a quick preview of this feature, install the below setting and export
  10267. the table that follows.
  10268. @lisp
  10269. (setq org-export-odt-table-styles
  10270. (append org-export-odt-table-styles
  10271. '(("TableWithHeaderRowAndColumn" "Custom"
  10272. ((use-first-row-styles . t)
  10273. (use-first-column-styles . t)))
  10274. ("TableWithFirstRowandLastRow" "Custom"
  10275. ((use-first-row-styles . t)
  10276. (use-last-row-styles . t))))))
  10277. @end lisp
  10278. @example
  10279. #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
  10280. | Name | Phone | Age |
  10281. | Peter | 1234 | 17 |
  10282. | Anna | 4321 | 25 |
  10283. @end example
  10284. In the above example, you used a template named @samp{Custom} and installed
  10285. two table styles with the names @samp{TableWithHeaderRowAndColumn} and
  10286. @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
  10287. styles needed for producing the above template have been pre-defined for you.
  10288. These styles are available under the section marked @samp{Custom Table
  10289. Template} in @file{OrgOdtContentTemplate.xml}
  10290. (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
  10291. additional templates you have to define these styles yourselves.
  10292. @subsubheading Custom table styles: the nitty-gritty
  10293. To use this feature proceed as follows:
  10294. @enumerate
  10295. @item
  10296. Create a table template@footnote{See the @code{<table:table-template>}
  10297. element of the OpenDocument-v1.2 specification}
  10298. A table template is nothing but a set of @samp{table-cell} and
  10299. @samp{paragraph} styles for each of the following table cell categories:
  10300. @itemize @minus
  10301. @item Body
  10302. @item First column
  10303. @item Last column
  10304. @item First row
  10305. @item Last row
  10306. @item Even row
  10307. @item Odd row
  10308. @item Even column
  10309. @item Odd Column
  10310. @end itemize
  10311. The names for the above styles must be chosen based on the name of the table
  10312. template using a well-defined convention.
  10313. The naming convention is better illustrated with an example. For a table
  10314. template with the name @samp{Custom}, the needed style names are listed in
  10315. the following table.
  10316. @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
  10317. @headitem Table cell type
  10318. @tab @code{table-cell} style
  10319. @tab @code{paragraph} style
  10320. @item
  10321. @tab
  10322. @tab
  10323. @item Body
  10324. @tab @samp{CustomTableCell}
  10325. @tab @samp{CustomTableParagraph}
  10326. @item First column
  10327. @tab @samp{CustomFirstColumnTableCell}
  10328. @tab @samp{CustomFirstColumnTableParagraph}
  10329. @item Last column
  10330. @tab @samp{CustomLastColumnTableCell}
  10331. @tab @samp{CustomLastColumnTableParagraph}
  10332. @item First row
  10333. @tab @samp{CustomFirstRowTableCell}
  10334. @tab @samp{CustomFirstRowTableParagraph}
  10335. @item Last row
  10336. @tab @samp{CustomLastRowTableCell}
  10337. @tab @samp{CustomLastRowTableParagraph}
  10338. @item Even row
  10339. @tab @samp{CustomEvenRowTableCell}
  10340. @tab @samp{CustomEvenRowTableParagraph}
  10341. @item Odd row
  10342. @tab @samp{CustomOddRowTableCell}
  10343. @tab @samp{CustomOddRowTableParagraph}
  10344. @item Even column
  10345. @tab @samp{CustomEvenColumnTableCell}
  10346. @tab @samp{CustomEvenColumnTableParagraph}
  10347. @item Odd column
  10348. @tab @samp{CustomOddColumnTableCell}
  10349. @tab @samp{CustomOddColumnTableParagraph}
  10350. @end multitable
  10351. To create a table template with the name @samp{Custom}, define the above
  10352. styles in the
  10353. @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
  10354. of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
  10355. styles}).
  10356. @item
  10357. Define a table style@footnote{See the attributes @code{table:template-name},
  10358. @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
  10359. @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
  10360. @code{table:use-banding-rows-styles}, and
  10361. @code{table:use-banding-column-styles} of the @code{<table:table>} element in
  10362. the OpenDocument-v1.2 specification}
  10363. @vindex org-export-odt-table-styles
  10364. To define a table style, create an entry for the style in the variable
  10365. @code{org-export-odt-table-styles} and specify the following:
  10366. @itemize @minus
  10367. @item the name of the table template created in step (1)
  10368. @item the set of cell styles in that template that are to be activated
  10369. @end itemize
  10370. For example, the entry below defines two different table styles
  10371. @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
  10372. based on the same template @samp{Custom}. The styles achieve their intended
  10373. effect by selectively activating the individual cell styles in that template.
  10374. @lisp
  10375. (setq org-export-odt-table-styles
  10376. (append org-export-odt-table-styles
  10377. '(("TableWithHeaderRowAndColumn" "Custom"
  10378. ((use-first-row-styles . t)
  10379. (use-first-column-styles . t)))
  10380. ("TableWithFirstRowandLastRow" "Custom"
  10381. ((use-first-row-styles . t)
  10382. (use-last-row-styles . t))))))
  10383. @end lisp
  10384. @item
  10385. Associate a table with the table style
  10386. To do this, specify the table style created in step (2) as part of
  10387. the @code{ATTR_ODT} line as shown below.
  10388. @example
  10389. #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
  10390. | Name | Phone | Age |
  10391. | Peter | 1234 | 17 |
  10392. | Anna | 4321 | 25 |
  10393. @end example
  10394. @end enumerate
  10395. @node Validating OpenDocument XML, , Customizing tables in ODT export, Advanced topics in ODT export
  10396. @subsubsection Validating OpenDocument XML
  10397. Occasionally, you will discover that the document created by the
  10398. ODT exporter cannot be opened by your favorite application. One of
  10399. the common reasons for this is that the @file{.odt} file is corrupt. In such
  10400. cases, you may want to validate the document against the OpenDocument RELAX
  10401. NG Compact Syntax (RNC) schema.
  10402. For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
  10403. nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
  10404. general help with validation (and schema-sensitive editing) of XML files:
  10405. @inforef{Introduction,,nxml-mode}.
  10406. @vindex org-export-odt-schema-dir
  10407. If you have ready access to OpenDocument @file{.rnc} files and the needed
  10408. schema-locating rules in a single folder, you can customize the variable
  10409. @code{org-export-odt-schema-dir} to point to that directory. The
  10410. ODT exporter will take care of updating the
  10411. @code{rng-schema-locating-files} for you.
  10412. @c end opendocument
  10413. @node TaskJuggler export, Freemind export, OpenDocument Text export, Exporting
  10414. @section TaskJuggler export
  10415. @cindex TaskJuggler export
  10416. @cindex Project management
  10417. @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
  10418. It provides an optimizing scheduler that computes your project time lines and
  10419. resource assignments based on the project outline and the constraints that
  10420. you have provided.
  10421. The TaskJuggler exporter is a bit different from other exporters, such as the
  10422. @code{HTML} and @LaTeX{} exporters for example, in that it does not export all the
  10423. nodes of a document or strictly follow the order of the nodes in the
  10424. document.
  10425. Instead the TaskJuggler exporter looks for a tree that defines the tasks and
  10426. optionally trees that define the resources and reports for this project.
  10427. It then creates a TaskJuggler file based on these trees and the attributes
  10428. defined in all the nodes.
  10429. @subsection TaskJuggler export commands
  10430. @table @kbd
  10431. @orgcmd{C-c C-e j,org-export-as-taskjuggler}
  10432. Export as a TaskJuggler file.
  10433. @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
  10434. Export as a TaskJuggler file and then open the file with TaskJugglerUI (only
  10435. for TaskJugglerUI 2.x).
  10436. @end table
  10437. @subsection Tasks
  10438. @vindex org-export-taskjuggler-project-tag
  10439. Create your tasks as you usually do with Org mode. Assign efforts to each
  10440. task using properties (it is easiest to do this in the column view). You
  10441. should end up with something similar to the example by Peter Jones in
  10442. @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
  10443. Now mark the top node of your tasks with a tag named
  10444. @code{:taskjuggler_project:} (or whatever you customized
  10445. @code{org-export-taskjuggler-project-tag} to). You are now ready to export
  10446. the project plan with @kbd{C-c C-e J} which will export the project plan and
  10447. open a gantt chart in TaskJugglerUI.
  10448. @subsection Resources
  10449. @vindex org-export-taskjuggler-resource-tag
  10450. Next you can define resources and assign those to work on specific tasks. You
  10451. can group your resources hierarchically. Tag the top node of the resources
  10452. with @code{:taskjuggler_resource:} (or whatever you customized
  10453. @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
  10454. identifier (named @samp{resource_id}) to the resources (using the standard
  10455. Org properties commands, @pxref{Property syntax}) or you can let the exporter
  10456. generate identifiers automatically (the exporter picks the first word of the
  10457. headline as the identifier as long as it is unique---see the documentation of
  10458. @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
  10459. allocate resources to tasks. This is again done with the @samp{allocate}
  10460. property on the tasks. Do this in column view or when on the task type
  10461. @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
  10462. Once the allocations are done you can again export to TaskJuggler and check
  10463. in the Resource Allocation Graph which person is working on what task at what
  10464. time.
  10465. @subsection Export of properties
  10466. The exporter also takes TODO state information into consideration, i.e., if
  10467. a task is marked as done it will have the corresponding attribute in
  10468. TaskJuggler (@samp{complete 100}). Scheduling information is also taken into
  10469. account to set start/end dates for tasks.
  10470. The exporter will also export any property on a task resource or resource
  10471. node which is known to TaskJuggler, such as @samp{limits}, @samp{vacation},
  10472. @samp{shift}, @samp{booking}, @samp{efficiency}, @samp{journalentry},
  10473. @samp{rate} for resources or @samp{account}, @samp{start}, @samp{note},
  10474. @samp{duration}, @samp{end}, @samp{journalentry}, @samp{milestone},
  10475. @samp{reference}, @samp{responsible}, @samp{scheduling}, etc for tasks.
  10476. @subsection Dependencies
  10477. The exporter will handle dependencies that are defined in the tasks either
  10478. with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
  10479. @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
  10480. @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
  10481. attribute can be either @samp{previous-sibling} or a reference to an
  10482. identifier (named @samp{task_id}) which is defined for another task in the
  10483. project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
  10484. dependencies separated by either space or comma. You can also specify
  10485. optional attributes on the dependency by simply appending it. The following
  10486. examples should illustrate this:
  10487. @example
  10488. * Preparation
  10489. :PROPERTIES:
  10490. :task_id: preparation
  10491. :ORDERED: t
  10492. :END:
  10493. * Training material
  10494. :PROPERTIES:
  10495. :task_id: training_material
  10496. :ORDERED: t
  10497. :END:
  10498. ** Markup Guidelines
  10499. :PROPERTIES:
  10500. :Effort: 2d
  10501. :END:
  10502. ** Workflow Guidelines
  10503. :PROPERTIES:
  10504. :Effort: 2d
  10505. :END:
  10506. * Presentation
  10507. :PROPERTIES:
  10508. :Effort: 2d
  10509. :BLOCKER: training_material @{ gapduration 1d @} preparation
  10510. :END:
  10511. @end example
  10512. @subsection Reports
  10513. @vindex org-export-taskjuggler-default-reports
  10514. TaskJuggler can produce many kinds of reports (e.g., gantt chart, resource
  10515. allocation, etc). The user defines what kind of reports should be generated
  10516. for a project in the TaskJuggler file. By default, the exporter will
  10517. automatically insert some pre-set reports in the file. These defaults are
  10518. defined in @code{org-export-taskjuggler-default-reports}. They can be
  10519. modified using customize along with a number of other options. For a more
  10520. complete list, see @kbd{M-x customize-group @key{RET} org-export-taskjuggler
  10521. @key{RET}}.
  10522. Alternately, the user can tag a tree with
  10523. @code{org-export-taskjuggler-report-tag}, and define reports in sub-nodes,
  10524. similarly to what is done with tasks or resources. The properties used for
  10525. report generation are defined in
  10526. @code{org-export-taskjuggler-valid-report-attributes}. In addition, a special
  10527. property named @samp{report-kind} is used to define the kind of report one
  10528. wants to generate (by default, a @samp{taskreport}).
  10529. For more information and examples see the Org-taskjuggler tutorial at
  10530. @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
  10531. @node Freemind export, XOXO export, TaskJuggler export, Exporting
  10532. @section Freemind export
  10533. @cindex Freemind export
  10534. @cindex mind map
  10535. The Freemind exporter was written by Lennart Borgman.
  10536. @table @kbd
  10537. @orgcmd{C-c C-e m,org-export-as-freemind}
  10538. Export as a Freemind mind map. For an Org file @file{myfile.org}, the Freemind
  10539. file will be @file{myfile.mm}.
  10540. @end table
  10541. @node XOXO export, iCalendar export, Freemind export, Exporting
  10542. @section XOXO export
  10543. @cindex XOXO export
  10544. Org mode contains an exporter that produces XOXO-style output.
  10545. Currently, this exporter only handles the general outline structure and
  10546. does not interpret any additional Org mode features.
  10547. @table @kbd
  10548. @orgcmd{C-c C-e x,org-export-as-xoxo}
  10549. Export as an XOXO file. For an Org file @file{myfile.org}, the XOXO file will be
  10550. @file{myfile.html}.
  10551. @orgkey{C-c C-e v x}
  10552. Export only the visible part of the document.
  10553. @end table
  10554. @node iCalendar export, , XOXO export, Exporting
  10555. @section iCalendar export
  10556. @cindex iCalendar export
  10557. @vindex org-icalendar-include-todo
  10558. @vindex org-icalendar-use-deadline
  10559. @vindex org-icalendar-use-scheduled
  10560. @vindex org-icalendar-categories
  10561. @vindex org-icalendar-alarm-time
  10562. Some people use Org mode for keeping track of projects, but still prefer a
  10563. standard calendar application for anniversaries and appointments. In this
  10564. case it can be useful to show deadlines and other time-stamped items in Org
  10565. files in the calendar application. Org mode can export calendar information
  10566. in the standard iCalendar format. If you also want to have TODO entries
  10567. included in the export, configure the variable
  10568. @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
  10569. and TODO items as VTODO@. It will also create events from deadlines that are
  10570. in non-TODO items. Deadlines and scheduling dates in TODO items will be used
  10571. to set the start and due dates for the TODO entry@footnote{See the variables
  10572. @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
  10573. As categories, it will use the tags locally defined in the heading, and the
  10574. file/tree category@footnote{To add inherited tags or the TODO state,
  10575. configure the variable @code{org-icalendar-categories}.}. See the variable
  10576. @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
  10577. time.
  10578. @vindex org-icalendar-store-UID
  10579. @cindex property, ID
  10580. The iCalendar standard requires each entry to have a globally unique
  10581. identifier (UID). Org creates these identifiers during export. If you set
  10582. the variable @code{org-icalendar-store-UID}, the UID will be stored in the
  10583. @code{:ID:} property of the entry and re-used next time you report this
  10584. entry. Since a single entry can give rise to multiple iCalendar entries (as
  10585. a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
  10586. prefixes to the UID, depending on what triggered the inclusion of the entry.
  10587. In this way the UID remains unique, but a synchronization program can still
  10588. figure out from which entry all the different instances originate.
  10589. @table @kbd
  10590. @orgcmd{C-c C-e i,org-export-icalendar-this-file}
  10591. Create iCalendar entries for the current file and store them in the same
  10592. directory, using a file extension @file{.ics}.
  10593. @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
  10594. @vindex org-agenda-files
  10595. Like @kbd{C-c C-e i}, but do this for all files in
  10596. @code{org-agenda-files}. For each of these files, a separate iCalendar
  10597. file will be written.
  10598. @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
  10599. @vindex org-combined-agenda-icalendar-file
  10600. Create a single large iCalendar file from all files in
  10601. @code{org-agenda-files} and write it to the file given by
  10602. @code{org-combined-agenda-icalendar-file}.
  10603. @end table
  10604. @vindex org-use-property-inheritance
  10605. @vindex org-icalendar-include-body
  10606. @cindex property, SUMMARY
  10607. @cindex property, DESCRIPTION
  10608. @cindex property, LOCATION
  10609. The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
  10610. property can be inherited from higher in the hierarchy if you configure
  10611. @code{org-use-property-inheritance} accordingly.} properties if the selected
  10612. entries have them. If not, the summary will be derived from the headline,
  10613. and the description from the body (limited to
  10614. @code{org-icalendar-include-body} characters).
  10615. How this calendar is best read and updated, depends on the application
  10616. you are using. The FAQ covers this issue.
  10617. @node Publishing, Working With Source Code, Exporting, Top
  10618. @chapter Publishing
  10619. @cindex publishing
  10620. Org includes a publishing management system that allows you to configure
  10621. automatic HTML conversion of @emph{projects} composed of interlinked org
  10622. files. You can also configure Org to automatically upload your exported HTML
  10623. pages and related attachments, such as images and source code files, to a web
  10624. server.
  10625. You can also use Org to convert files into PDF, or even combine HTML and PDF
  10626. conversion so that files are available in both formats on the server.
  10627. Publishing has been contributed to Org by David O'Toole.
  10628. @menu
  10629. * Configuration:: Defining projects
  10630. * Uploading files:: How to get files up on the server
  10631. * Sample configuration:: Example projects
  10632. * Triggering publication:: Publication commands
  10633. @end menu
  10634. @node Configuration, Uploading files, Publishing, Publishing
  10635. @section Configuration
  10636. Publishing needs significant configuration to specify files, destination
  10637. and many other properties of a project.
  10638. @menu
  10639. * Project alist:: The central configuration variable
  10640. * Sources and destinations:: From here to there
  10641. * Selecting files:: What files are part of the project?
  10642. * Publishing action:: Setting the function doing the publishing
  10643. * Publishing options:: Tweaking HTML/@LaTeX{} export
  10644. * Publishing links:: Which links keep working after publishing?
  10645. * Sitemap:: Generating a list of all pages
  10646. * Generating an index:: An index that reaches across pages
  10647. @end menu
  10648. @node Project alist, Sources and destinations, Configuration, Configuration
  10649. @subsection The variable @code{org-publish-project-alist}
  10650. @cindex org-publish-project-alist
  10651. @cindex projects, for publishing
  10652. @vindex org-publish-project-alist
  10653. Publishing is configured almost entirely through setting the value of one
  10654. variable, called @code{org-publish-project-alist}. Each element of the list
  10655. configures one project, and may be in one of the two following forms:
  10656. @lisp
  10657. ("project-name" :property value :property value ...)
  10658. @r{i.e., a well-formed property list with alternating keys and values}
  10659. @r{or}
  10660. ("project-name" :components ("project-name" "project-name" ...))
  10661. @end lisp
  10662. In both cases, projects are configured by specifying property values. A
  10663. project defines the set of files that will be published, as well as the
  10664. publishing configuration to use when publishing those files. When a project
  10665. takes the second form listed above, the individual members of the
  10666. @code{:components} property are taken to be sub-projects, which group
  10667. together files requiring different publishing options. When you publish such
  10668. a ``meta-project'', all the components will also be published, in the
  10669. sequence given.
  10670. @node Sources and destinations, Selecting files, Project alist, Configuration
  10671. @subsection Sources and destinations for files
  10672. @cindex directories, for publishing
  10673. Most properties are optional, but some should always be set. In
  10674. particular, Org needs to know where to look for source files,
  10675. and where to put published files.
  10676. @multitable @columnfractions 0.3 0.7
  10677. @item @code{:base-directory}
  10678. @tab Directory containing publishing source files
  10679. @item @code{:publishing-directory}
  10680. @tab Directory where output files will be published. You can directly
  10681. publish to a webserver using a file name syntax appropriate for
  10682. the Emacs @file{tramp} package. Or you can publish to a local directory and
  10683. use external tools to upload your website (@pxref{Uploading files}).
  10684. @item @code{:preparation-function}
  10685. @tab Function or list of functions to be called before starting the
  10686. publishing process, for example, to run @code{make} for updating files to be
  10687. published. The project property list is scoped into this call as the
  10688. variable @code{project-plist}.
  10689. @item @code{:completion-function}
  10690. @tab Function or list of functions called after finishing the publishing
  10691. process, for example, to change permissions of the resulting files. The
  10692. project property list is scoped into this call as the variable
  10693. @code{project-plist}.
  10694. @end multitable
  10695. @noindent
  10696. @node Selecting files, Publishing action, Sources and destinations, Configuration
  10697. @subsection Selecting files
  10698. @cindex files, selecting for publishing
  10699. By default, all files with extension @file{.org} in the base directory
  10700. are considered part of the project. This can be modified by setting the
  10701. properties
  10702. @multitable @columnfractions 0.25 0.75
  10703. @item @code{:base-extension}
  10704. @tab Extension (without the dot!) of source files. This actually is a
  10705. regular expression. Set this to the symbol @code{any} if you want to get all
  10706. files in @code{:base-directory}, even without extension.
  10707. @item @code{:exclude}
  10708. @tab Regular expression to match file names that should not be
  10709. published, even though they have been selected on the basis of their
  10710. extension.
  10711. @item @code{:include}
  10712. @tab List of files to be included regardless of @code{:base-extension}
  10713. and @code{:exclude}.
  10714. @item @code{:recursive}
  10715. @tab Non-nil means, check base-directory recursively for files to publish.
  10716. @end multitable
  10717. @node Publishing action, Publishing options, Selecting files, Configuration
  10718. @subsection Publishing action
  10719. @cindex action, for publishing
  10720. Publishing means that a file is copied to the destination directory and
  10721. possibly transformed in the process. The default transformation is to export
  10722. Org files as HTML files, and this is done by the function
  10723. @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
  10724. export}). But you also can publish your content as PDF files using
  10725. @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
  10726. @code{utf8} encoded files using the corresponding functions. If you want to
  10727. publish the Org file itself, but with @i{archived}, @i{commented}, and
  10728. @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
  10729. parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
  10730. produce @file{file.org} and @file{file.org.html} in the publishing
  10731. directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
  10732. source and publishing directories are equal. Note that with this kind of
  10733. setup, you need to add @code{:exclude "-source\\.org"} to the project
  10734. definition in @code{org-publish-project-alist} to prevent the published
  10735. source files from being considered as new org files the next time the project
  10736. is published.}. Other files like images only need to be copied to the
  10737. publishing destination; for this you may use @code{org-publish-attachment}.
  10738. For non-Org files, you always need to specify the publishing function:
  10739. @multitable @columnfractions 0.3 0.7
  10740. @item @code{:publishing-function}
  10741. @tab Function executing the publication of a file. This may also be a
  10742. list of functions, which will all be called in turn.
  10743. @item @code{:plain-source}
  10744. @tab Non-nil means, publish plain source.
  10745. @item @code{:htmlized-source}
  10746. @tab Non-nil means, publish htmlized source.
  10747. @end multitable
  10748. The function must accept three arguments: a property list containing at least
  10749. a @code{:publishing-directory} property, the name of the file to be
  10750. published, and the path to the publishing directory of the output file. It
  10751. should take the specified file, make the necessary transformation (if any)
  10752. and place the result into the destination folder.
  10753. @node Publishing options, Publishing links, Publishing action, Configuration
  10754. @subsection Options for the HTML/@LaTeX{} exporters
  10755. @cindex options, for publishing
  10756. The property list can be used to set many export options for the HTML
  10757. and @LaTeX{} exporters. In most cases, these properties correspond to user
  10758. variables in Org. The table below lists these properties along
  10759. with the variable they belong to. See the documentation string for the
  10760. respective variable for details.
  10761. @vindex org-export-html-link-up
  10762. @vindex org-export-html-link-home
  10763. @vindex org-export-default-language
  10764. @vindex org-display-custom-times
  10765. @vindex org-export-headline-levels
  10766. @vindex org-export-with-section-numbers
  10767. @vindex org-export-section-number-format
  10768. @vindex org-export-with-toc
  10769. @vindex org-export-preserve-breaks
  10770. @vindex org-export-with-archived-trees
  10771. @vindex org-export-with-emphasize
  10772. @vindex org-export-with-sub-superscripts
  10773. @vindex org-export-with-special-strings
  10774. @vindex org-export-with-footnotes
  10775. @vindex org-export-with-drawers
  10776. @vindex org-export-with-tags
  10777. @vindex org-export-with-todo-keywords
  10778. @vindex org-export-with-tasks
  10779. @vindex org-export-with-done-tasks
  10780. @vindex org-export-with-priority
  10781. @vindex org-export-with-TeX-macros
  10782. @vindex org-export-with-LaTeX-fragments
  10783. @vindex org-export-skip-text-before-1st-heading
  10784. @vindex org-export-with-fixed-width
  10785. @vindex org-export-with-timestamps
  10786. @vindex org-export-author-info
  10787. @vindex org-export-email-info
  10788. @vindex org-export-creator-info
  10789. @vindex org-export-time-stamp-file
  10790. @vindex org-export-with-tables
  10791. @vindex org-export-highlight-first-table-line
  10792. @vindex org-export-html-style-include-default
  10793. @vindex org-export-html-style-include-scripts
  10794. @vindex org-export-html-style
  10795. @vindex org-export-html-style-extra
  10796. @vindex org-export-html-link-org-files-as-html
  10797. @vindex org-export-html-inline-images
  10798. @vindex org-export-html-extension
  10799. @vindex org-export-html-table-tag
  10800. @vindex org-export-html-expand
  10801. @vindex org-export-html-with-timestamp
  10802. @vindex org-export-publishing-directory
  10803. @vindex org-export-html-preamble
  10804. @vindex org-export-html-postamble
  10805. @vindex user-full-name
  10806. @vindex user-mail-address
  10807. @vindex org-export-select-tags
  10808. @vindex org-export-exclude-tags
  10809. @multitable @columnfractions 0.32 0.68
  10810. @item @code{:link-up} @tab @code{org-export-html-link-up}
  10811. @item @code{:link-home} @tab @code{org-export-html-link-home}
  10812. @item @code{:language} @tab @code{org-export-default-language}
  10813. @item @code{:customtime} @tab @code{org-display-custom-times}
  10814. @item @code{:headline-levels} @tab @code{org-export-headline-levels}
  10815. @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
  10816. @item @code{:section-number-format} @tab @code{org-export-section-number-format}
  10817. @item @code{:table-of-contents} @tab @code{org-export-with-toc}
  10818. @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
  10819. @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
  10820. @item @code{:emphasize} @tab @code{org-export-with-emphasize}
  10821. @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
  10822. @item @code{:special-strings} @tab @code{org-export-with-special-strings}
  10823. @item @code{:footnotes} @tab @code{org-export-with-footnotes}
  10824. @item @code{:drawers} @tab @code{org-export-with-drawers}
  10825. @item @code{:tags} @tab @code{org-export-with-tags}
  10826. @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
  10827. @item @code{:tasks} @tab @code{org-export-with-tasks}
  10828. @item @code{:priority} @tab @code{org-export-with-priority}
  10829. @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
  10830. @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
  10831. @item @code{:latex-listings} @tab @code{org-export-latex-listings}
  10832. @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
  10833. @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
  10834. @item @code{:timestamps} @tab @code{org-export-with-timestamps}
  10835. @item @code{:author} @tab @code{user-full-name}
  10836. @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
  10837. @item @code{:author-info} @tab @code{org-export-author-info}
  10838. @item @code{:email-info} @tab @code{org-export-email-info}
  10839. @item @code{:creator-info} @tab @code{org-export-creator-info}
  10840. @item @code{:tables} @tab @code{org-export-with-tables}
  10841. @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
  10842. @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
  10843. @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
  10844. @item @code{:style} @tab @code{org-export-html-style}
  10845. @item @code{:style-extra} @tab @code{org-export-html-style-extra}
  10846. @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
  10847. @item @code{:inline-images} @tab @code{org-export-html-inline-images}
  10848. @item @code{:html-extension} @tab @code{org-export-html-extension}
  10849. @item @code{:html-preamble} @tab @code{org-export-html-preamble}
  10850. @item @code{:html-postamble} @tab @code{org-export-html-postamble}
  10851. @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
  10852. @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
  10853. @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
  10854. @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
  10855. @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
  10856. @item @code{:select-tags} @tab @code{org-export-select-tags}
  10857. @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
  10858. @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
  10859. @end multitable
  10860. Most of the @code{org-export-with-*} variables have the same effect in
  10861. both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
  10862. @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
  10863. @LaTeX{} export. See @code{org-export-plist-vars} to check this list of
  10864. options.
  10865. @vindex org-publish-project-alist
  10866. When a property is given a value in @code{org-publish-project-alist},
  10867. its setting overrides the value of the corresponding user variable (if
  10868. any) during publishing. Options set within a file (@pxref{Export
  10869. options}), however, override everything.
  10870. @node Publishing links, Sitemap, Publishing options, Configuration
  10871. @subsection Links between published files
  10872. @cindex links, publishing
  10873. To create a link from one Org file to another, you would use
  10874. something like @samp{[[file:foo.org][The foo]]} or simply
  10875. @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
  10876. becomes a link to @file{foo.html}. In this way, you can interlink the
  10877. pages of your "org web" project and the links will work as expected when
  10878. you publish them to HTML@. If you also publish the Org source file and want
  10879. to link to that, use an @code{http:} link instead of a @code{file:} link,
  10880. because @code{file:} links are converted to link to the corresponding
  10881. @file{html} file.
  10882. You may also link to related files, such as images. Provided you are careful
  10883. with relative file names, and provided you have also configured Org to upload
  10884. the related files, these links will work too. See @ref{Complex example}, for
  10885. an example of this usage.
  10886. Sometimes an Org file to be published may contain links that are
  10887. only valid in your production environment, but not in the publishing
  10888. location. In this case, use the property
  10889. @multitable @columnfractions 0.4 0.6
  10890. @item @code{:link-validation-function}
  10891. @tab Function to validate links
  10892. @end multitable
  10893. @noindent
  10894. to define a function for checking link validity. This function must
  10895. accept two arguments, the file name and a directory relative to which
  10896. the file name is interpreted in the production environment. If this
  10897. function returns @code{nil}, then the HTML generator will only insert a
  10898. description into the HTML file, but no link. One option for this
  10899. function is @code{org-publish-validate-link} which checks if the given
  10900. file is part of any project in @code{org-publish-project-alist}.
  10901. @node Sitemap, Generating an index, Publishing links, Configuration
  10902. @subsection Generating a sitemap
  10903. @cindex sitemap, of published pages
  10904. The following properties may be used to control publishing of
  10905. a map of files for a given project.
  10906. @multitable @columnfractions 0.35 0.65
  10907. @item @code{:auto-sitemap}
  10908. @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
  10909. or @code{org-publish-all}.
  10910. @item @code{:sitemap-filename}
  10911. @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
  10912. becomes @file{sitemap.html}).
  10913. @item @code{:sitemap-title}
  10914. @tab Title of sitemap page. Defaults to name of file.
  10915. @item @code{:sitemap-function}
  10916. @tab Plug-in function to use for generation of the sitemap.
  10917. Defaults to @code{org-publish-org-sitemap}, which generates a plain list
  10918. of links to all files in the project.
  10919. @item @code{:sitemap-sort-folders}
  10920. @tab Where folders should appear in the sitemap. Set this to @code{first}
  10921. (default) or @code{last} to display folders first or last,
  10922. respectively. Any other value will mix files and folders.
  10923. @item @code{:sitemap-sort-files}
  10924. @tab How the files are sorted in the site map. Set this to
  10925. @code{alphabetically} (default), @code{chronologically} or
  10926. @code{anti-chronologically}. @code{chronologically} sorts the files with
  10927. older date first while @code{anti-chronologically} sorts the files with newer
  10928. date first. @code{alphabetically} sorts the files alphabetically. The date of
  10929. a file is retrieved with @code{org-publish-find-date}.
  10930. @item @code{:sitemap-ignore-case}
  10931. @tab Should sorting be case-sensitive? Default @code{nil}.
  10932. @item @code{:sitemap-file-entry-format}
  10933. @tab With this option one can tell how a sitemap's entry is formatted in the
  10934. sitemap. This is a format string with some escape sequences: @code{%t} stands
  10935. for the title of the file, @code{%a} stands for the author of the file and
  10936. @code{%d} stands for the date of the file. The date is retrieved with the
  10937. @code{org-publish-find-date} function and formatted with
  10938. @code{org-publish-sitemap-date-format}. Default @code{%t}.
  10939. @item @code{:sitemap-date-format}
  10940. @tab Format string for the @code{format-time-string} function that tells how
  10941. a sitemap entry's date is to be formatted. This property bypasses
  10942. @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
  10943. @item @code{:sitemap-sans-extension}
  10944. @tab When non-nil, remove filenames' extensions from the generated sitemap.
  10945. Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
  10946. Defaults to @code{nil}.
  10947. @end multitable
  10948. @node Generating an index, , Sitemap, Configuration
  10949. @subsection Generating an index
  10950. @cindex index, in a publishing project
  10951. Org mode can generate an index across the files of a publishing project.
  10952. @multitable @columnfractions 0.25 0.75
  10953. @item @code{:makeindex}
  10954. @tab When non-nil, generate in index in the file @file{theindex.org} and
  10955. publish it as @file{theindex.html}.
  10956. @end multitable
  10957. The file will be created when first publishing a project with the
  10958. @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
  10959. "theindex.inc"}. You can then build around this include statement by adding
  10960. a title, style information, etc.
  10961. @node Uploading files, Sample configuration, Configuration, Publishing
  10962. @section Uploading files
  10963. @cindex rsync
  10964. @cindex unison
  10965. For those people already utilizing third party sync tools such as
  10966. @command{rsync} or @command{unison}, it might be preferable not to use the built in
  10967. @i{remote} publishing facilities of Org mode which rely heavily on
  10968. Tramp. Tramp, while very useful and powerful, tends not to be
  10969. so efficient for multiple file transfer and has been known to cause problems
  10970. under heavy usage.
  10971. Specialized synchronization utilities offer several advantages. In addition
  10972. to timestamp comparison, they also do content and permissions/attribute
  10973. checks. For this reason you might prefer to publish your web to a local
  10974. directory (possibly even @i{in place} with your Org files) and then use
  10975. @file{unison} or @file{rsync} to do the synchronization with the remote host.
  10976. Since Unison (for example) can be configured as to which files to transfer to
  10977. a certain remote destination, it can greatly simplify the project publishing
  10978. definition. Simply keep all files in the correct location, process your Org
  10979. files with @code{org-publish} and let the synchronization tool do the rest.
  10980. You do not need, in this scenario, to include attachments such as @file{jpg},
  10981. @file{css} or @file{gif} files in the project definition since the 3rd party
  10982. tool syncs them.
  10983. Publishing to a local directory is also much faster than to a remote one, so
  10984. that you can afford more easily to republish entire projects. If you set
  10985. @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
  10986. benefit of re-including any changed external files such as source example
  10987. files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
  10988. Org is not smart enough to detect if included files have been modified.
  10989. @node Sample configuration, Triggering publication, Uploading files, Publishing
  10990. @section Sample configuration
  10991. Below we provide two example configurations. The first one is a simple
  10992. project publishing only a set of Org files. The second example is
  10993. more complex, with a multi-component project.
  10994. @menu
  10995. * Simple example:: One-component publishing
  10996. * Complex example:: A multi-component publishing example
  10997. @end menu
  10998. @node Simple example, Complex example, Sample configuration, Sample configuration
  10999. @subsection Example: simple publishing configuration
  11000. This example publishes a set of Org files to the @file{public_html}
  11001. directory on the local machine.
  11002. @lisp
  11003. (setq org-publish-project-alist
  11004. '(("org"
  11005. :base-directory "~/org/"
  11006. :publishing-directory "~/public_html"
  11007. :section-numbers nil
  11008. :table-of-contents nil
  11009. :style "<link rel=\"stylesheet\"
  11010. href=\"../other/mystyle.css\"
  11011. type=\"text/css\"/>")))
  11012. @end lisp
  11013. @node Complex example, , Simple example, Sample configuration
  11014. @subsection Example: complex publishing configuration
  11015. This more complicated example publishes an entire website, including
  11016. Org files converted to HTML, image files, Emacs Lisp source code, and
  11017. style sheets. The publishing directory is remote and private files are
  11018. excluded.
  11019. To ensure that links are preserved, care should be taken to replicate
  11020. your directory structure on the web server, and to use relative file
  11021. paths. For example, if your Org files are kept in @file{~/org} and your
  11022. publishable images in @file{~/images}, you would link to an image with
  11023. @c
  11024. @example
  11025. file:../images/myimage.png
  11026. @end example
  11027. @c
  11028. On the web server, the relative path to the image should be the
  11029. same. You can accomplish this by setting up an "images" folder in the
  11030. right place on the web server, and publishing images to it.
  11031. @lisp
  11032. (setq org-publish-project-alist
  11033. '(("orgfiles"
  11034. :base-directory "~/org/"
  11035. :base-extension "org"
  11036. :publishing-directory "/ssh:user@@host:~/html/notebook/"
  11037. :publishing-function org-publish-org-to-html
  11038. :exclude "PrivatePage.org" ;; regexp
  11039. :headline-levels 3
  11040. :section-numbers nil
  11041. :table-of-contents nil
  11042. :style "<link rel=\"stylesheet\"
  11043. href=\"../other/mystyle.css\" type=\"text/css\"/>"
  11044. :html-preamble t)
  11045. ("images"
  11046. :base-directory "~/images/"
  11047. :base-extension "jpg\\|gif\\|png"
  11048. :publishing-directory "/ssh:user@@host:~/html/images/"
  11049. :publishing-function org-publish-attachment)
  11050. ("other"
  11051. :base-directory "~/other/"
  11052. :base-extension "css\\|el"
  11053. :publishing-directory "/ssh:user@@host:~/html/other/"
  11054. :publishing-function org-publish-attachment)
  11055. ("website" :components ("orgfiles" "images" "other"))))
  11056. @end lisp
  11057. @node Triggering publication, , Sample configuration, Publishing
  11058. @section Triggering publication
  11059. Once properly configured, Org can publish with the following commands:
  11060. @table @kbd
  11061. @orgcmd{C-c C-e X,org-publish}
  11062. Prompt for a specific project and publish all files that belong to it.
  11063. @orgcmd{C-c C-e P,org-publish-current-project}
  11064. Publish the project containing the current file.
  11065. @orgcmd{C-c C-e F,org-publish-current-file}
  11066. Publish only the current file.
  11067. @orgcmd{C-c C-e E,org-publish-all}
  11068. Publish every project.
  11069. @end table
  11070. @vindex org-publish-use-timestamps-flag
  11071. Org uses timestamps to track when a file has changed. The above functions
  11072. normally only publish changed files. You can override this and force
  11073. publishing of all files by giving a prefix argument to any of the commands
  11074. above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
  11075. This may be necessary in particular if files include other files via
  11076. @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
  11077. @comment node-name, next, previous, up
  11078. @comment Working With Source Code, Miscellaneous, Publishing, Top
  11079. @node Working With Source Code, Miscellaneous, Publishing, Top
  11080. @chapter Working with source code
  11081. @cindex Schulte, Eric
  11082. @cindex Davison, Dan
  11083. @cindex source code, working with
  11084. Source code can be included in Org mode documents using a @samp{src} block,
  11085. e.g.:
  11086. @example
  11087. #+BEGIN_SRC emacs-lisp
  11088. (defun org-xor (a b)
  11089. "Exclusive or."
  11090. (if a (not b) b))
  11091. #+END_SRC
  11092. @end example
  11093. Org mode provides a number of features for working with live source code,
  11094. including editing of code blocks in their native major-mode, evaluation of
  11095. code blocks, converting code blocks into source files (known as @dfn{tangling}
  11096. in literate programming), and exporting code blocks and their
  11097. results in several formats. This functionality was contributed by Eric
  11098. Schulte and Dan Davison, and was originally named Org-babel.
  11099. The following sections describe Org mode's code block handling facilities.
  11100. @menu
  11101. * Structure of code blocks:: Code block syntax described
  11102. * Editing source code:: Language major-mode editing
  11103. * Exporting code blocks:: Export contents and/or results
  11104. * Extracting source code:: Create pure source code files
  11105. * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
  11106. * Library of Babel:: Use and contribute to a library of useful code blocks
  11107. * Languages:: List of supported code block languages
  11108. * Header arguments:: Configure code block functionality
  11109. * Results of evaluation:: How evaluation results are handled
  11110. * Noweb reference syntax:: Literate programming in Org mode
  11111. * Key bindings and useful functions:: Work quickly with code blocks
  11112. * Batch execution:: Call functions from the command line
  11113. @end menu
  11114. @comment node-name, next, previous, up
  11115. @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
  11116. @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
  11117. @section Structure of code blocks
  11118. @cindex code block, structure
  11119. @cindex source code, block structure
  11120. @cindex #+NAME
  11121. @cindex #+BEGIN_SRC
  11122. Live code blocks can be specified with a @samp{src} block or
  11123. inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
  11124. @ref{Easy Templates} system} The structure of a @samp{src} block is
  11125. @example
  11126. #+NAME: <name>
  11127. #+BEGIN_SRC <language> <switches> <header arguments>
  11128. <body>
  11129. #+END_SRC
  11130. @end example
  11131. The @code{#+NAME:} line is optional, and can be used to name the code
  11132. block. Live code blocks require that a language be specified on the
  11133. @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
  11134. @cindex source code, inline
  11135. Live code blocks can also be specified inline using
  11136. @example
  11137. src_<language>@{<body>@}
  11138. @end example
  11139. or
  11140. @example
  11141. src_<language>[<header arguments>]@{<body>@}
  11142. @end example
  11143. @table @code
  11144. @item <#+NAME: name>
  11145. This line associates a name with the code block. This is similar to the
  11146. @code{#+TBLNAME: NAME} lines that can be used to name tables in Org mode
  11147. files. Referencing the name of a code block makes it possible to evaluate
  11148. the block from other places in the file, from other files, or from Org mode
  11149. table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
  11150. and the behavior of Org mode when two or more blocks share the same name is
  11151. undefined.
  11152. @cindex #+NAME
  11153. @item <language>
  11154. The language of the code in the block (see @ref{Languages}).
  11155. @cindex source code, language
  11156. @item <switches>
  11157. Optional switches control code block export (see the discussion of switches in
  11158. @ref{Literal examples})
  11159. @cindex source code, switches
  11160. @item <header arguments>
  11161. Optional header arguments control many aspects of evaluation, export and
  11162. tangling of code blocks (see @ref{Header arguments}).
  11163. Header arguments can also be set on a per-buffer or per-subtree
  11164. basis using properties.
  11165. @item source code, header arguments
  11166. @item <body>
  11167. Source code in the specified language.
  11168. @end table
  11169. @comment node-name, next, previous, up
  11170. @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
  11171. @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
  11172. @section Editing source code
  11173. @cindex code block, editing
  11174. @cindex source code, editing
  11175. @kindex C-c '
  11176. Use @kbd{C-c '} to edit the current code block. This brings up
  11177. a language major-mode edit buffer containing the body of the code
  11178. block. Saving this buffer will write the new contents back to the Org
  11179. buffer. Use @kbd{C-c '} again to exit.
  11180. The @code{org-src-mode} minor mode will be active in the edit buffer. The
  11181. following variables can be used to configure the behavior of the edit
  11182. buffer. See also the customization group @code{org-edit-structure} for
  11183. further configuration options.
  11184. @table @code
  11185. @item org-src-lang-modes
  11186. If an Emacs major-mode named @code{<lang>-mode} exists, where
  11187. @code{<lang>} is the language named in the header line of the code block,
  11188. then the edit buffer will be placed in that major-mode. This variable
  11189. can be used to map arbitrary language names to existing major modes.
  11190. @item org-src-window-setup
  11191. Controls the way Emacs windows are rearranged when the edit buffer is created.
  11192. @item org-src-preserve-indentation
  11193. This variable is especially useful for tangling languages such as
  11194. Python, in which whitespace indentation in the output is critical.
  11195. @item org-src-ask-before-returning-to-edit-buffer
  11196. By default, Org will ask before returning to an open edit buffer. Set this
  11197. variable to nil to switch without asking.
  11198. @end table
  11199. To turn on native code fontification in the @emph{Org} buffer, configure the
  11200. variable @code{org-src-fontify-natively}.
  11201. @comment node-name, next, previous, up
  11202. @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
  11203. @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
  11204. @section Exporting code blocks
  11205. @cindex code block, exporting
  11206. @cindex source code, exporting
  11207. It is possible to export the @emph{code} of code blocks, the @emph{results}
  11208. of code block evaluation, @emph{both} the code and the results of code block
  11209. evaluation, or @emph{none}. For most languages, the default exports code.
  11210. However, for some languages (e.g., @code{ditaa}) the default exports the
  11211. results of code block evaluation. For information on exporting code block
  11212. bodies, see @ref{Literal examples}.
  11213. The @code{:exports} header argument can be used to specify export
  11214. behavior:
  11215. @subsubheading Header arguments:
  11216. @table @code
  11217. @item :exports code
  11218. The default in most languages. The body of the code block is exported, as
  11219. described in @ref{Literal examples}.
  11220. @item :exports results
  11221. The code block will be evaluated and the results will be placed in the
  11222. Org mode buffer for export, either updating previous results of the code
  11223. block located anywhere in the buffer or, if no previous results exist,
  11224. placing the results immediately after the code block. The body of the code
  11225. block will not be exported.
  11226. @item :exports both
  11227. Both the code block and its results will be exported.
  11228. @item :exports none
  11229. Neither the code block nor its results will be exported.
  11230. @end table
  11231. It is possible to inhibit the evaluation of code blocks during export.
  11232. Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
  11233. ensure that no code blocks are evaluated as part of the export process. This
  11234. can be useful in situations where potentially untrusted Org mode files are
  11235. exported in an automated fashion, for example when Org mode is used as the
  11236. markup language for a wiki.
  11237. @comment node-name, next, previous, up
  11238. @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
  11239. @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
  11240. @section Extracting source code
  11241. @cindex tangling
  11242. @cindex source code, extracting
  11243. @cindex code block, extracting source code
  11244. Creating pure source code files by extracting code from source blocks is
  11245. referred to as ``tangling''---a term adopted from the literate programming
  11246. community. During ``tangling'' of code blocks their bodies are expanded
  11247. using @code{org-babel-expand-src-block} which can expand both variable and
  11248. ``noweb'' style references (see @ref{Noweb reference syntax}).
  11249. @subsubheading Header arguments
  11250. @table @code
  11251. @item :tangle no
  11252. The default. The code block is not included in the tangled output.
  11253. @item :tangle yes
  11254. Include the code block in the tangled output. The output file name is the
  11255. name of the org file with the extension @samp{.org} replaced by the extension
  11256. for the block language.
  11257. @item :tangle filename
  11258. Include the code block in the tangled output to file @samp{filename}.
  11259. @end table
  11260. @kindex C-c C-v t
  11261. @subsubheading Functions
  11262. @table @code
  11263. @item org-babel-tangle
  11264. Tangle the current file. Bound to @kbd{C-c C-v t}.
  11265. With prefix argument only tangle the current code block.
  11266. @item org-babel-tangle-file
  11267. Choose a file to tangle. Bound to @kbd{C-c C-v f}.
  11268. @end table
  11269. @subsubheading Hooks
  11270. @table @code
  11271. @item org-babel-post-tangle-hook
  11272. This hook is run from within code files tangled by @code{org-babel-tangle}.
  11273. Example applications could include post-processing, compilation or evaluation
  11274. of tangled code files.
  11275. @end table
  11276. @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
  11277. @section Evaluating code blocks
  11278. @cindex code block, evaluating
  11279. @cindex source code, evaluating
  11280. @cindex #+RESULTS
  11281. Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
  11282. potential for that code to do harm. Org mode provides safeguards to ensure
  11283. that code is only evaluated after explicit confirmation from the user. For
  11284. information on these safeguards (and on how to disable them) see @ref{Code
  11285. evaluation security}.} and the results of evaluation optionally placed in the
  11286. Org mode buffer. The results of evaluation are placed following a line that
  11287. begins by default with @code{#+RESULTS} and optionally a cache identifier
  11288. and/or the name of the evaluated code block. The default value of
  11289. @code{#+RESULTS} can be changed with the customizable variable
  11290. @code{org-babel-results-keyword}.
  11291. By default, the evaluation facility is only enabled for Lisp code blocks
  11292. specified as @code{emacs-lisp}. However, source code blocks in many languages
  11293. can be evaluated within Org mode (see @ref{Languages} for a list of supported
  11294. languages and @ref{Structure of code blocks} for information on the syntax
  11295. used to define a code block).
  11296. @kindex C-c C-c
  11297. There are a number of ways to evaluate code blocks. The simplest is to press
  11298. @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
  11299. @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
  11300. evaluation from the @kbd{C-c C-c} key binding.}. This will call the
  11301. @code{org-babel-execute-src-block} function to evaluate the block and insert
  11302. its results into the Org mode buffer.
  11303. @cindex #+CALL
  11304. It is also possible to evaluate named code blocks from anywhere in an Org
  11305. mode buffer or an Org mode table. Live code blocks located in the current
  11306. Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
  11307. can be executed. Named code blocks can be executed with a separate
  11308. @code{#+CALL:} line or inline within a block of text.
  11309. The syntax of the @code{#+CALL:} line is
  11310. @example
  11311. #+CALL: <name>(<arguments>)
  11312. #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
  11313. @end example
  11314. The syntax for inline evaluation of named code blocks is
  11315. @example
  11316. ... call_<name>(<arguments>) ...
  11317. ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
  11318. @end example
  11319. @table @code
  11320. @item <name>
  11321. The name of the code block to be evaluated (see @ref{Structure of code blocks}).
  11322. @item <arguments>
  11323. Arguments specified in this section will be passed to the code block. These
  11324. arguments use standard function call syntax, rather than
  11325. header argument syntax. For example, a @code{#+CALL:} line that passes the
  11326. number four to a code block named @code{double}, which declares the header
  11327. argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
  11328. @item <inside header arguments>
  11329. Inside header arguments are passed through and applied to the named code
  11330. block. These arguments use header argument syntax rather than standard
  11331. function call syntax. Inside header arguments affect how the code block is
  11332. evaluated. For example, @code{[:results output]} will collect the results of
  11333. everything printed to @code{STDOUT} during execution of the code block.
  11334. @item <end header arguments>
  11335. End header arguments are applied to the calling instance and do not affect
  11336. evaluation of the named code block. They affect how the results are
  11337. incorporated into the Org mode buffer and how the call line is exported. For
  11338. example, @code{:results html} will insert the results of the call line
  11339. evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
  11340. For more examples of passing header arguments to @code{#+CALL:} lines see
  11341. @ref{Header arguments in function calls}.
  11342. @end table
  11343. @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
  11344. @section Library of Babel
  11345. @cindex babel, library of
  11346. @cindex source code, library
  11347. @cindex code block, library
  11348. The ``Library of Babel'' consists of code blocks that can be called from any
  11349. Org mode file. Code blocks defined in the ``Library of Babel'' can be called
  11350. remotely as if they were in the current Org mode buffer (see @ref{Evaluating
  11351. code blocks} for information on the syntax of remote code block evaluation).
  11352. The central repository of code blocks in the ``Library of Babel'' is housed
  11353. in an Org mode file located in the @samp{contrib} directory of Org mode.
  11354. Users can add code blocks they believe to be generally useful to their
  11355. ``Library of Babel.'' The code blocks can be stored in any Org mode file and
  11356. then loaded into the library with @code{org-babel-lob-ingest}.
  11357. @kindex C-c C-v i
  11358. Code blocks located in any Org mode file can be loaded into the ``Library of
  11359. Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
  11360. i}.
  11361. @node Languages, Header arguments, Library of Babel, Working With Source Code
  11362. @section Languages
  11363. @cindex babel, languages
  11364. @cindex source code, languages
  11365. @cindex code block, languages
  11366. Code blocks in the following languages are supported.
  11367. @multitable @columnfractions 0.28 0.3 0.22 0.2
  11368. @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
  11369. @item Asymptote @tab asymptote @tab Awk @tab awk
  11370. @item Emacs Calc @tab calc @tab C @tab C
  11371. @item C++ @tab C++ @tab Clojure @tab clojure
  11372. @item CSS @tab css @tab ditaa @tab ditaa
  11373. @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
  11374. @item gnuplot @tab gnuplot @tab Haskell @tab haskell
  11375. @item Java @tab java @tab @tab
  11376. @item Javascript @tab js @tab LaTeX @tab latex
  11377. @item Ledger @tab ledger @tab Lisp @tab lisp
  11378. @item Lilypond @tab lilypond @tab MATLAB @tab matlab
  11379. @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
  11380. @item Octave @tab octave @tab Org mode @tab org
  11381. @item Oz @tab oz @tab Perl @tab perl
  11382. @item Plantuml @tab plantuml @tab Python @tab python
  11383. @item R @tab R @tab Ruby @tab ruby
  11384. @item Sass @tab sass @tab Scheme @tab scheme
  11385. @item GNU Screen @tab screen @tab shell @tab sh
  11386. @item SQL @tab sql @tab SQLite @tab sqlite
  11387. @end multitable
  11388. Language-specific documentation is available for some languages. If
  11389. available, it can be found at
  11390. @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
  11391. The @code{org-babel-load-languages} controls which languages are enabled for
  11392. evaluation (by default only @code{emacs-lisp} is enabled). This variable can
  11393. be set using the customization interface or by adding code like the following
  11394. to your emacs configuration.
  11395. @quotation
  11396. The following disables @code{emacs-lisp} evaluation and enables evaluation of
  11397. @code{R} code blocks.
  11398. @end quotation
  11399. @lisp
  11400. (org-babel-do-load-languages
  11401. 'org-babel-load-languages
  11402. '((emacs-lisp . nil)
  11403. (R . t)))
  11404. @end lisp
  11405. It is also possible to enable support for a language by loading the related
  11406. elisp file with @code{require}.
  11407. @quotation
  11408. The following adds support for evaluating @code{clojure} code blocks.
  11409. @end quotation
  11410. @lisp
  11411. (require 'ob-clojure)
  11412. @end lisp
  11413. @node Header arguments, Results of evaluation, Languages, Working With Source Code
  11414. @section Header arguments
  11415. @cindex code block, header arguments
  11416. @cindex source code, block header arguments
  11417. Code block functionality can be configured with header arguments. This
  11418. section provides an overview of the use of header arguments, and then
  11419. describes each header argument in detail.
  11420. @menu
  11421. * Using header arguments:: Different ways to set header arguments
  11422. * Specific header arguments:: List of header arguments
  11423. @end menu
  11424. @node Using header arguments, Specific header arguments, Header arguments, Header arguments
  11425. @subsection Using header arguments
  11426. The values of header arguments can be set in six different ways, each more
  11427. specific (and having higher priority) than the last.
  11428. @menu
  11429. * System-wide header arguments:: Set global default values
  11430. * Language-specific header arguments:: Set default values by language
  11431. * Buffer-wide header arguments:: Set default values for a specific buffer
  11432. * Header arguments in Org mode properties:: Set default values for a buffer or heading
  11433. * Code block specific header arguments:: The most common way to set values
  11434. * Header arguments in function calls:: The most specific level
  11435. @end menu
  11436. @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
  11437. @subsubheading System-wide header arguments
  11438. @vindex org-babel-default-header-args
  11439. System-wide values of header arguments can be specified by customizing the
  11440. @code{org-babel-default-header-args} variable:
  11441. @example
  11442. :session => "none"
  11443. :results => "replace"
  11444. :exports => "code"
  11445. :cache => "no"
  11446. :noweb => "no"
  11447. @end example
  11448. @c @example
  11449. @c org-babel-default-header-args is a variable defined in `org-babel.el'.
  11450. @c Its value is
  11451. @c ((:session . "none")
  11452. @c (:results . "replace")
  11453. @c (:exports . "code")
  11454. @c (:cache . "no")
  11455. @c (:noweb . "no"))
  11456. @c Documentation:
  11457. @c Default arguments to use when evaluating a code block.
  11458. @c @end example
  11459. For example, the following example could be used to set the default value of
  11460. @code{:noweb} header arguments to @code{yes}. This would have the effect of
  11461. expanding @code{:noweb} references by default when evaluating source code
  11462. blocks.
  11463. @lisp
  11464. (setq org-babel-default-header-args
  11465. (cons '(:noweb . "yes")
  11466. (assq-delete-all :noweb org-babel-default-header-args)))
  11467. @end lisp
  11468. @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
  11469. @subsubheading Language-specific header arguments
  11470. Each language can define its own set of default header arguments. See the
  11471. language-specific documentation available online at
  11472. @uref{http://orgmode.org/worg/org-contrib/babel}.
  11473. @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
  11474. @subsubheading Buffer-wide header arguments
  11475. Buffer-wide header arguments may be specified as properties through the use
  11476. of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
  11477. @ref{Property syntax}).
  11478. For example the following would set @code{session} to @code{*R*}, and
  11479. @code{results} to @code{silent} for every code block in the buffer, ensuring
  11480. that all execution took place in the same session, and no results would be
  11481. inserted into the buffer.
  11482. @example
  11483. #+PROPERTY: session *R*
  11484. #+PROPERTY: results silent
  11485. @end example
  11486. @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
  11487. @subsubheading Header arguments in Org mode properties
  11488. Header arguments are also read from Org mode properties (see @ref{Property
  11489. syntax}), which can be set on a buffer-wide or per-heading basis. An example
  11490. of setting a header argument for all code blocks in a buffer is
  11491. @example
  11492. #+PROPERTY: tangle yes
  11493. @end example
  11494. @vindex org-use-property-inheritance
  11495. When properties are used to set default header arguments, they are looked up
  11496. with inheritance, regardless of the value of
  11497. @code{org-use-property-inheritance}. In the following example the value of
  11498. the @code{:cache} header argument will default to @code{yes} in all code
  11499. blocks in the subtree rooted at the following heading:
  11500. @example
  11501. * outline header
  11502. :PROPERTIES:
  11503. :cache: yes
  11504. :END:
  11505. @end example
  11506. @kindex C-c C-x p
  11507. @vindex org-babel-default-header-args
  11508. Properties defined in this way override the properties set in
  11509. @code{org-babel-default-header-args}. It is convenient to use the
  11510. @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
  11511. in Org mode documents.
  11512. @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
  11513. @subsubheading Code block specific header arguments
  11514. The most common way to assign values to header arguments is at the
  11515. code block level. This can be done by listing a sequence of header
  11516. arguments and their values as part of the @code{#+BEGIN_SRC} line.
  11517. Properties set in this way override both the values of
  11518. @code{org-babel-default-header-args} and header arguments specified as
  11519. properties. In the following example, the @code{:results} header argument
  11520. is set to @code{silent}, meaning the results of execution will not be
  11521. inserted in the buffer, and the @code{:exports} header argument is set to
  11522. @code{code}, meaning only the body of the code block will be
  11523. preserved on export to HTML or @LaTeX{}.
  11524. @example
  11525. #+NAME: factorial
  11526. #+BEGIN_SRC haskell :results silent :exports code :var n=0
  11527. fac 0 = 1
  11528. fac n = n * fac (n-1)
  11529. #+END_SRC
  11530. @end example
  11531. Similarly, it is possible to set header arguments for inline code blocks
  11532. @example
  11533. src_haskell[:exports both]@{fac 5@}
  11534. @end example
  11535. Code block header arguments can span multiple lines using @code{#+HEADER:} or
  11536. @code{#+HEADERS:} lines preceding a code block or nested between the
  11537. @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
  11538. @cindex #+HEADER:
  11539. @cindex #+HEADERS:
  11540. Multi-line header arguments on an un-named code block:
  11541. @example
  11542. #+HEADERS: :var data1=1
  11543. #+BEGIN_SRC emacs-lisp :var data2=2
  11544. (message "data1:%S, data2:%S" data1 data2)
  11545. #+END_SRC
  11546. #+RESULTS:
  11547. : data1:1, data2:2
  11548. @end example
  11549. Multi-line header arguments on a named code block:
  11550. @example
  11551. #+NAME: named-block
  11552. #+HEADER: :var data=2
  11553. #+BEGIN_SRC emacs-lisp
  11554. (message "data:%S" data)
  11555. #+END_SRC
  11556. #+RESULTS: named-block
  11557. : data:2
  11558. @end example
  11559. @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
  11560. @comment node-name, next, previous, up
  11561. @subsubheading Header arguments in function calls
  11562. At the most specific level, header arguments for ``Library of Babel'' or
  11563. @code{#+CALL:} lines can be set as shown in the two examples below. For more
  11564. information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
  11565. blocks}.
  11566. The following will apply the @code{:exports results} header argument to the
  11567. evaluation of the @code{#+CALL:} line.
  11568. @example
  11569. #+CALL: factorial(n=5) :exports results
  11570. @end example
  11571. The following will apply the @code{:session special} header argument to the
  11572. evaluation of the @code{factorial} code block.
  11573. @example
  11574. #+CALL: factorial[:session special](n=5)
  11575. @end example
  11576. @node Specific header arguments, , Using header arguments, Header arguments
  11577. @subsection Specific header arguments
  11578. Header arguments consist of an initial colon followed by the name of the
  11579. argument in lowercase letters. The following header arguments are defined:
  11580. @menu
  11581. * var:: Pass arguments to code blocks
  11582. * results:: Specify the type of results and how they will
  11583. be collected and handled
  11584. * file:: Specify a path for file output
  11585. * file-desc:: Specify a description for file results
  11586. * dir:: Specify the default (possibly remote)
  11587. directory for code block execution
  11588. * exports:: Export code and/or results
  11589. * tangle:: Toggle tangling and specify file name
  11590. * mkdirp:: Toggle creation of parent directories of target
  11591. files during tangling
  11592. * comments:: Toggle insertion of comments in tangled
  11593. code files
  11594. * padline:: Control insertion of padding lines in tangled
  11595. code files
  11596. * no-expand:: Turn off variable assignment and noweb
  11597. expansion during tangling
  11598. * session:: Preserve the state of code evaluation
  11599. * noweb:: Toggle expansion of noweb references
  11600. * noweb-ref:: Specify block's noweb reference resolution target
  11601. * noweb-sep:: String used to separate noweb references
  11602. * cache:: Avoid re-evaluating unchanged code blocks
  11603. * sep:: Delimiter for writing tabular results outside Org
  11604. * hlines:: Handle horizontal lines in tables
  11605. * colnames:: Handle column names in tables
  11606. * rownames:: Handle row names in tables
  11607. * shebang:: Make tangled files executable
  11608. * eval:: Limit evaluation of specific code blocks
  11609. * wrap:: Mark source block evaluation results
  11610. @end menu
  11611. Additional header arguments are defined on a language-specific basis, see
  11612. @ref{Languages}.
  11613. @node var, results, Specific header arguments, Specific header arguments
  11614. @subsubsection @code{:var}
  11615. The @code{:var} header argument is used to pass arguments to code blocks.
  11616. The specifics of how arguments are included in a code block vary by language;
  11617. these are addressed in the language-specific documentation. However, the
  11618. syntax used to specify arguments is the same across all languages. In every
  11619. case, variables require a default value when they are declared.
  11620. The values passed to arguments can either be literal values, references, or
  11621. Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
  11622. include anything in the Org mode file that takes a @code{#+NAME:},
  11623. @code{#+TBLNAME:}, or @code{#+RESULTS:} line. This includes tables, lists,
  11624. @code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
  11625. code blocks.
  11626. Argument values can be indexed in a manner similar to arrays (see @ref{var,
  11627. Indexable variable values}).
  11628. The following syntax is used to pass arguments to code blocks using the
  11629. @code{:var} header argument.
  11630. @example
  11631. :var name=assign
  11632. @end example
  11633. The argument, @code{assign}, can either be a literal value, such as a string
  11634. @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
  11635. literal example, another code block (with or without arguments), or the
  11636. results of evaluating another code block.
  11637. Here are examples of passing values by reference:
  11638. @table @dfn
  11639. @item table
  11640. an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
  11641. @example
  11642. #+TBLNAME: example-table
  11643. | 1 |
  11644. | 2 |
  11645. | 3 |
  11646. | 4 |
  11647. #+NAME: table-length
  11648. #+BEGIN_SRC emacs-lisp :var table=example-table
  11649. (length table)
  11650. #+END_SRC
  11651. #+RESULTS: table-length
  11652. : 4
  11653. @end example
  11654. @item list
  11655. a simple list named with a @code{#+NAME:} line (note that nesting is not
  11656. carried through to the source code block)
  11657. @example
  11658. #+NAME: example-list
  11659. - simple
  11660. - not
  11661. - nested
  11662. - list
  11663. #+BEGIN_SRC emacs-lisp :var x=example-list
  11664. (print x)
  11665. #+END_SRC
  11666. #+RESULTS:
  11667. | simple | list |
  11668. @end example
  11669. @item code block without arguments
  11670. a code block name (from the example above), as assigned by @code{#+NAME:},
  11671. optionally followed by parentheses
  11672. @example
  11673. #+BEGIN_SRC emacs-lisp :var length=table-length()
  11674. (* 2 length)
  11675. #+END_SRC
  11676. #+RESULTS:
  11677. : 8
  11678. @end example
  11679. @item code block with arguments
  11680. a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
  11681. optional arguments passed within the parentheses following the
  11682. code block name using standard function call syntax
  11683. @example
  11684. #+NAME: double
  11685. #+BEGIN_SRC emacs-lisp :var input=8
  11686. (* 2 input)
  11687. #+END_SRC
  11688. #+RESULTS: double
  11689. : 16
  11690. #+NAME: squared
  11691. #+BEGIN_SRC emacs-lisp :var input=double(input=1)
  11692. (* input input)
  11693. #+END_SRC
  11694. #+RESULTS: squared
  11695. : 4
  11696. @end example
  11697. @item literal example
  11698. a literal example block named with a @code{#+NAME:} line
  11699. @example
  11700. #+NAME: literal-example
  11701. #+BEGIN_EXAMPLE
  11702. A literal example
  11703. on two lines
  11704. #+END_EXAMPLE
  11705. #+NAME: read-literal-example
  11706. #+BEGIN_SRC emacs-lisp :var x=literal-example
  11707. (concatenate 'string x " for you.")
  11708. #+END_SRC
  11709. #+RESULTS: read-literal-example
  11710. : A literal example
  11711. : on two lines for you.
  11712. @end example
  11713. @end table
  11714. @subsubheading Alternate argument syntax
  11715. It is also possible to specify arguments in a potentially more natural way
  11716. using the @code{#+NAME:} line of a code block. As in the following
  11717. example, arguments can be packed inside of parentheses, separated by commas,
  11718. following the source name.
  11719. @example
  11720. #+NAME: double(input=0, x=2)
  11721. #+BEGIN_SRC emacs-lisp
  11722. (* 2 (+ input x))
  11723. #+END_SRC
  11724. @end example
  11725. @subsubheading Indexable variable values
  11726. It is possible to reference portions of variable values by ``indexing'' into
  11727. the variables. Indexes are 0 based with negative values counting back from
  11728. the end. If an index is separated by @code{,}s then each subsequent section
  11729. will index into the next deepest nesting or dimension of the value. Note
  11730. that this indexing occurs @emph{before} other table related header arguments
  11731. like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
  11732. following example assigns the last cell of the first row the table
  11733. @code{example-table} to the variable @code{data}:
  11734. @example
  11735. #+NAME: example-table
  11736. | 1 | a |
  11737. | 2 | b |
  11738. | 3 | c |
  11739. | 4 | d |
  11740. #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
  11741. data
  11742. #+END_SRC
  11743. #+RESULTS:
  11744. : a
  11745. @end example
  11746. Ranges of variable values can be referenced using two integers separated by a
  11747. @code{:}, in which case the entire inclusive range is referenced. For
  11748. example the following assigns the middle three rows of @code{example-table}
  11749. to @code{data}.
  11750. @example
  11751. #+NAME: example-table
  11752. | 1 | a |
  11753. | 2 | b |
  11754. | 3 | c |
  11755. | 4 | d |
  11756. | 5 | 3 |
  11757. #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
  11758. data
  11759. #+END_SRC
  11760. #+RESULTS:
  11761. | 2 | b |
  11762. | 3 | c |
  11763. | 4 | d |
  11764. @end example
  11765. Additionally, an empty index, or the single character @code{*}, are both
  11766. interpreted to mean the entire range and as such are equivalent to
  11767. @code{0:-1}, as shown in the following example in which the entire first
  11768. column is referenced.
  11769. @example
  11770. #+NAME: example-table
  11771. | 1 | a |
  11772. | 2 | b |
  11773. | 3 | c |
  11774. | 4 | d |
  11775. #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
  11776. data
  11777. #+END_SRC
  11778. #+RESULTS:
  11779. | 1 | 2 | 3 | 4 |
  11780. @end example
  11781. It is possible to index into the results of code blocks as well as tables.
  11782. Any number of dimensions can be indexed. Dimensions are separated from one
  11783. another by commas, as shown in the following example.
  11784. @example
  11785. #+NAME: 3D
  11786. #+BEGIN_SRC emacs-lisp
  11787. '(((1 2 3) (4 5 6) (7 8 9))
  11788. ((10 11 12) (13 14 15) (16 17 18))
  11789. ((19 20 21) (22 23 24) (25 26 27)))
  11790. #+END_SRC
  11791. #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
  11792. data
  11793. #+END_SRC
  11794. #+RESULTS:
  11795. | 11 | 14 | 17 |
  11796. @end example
  11797. @subsubheading Emacs Lisp evaluation of variables
  11798. Emacs lisp code can be used to initialize variable values. When a variable
  11799. value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
  11800. evaluated as Emacs Lisp and the result of the evaluation will be assigned as
  11801. the variable value. The following example demonstrates use of this
  11802. evaluation to reliably pass the file-name of the Org mode buffer to a code
  11803. block---note that evaluation of header arguments is guaranteed to take place
  11804. in the original Org mode file, while there is no such guarantee for
  11805. evaluation of the code block body.
  11806. @example
  11807. #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
  11808. wc -w $filename
  11809. #+END_SRC
  11810. @end example
  11811. Note that values read from tables and lists will not be evaluated as
  11812. Emacs Lisp, as shown in the following example.
  11813. @example
  11814. #+NAME: table
  11815. | (a b c) |
  11816. #+HEADERS: :var data=table[0,0]
  11817. #+BEGIN_SRC perl
  11818. $data
  11819. #+END_SRC
  11820. #+RESULTS:
  11821. : (a b c)
  11822. @end example
  11823. @node results, file, var, Specific header arguments
  11824. @subsubsection @code{:results}
  11825. There are three classes of @code{:results} header argument. Only one option
  11826. per class may be supplied per code block.
  11827. @itemize @bullet
  11828. @item
  11829. @b{collection} header arguments specify how the results should be collected
  11830. from the code block
  11831. @item
  11832. @b{type} header arguments specify what type of result the code block will
  11833. return---which has implications for how they will be inserted into the
  11834. Org mode buffer
  11835. @item
  11836. @b{handling} header arguments specify how the results of evaluating the code
  11837. block should be handled.
  11838. @end itemize
  11839. @subsubheading Collection
  11840. The following options are mutually exclusive, and specify how the results
  11841. should be collected from the code block.
  11842. @itemize @bullet
  11843. @item @code{value}
  11844. This is the default. The result is the value of the last statement in the
  11845. code block. This header argument places the evaluation in functional
  11846. mode. Note that in some languages, e.g., Python, use of this result type
  11847. requires that a @code{return} statement be included in the body of the source
  11848. code block. E.g., @code{:results value}.
  11849. @item @code{output}
  11850. The result is the collection of everything printed to STDOUT during the
  11851. execution of the code block. This header argument places the
  11852. evaluation in scripting mode. E.g., @code{:results output}.
  11853. @end itemize
  11854. @subsubheading Type
  11855. The following options are mutually exclusive and specify what type of results
  11856. the code block will return. By default, results are inserted as either a
  11857. table or scalar depending on their value.
  11858. @itemize @bullet
  11859. @item @code{table}, @code{vector}
  11860. The results should be interpreted as an Org mode table. If a single value is
  11861. returned, it will be converted into a table with one row and one column.
  11862. E.g., @code{:results value table}.
  11863. @item @code{list}
  11864. The results should be interpreted as an Org mode list. If a single scalar
  11865. value is returned it will be converted into a list with only one element.
  11866. @item @code{scalar}, @code{verbatim}
  11867. The results should be interpreted literally---they will not be
  11868. converted into a table. The results will be inserted into the Org mode
  11869. buffer as quoted text. E.g., @code{:results value verbatim}.
  11870. @item @code{file}
  11871. The results will be interpreted as the path to a file, and will be inserted
  11872. into the Org mode buffer as a file link. E.g., @code{:results value file}.
  11873. @item @code{raw}
  11874. The results are interpreted as raw Org mode code and are inserted directly
  11875. into the buffer. If the results look like a table they will be aligned as
  11876. such by Org mode. E.g., @code{:results value raw}.
  11877. @item @code{org}
  11878. The results are will be enclosed in a @code{BEGIN_SRC org} block.
  11879. They are not comma-escaped by default but they will be if you hit @kbd{TAB}
  11880. in the block and/or if you export the file. E.g., @code{:results value org}.
  11881. @item @code{html}
  11882. Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
  11883. block. E.g., @code{:results value html}.
  11884. @item @code{latex}
  11885. Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
  11886. E.g., @code{:results value latex}.
  11887. @item @code{code}
  11888. Result are assumed to be parsable code and are enclosed in a code block.
  11889. E.g., @code{:results value code}.
  11890. @item @code{pp}
  11891. The result is converted to pretty-printed code and is enclosed in a code
  11892. block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
  11893. @code{:results value pp}.
  11894. @item @code{drawer}
  11895. The result is wrapped in a RESULTS drawer. This can be useful for
  11896. inserting @code{raw} or @code{org} syntax results in such a way that their
  11897. extent is known and they can be automatically removed or replaced.
  11898. @end itemize
  11899. @subsubheading Handling
  11900. The following results options indicate what happens with the
  11901. results once they are collected.
  11902. @itemize @bullet
  11903. @item @code{silent}
  11904. The results will be echoed in the minibuffer but will not be inserted into
  11905. the Org mode buffer. E.g., @code{:results output silent}.
  11906. @item @code{replace}
  11907. The default value. Any existing results will be removed, and the new results
  11908. will be inserted into the Org mode buffer in their place. E.g.,
  11909. @code{:results output replace}.
  11910. @item @code{append}
  11911. If there are pre-existing results of the code block then the new results will
  11912. be appended to the existing results. Otherwise the new results will be
  11913. inserted as with @code{replace}.
  11914. @item @code{prepend}
  11915. If there are pre-existing results of the code block then the new results will
  11916. be prepended to the existing results. Otherwise the new results will be
  11917. inserted as with @code{replace}.
  11918. @end itemize
  11919. @node file, file-desc, results, Specific header arguments
  11920. @subsubsection @code{:file}
  11921. The header argument @code{:file} is used to specify an external file in which
  11922. to save code block results. After code block evaluation an Org mode style
  11923. @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
  11924. into the Org mode buffer. Some languages including R, gnuplot, dot, and
  11925. ditaa provide special handling of the @code{:file} header argument
  11926. automatically wrapping the code block body in the boilerplate code required
  11927. to save output to the specified file. This is often useful for saving
  11928. graphical output of a code block to the specified file.
  11929. The argument to @code{:file} should be either a string specifying the path to
  11930. a file, or a list of two strings in which case the first element of the list
  11931. should be the path to a file and the second a description for the link.
  11932. @node file-desc, dir, file, Specific header arguments
  11933. @subsubsection @code{:file-desc}
  11934. The value of the @code{:file-desc} header argument is used to provide a
  11935. description for file code block results which are inserted as Org mode links
  11936. (see @ref{Link format}). If the @code{:file-desc} header argument is given
  11937. with no value the link path will be placed in both the ``link'' and the
  11938. ``description'' portion of the Org mode link.
  11939. @node dir, exports, file-desc, Specific header arguments
  11940. @subsubsection @code{:dir} and remote execution
  11941. While the @code{:file} header argument can be used to specify the path to the
  11942. output file, @code{:dir} specifies the default directory during code block
  11943. execution. If it is absent, then the directory associated with the current
  11944. buffer is used. In other words, supplying @code{:dir path} temporarily has
  11945. the same effect as changing the current directory with @kbd{M-x cd path}, and
  11946. then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
  11947. the value of the Emacs variable @code{default-directory}.
  11948. When using @code{:dir}, you should supply a relative path for file output
  11949. (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
  11950. case that path will be interpreted relative to the default directory.
  11951. In other words, if you want your plot to go into a folder called @file{Work}
  11952. in your home directory, you could use
  11953. @example
  11954. #+BEGIN_SRC R :file myplot.png :dir ~/Work
  11955. matplot(matrix(rnorm(100), 10), type="l")
  11956. #+END_SRC
  11957. @end example
  11958. @subsubheading Remote execution
  11959. A directory on a remote machine can be specified using tramp file syntax, in
  11960. which case the code will be evaluated on the remote machine. An example is
  11961. @example
  11962. #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
  11963. plot(1:10, main=system("hostname", intern=TRUE))
  11964. #+END_SRC
  11965. @end example
  11966. Text results will be returned to the local Org mode buffer as usual, and file
  11967. output will be created on the remote machine with relative paths interpreted
  11968. relative to the remote directory. An Org mode link to the remote file will be
  11969. created.
  11970. So, in the above example a plot will be created on the remote machine,
  11971. and a link of the following form will be inserted in the org buffer:
  11972. @example
  11973. [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
  11974. @end example
  11975. Most of this functionality follows immediately from the fact that @code{:dir}
  11976. sets the value of the Emacs variable @code{default-directory}, thanks to
  11977. tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
  11978. install tramp separately in order for these features to work correctly.
  11979. @subsubheading Further points
  11980. @itemize @bullet
  11981. @item
  11982. If @code{:dir} is used in conjunction with @code{:session}, although it will
  11983. determine the starting directory for a new session as expected, no attempt is
  11984. currently made to alter the directory associated with an existing session.
  11985. @item
  11986. @code{:dir} should typically not be used to create files during export with
  11987. @code{:exports results} or @code{:exports both}. The reason is that, in order
  11988. to retain portability of exported material between machines, during export
  11989. links inserted into the buffer will @emph{not} be expanded against @code{default
  11990. directory}. Therefore, if @code{default-directory} is altered using
  11991. @code{:dir}, it is probable that the file will be created in a location to
  11992. which the link does not point.
  11993. @end itemize
  11994. @node exports, tangle, dir, Specific header arguments
  11995. @subsubsection @code{:exports}
  11996. The @code{:exports} header argument specifies what should be included in HTML
  11997. or @LaTeX{} exports of the Org mode file.
  11998. @itemize @bullet
  11999. @item @code{code}
  12000. The default. The body of code is included into the exported file. E.g.,
  12001. @code{:exports code}.
  12002. @item @code{results}
  12003. The result of evaluating the code is included in the exported file. E.g.,
  12004. @code{:exports results}.
  12005. @item @code{both}
  12006. Both the code and results are included in the exported file. E.g.,
  12007. @code{:exports both}.
  12008. @item @code{none}
  12009. Nothing is included in the exported file. E.g., @code{:exports none}.
  12010. @end itemize
  12011. @node tangle, mkdirp, exports, Specific header arguments
  12012. @subsubsection @code{:tangle}
  12013. The @code{:tangle} header argument specifies whether or not the code
  12014. block should be included in tangled extraction of source code files.
  12015. @itemize @bullet
  12016. @item @code{tangle}
  12017. The code block is exported to a source code file named after the full path
  12018. (including the directory) and file name (w/o extension) of the Org mode file.
  12019. E.g., @code{:tangle yes}.
  12020. @item @code{no}
  12021. The default. The code block is not exported to a source code file.
  12022. E.g., @code{:tangle no}.
  12023. @item other
  12024. Any other string passed to the @code{:tangle} header argument is interpreted
  12025. as a path (directory and file name relative to the directory of the Org mode
  12026. file) to which the block will be exported. E.g., @code{:tangle path}.
  12027. @end itemize
  12028. @node mkdirp, comments, tangle, Specific header arguments
  12029. @subsubsection @code{:mkdirp}
  12030. The @code{:mkdirp} header argument can be used to create parent directories
  12031. of tangled files when missing. This can be set to @code{yes} to enable
  12032. directory creation or to @code{no} to inhibit directory creation.
  12033. @node comments, padline, mkdirp, Specific header arguments
  12034. @subsubsection @code{:comments}
  12035. By default code blocks are tangled to source-code files without any insertion
  12036. of comments beyond those which may already exist in the body of the code
  12037. block. The @code{:comments} header argument can be set as follows to control
  12038. the insertion of extra comments into the tangled code file.
  12039. @itemize @bullet
  12040. @item @code{no}
  12041. The default. No extra comments are inserted during tangling.
  12042. @item @code{link}
  12043. The code block is wrapped in comments which contain pointers back to the
  12044. original Org file from which the code was tangled.
  12045. @item @code{yes}
  12046. A synonym for ``link'' to maintain backwards compatibility.
  12047. @item @code{org}
  12048. Include text from the Org mode file as a comment.
  12049. The text is picked from the leading context of the tangled code and is
  12050. limited by the nearest headline or source block as the case may be.
  12051. @item @code{both}
  12052. Turns on both the ``link'' and ``org'' comment options.
  12053. @item @code{noweb}
  12054. Turns on the ``link'' comment option, and additionally wraps expanded noweb
  12055. references in the code block body in link comments.
  12056. @end itemize
  12057. @node padline, no-expand, comments, Specific header arguments
  12058. @subsubsection @code{:padline}
  12059. Control in insertion of padding lines around code block bodies in tangled
  12060. code files. The default value is @code{yes} which results in insertion of
  12061. newlines before and after each tangled code block. The following arguments
  12062. are accepted.
  12063. @itemize @bullet
  12064. @item @code{yes}
  12065. Insert newlines before and after each code block body in tangled code files.
  12066. @item @code{no}
  12067. Do not insert any newline padding in tangled output.
  12068. @end itemize
  12069. @node no-expand, session, padline, Specific header arguments
  12070. @subsubsection @code{:no-expand}
  12071. By default, code blocks are expanded with @code{org-babel-expand-src-block}
  12072. during tangling. This has the effect of assigning values to variables
  12073. specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
  12074. references (see @ref{Noweb reference syntax}) with their targets. The
  12075. @code{:no-expand} header argument can be used to turn off this behavior.
  12076. @node session, noweb, no-expand, Specific header arguments
  12077. @subsubsection @code{:session}
  12078. The @code{:session} header argument starts a session for an interpreted
  12079. language where state is preserved.
  12080. By default, a session is not started.
  12081. A string passed to the @code{:session} header argument will give the session
  12082. a name. This makes it possible to run concurrent sessions for each
  12083. interpreted language.
  12084. @node noweb, noweb-ref, session, Specific header arguments
  12085. @subsubsection @code{:noweb}
  12086. The @code{:noweb} header argument controls expansion of ``noweb'' syntax
  12087. references (see @ref{Noweb reference syntax}) when the code block is
  12088. evaluated, tangled, or exported. The @code{:noweb} header argument can have
  12089. one of the five values: @code{no}, @code{yes}, @code{tangle}, or
  12090. @code{no-export} @code{strip-export}.
  12091. @itemize @bullet
  12092. @item @code{no}
  12093. The default. ``Noweb'' syntax references in the body of the code block will
  12094. not be expanded before the code block is evaluated, tangled or exported.
  12095. @item @code{yes}
  12096. ``Noweb'' syntax references in the body of the code block will be
  12097. expanded before the code block is evaluated, tangled or exported.
  12098. @item @code{tangle}
  12099. ``Noweb'' syntax references in the body of the code block will be expanded
  12100. before the code block is tangled. However, ``noweb'' syntax references will
  12101. not be expanded when the code block is evaluated or exported.
  12102. @item @code{no-export}
  12103. ``Noweb'' syntax references in the body of the code block will be expanded
  12104. before the block is evaluated or tangled. However, ``noweb'' syntax
  12105. references will not be expanded when the code block is exported.
  12106. @item @code{strip-export}
  12107. ``Noweb'' syntax references in the body of the code block will be expanded
  12108. before the block is evaluated or tangled. However, ``noweb'' syntax
  12109. references will not be removed when the code block is exported.
  12110. @item @code{eval}
  12111. ``Noweb'' syntax references in the body of the code block will only be
  12112. expanded before the block is evaluated.
  12113. @end itemize
  12114. @subsubheading Noweb prefix lines
  12115. Noweb insertions are now placed behind the line prefix of the
  12116. @code{<<reference>>}.
  12117. This behavior is illustrated in the following example. Because the
  12118. @code{<<example>>} noweb reference appears behind the SQL comment syntax,
  12119. each line of the expanded noweb reference will be commented.
  12120. This code block:
  12121. @example
  12122. -- <<example>>
  12123. @end example
  12124. expands to:
  12125. @example
  12126. -- this is the
  12127. -- multi-line body of example
  12128. @end example
  12129. Note that noweb replacement text that does not contain any newlines will not
  12130. be affected by this change, so it is still possible to use inline noweb
  12131. references.
  12132. @node noweb-ref, noweb-sep, noweb, Specific header arguments
  12133. @subsubsection @code{:noweb-ref}
  12134. When expanding ``noweb'' style references the bodies of all code block with
  12135. @emph{either} a block name matching the reference name @emph{or} a
  12136. @code{:noweb-ref} header argument matching the reference name will be
  12137. concatenated together to form the replacement text.
  12138. By setting this header argument at the sub-tree or file level, simple code
  12139. block concatenation may be achieved. For example, when tangling the
  12140. following Org mode file, the bodies of code blocks will be concatenated into
  12141. the resulting pure code file@footnote{(The example needs property inheritance
  12142. to be turned on for the @code{noweb-ref} property, see @ref{Property
  12143. inheritance}).}.
  12144. @example
  12145. #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
  12146. <<fullest-disk>>
  12147. #+END_SRC
  12148. * the mount point of the fullest disk
  12149. :PROPERTIES:
  12150. :noweb-ref: fullest-disk
  12151. :END:
  12152. ** query all mounted disks
  12153. #+BEGIN_SRC sh
  12154. df \
  12155. #+END_SRC
  12156. ** strip the header row
  12157. #+BEGIN_SRC sh
  12158. |sed '1d' \
  12159. #+END_SRC
  12160. ** sort by the percent full
  12161. #+BEGIN_SRC sh
  12162. |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
  12163. #+END_SRC
  12164. ** extract the mount point
  12165. #+BEGIN_SRC sh
  12166. |awk '@{print $2@}'
  12167. #+END_SRC
  12168. @end example
  12169. The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
  12170. used to separate accumulate noweb references like those above. By default a
  12171. newline is used.
  12172. @node noweb-sep, cache, noweb-ref, Specific header arguments
  12173. @subsubsection @code{:noweb-sep}
  12174. The @code{:noweb-sep} header argument holds the string used to separate
  12175. accumulate noweb references (see @ref{noweb-ref}). By default a newline is
  12176. used.
  12177. @node cache, sep, noweb-sep, Specific header arguments
  12178. @subsubsection @code{:cache}
  12179. The @code{:cache} header argument controls the use of in-buffer caching of
  12180. the results of evaluating code blocks. It can be used to avoid re-evaluating
  12181. unchanged code blocks. Note that the @code{:cache} header argument will not
  12182. attempt to cache results when the @code{:session} header argument is used,
  12183. because the results of the code block execution may be stored in the session
  12184. outside of the Org mode buffer. The @code{:cache} header argument can have
  12185. one of two values: @code{yes} or @code{no}.
  12186. @itemize @bullet
  12187. @item @code{no}
  12188. The default. No caching takes place, and the code block will be evaluated
  12189. every time it is called.
  12190. @item @code{yes}
  12191. Every time the code block is run a SHA1 hash of the code and arguments
  12192. passed to the block will be generated. This hash is packed into the
  12193. @code{#+RESULTS:} line and will be checked on subsequent
  12194. executions of the code block. If the code block has not
  12195. changed since the last time it was evaluated, it will not be re-evaluated.
  12196. @end itemize
  12197. Code block caches notice if the value of a variable argument
  12198. to the code block has changed. If this is the case, the cache is
  12199. invalidated and the code block is re-run. In the following example,
  12200. @code{caller} will not be re-run unless the results of @code{random} have
  12201. changed since it was last run.
  12202. @example
  12203. #+NAME: random
  12204. #+BEGIN_SRC R :cache yes
  12205. runif(1)
  12206. #+END_SRC
  12207. #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
  12208. 0.4659510825295
  12209. #+NAME: caller
  12210. #+BEGIN_SRC emacs-lisp :var x=random :cache yes
  12211. x
  12212. #+END_SRC
  12213. #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
  12214. 0.254227238707244
  12215. @end example
  12216. @node sep, hlines, cache, Specific header arguments
  12217. @subsubsection @code{:sep}
  12218. The @code{:sep} header argument can be used to control the delimiter used
  12219. when writing tabular results out to files external to Org mode. This is used
  12220. either when opening tabular results of a code block by calling the
  12221. @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
  12222. or when writing code block results to an external file (see @ref{file})
  12223. header argument.
  12224. By default, when @code{:sep} is not specified output tables are tab
  12225. delimited.
  12226. @node hlines, colnames, sep, Specific header arguments
  12227. @subsubsection @code{:hlines}
  12228. Tables are frequently represented with one or more horizontal lines, or
  12229. hlines. The @code{:hlines} argument to a code block accepts the
  12230. values @code{yes} or @code{no}, with a default value of @code{no}.
  12231. @itemize @bullet
  12232. @item @code{no}
  12233. Strips horizontal lines from the input table. In most languages this is the
  12234. desired effect because an @code{hline} symbol is interpreted as an unbound
  12235. variable and raises an error. Setting @code{:hlines no} or relying on the
  12236. default value yields the following results. Note that the @code{:hline}
  12237. header argument has no effect for Emacs Lisp code blocks.
  12238. @example
  12239. #+TBLNAME: many-cols
  12240. | a | b | c |
  12241. |---+---+---|
  12242. | d | e | f |
  12243. |---+---+---|
  12244. | g | h | i |
  12245. #+NAME: echo-table
  12246. #+BEGIN_SRC python :var tab=many-cols
  12247. return tab
  12248. #+END_SRC
  12249. #+RESULTS: echo-table
  12250. | a | b | c |
  12251. | d | e | f |
  12252. | g | h | i |
  12253. @end example
  12254. @item @code{yes}
  12255. Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
  12256. @example
  12257. #+TBLNAME: many-cols
  12258. | a | b | c |
  12259. |---+---+---|
  12260. | d | e | f |
  12261. |---+---+---|
  12262. | g | h | i |
  12263. #+NAME: echo-table
  12264. #+BEGIN_SRC python :var tab=many-cols :hlines yes
  12265. return tab
  12266. #+END_SRC
  12267. #+RESULTS: echo-table
  12268. | a | b | c |
  12269. |---+---+---|
  12270. | d | e | f |
  12271. |---+---+---|
  12272. | g | h | i |
  12273. @end example
  12274. @end itemize
  12275. @node colnames, rownames, hlines, Specific header arguments
  12276. @subsubsection @code{:colnames}
  12277. The @code{:colnames} header argument accepts the values @code{yes},
  12278. @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
  12279. Note that the behavior of the @code{:colnames} header argument may differ
  12280. across languages. For example Emacs Lisp code blocks ignore the
  12281. @code{:colnames} header argument entirely given the ease with which tables
  12282. with column names may be handled directly in Emacs Lisp.
  12283. @itemize @bullet
  12284. @item @code{nil}
  12285. If an input table looks like it has column names
  12286. (because its second row is an hline), then the column
  12287. names will be removed from the table before
  12288. processing, then reapplied to the results.
  12289. @example
  12290. #+TBLNAME: less-cols
  12291. | a |
  12292. |---|
  12293. | b |
  12294. | c |
  12295. #+NAME: echo-table-again
  12296. #+BEGIN_SRC python :var tab=less-cols
  12297. return [[val + '*' for val in row] for row in tab]
  12298. #+END_SRC
  12299. #+RESULTS: echo-table-again
  12300. | a |
  12301. |----|
  12302. | b* |
  12303. | c* |
  12304. @end example
  12305. Please note that column names are not removed before the table is indexed
  12306. using variable indexing @xref{var, Indexable variable values}.
  12307. @item @code{no}
  12308. No column name pre-processing takes place
  12309. @item @code{yes}
  12310. Column names are removed and reapplied as with @code{nil} even if the table
  12311. does not ``look like'' it has column names (i.e., the second row is not an
  12312. hline)
  12313. @end itemize
  12314. @node rownames, shebang, colnames, Specific header arguments
  12315. @subsubsection @code{:rownames}
  12316. The @code{:rownames} header argument can take on the values @code{yes} or
  12317. @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
  12318. blocks ignore the @code{:rownames} header argument entirely given the ease
  12319. with which tables with row names may be handled directly in Emacs Lisp.
  12320. @itemize @bullet
  12321. @item @code{no}
  12322. No row name pre-processing will take place.
  12323. @item @code{yes}
  12324. The first column of the table is removed from the table before processing,
  12325. and is then reapplied to the results.
  12326. @example
  12327. #+TBLNAME: with-rownames
  12328. | one | 1 | 2 | 3 | 4 | 5 |
  12329. | two | 6 | 7 | 8 | 9 | 10 |
  12330. #+NAME: echo-table-once-again
  12331. #+BEGIN_SRC python :var tab=with-rownames :rownames yes
  12332. return [[val + 10 for val in row] for row in tab]
  12333. #+END_SRC
  12334. #+RESULTS: echo-table-once-again
  12335. | one | 11 | 12 | 13 | 14 | 15 |
  12336. | two | 16 | 17 | 18 | 19 | 20 |
  12337. @end example
  12338. Please note that row names are not removed before the table is indexed using
  12339. variable indexing @xref{var, Indexable variable values}.
  12340. @end itemize
  12341. @node shebang, eval, rownames, Specific header arguments
  12342. @subsubsection @code{:shebang}
  12343. Setting the @code{:shebang} header argument to a string value
  12344. (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
  12345. first line of any tangled file holding the code block, and the file
  12346. permissions of the tangled file are set to make it executable.
  12347. @node eval, wrap, shebang, Specific header arguments
  12348. @subsubsection @code{:eval}
  12349. The @code{:eval} header argument can be used to limit the evaluation of
  12350. specific code blocks. The @code{:eval} header argument can be useful for
  12351. protecting against the evaluation of dangerous code blocks or to ensure that
  12352. evaluation will require a query regardless of the value of the
  12353. @code{org-confirm-babel-evaluate} variable. The possible values of
  12354. @code{:eval} and their effects are shown below.
  12355. @table @code
  12356. @item never or no
  12357. The code block will not be evaluated under any circumstances.
  12358. @item query
  12359. Evaluation of the code block will require a query.
  12360. @item never-export or no-export
  12361. The code block will not be evaluated during export but may still be called
  12362. interactively.
  12363. @item query-export
  12364. Evaluation of the code block during export will require a query.
  12365. @end table
  12366. If this header argument is not set then evaluation is determined by the value
  12367. of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
  12368. security}.
  12369. @node wrap, , eval, Specific header arguments
  12370. @subsubsection @code{:wrap}
  12371. The @code{:wrap} header argument is used to mark the results of source block
  12372. evaluation. The header argument can be passed a string that will be appended
  12373. to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
  12374. results. If not string is specified then the results will be wrapped in a
  12375. @code{#+BEGIN/END_RESULTS} block.
  12376. @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
  12377. @section Results of evaluation
  12378. @cindex code block, results of evaluation
  12379. @cindex source code, results of evaluation
  12380. The way in which results are handled depends on whether a session is invoked,
  12381. as well as on whether @code{:results value} or @code{:results output} is
  12382. used. The following table shows the table possibilities. For a full listing
  12383. of the possible results header arguments see @ref{results}.
  12384. @multitable @columnfractions 0.26 0.33 0.41
  12385. @item @tab @b{Non-session} @tab @b{Session}
  12386. @item @code{:results value} @tab value of last expression @tab value of last expression
  12387. @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
  12388. @end multitable
  12389. Note: With @code{:results value}, the result in both @code{:session} and
  12390. non-session is returned to Org mode as a table (a one- or two-dimensional
  12391. vector of strings or numbers) when appropriate.
  12392. @subsection Non-session
  12393. @subsubsection @code{:results value}
  12394. This is the default. Internally, the value is obtained by wrapping the code
  12395. in a function definition in the external language, and evaluating that
  12396. function. Therefore, code should be written as if it were the body of such a
  12397. function. In particular, note that Python does not automatically return a
  12398. value from a function unless a @code{return} statement is present, and so a
  12399. @samp{return} statement will usually be required in Python.
  12400. This is the only one of the four evaluation contexts in which the code is
  12401. automatically wrapped in a function definition.
  12402. @subsubsection @code{:results output}
  12403. The code is passed to the interpreter as an external process, and the
  12404. contents of the standard output stream are returned as text. (In certain
  12405. languages this also contains the error output stream; this is an area for
  12406. future work.)
  12407. @subsection Session
  12408. @subsubsection @code{:results value}
  12409. The code is passed to an interpreter running as an interactive Emacs inferior
  12410. process. Only languages which provide tools for interactive evaluation of
  12411. code have session support, so some language (e.g., C and ditaa) do not
  12412. support the @code{:session} header argument, and in other languages (e.g.,
  12413. Python and Haskell) which have limitations on the code which may be entered
  12414. into interactive sessions, those limitations apply to the code in code blocks
  12415. using the @code{:session} header argument as well.
  12416. Unless the @code{:results output} option is supplied (see below) the result
  12417. returned is the result of the last evaluation performed by the
  12418. interpreter. (This is obtained in a language-specific manner: the value of
  12419. the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
  12420. in R).
  12421. @subsubsection @code{:results output}
  12422. The code is passed to the interpreter running as an interactive Emacs
  12423. inferior process. The result returned is the concatenation of the sequence of
  12424. (text) output from the interactive interpreter. Notice that this is not
  12425. necessarily the same as what would be sent to @code{STDOUT} if the same code
  12426. were passed to a non-interactive interpreter running as an external
  12427. process. For example, compare the following two blocks:
  12428. @example
  12429. #+BEGIN_SRC python :results output
  12430. print "hello"
  12431. 2
  12432. print "bye"
  12433. #+END_SRC
  12434. #+RESULTS:
  12435. : hello
  12436. : bye
  12437. @end example
  12438. In non-session mode, the `2' is not printed and does not appear.
  12439. @example
  12440. #+BEGIN_SRC python :results output :session
  12441. print "hello"
  12442. 2
  12443. print "bye"
  12444. #+END_SRC
  12445. #+RESULTS:
  12446. : hello
  12447. : 2
  12448. : bye
  12449. @end example
  12450. But in @code{:session} mode, the interactive interpreter receives input `2'
  12451. and prints out its value, `2'. (Indeed, the other print statements are
  12452. unnecessary here).
  12453. @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
  12454. @section Noweb reference syntax
  12455. @cindex code block, noweb reference
  12456. @cindex syntax, noweb
  12457. @cindex source code, noweb reference
  12458. The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
  12459. Programming system allows named blocks of code to be referenced by using the
  12460. familiar Noweb syntax:
  12461. @example
  12462. <<code-block-name>>
  12463. @end example
  12464. When a code block is tangled or evaluated, whether or not ``noweb''
  12465. references are expanded depends upon the value of the @code{:noweb} header
  12466. argument. If @code{:noweb yes}, then a Noweb reference is expanded before
  12467. evaluation. If @code{:noweb no}, the default, then the reference is not
  12468. expanded before evaluation. See the @ref{noweb-ref} header argument for
  12469. a more flexible way to resolve noweb references.
  12470. It is possible to include the @emph{results} of a code block rather than the
  12471. body. This is done by appending parenthesis to the code block name which may
  12472. optionally contain arguments to the code block as shown below.
  12473. @example
  12474. <<code-block-name(optional arguments)>>
  12475. @end example
  12476. Note: the default value, @code{:noweb no}, was chosen to ensure that
  12477. correct code is not broken in a language, such as Ruby, where
  12478. @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
  12479. syntactically valid in languages that you use, then please consider setting
  12480. the default value.
  12481. Note: if noweb tangling is slow in large Org mode files consider setting the
  12482. @code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
  12483. This will result in faster noweb reference resolution at the expense of not
  12484. correctly resolving inherited values of the @code{:noweb-ref} header
  12485. argument.
  12486. @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
  12487. @section Key bindings and useful functions
  12488. @cindex code block, key bindings
  12489. Many common Org mode key sequences are re-bound depending on
  12490. the context.
  12491. Within a code block, the following key bindings
  12492. are active:
  12493. @multitable @columnfractions 0.25 0.75
  12494. @kindex C-c C-c
  12495. @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
  12496. @kindex C-c C-o
  12497. @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
  12498. @kindex C-up
  12499. @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
  12500. @kindex M-down
  12501. @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
  12502. @end multitable
  12503. In an Org mode buffer, the following key bindings are active:
  12504. @multitable @columnfractions 0.45 0.55
  12505. @kindex C-c C-v p
  12506. @kindex C-c C-v C-p
  12507. @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
  12508. @kindex C-c C-v n
  12509. @kindex C-c C-v C-n
  12510. @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
  12511. @kindex C-c C-v e
  12512. @kindex C-c C-v C-e
  12513. @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
  12514. @kindex C-c C-v o
  12515. @kindex C-c C-v C-o
  12516. @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
  12517. @kindex C-c C-v v
  12518. @kindex C-c C-v C-v
  12519. @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
  12520. @kindex C-c C-v u
  12521. @kindex C-c C-v C-u
  12522. @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
  12523. @kindex C-c C-v g
  12524. @kindex C-c C-v C-g
  12525. @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
  12526. @kindex C-c C-v r
  12527. @kindex C-c C-v C-r
  12528. @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
  12529. @kindex C-c C-v b
  12530. @kindex C-c C-v C-b
  12531. @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
  12532. @kindex C-c C-v s
  12533. @kindex C-c C-v C-s
  12534. @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
  12535. @kindex C-c C-v d
  12536. @kindex C-c C-v C-d
  12537. @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
  12538. @kindex C-c C-v t
  12539. @kindex C-c C-v C-t
  12540. @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
  12541. @kindex C-c C-v f
  12542. @kindex C-c C-v C-f
  12543. @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
  12544. @kindex C-c C-v c
  12545. @kindex C-c C-v C-c
  12546. @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
  12547. @kindex C-c C-v j
  12548. @kindex C-c C-v C-j
  12549. @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
  12550. @kindex C-c C-v l
  12551. @kindex C-c C-v C-l
  12552. @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
  12553. @kindex C-c C-v i
  12554. @kindex C-c C-v C-i
  12555. @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
  12556. @kindex C-c C-v I
  12557. @kindex C-c C-v C-I
  12558. @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
  12559. @kindex C-c C-v z
  12560. @kindex C-c C-v C-z
  12561. @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session-with-code}
  12562. @kindex C-c C-v a
  12563. @kindex C-c C-v C-a
  12564. @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
  12565. @kindex C-c C-v h
  12566. @kindex C-c C-v C-h
  12567. @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
  12568. @kindex C-c C-v x
  12569. @kindex C-c C-v C-x
  12570. @item @kbd{C-c C-v x} @ @ @r{or} @ @ @kbd{C-c C-v C-x} @tab @code{org-babel-do-key-sequence-in-edit-buffer}
  12571. @end multitable
  12572. @c When possible these keybindings were extended to work when the control key is
  12573. @c kept pressed, resulting in the following additional keybindings.
  12574. @c @multitable @columnfractions 0.25 0.75
  12575. @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
  12576. @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
  12577. @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
  12578. @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
  12579. @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
  12580. @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
  12581. @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
  12582. @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
  12583. @c @end multitable
  12584. @node Batch execution, , Key bindings and useful functions, Working With Source Code
  12585. @section Batch execution
  12586. @cindex code block, batch execution
  12587. @cindex source code, batch execution
  12588. It is possible to call functions from the command line. This shell
  12589. script calls @code{org-babel-tangle} on every one of its arguments.
  12590. Be sure to adjust the paths to fit your system.
  12591. @example
  12592. #!/bin/sh
  12593. # -*- mode: shell-script -*-
  12594. #
  12595. # tangle files with org-mode
  12596. #
  12597. DIR=`pwd`
  12598. FILES=""
  12599. # wrap each argument in the code required to call tangle on it
  12600. for i in $@@; do
  12601. FILES="$FILES \"$i\""
  12602. done
  12603. emacs -Q --batch \
  12604. --eval "(progn
  12605. (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
  12606. (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
  12607. (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
  12608. (mapc (lambda (file)
  12609. (find-file (expand-file-name file \"$DIR\"))
  12610. (org-babel-tangle)
  12611. (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
  12612. @end example
  12613. @node Miscellaneous, Hacking, Working With Source Code, Top
  12614. @chapter Miscellaneous
  12615. @menu
  12616. * Completion:: M-TAB knows what you need
  12617. * Easy Templates:: Quick insertion of structural elements
  12618. * Speed keys:: Electric commands at the beginning of a headline
  12619. * Code evaluation security:: Org mode files evaluate inline code
  12620. * Customization:: Adapting Org to your taste
  12621. * In-buffer settings:: Overview of the #+KEYWORDS
  12622. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  12623. * Clean view:: Getting rid of leading stars in the outline
  12624. * TTY keys:: Using Org on a tty
  12625. * Interaction:: Other Emacs packages
  12626. * org-crypt.el:: Encrypting Org files
  12627. @end menu
  12628. @node Completion, Easy Templates, Miscellaneous, Miscellaneous
  12629. @section Completion
  12630. @cindex completion, of @TeX{} symbols
  12631. @cindex completion, of TODO keywords
  12632. @cindex completion, of dictionary words
  12633. @cindex completion, of option keywords
  12634. @cindex completion, of tags
  12635. @cindex completion, of property keys
  12636. @cindex completion, of link abbreviations
  12637. @cindex @TeX{} symbol completion
  12638. @cindex TODO keywords completion
  12639. @cindex dictionary word completion
  12640. @cindex option keyword completion
  12641. @cindex tag completion
  12642. @cindex link abbreviations, completion of
  12643. Emacs would not be Emacs without completion, and Org mode uses it whenever it
  12644. makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
  12645. some of the completion prompts, you can specify your preference by setting at
  12646. most one of the variables @code{org-completion-use-iswitchb}
  12647. @code{org-completion-use-ido}.
  12648. Org supports in-buffer completion. This type of completion does
  12649. not make use of the minibuffer. You simply type a few letters into
  12650. the buffer and use the key to complete text right there.
  12651. @table @kbd
  12652. @kindex M-@key{TAB}
  12653. @item M-@key{TAB}
  12654. Complete word at point
  12655. @itemize @bullet
  12656. @item
  12657. At the beginning of a headline, complete TODO keywords.
  12658. @item
  12659. After @samp{\}, complete @TeX{} symbols supported by the exporter.
  12660. @item
  12661. After @samp{*}, complete headlines in the current buffer so that they
  12662. can be used in search links like @samp{[[*find this headline]]}.
  12663. @item
  12664. After @samp{:} in a headline, complete tags. The list of tags is taken
  12665. from the variable @code{org-tag-alist} (possibly set through the
  12666. @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
  12667. dynamically from all tags used in the current buffer.
  12668. @item
  12669. After @samp{:} and not in a headline, complete property keys. The list
  12670. of keys is constructed dynamically from all keys used in the current
  12671. buffer.
  12672. @item
  12673. After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
  12674. @item
  12675. After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
  12676. @samp{OPTIONS} which set file-specific options for Org mode. When the
  12677. option keyword is already complete, pressing @kbd{M-@key{TAB}} again
  12678. will insert example settings for this keyword.
  12679. @item
  12680. In the line after @samp{#+STARTUP: }, complete startup keywords,
  12681. i.e., valid keys for this line.
  12682. @item
  12683. Elsewhere, complete dictionary words using Ispell.
  12684. @end itemize
  12685. @end table
  12686. @node Easy Templates, Speed keys, Completion, Miscellaneous
  12687. @section Easy Templates
  12688. @cindex template insertion
  12689. @cindex insertion, of templates
  12690. Org mode supports insertion of empty structural elements (like
  12691. @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
  12692. strokes. This is achieved through a native template expansion mechanism.
  12693. Note that Emacs has several other template mechanisms which could be used in
  12694. a similar way, for example @file{yasnippet}.
  12695. To insert a structural element, type a @samp{<}, followed by a template
  12696. selector and @kbd{@key{TAB}}. Completion takes effect only when the above
  12697. keystrokes are typed on a line by itself.
  12698. The following template selectors are currently supported.
  12699. @multitable @columnfractions 0.1 0.9
  12700. @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
  12701. @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
  12702. @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
  12703. @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
  12704. @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
  12705. @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
  12706. @item @kbd{L} @tab @code{#+LaTeX:}
  12707. @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
  12708. @item @kbd{H} @tab @code{#+HTML:}
  12709. @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
  12710. @item @kbd{A} @tab @code{#+ASCII:}
  12711. @item @kbd{i} @tab @code{#+INDEX:} line
  12712. @item @kbd{I} @tab @code{#+INCLUDE:} line
  12713. @end multitable
  12714. For example, on an empty line, typing "<e" and then pressing TAB, will expand
  12715. into a complete EXAMPLE template.
  12716. You can install additional templates by customizing the variable
  12717. @code{org-structure-template-alist}. See the docstring of the variable for
  12718. additional details.
  12719. @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
  12720. @section Speed keys
  12721. @cindex speed keys
  12722. @vindex org-use-speed-commands
  12723. @vindex org-speed-commands-user
  12724. Single keys can be made to execute commands when the cursor is at the
  12725. beginning of a headline, i.e., before the first star. Configure the variable
  12726. @code{org-use-speed-commands} to activate this feature. There is a
  12727. pre-defined list of commands, and you can add more such commands using the
  12728. variable @code{org-speed-commands-user}. Speed keys do not only speed up
  12729. navigation and other commands, but they also provide an alternative way to
  12730. execute commands bound to keys that are not or not easily available on a TTY,
  12731. or on a small mobile device with a limited keyboard.
  12732. To see which commands are available, activate the feature and press @kbd{?}
  12733. with the cursor at the beginning of a headline.
  12734. @node Code evaluation security, Customization, Speed keys, Miscellaneous
  12735. @section Code evaluation and security issues
  12736. Org provides tools to work with the code snippets, including evaluating them.
  12737. Running code on your machine always comes with a security risk. Badly
  12738. written or malicious code can be executed on purpose or by accident. Org has
  12739. default settings which will only evaluate such code if you give explicit
  12740. permission to do so, and as a casual user of these features you should leave
  12741. these precautions intact.
  12742. For people who regularly work with such code, the confirmation prompts can
  12743. become annoying, and you might want to turn them off. This can be done, but
  12744. you must be aware of the risks that are involved.
  12745. Code evaluation can happen under the following circumstances:
  12746. @table @i
  12747. @item Source code blocks
  12748. Source code blocks can be evaluated during export, or when pressing @kbd{C-c
  12749. C-c} in the block. The most important thing to realize here is that Org mode
  12750. files which contain code snippets are, in a certain sense, like executable
  12751. files. So you should accept them and load them into Emacs only from trusted
  12752. sources---just like you would do with a program you install on your computer.
  12753. Make sure you know what you are doing before customizing the variables
  12754. which take off the default security brakes.
  12755. @defopt org-confirm-babel-evaluate
  12756. When t (the default), the user is asked before every code block evaluation.
  12757. When nil, the user is not asked. When set to a function, it is called with
  12758. two arguments (language and body of the code block) and should return t to
  12759. ask and nil not to ask.
  12760. @end defopt
  12761. For example, here is how to execute "ditaa" code (which is considered safe)
  12762. without asking:
  12763. @example
  12764. (defun my-org-confirm-babel-evaluate (lang body)
  12765. (not (string= lang "ditaa"))) ; don't ask for ditaa
  12766. (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
  12767. @end example
  12768. @item Following @code{shell} and @code{elisp} links
  12769. Org has two link types that can directly evaluate code (@pxref{External
  12770. links}). These links can be problematic because the code to be evaluated is
  12771. not visible.
  12772. @defopt org-confirm-shell-link-function
  12773. Function to queries user about shell link execution.
  12774. @end defopt
  12775. @defopt org-confirm-elisp-link-function
  12776. Functions to query user for Emacs Lisp link execution.
  12777. @end defopt
  12778. @item Formulas in tables
  12779. Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
  12780. either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
  12781. @end table
  12782. @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
  12783. @section Customization
  12784. @cindex customization
  12785. @cindex options, for customization
  12786. @cindex variables, for customization
  12787. There are more than 500 variables that can be used to customize
  12788. Org. For the sake of compactness of the manual, I am not
  12789. describing the variables here. A structured overview of customization
  12790. variables is available with @kbd{M-x org-customize}. Or select
  12791. @code{Browse Org Group} from the @code{Org->Customization} menu. Many
  12792. settings can also be activated on a per-file basis, by putting special
  12793. lines into the buffer (@pxref{In-buffer settings}).
  12794. @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
  12795. @section Summary of in-buffer settings
  12796. @cindex in-buffer settings
  12797. @cindex special keywords
  12798. Org mode uses special lines in the buffer to define settings on a
  12799. per-file basis. These lines start with a @samp{#+} followed by a
  12800. keyword, a colon, and then individual words defining a setting. Several
  12801. setting words can be in the same line, but you can also have multiple
  12802. lines for the keyword. While these settings are described throughout
  12803. the manual, here is a summary. After changing any of those lines in the
  12804. buffer, press @kbd{C-c C-c} with the cursor still in the line to
  12805. activate the changes immediately. Otherwise they become effective only
  12806. when the file is visited again in a new Emacs session.
  12807. @vindex org-archive-location
  12808. @table @kbd
  12809. @item #+ARCHIVE: %s_done::
  12810. This line sets the archive location for the agenda file. It applies for
  12811. all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
  12812. of the file. The first such line also applies to any entries before it.
  12813. The corresponding variable is @code{org-archive-location}.
  12814. @item #+CATEGORY:
  12815. This line sets the category for the agenda file. The category applies
  12816. for all subsequent lines until the next @samp{#+CATEGORY} line, or the
  12817. end of the file. The first such line also applies to any entries before it.
  12818. @item #+COLUMNS: %25ITEM .....
  12819. @cindex property, COLUMNS
  12820. Set the default format for columns view. This format applies when
  12821. columns view is invoked in locations where no @code{COLUMNS} property
  12822. applies.
  12823. @item #+CONSTANTS: name1=value1 ...
  12824. @vindex org-table-formula-constants
  12825. @vindex org-table-formula
  12826. Set file-local values for constants to be used in table formulas. This
  12827. line sets the local variable @code{org-table-formula-constants-local}.
  12828. The global version of this variable is
  12829. @code{org-table-formula-constants}.
  12830. @item #+FILETAGS: :tag1:tag2:tag3:
  12831. Set tags that can be inherited by any entry in the file, including the
  12832. top-level entries.
  12833. @item #+DRAWERS: NAME1 .....
  12834. @vindex org-drawers
  12835. Set the file-local set of additional drawers. The corresponding global
  12836. variable is @code{org-drawers}.
  12837. @item #+LINK: linkword replace
  12838. @vindex org-link-abbrev-alist
  12839. These lines (several are allowed) specify link abbreviations.
  12840. @xref{Link abbreviations}. The corresponding variable is
  12841. @code{org-link-abbrev-alist}.
  12842. @item #+PRIORITIES: highest lowest default
  12843. @vindex org-highest-priority
  12844. @vindex org-lowest-priority
  12845. @vindex org-default-priority
  12846. This line sets the limits and the default for the priorities. All three
  12847. must be either letters A--Z or numbers 0--9. The highest priority must
  12848. have a lower ASCII number than the lowest priority.
  12849. @item #+PROPERTY: Property_Name Value
  12850. This line sets a default inheritance value for entries in the current
  12851. buffer, most useful for specifying the allowed values of a property.
  12852. @cindex #+SETUPFILE
  12853. @item #+SETUPFILE: file
  12854. This line defines a file that holds more in-buffer setup. Normally this is
  12855. entirely ignored. Only when the buffer is parsed for option-setting lines
  12856. (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
  12857. settings line, or when exporting), then the contents of this file are parsed
  12858. as if they had been included in the buffer. In particular, the file can be
  12859. any other Org mode file with internal setup. You can visit the file the
  12860. cursor is in the line with @kbd{C-c '}.
  12861. @item #+STARTUP:
  12862. @cindex #+STARTUP:
  12863. This line sets options to be used at startup of Org mode, when an
  12864. Org file is being visited.
  12865. The first set of options deals with the initial visibility of the outline
  12866. tree. The corresponding variable for global default settings is
  12867. @code{org-startup-folded}, with a default value @code{t}, which means
  12868. @code{overview}.
  12869. @vindex org-startup-folded
  12870. @cindex @code{overview}, STARTUP keyword
  12871. @cindex @code{content}, STARTUP keyword
  12872. @cindex @code{showall}, STARTUP keyword
  12873. @cindex @code{showeverything}, STARTUP keyword
  12874. @example
  12875. overview @r{top-level headlines only}
  12876. content @r{all headlines}
  12877. showall @r{no folding of any entries}
  12878. showeverything @r{show even drawer contents}
  12879. @end example
  12880. @vindex org-startup-indented
  12881. @cindex @code{indent}, STARTUP keyword
  12882. @cindex @code{noindent}, STARTUP keyword
  12883. Dynamic virtual indentation is controlled by the variable
  12884. @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
  12885. @example
  12886. indent @r{start with @code{org-indent-mode} turned on}
  12887. noindent @r{start with @code{org-indent-mode} turned off}
  12888. @end example
  12889. @vindex org-startup-align-all-tables
  12890. Then there are options for aligning tables upon visiting a file. This
  12891. is useful in files containing narrowed table columns. The corresponding
  12892. variable is @code{org-startup-align-all-tables}, with a default value
  12893. @code{nil}.
  12894. @cindex @code{align}, STARTUP keyword
  12895. @cindex @code{noalign}, STARTUP keyword
  12896. @example
  12897. align @r{align all tables}
  12898. noalign @r{don't align tables on startup}
  12899. @end example
  12900. @vindex org-startup-with-inline-images
  12901. When visiting a file, inline images can be automatically displayed. The
  12902. corresponding variable is @code{org-startup-with-inline-images}, with a
  12903. default value @code{nil} to avoid delays when visiting a file.
  12904. @cindex @code{inlineimages}, STARTUP keyword
  12905. @cindex @code{noinlineimages}, STARTUP keyword
  12906. @example
  12907. inlineimages @r{show inline images}
  12908. noinlineimages @r{don't show inline images on startup}
  12909. @end example
  12910. @vindex org-log-done
  12911. @vindex org-log-note-clock-out
  12912. @vindex org-log-repeat
  12913. Logging the closing and reopening of TODO items and clock intervals can be
  12914. configured using these options (see variables @code{org-log-done},
  12915. @code{org-log-note-clock-out} and @code{org-log-repeat})
  12916. @cindex @code{logdone}, STARTUP keyword
  12917. @cindex @code{lognotedone}, STARTUP keyword
  12918. @cindex @code{nologdone}, STARTUP keyword
  12919. @cindex @code{lognoteclock-out}, STARTUP keyword
  12920. @cindex @code{nolognoteclock-out}, STARTUP keyword
  12921. @cindex @code{logrepeat}, STARTUP keyword
  12922. @cindex @code{lognoterepeat}, STARTUP keyword
  12923. @cindex @code{nologrepeat}, STARTUP keyword
  12924. @cindex @code{logreschedule}, STARTUP keyword
  12925. @cindex @code{lognotereschedule}, STARTUP keyword
  12926. @cindex @code{nologreschedule}, STARTUP keyword
  12927. @cindex @code{logredeadline}, STARTUP keyword
  12928. @cindex @code{lognoteredeadline}, STARTUP keyword
  12929. @cindex @code{nologredeadline}, STARTUP keyword
  12930. @cindex @code{logrefile}, STARTUP keyword
  12931. @cindex @code{lognoterefile}, STARTUP keyword
  12932. @cindex @code{nologrefile}, STARTUP keyword
  12933. @cindex @code{logdrawer}, STARTUP keyword
  12934. @cindex @code{nologdrawer}, STARTUP keyword
  12935. @cindex @code{logstatesreversed}, STARTUP keyword
  12936. @cindex @code{nologstatesreversed}, STARTUP keyword
  12937. @example
  12938. logdone @r{record a timestamp when an item is marked DONE}
  12939. lognotedone @r{record timestamp and a note when DONE}
  12940. nologdone @r{don't record when items are marked DONE}
  12941. logrepeat @r{record a time when reinstating a repeating item}
  12942. lognoterepeat @r{record a note when reinstating a repeating item}
  12943. nologrepeat @r{do not record when reinstating repeating item}
  12944. lognoteclock-out @r{record a note when clocking out}
  12945. nolognoteclock-out @r{don't record a note when clocking out}
  12946. logreschedule @r{record a timestamp when scheduling time changes}
  12947. lognotereschedule @r{record a note when scheduling time changes}
  12948. nologreschedule @r{do not record when a scheduling date changes}
  12949. logredeadline @r{record a timestamp when deadline changes}
  12950. lognoteredeadline @r{record a note when deadline changes}
  12951. nologredeadline @r{do not record when a deadline date changes}
  12952. logrefile @r{record a timestamp when refiling}
  12953. lognoterefile @r{record a note when refiling}
  12954. nologrefile @r{do not record when refiling}
  12955. logdrawer @r{store log into drawer}
  12956. nologdrawer @r{store log outside of drawer}
  12957. logstatesreversed @r{reverse the order of states notes}
  12958. nologstatesreversed @r{do not reverse the order of states notes}
  12959. @end example
  12960. @vindex org-hide-leading-stars
  12961. @vindex org-odd-levels-only
  12962. Here are the options for hiding leading stars in outline headings, and for
  12963. indenting outlines. The corresponding variables are
  12964. @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
  12965. default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
  12966. @cindex @code{hidestars}, STARTUP keyword
  12967. @cindex @code{showstars}, STARTUP keyword
  12968. @cindex @code{odd}, STARTUP keyword
  12969. @cindex @code{even}, STARTUP keyword
  12970. @example
  12971. hidestars @r{make all but one of the stars starting a headline invisible.}
  12972. showstars @r{show all stars starting a headline}
  12973. indent @r{virtual indentation according to outline level}
  12974. noindent @r{no virtual indentation according to outline level}
  12975. odd @r{allow only odd outline levels (1,3,...)}
  12976. oddeven @r{allow all outline levels}
  12977. @end example
  12978. @vindex org-put-time-stamp-overlays
  12979. @vindex org-time-stamp-overlay-formats
  12980. To turn on custom format overlays over timestamps (variables
  12981. @code{org-put-time-stamp-overlays} and
  12982. @code{org-time-stamp-overlay-formats}), use
  12983. @cindex @code{customtime}, STARTUP keyword
  12984. @example
  12985. customtime @r{overlay custom time format}
  12986. @end example
  12987. @vindex constants-unit-system
  12988. The following options influence the table spreadsheet (variable
  12989. @code{constants-unit-system}).
  12990. @cindex @code{constcgs}, STARTUP keyword
  12991. @cindex @code{constSI}, STARTUP keyword
  12992. @example
  12993. constcgs @r{@file{constants.el} should use the c-g-s unit system}
  12994. constSI @r{@file{constants.el} should use the SI unit system}
  12995. @end example
  12996. @vindex org-footnote-define-inline
  12997. @vindex org-footnote-auto-label
  12998. @vindex org-footnote-auto-adjust
  12999. To influence footnote settings, use the following keywords. The
  13000. corresponding variables are @code{org-footnote-define-inline},
  13001. @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
  13002. @cindex @code{fninline}, STARTUP keyword
  13003. @cindex @code{nofninline}, STARTUP keyword
  13004. @cindex @code{fnlocal}, STARTUP keyword
  13005. @cindex @code{fnprompt}, STARTUP keyword
  13006. @cindex @code{fnauto}, STARTUP keyword
  13007. @cindex @code{fnconfirm}, STARTUP keyword
  13008. @cindex @code{fnplain}, STARTUP keyword
  13009. @cindex @code{fnadjust}, STARTUP keyword
  13010. @cindex @code{nofnadjust}, STARTUP keyword
  13011. @example
  13012. fninline @r{define footnotes inline}
  13013. fnnoinline @r{define footnotes in separate section}
  13014. fnlocal @r{define footnotes near first reference, but not inline}
  13015. fnprompt @r{prompt for footnote labels}
  13016. fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
  13017. fnconfirm @r{offer automatic label for editing or confirmation}
  13018. fnplain @r{create @code{[1]}-like labels automatically}
  13019. fnadjust @r{automatically renumber and sort footnotes}
  13020. nofnadjust @r{do not renumber and sort automatically}
  13021. @end example
  13022. @cindex org-hide-block-startup
  13023. To hide blocks on startup, use these keywords. The corresponding variable is
  13024. @code{org-hide-block-startup}.
  13025. @cindex @code{hideblocks}, STARTUP keyword
  13026. @cindex @code{nohideblocks}, STARTUP keyword
  13027. @example
  13028. hideblocks @r{Hide all begin/end blocks on startup}
  13029. nohideblocks @r{Do not hide blocks on startup}
  13030. @end example
  13031. @cindex org-pretty-entities
  13032. The display of entities as UTF-8 characters is governed by the variable
  13033. @code{org-pretty-entities} and the keywords
  13034. @cindex @code{entitiespretty}, STARTUP keyword
  13035. @cindex @code{entitiesplain}, STARTUP keyword
  13036. @example
  13037. entitiespretty @r{Show entities as UTF-8 characters where possible}
  13038. entitiesplain @r{Leave entities plain}
  13039. @end example
  13040. @item #+TAGS: TAG1(c1) TAG2(c2)
  13041. @vindex org-tag-alist
  13042. These lines (several such lines are allowed) specify the valid tags in
  13043. this file, and (potentially) the corresponding @emph{fast tag selection}
  13044. keys. The corresponding variable is @code{org-tag-alist}.
  13045. @item #+TBLFM:
  13046. This line contains the formulas for the table directly above the line.
  13047. @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
  13048. @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
  13049. @itemx #+DESCRIPTION:, #+KEYWORDS:,
  13050. @itemx #+LaTeX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
  13051. @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
  13052. These lines provide settings for exporting files. For more details see
  13053. @ref{Export options}.
  13054. @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
  13055. @vindex org-todo-keywords
  13056. These lines set the TODO keywords and their interpretation in the
  13057. current file. The corresponding variable is @code{org-todo-keywords}.
  13058. @end table
  13059. @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
  13060. @section The very busy C-c C-c key
  13061. @kindex C-c C-c
  13062. @cindex C-c C-c, overview
  13063. The key @kbd{C-c C-c} has many purposes in Org, which are all
  13064. mentioned scattered throughout this manual. One specific function of
  13065. this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
  13066. other circumstances it means something like @emph{``Hey Org, look
  13067. here and update according to what you see here''}. Here is a summary of
  13068. what this means in different contexts.
  13069. @itemize @minus
  13070. @item
  13071. If there are highlights in the buffer from the creation of a sparse
  13072. tree, or from clock display, remove these highlights.
  13073. @item
  13074. If the cursor is in one of the special @code{#+KEYWORD} lines, this
  13075. triggers scanning the buffer for these lines and updating the
  13076. information.
  13077. @item
  13078. If the cursor is inside a table, realign the table. This command
  13079. works even if the automatic table editor has been turned off.
  13080. @item
  13081. If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
  13082. the entire table.
  13083. @item
  13084. If the current buffer is a capture buffer, close the note and file it.
  13085. With a prefix argument, file it, without further interaction, to the
  13086. default location.
  13087. @item
  13088. If the cursor is on a @code{<<<target>>>}, update radio targets and
  13089. corresponding links in this buffer.
  13090. @item
  13091. If the cursor is in a property line or at the start or end of a property
  13092. drawer, offer property commands.
  13093. @item
  13094. If the cursor is at a footnote reference, go to the corresponding
  13095. definition, and vice versa.
  13096. @item
  13097. If the cursor is on a statistics cookie, update it.
  13098. @item
  13099. If the cursor is in a plain list item with a checkbox, toggle the status
  13100. of the checkbox.
  13101. @item
  13102. If the cursor is on a numbered item in a plain list, renumber the
  13103. ordered list.
  13104. @item
  13105. If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
  13106. block is updated.
  13107. @item
  13108. If the cursor is at a timestamp, fix the day name in the timestamp.
  13109. @end itemize
  13110. @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
  13111. @section A cleaner outline view
  13112. @cindex hiding leading stars
  13113. @cindex dynamic indentation
  13114. @cindex odd-levels-only outlines
  13115. @cindex clean outline view
  13116. Some people find it noisy and distracting that the Org headlines start with a
  13117. potentially large number of stars, and that text below the headlines is not
  13118. indented. While this is no problem when writing a @emph{book-like} document
  13119. where the outline headings are really section headings, in a more
  13120. @emph{list-oriented} outline, indented structure is a lot cleaner:
  13121. @example
  13122. @group
  13123. * Top level headline | * Top level headline
  13124. ** Second level | * Second level
  13125. *** 3rd level | * 3rd level
  13126. some text | some text
  13127. *** 3rd level | * 3rd level
  13128. more text | more text
  13129. * Another top level headline | * Another top level headline
  13130. @end group
  13131. @end example
  13132. @noindent
  13133. If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
  13134. with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
  13135. be achieved dynamically at display time using @code{org-indent-mode}. In
  13136. this minor mode, all lines are prefixed for display with the necessary amount
  13137. of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
  13138. property, such that @code{visual-line-mode} (or purely setting
  13139. @code{word-wrap}) wraps long lines (including headlines) correctly indented.
  13140. }. Also headlines are prefixed with additional stars, so that the amount of
  13141. indentation shifts by two@footnote{See the variable
  13142. @code{org-indent-indentation-per-level}.} spaces per level. All headline
  13143. stars but the last one are made invisible using the @code{org-hide}
  13144. face@footnote{Turning on @code{org-indent-mode} sets
  13145. @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
  13146. @code{nil}.}; see below under @samp{2.} for more information on how this
  13147. works. You can turn on @code{org-indent-mode} for all files by customizing
  13148. the variable @code{org-startup-indented}, or you can turn it on for
  13149. individual files using
  13150. @example
  13151. #+STARTUP: indent
  13152. @end example
  13153. If you want a similar effect in an earlier version of Emacs and/or Org, or if
  13154. you want the indentation to be hard space characters so that the plain text
  13155. file looks as similar as possible to the Emacs display, Org supports you in
  13156. the following way:
  13157. @enumerate
  13158. @item
  13159. @emph{Indentation of text below headlines}@*
  13160. You may indent text below each headline to make the left boundary line up
  13161. with the headline, like
  13162. @example
  13163. *** 3rd level
  13164. more text, now indented
  13165. @end example
  13166. @vindex org-adapt-indentation
  13167. Org supports this with paragraph filling, line wrapping, and structure
  13168. editing@footnote{See also the variable @code{org-adapt-indentation}.},
  13169. preserving or adapting the indentation as appropriate.
  13170. @item
  13171. @vindex org-hide-leading-stars
  13172. @emph{Hiding leading stars}@* You can modify the display in such a way that
  13173. all leading stars become invisible. To do this in a global way, configure
  13174. the variable @code{org-hide-leading-stars} or change this on a per-file basis
  13175. with
  13176. @example
  13177. #+STARTUP: hidestars
  13178. #+STARTUP: showstars
  13179. @end example
  13180. With hidden stars, the tree becomes:
  13181. @example
  13182. @group
  13183. * Top level headline
  13184. * Second level
  13185. * 3rd level
  13186. ...
  13187. @end group
  13188. @end example
  13189. @noindent
  13190. @vindex org-hide @r{(face)}
  13191. The leading stars are not truly replaced by whitespace, they are only
  13192. fontified with the face @code{org-hide} that uses the background color as
  13193. font color. If you are not using either white or black background, you may
  13194. have to customize this face to get the wanted effect. Another possibility is
  13195. to set this font such that the extra stars are @i{almost} invisible, for
  13196. example using the color @code{grey90} on a white background.
  13197. @item
  13198. @vindex org-odd-levels-only
  13199. Things become cleaner still if you skip all the even levels and use only odd
  13200. levels 1, 3, 5..., effectively adding two stars to go from one outline level
  13201. to the next@footnote{When you need to specify a level for a property search
  13202. or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
  13203. way we get the outline view shown at the beginning of this section. In order
  13204. to make the structure editing and export commands handle this convention
  13205. correctly, configure the variable @code{org-odd-levels-only}, or set this on
  13206. a per-file basis with one of the following lines:
  13207. @example
  13208. #+STARTUP: odd
  13209. #+STARTUP: oddeven
  13210. @end example
  13211. You can convert an Org file from single-star-per-level to the
  13212. double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
  13213. RET} in that file. The reverse operation is @kbd{M-x
  13214. org-convert-to-oddeven-levels}.
  13215. @end enumerate
  13216. @node TTY keys, Interaction, Clean view, Miscellaneous
  13217. @section Using Org on a tty
  13218. @cindex tty key bindings
  13219. Because Org contains a large number of commands, by default many of
  13220. Org's core commands are bound to keys that are generally not
  13221. accessible on a tty, such as the cursor keys (@key{left}, @key{right},
  13222. @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
  13223. together with modifiers like @key{Meta} and/or @key{Shift}. To access
  13224. these commands on a tty when special keys are unavailable, the following
  13225. alternative bindings can be used. The tty bindings below will likely be
  13226. more cumbersome; you may find for some of the bindings below that a
  13227. customized workaround suits you better. For example, changing a timestamp
  13228. is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
  13229. tty you would rather use @kbd{C-c .} to re-insert the timestamp.
  13230. @multitable @columnfractions 0.15 0.2 0.1 0.2
  13231. @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
  13232. @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
  13233. @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
  13234. @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
  13235. @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
  13236. @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
  13237. @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
  13238. @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
  13239. @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
  13240. @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
  13241. @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
  13242. @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
  13243. @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
  13244. @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
  13245. @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
  13246. @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
  13247. @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
  13248. @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
  13249. @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
  13250. @end multitable
  13251. @node Interaction, org-crypt.el, TTY keys, Miscellaneous
  13252. @section Interaction with other packages
  13253. @cindex packages, interaction with other
  13254. Org lives in the world of GNU Emacs and interacts in various ways
  13255. with other code out there.
  13256. @menu
  13257. * Cooperation:: Packages Org cooperates with
  13258. * Conflicts:: Packages that lead to conflicts
  13259. @end menu
  13260. @node Cooperation, Conflicts, Interaction, Interaction
  13261. @subsection Packages that Org cooperates with
  13262. @table @asis
  13263. @cindex @file{calc.el}
  13264. @cindex Gillespie, Dave
  13265. @item @file{calc.el} by Dave Gillespie
  13266. Org uses the Calc package for implementing spreadsheet
  13267. functionality in its tables (@pxref{The spreadsheet}). Org
  13268. checks for the availability of Calc by looking for the function
  13269. @code{calc-eval} which will have been autoloaded during setup if Calc has
  13270. been installed properly. As of Emacs 22, Calc is part of the Emacs
  13271. distribution. Another possibility for interaction between the two
  13272. packages is using Calc for embedded calculations. @xref{Embedded Mode,
  13273. , Embedded Mode, calc, GNU Emacs Calc Manual}.
  13274. @item @file{constants.el} by Carsten Dominik
  13275. @cindex @file{constants.el}
  13276. @cindex Dominik, Carsten
  13277. @vindex org-table-formula-constants
  13278. In a table formula (@pxref{The spreadsheet}), it is possible to use
  13279. names for natural constants or units. Instead of defining your own
  13280. constants in the variable @code{org-table-formula-constants}, install
  13281. the @file{constants} package which defines a large number of constants
  13282. and units, and lets you use unit prefixes like @samp{M} for
  13283. @samp{Mega}, etc. You will need version 2.0 of this package, available
  13284. at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
  13285. the function @code{constants-get}, which has to be autoloaded in your
  13286. setup. See the installation instructions in the file
  13287. @file{constants.el}.
  13288. @item @file{cdlatex.el} by Carsten Dominik
  13289. @cindex @file{cdlatex.el}
  13290. @cindex Dominik, Carsten
  13291. Org mode can make use of the CD@LaTeX{} package to efficiently enter
  13292. @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
  13293. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
  13294. @cindex @file{imenu.el}
  13295. Imenu allows menu access to an index of items in a file. Org mode
  13296. supports Imenu---all you need to do to get the index is the following:
  13297. @lisp
  13298. (add-hook 'org-mode-hook
  13299. (lambda () (imenu-add-to-menubar "Imenu")))
  13300. @end lisp
  13301. @vindex org-imenu-depth
  13302. By default the index is two levels deep---you can modify the depth using
  13303. the option @code{org-imenu-depth}.
  13304. @item @file{remember.el} by John Wiegley
  13305. @cindex @file{remember.el}
  13306. @cindex Wiegley, John
  13307. Org used to use this package for capture, but no longer does.
  13308. @item @file{speedbar.el} by Eric M. Ludlam
  13309. @cindex @file{speedbar.el}
  13310. @cindex Ludlam, Eric M.
  13311. Speedbar is a package that creates a special frame displaying files and
  13312. index items in files. Org mode supports Speedbar and allows you to
  13313. drill into Org files directly from the Speedbar. It also allows you to
  13314. restrict the scope of agenda commands to a file or a subtree by using
  13315. the command @kbd{<} in the Speedbar frame.
  13316. @cindex @file{table.el}
  13317. @item @file{table.el} by Takaaki Ota
  13318. @kindex C-c C-c
  13319. @cindex table editor, @file{table.el}
  13320. @cindex @file{table.el}
  13321. @cindex Ota, Takaaki
  13322. Complex ASCII tables with automatic line wrapping, column- and row-spanning,
  13323. and alignment can be created using the Emacs table package by Takaaki Ota
  13324. (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
  13325. Org mode will recognize these tables and export them properly. Because of
  13326. interference with other Org mode functionality, you unfortunately cannot edit
  13327. these tables directly in the buffer. Instead, you need to use the command
  13328. @kbd{C-c '} to edit them, similar to source code snippets.
  13329. @table @kbd
  13330. @orgcmd{C-c ',org-edit-special}
  13331. Edit a @file{table.el} table. Works when the cursor is in a table.el table.
  13332. @c
  13333. @orgcmd{C-c ~,org-table-create-with-table.el}
  13334. Insert a @file{table.el} table. If there is already a table at point, this
  13335. command converts it between the @file{table.el} format and the Org mode
  13336. format. See the documentation string of the command
  13337. @code{org-convert-table} for the restrictions under which this is
  13338. possible.
  13339. @end table
  13340. @file{table.el} is part of Emacs since Emacs 22.
  13341. @item @file{footnote.el} by Steven L. Baur
  13342. @cindex @file{footnote.el}
  13343. @cindex Baur, Steven L.
  13344. Org mode recognizes numerical footnotes as provided by this package.
  13345. However, Org mode also has its own footnote support (@pxref{Footnotes}),
  13346. which makes using @file{footnote.el} unnecessary.
  13347. @end table
  13348. @node Conflicts, , Cooperation, Interaction
  13349. @subsection Packages that lead to conflicts with Org mode
  13350. @table @asis
  13351. @cindex @code{shift-selection-mode}
  13352. @vindex org-support-shift-select
  13353. In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
  13354. cursor motions combined with the shift key should start or enlarge regions.
  13355. This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
  13356. timestamps, TODO keywords, priorities, and item bullet types if the cursor is
  13357. at such a location. By default, @kbd{S-@key{cursor}} commands outside
  13358. special contexts don't do anything, but you can customize the variable
  13359. @code{org-support-shift-select}. Org mode then tries to accommodate shift
  13360. selection by (i) using it outside of the special contexts where special
  13361. commands apply, and by (ii) extending an existing active region even if the
  13362. cursor moves across a special context.
  13363. @item @file{CUA.el} by Kim. F. Storm
  13364. @cindex @file{CUA.el}
  13365. @cindex Storm, Kim. F.
  13366. @vindex org-replace-disputed-keys
  13367. Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
  13368. (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
  13369. region. In fact, Emacs 23 has this built-in in the form of
  13370. @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
  13371. 23, you probably don't want to use another package for this purpose. However,
  13372. if you prefer to leave these keys to a different package while working in
  13373. Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
  13374. Org will move the following key bindings in Org files, and in the agenda
  13375. buffer (but not during date selection).
  13376. @example
  13377. S-UP @result{} M-p S-DOWN @result{} M-n
  13378. S-LEFT @result{} M-- S-RIGHT @result{} M-+
  13379. C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
  13380. @end example
  13381. @vindex org-disputed-keys
  13382. Yes, these are unfortunately more difficult to remember. If you want
  13383. to have other replacement keys, look at the variable
  13384. @code{org-disputed-keys}.
  13385. @item @file{filladapt.el} by Kyle Jones
  13386. @cindex @file{filladapt.el}
  13387. Org mode tries to do the right thing when filling paragraphs, list items and
  13388. other elements. Many users reported they had problems using both
  13389. @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
  13390. this:
  13391. @lisp
  13392. (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
  13393. @end lisp
  13394. @item @file{yasnippet.el}
  13395. @cindex @file{yasnippet.el}
  13396. The way Org mode binds the TAB key (binding to @code{[tab]} instead of
  13397. @code{"\t"}) overrules YASnippet's access to this key. The following code
  13398. fixed this problem:
  13399. @lisp
  13400. (add-hook 'org-mode-hook
  13401. (lambda ()
  13402. (org-set-local 'yas/trigger-key [tab])
  13403. (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
  13404. @end lisp
  13405. The latest version of yasnippet doesn't play well with Org mode. If the
  13406. above code does not fix the conflict, start by defining the following
  13407. function:
  13408. @lisp
  13409. (defun yas/org-very-safe-expand ()
  13410. (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
  13411. @end lisp
  13412. Then, tell Org mode what to do with the new function:
  13413. @lisp
  13414. (add-hook 'org-mode-hook
  13415. (lambda ()
  13416. (make-variable-buffer-local 'yas/trigger-key)
  13417. (setq yas/trigger-key [tab])
  13418. (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
  13419. (define-key yas/keymap [tab] 'yas/next-field)))
  13420. @end lisp
  13421. @item @file{windmove.el} by Hovav Shacham
  13422. @cindex @file{windmove.el}
  13423. This package also uses the @kbd{S-<cursor>} keys, so everything written
  13424. in the paragraph above about CUA mode also applies here. If you want make
  13425. the windmove function active in locations where Org mode does not have
  13426. special functionality on @kbd{S-@key{cursor}}, add this to your
  13427. configuration:
  13428. @lisp
  13429. ;; Make windmove work in org-mode:
  13430. (add-hook 'org-shiftup-final-hook 'windmove-up)
  13431. (add-hook 'org-shiftleft-final-hook 'windmove-left)
  13432. (add-hook 'org-shiftdown-final-hook 'windmove-down)
  13433. (add-hook 'org-shiftright-final-hook 'windmove-right)
  13434. @end lisp
  13435. @item @file{viper.el} by Michael Kifer
  13436. @cindex @file{viper.el}
  13437. @kindex C-c /
  13438. Viper uses @kbd{C-c /} and therefore makes this key not access the
  13439. corresponding Org mode command @code{org-sparse-tree}. You need to find
  13440. another key for this command, or override the key in
  13441. @code{viper-vi-global-user-map} with
  13442. @lisp
  13443. (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
  13444. @end lisp
  13445. @end table
  13446. @node org-crypt.el, , Interaction, Miscellaneous
  13447. @section org-crypt.el
  13448. @cindex @file{org-crypt.el}
  13449. @cindex @code{org-decrypt-entry}
  13450. Org-crypt will encrypt the text of an entry, but not the headline, or
  13451. properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
  13452. files.
  13453. Any text below a headline that has a @samp{:crypt:} tag will be automatically
  13454. be encrypted when the file is saved. If you want to use a different tag just
  13455. customize the @code{org-crypt-tag-matcher} setting.
  13456. To use org-crypt it is suggested that you have the following in your
  13457. @file{.emacs}:
  13458. @example
  13459. (require 'org-crypt)
  13460. (org-crypt-use-before-save-magic)
  13461. (setq org-tags-exclude-from-inheritance (quote ("crypt")))
  13462. (setq org-crypt-key nil)
  13463. ;; GPG key to use for encryption
  13464. ;; Either the Key ID or set to nil to use symmetric encryption.
  13465. (setq auto-save-default nil)
  13466. ;; Auto-saving does not cooperate with org-crypt.el: so you need
  13467. ;; to turn it off if you plan to use org-crypt.el quite often.
  13468. ;; Otherwise, you'll get an (annoying) message each time you
  13469. ;; start Org.
  13470. ;; To turn it off only locally, you can insert this:
  13471. ;;
  13472. ;; # -*- buffer-auto-save-file-name: nil; -*-
  13473. @end example
  13474. Excluding the crypt tag from inheritance prevents already encrypted text
  13475. being encrypted again.
  13476. @node Hacking, MobileOrg, Miscellaneous, Top
  13477. @appendix Hacking
  13478. @cindex hacking
  13479. This appendix covers some aspects where users can extend the functionality of
  13480. Org.
  13481. @menu
  13482. * Hooks:: How to reach into Org's internals
  13483. * Add-on packages:: Available extensions
  13484. * Adding hyperlink types:: New custom link types
  13485. * Context-sensitive commands:: How to add functionality to such commands
  13486. * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
  13487. * Dynamic blocks:: Automatically filled blocks
  13488. * Special agenda views:: Customized views
  13489. * Extracting agenda information:: Postprocessing of agenda information
  13490. * Using the property API:: Writing programs that use entry properties
  13491. * Using the mapping API:: Mapping over all or selected entries
  13492. @end menu
  13493. @node Hooks, Add-on packages, Hacking, Hacking
  13494. @section Hooks
  13495. @cindex hooks
  13496. Org has a large number of hook variables that can be used to add
  13497. functionality. This appendix about hacking is going to illustrate the
  13498. use of some of them. A complete list of all hooks with documentation is
  13499. maintained by the Worg project and can be found at
  13500. @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
  13501. @node Add-on packages, Adding hyperlink types, Hooks, Hacking
  13502. @section Add-on packages
  13503. @cindex add-on packages
  13504. A large number of add-on packages have been written by various authors.
  13505. These packages are not part of Emacs, but they are distributed as contributed
  13506. packages with the separate release available at the Org mode home page at
  13507. @uref{http://orgmode.org}. The list of contributed packages, along with
  13508. documentation about each package, is maintained by the Worg project at
  13509. @uref{http://orgmode.org/worg/org-contrib/}.
  13510. @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
  13511. @section Adding hyperlink types
  13512. @cindex hyperlinks, adding new types
  13513. Org has a large number of hyperlink types built-in
  13514. (@pxref{Hyperlinks}). If you would like to add new link types, Org
  13515. provides an interface for doing so. Let's look at an example file,
  13516. @file{org-man.el}, that will add support for creating links like
  13517. @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
  13518. Emacs:
  13519. @lisp
  13520. ;;; org-man.el - Support for links to manpages in Org
  13521. (require 'org)
  13522. (org-add-link-type "man" 'org-man-open)
  13523. (add-hook 'org-store-link-functions 'org-man-store-link)
  13524. (defcustom org-man-command 'man
  13525. "The Emacs command to be used to display a man page."
  13526. :group 'org-link
  13527. :type '(choice (const man) (const woman)))
  13528. (defun org-man-open (path)
  13529. "Visit the manpage on PATH.
  13530. PATH should be a topic that can be thrown at the man command."
  13531. (funcall org-man-command path))
  13532. (defun org-man-store-link ()
  13533. "Store a link to a manpage."
  13534. (when (memq major-mode '(Man-mode woman-mode))
  13535. ;; This is a man page, we do make this link
  13536. (let* ((page (org-man-get-page-name))
  13537. (link (concat "man:" page))
  13538. (description (format "Manpage for %s" page)))
  13539. (org-store-link-props
  13540. :type "man"
  13541. :link link
  13542. :description description))))
  13543. (defun org-man-get-page-name ()
  13544. "Extract the page name from the buffer name."
  13545. ;; This works for both `Man-mode' and `woman-mode'.
  13546. (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
  13547. (match-string 1 (buffer-name))
  13548. (error "Cannot create link to this man page")))
  13549. (provide 'org-man)
  13550. ;;; org-man.el ends here
  13551. @end lisp
  13552. @noindent
  13553. You would activate this new link type in @file{.emacs} with
  13554. @lisp
  13555. (require 'org-man)
  13556. @end lisp
  13557. @noindent
  13558. Let's go through the file and see what it does.
  13559. @enumerate
  13560. @item
  13561. It does @code{(require 'org)} to make sure that @file{org.el} has been
  13562. loaded.
  13563. @item
  13564. The next line calls @code{org-add-link-type} to define a new link type
  13565. with prefix @samp{man}. The call also contains the name of a function
  13566. that will be called to follow such a link.
  13567. @item
  13568. @vindex org-store-link-functions
  13569. The next line adds a function to @code{org-store-link-functions}, in
  13570. order to allow the command @kbd{C-c l} to record a useful link in a
  13571. buffer displaying a man page.
  13572. @end enumerate
  13573. The rest of the file defines the necessary variables and functions.
  13574. First there is a customization variable that determines which Emacs
  13575. command should be used to display man pages. There are two options,
  13576. @code{man} and @code{woman}. Then the function to follow a link is
  13577. defined. It gets the link path as an argument---in this case the link
  13578. path is just a topic for the manual command. The function calls the
  13579. value of @code{org-man-command} to display the man page.
  13580. Finally the function @code{org-man-store-link} is defined. When you try
  13581. to store a link with @kbd{C-c l}, this function will be called to
  13582. try to make a link. The function must first decide if it is supposed to
  13583. create the link for this buffer type; we do this by checking the value
  13584. of the variable @code{major-mode}. If not, the function must exit and
  13585. return the value @code{nil}. If yes, the link is created by getting the
  13586. manual topic from the buffer name and prefixing it with the string
  13587. @samp{man:}. Then it must call the command @code{org-store-link-props}
  13588. and set the @code{:type} and @code{:link} properties. Optionally you
  13589. can also set the @code{:description} property to provide a default for
  13590. the link description when the link is later inserted into an Org
  13591. buffer with @kbd{C-c C-l}.
  13592. When it makes sense for your new link type, you may also define a function
  13593. @code{org-PREFIX-complete-link} that implements special (e.g., completion)
  13594. support for inserting such a link with @kbd{C-c C-l}. Such a function should
  13595. not accept any arguments, and return the full link with prefix.
  13596. @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
  13597. @section Context-sensitive commands
  13598. @cindex context-sensitive commands, hooks
  13599. @cindex add-ons, context-sensitive commands
  13600. @vindex org-ctrl-c-ctrl-c-hook
  13601. Org has several commands that act differently depending on context. The most
  13602. important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
  13603. Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
  13604. Add-ons can tap into this functionality by providing a function that detects
  13605. special context for that add-on and executes functionality appropriate for
  13606. the context. Here is an example from Dan Davison's @file{org-R.el} which
  13607. allows you to evaluate commands based on the @file{R} programming language
  13608. @footnote{@file{org-R.el} has been replaced by the Org mode functionality
  13609. described in @ref{Working With Source Code} and is now obsolete.}. For this
  13610. package, special contexts are lines that start with @code{#+R:} or
  13611. @code{#+RR:}.
  13612. @lisp
  13613. (defun org-R-apply-maybe ()
  13614. "Detect if this is context for org-R and execute R commands."
  13615. (if (save-excursion
  13616. (beginning-of-line 1)
  13617. (looking-at "#\\+RR?:"))
  13618. (progn (call-interactively 'org-R-apply)
  13619. t) ;; to signal that we took action
  13620. nil)) ;; to signal that we did not
  13621. (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
  13622. @end lisp
  13623. The function first checks if the cursor is in such a line. If that is the
  13624. case, @code{org-R-apply} is called and the function returns @code{t} to
  13625. signal that action was taken, and @kbd{C-c C-c} will stop looking for other
  13626. contexts. If the function finds it should do nothing locally, it returns
  13627. @code{nil} so that other, similar functions can have a try.
  13628. @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
  13629. @section Tables and lists in arbitrary syntax
  13630. @cindex tables, in other modes
  13631. @cindex lists, in other modes
  13632. @cindex Orgtbl mode
  13633. Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
  13634. frequent feature request has been to make it work with native tables in
  13635. specific languages, for example @LaTeX{}. However, this is extremely
  13636. hard to do in a general way, would lead to a customization nightmare,
  13637. and would take away much of the simplicity of the Orgtbl mode table
  13638. editor.
  13639. This appendix describes a different approach. We keep the Orgtbl mode
  13640. table in its native format (the @i{source table}), and use a custom
  13641. function to @i{translate} the table to the correct syntax, and to
  13642. @i{install} it in the right location (the @i{target table}). This puts
  13643. the burden of writing conversion functions on the user, but it allows
  13644. for a very flexible system.
  13645. Bastien added the ability to do the same with lists, in Orgstruct mode. You
  13646. can use Org's facilities to edit and structure lists by turning
  13647. @code{orgstruct-mode} on, then locally exporting such lists in another format
  13648. (HTML, @LaTeX{} or Texinfo.)
  13649. @menu
  13650. * Radio tables:: Sending and receiving radio tables
  13651. * A @LaTeX{} example:: Step by step, almost a tutorial
  13652. * Translator functions:: Copy and modify
  13653. * Radio lists:: Doing the same for lists
  13654. @end menu
  13655. @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
  13656. @subsection Radio tables
  13657. @cindex radio tables
  13658. To define the location of the target table, you first need to create two
  13659. lines that are comments in the current mode, but contain magic words for
  13660. Orgtbl mode to find. Orgtbl mode will insert the translated table
  13661. between these lines, replacing whatever was there before. For example:
  13662. @example
  13663. /* BEGIN RECEIVE ORGTBL table_name */
  13664. /* END RECEIVE ORGTBL table_name */
  13665. @end example
  13666. @noindent
  13667. Just above the source table, we put a special line that tells
  13668. Orgtbl mode how to translate this table and where to install it. For
  13669. example:
  13670. @cindex #+ORGTBL
  13671. @example
  13672. #+ORGTBL: SEND table_name translation_function arguments....
  13673. @end example
  13674. @noindent
  13675. @code{table_name} is the reference name for the table that is also used
  13676. in the receiver lines. @code{translation_function} is the Lisp function
  13677. that does the translation. Furthermore, the line can contain a list of
  13678. arguments (alternating key and value) at the end. The arguments will be
  13679. passed as a property list to the translation function for
  13680. interpretation. A few standard parameters are already recognized and
  13681. acted upon before the translation function is called:
  13682. @table @code
  13683. @item :skip N
  13684. Skip the first N lines of the table. Hlines do count as separate lines for
  13685. this parameter!
  13686. @item :skipcols (n1 n2 ...)
  13687. List of columns that should be skipped. If the table has a column with
  13688. calculation marks, that column is automatically discarded as well.
  13689. Please note that the translator function sees the table @emph{after} the
  13690. removal of these columns, the function never knows that there have been
  13691. additional columns.
  13692. @item :no-escape t
  13693. When non-nil, do not escape special characters @code{&%#_^} when exporting
  13694. the table. The default value is nil.
  13695. @end table
  13696. @noindent
  13697. The one problem remaining is how to keep the source table in the buffer
  13698. without disturbing the normal workings of the file, for example during
  13699. compilation of a C file or processing of a @LaTeX{} file. There are a
  13700. number of different solutions:
  13701. @itemize @bullet
  13702. @item
  13703. The table could be placed in a block comment if that is supported by the
  13704. language. For example, in C mode you could wrap the table between
  13705. @samp{/*} and @samp{*/} lines.
  13706. @item
  13707. Sometimes it is possible to put the table after some kind of @i{END}
  13708. statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
  13709. in @LaTeX{}.
  13710. @item
  13711. You can just comment the table line-by-line whenever you want to process
  13712. the file, and uncomment it whenever you need to edit the table. This
  13713. only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
  13714. makes this comment-toggling very easy, in particular if you bind it to a
  13715. key.
  13716. @end itemize
  13717. @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
  13718. @subsection A @LaTeX{} example of radio tables
  13719. @cindex @LaTeX{}, and Orgtbl mode
  13720. The best way to wrap the source table in @LaTeX{} is to use the
  13721. @code{comment} environment provided by @file{comment.sty}. It has to be
  13722. activated by placing @code{\usepackage@{comment@}} into the document
  13723. header. Orgtbl mode can insert a radio table skeleton@footnote{By
  13724. default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
  13725. variable @code{orgtbl-radio-tables} to install templates for other
  13726. modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
  13727. be prompted for a table name, let's say we use @samp{salesfigures}. You
  13728. will then get the following template:
  13729. @cindex #+ORGTBL, SEND
  13730. @example
  13731. % BEGIN RECEIVE ORGTBL salesfigures
  13732. % END RECEIVE ORGTBL salesfigures
  13733. \begin@{comment@}
  13734. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  13735. | | |
  13736. \end@{comment@}
  13737. @end example
  13738. @noindent
  13739. @vindex @LaTeX{}-verbatim-environments
  13740. The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
  13741. @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
  13742. into the receiver location with name @code{salesfigures}. You may now
  13743. fill in the table---feel free to use the spreadsheet features@footnote{If
  13744. the @samp{#+TBLFM} line contains an odd number of dollar characters,
  13745. this may cause problems with font-lock in @LaTeX{} mode. As shown in the
  13746. example you can fix this by adding an extra line inside the
  13747. @code{comment} environment that is used to balance the dollar
  13748. expressions. If you are using AUC@TeX{} with the font-latex library, a
  13749. much better solution is to add the @code{comment} environment to the
  13750. variable @code{LaTeX-verbatim-environments}.}:
  13751. @example
  13752. % BEGIN RECEIVE ORGTBL salesfigures
  13753. % END RECEIVE ORGTBL salesfigures
  13754. \begin@{comment@}
  13755. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  13756. | Month | Days | Nr sold | per day |
  13757. |-------+------+---------+---------|
  13758. | Jan | 23 | 55 | 2.4 |
  13759. | Feb | 21 | 16 | 0.8 |
  13760. | March | 22 | 278 | 12.6 |
  13761. #+TBLFM: $4=$3/$2;%.1f
  13762. % $ (optional extra dollar to keep font-lock happy, see footnote)
  13763. \end@{comment@}
  13764. @end example
  13765. @noindent
  13766. When you are done, press @kbd{C-c C-c} in the table to get the converted
  13767. table inserted between the two marker lines.
  13768. Now let's assume you want to make the table header by hand, because you
  13769. want to control how columns are aligned, etc. In this case we make sure
  13770. that the table translator skips the first 2 lines of the source
  13771. table, and tell the command to work as a @i{splice}, i.e., to not produce
  13772. header and footer commands of the target table:
  13773. @example
  13774. \begin@{tabular@}@{lrrr@}
  13775. Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
  13776. % BEGIN RECEIVE ORGTBL salesfigures
  13777. % END RECEIVE ORGTBL salesfigures
  13778. \end@{tabular@}
  13779. %
  13780. \begin@{comment@}
  13781. #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
  13782. | Month | Days | Nr sold | per day |
  13783. |-------+------+---------+---------|
  13784. | Jan | 23 | 55 | 2.4 |
  13785. | Feb | 21 | 16 | 0.8 |
  13786. | March | 22 | 278 | 12.6 |
  13787. #+TBLFM: $4=$3/$2;%.1f
  13788. \end@{comment@}
  13789. @end example
  13790. The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
  13791. Orgtbl mode. It uses a @code{tabular} environment to typeset the table
  13792. and marks horizontal lines with @code{\hline}. Furthermore, it
  13793. interprets the following parameters (see also @pxref{Translator functions}):
  13794. @table @code
  13795. @item :splice nil/t
  13796. When set to t, return only table body lines, don't wrap them into a
  13797. tabular environment. Default is nil.
  13798. @item :fmt fmt
  13799. A format to be used to wrap each field, it should contain @code{%s} for the
  13800. original field value. For example, to wrap each field value in dollars,
  13801. you could use @code{:fmt "$%s$"}. This may also be a property list with
  13802. column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
  13803. A function of one argument can be used in place of the strings; the
  13804. function must return a formatted string.
  13805. @item :efmt efmt
  13806. Use this format to print numbers with exponentials. The format should
  13807. have @code{%s} twice for inserting mantissa and exponent, for example
  13808. @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
  13809. may also be a property list with column numbers and formats, for example
  13810. @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
  13811. @code{efmt} has been applied to a value, @code{fmt} will also be
  13812. applied. Similar to @code{fmt}, functions of two arguments can be
  13813. supplied instead of strings.
  13814. @end table
  13815. @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
  13816. @subsection Translator functions
  13817. @cindex HTML, and Orgtbl mode
  13818. @cindex translator function
  13819. Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
  13820. (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
  13821. @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
  13822. Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
  13823. code that produces tables during HTML export.}, these all use a generic
  13824. translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
  13825. itself is a very short function that computes the column definitions for the
  13826. @code{tabular} environment, defines a few field and line separators and then
  13827. hands processing over to the generic translator. Here is the entire code:
  13828. @lisp
  13829. @group
  13830. (defun orgtbl-to-latex (table params)
  13831. "Convert the Orgtbl mode TABLE to LaTeX."
  13832. (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
  13833. org-table-last-alignment ""))
  13834. (params2
  13835. (list
  13836. :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
  13837. :tend "\\end@{tabular@}"
  13838. :lstart "" :lend " \\\\" :sep " & "
  13839. :efmt "%s\\,(%s)" :hline "\\hline")))
  13840. (orgtbl-to-generic table (org-combine-plists params2 params))))
  13841. @end group
  13842. @end lisp
  13843. As you can see, the properties passed into the function (variable
  13844. @var{PARAMS}) are combined with the ones newly defined in the function
  13845. (variable @var{PARAMS2}). The ones passed into the function (i.e., the
  13846. ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
  13847. would like to use the @LaTeX{} translator, but wanted the line endings to
  13848. be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
  13849. overrule the default with
  13850. @example
  13851. #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
  13852. @end example
  13853. For a new language, you can either write your own converter function in
  13854. analogy with the @LaTeX{} translator, or you can use the generic function
  13855. directly. For example, if you have a language where a table is started
  13856. with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
  13857. started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
  13858. separator is a TAB, you could call the generic translator like this (on
  13859. a single line!):
  13860. @example
  13861. #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
  13862. :lstart "!BL! " :lend " !EL!" :sep "\t"
  13863. @end example
  13864. @noindent
  13865. Please check the documentation string of the function
  13866. @code{orgtbl-to-generic} for a full list of parameters understood by
  13867. that function, and remember that you can pass each of them into
  13868. @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
  13869. using the generic function.
  13870. Of course you can also write a completely new function doing complicated
  13871. things the generic translator cannot do. A translator function takes
  13872. two arguments. The first argument is the table, a list of lines, each
  13873. line either the symbol @code{hline} or a list of fields. The second
  13874. argument is the property list containing all parameters specified in the
  13875. @samp{#+ORGTBL: SEND} line. The function must return a single string
  13876. containing the formatted table. If you write a generally useful
  13877. translator, please post it on @email{emacs-orgmode@@gnu.org} so that
  13878. others can benefit from your work.
  13879. @node Radio lists, , Translator functions, Tables in arbitrary syntax
  13880. @subsection Radio lists
  13881. @cindex radio lists
  13882. @cindex org-list-insert-radio-list
  13883. Sending and receiving radio lists works exactly the same way as sending and
  13884. receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
  13885. insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
  13886. @code{org-list-insert-radio-list}.
  13887. Here are the differences with radio tables:
  13888. @itemize @minus
  13889. @item
  13890. Orgstruct mode must be active.
  13891. @item
  13892. Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
  13893. @item
  13894. The available translation functions for radio lists don't take
  13895. parameters.
  13896. @item
  13897. @kbd{C-c C-c} will work when pressed on the first item of the list.
  13898. @end itemize
  13899. Here is a @LaTeX{} example. Let's say that you have this in your
  13900. @LaTeX{} file:
  13901. @cindex #+ORGLST
  13902. @example
  13903. % BEGIN RECEIVE ORGLST to-buy
  13904. % END RECEIVE ORGLST to-buy
  13905. \begin@{comment@}
  13906. #+ORGLST: SEND to-buy org-list-to-latex
  13907. - a new house
  13908. - a new computer
  13909. + a new keyboard
  13910. + a new mouse
  13911. - a new life
  13912. \end@{comment@}
  13913. @end example
  13914. Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
  13915. @LaTeX{} list between the two marker lines.
  13916. @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
  13917. @section Dynamic blocks
  13918. @cindex dynamic blocks
  13919. Org documents can contain @emph{dynamic blocks}. These are
  13920. specially marked regions that are updated by some user-written function.
  13921. A good example for such a block is the clock table inserted by the
  13922. command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
  13923. Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
  13924. to the block and can also specify parameters for the function producing
  13925. the content of the block.
  13926. @cindex #+BEGIN:dynamic block
  13927. @example
  13928. #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
  13929. #+END:
  13930. @end example
  13931. Dynamic blocks are updated with the following commands
  13932. @table @kbd
  13933. @orgcmd{C-c C-x C-u,org-dblock-update}
  13934. Update dynamic block at point.
  13935. @orgkey{C-u C-c C-x C-u}
  13936. Update all dynamic blocks in the current file.
  13937. @end table
  13938. Updating a dynamic block means to remove all the text between BEGIN and
  13939. END, parse the BEGIN line for parameters and then call the specific
  13940. writer function for this block to insert the new content. If you want
  13941. to use the original content in the writer function, you can use the
  13942. extra parameter @code{:content}.
  13943. For a block with name @code{myblock}, the writer function is
  13944. @code{org-dblock-write:myblock} with as only parameter a property list
  13945. with the parameters given in the begin line. Here is a trivial example
  13946. of a block that keeps track of when the block update function was last
  13947. run:
  13948. @example
  13949. #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
  13950. #+END:
  13951. @end example
  13952. @noindent
  13953. The corresponding block writer function could look like this:
  13954. @lisp
  13955. (defun org-dblock-write:block-update-time (params)
  13956. (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
  13957. (insert "Last block update at: "
  13958. (format-time-string fmt (current-time)))))
  13959. @end lisp
  13960. If you want to make sure that all dynamic blocks are always up-to-date,
  13961. you could add the function @code{org-update-all-dblocks} to a hook, for
  13962. example @code{before-save-hook}. @code{org-update-all-dblocks} is
  13963. written in a way such that it does nothing in buffers that are not in
  13964. @code{org-mode}.
  13965. You can narrow the current buffer to the current dynamic block (like any
  13966. other block) with @code{org-narrow-to-block}.
  13967. @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
  13968. @section Special agenda views
  13969. @cindex agenda views, user-defined
  13970. @vindex org-agenda-skip-function
  13971. @vindex org-agenda-skip-function-global
  13972. Org provides a special hook that can be used to narrow down the selection
  13973. made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
  13974. @code{tags}, @code{tags-todo}, @code{tags-tree}. You may specify a function
  13975. that is used at each match to verify if the match should indeed be part of
  13976. the agenda view, and if not, how much should be skipped. You can specify a
  13977. global condition that will be applied to all agenda views, this condition
  13978. would be stored in the variable @code{org-agenda-skip-function-global}. More
  13979. commonly, such a definition is applied only to specific custom searches,
  13980. using @code{org-agenda-skip-function}.
  13981. Let's say you want to produce a list of projects that contain a WAITING
  13982. tag anywhere in the project tree. Let's further assume that you have
  13983. marked all tree headings that define a project with the TODO keyword
  13984. PROJECT@. In this case you would run a TODO search for the keyword
  13985. PROJECT, but skip the match unless there is a WAITING tag anywhere in
  13986. the subtree belonging to the project line.
  13987. To achieve this, you must write a function that searches the subtree for
  13988. the tag. If the tag is found, the function must return @code{nil} to
  13989. indicate that this match should not be skipped. If there is no such
  13990. tag, return the location of the end of the subtree, to indicate that
  13991. search should continue from there.
  13992. @lisp
  13993. (defun my-skip-unless-waiting ()
  13994. "Skip trees that are not waiting"
  13995. (let ((subtree-end (save-excursion (org-end-of-subtree t))))
  13996. (if (re-search-forward ":waiting:" subtree-end t)
  13997. nil ; tag found, do not skip
  13998. subtree-end))) ; tag not found, continue after end of subtree
  13999. @end lisp
  14000. Now you may use this function in an agenda custom command, for example
  14001. like this:
  14002. @lisp
  14003. (org-add-agenda-custom-command
  14004. '("b" todo "PROJECT"
  14005. ((org-agenda-skip-function 'my-skip-unless-waiting)
  14006. (org-agenda-overriding-header "Projects waiting for something: "))))
  14007. @end lisp
  14008. @vindex org-agenda-overriding-header
  14009. Note that this also binds @code{org-agenda-overriding-header} to get a
  14010. meaningful header in the agenda view.
  14011. @vindex org-odd-levels-only
  14012. @vindex org-agenda-skip-function
  14013. A general way to create custom searches is to base them on a search for
  14014. entries with a certain level limit. If you want to study all entries with
  14015. your custom search function, simply do a search for
  14016. @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
  14017. level number corresponds to order in the hierarchy, not to the number of
  14018. stars.}, and then use @code{org-agenda-skip-function} to select the entries
  14019. you really want to have.
  14020. You may also put a Lisp form into @code{org-agenda-skip-function}. In
  14021. particular, you may use the functions @code{org-agenda-skip-entry-if}
  14022. and @code{org-agenda-skip-subtree-if} in this form, for example:
  14023. @table @code
  14024. @item (org-agenda-skip-entry-if 'scheduled)
  14025. Skip current entry if it has been scheduled.
  14026. @item (org-agenda-skip-entry-if 'notscheduled)
  14027. Skip current entry if it has not been scheduled.
  14028. @item (org-agenda-skip-entry-if 'deadline)
  14029. Skip current entry if it has a deadline.
  14030. @item (org-agenda-skip-entry-if 'scheduled 'deadline)
  14031. Skip current entry if it has a deadline, or if it is scheduled.
  14032. @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
  14033. Skip current entry if the TODO keyword is TODO or WAITING.
  14034. @item (org-agenda-skip-entry-if 'todo 'done)
  14035. Skip current entry if the TODO keyword marks a DONE state.
  14036. @item (org-agenda-skip-entry-if 'timestamp)
  14037. Skip current entry if it has any timestamp, may also be deadline or scheduled.
  14038. @anchor{x-agenda-skip-entry-regexp}
  14039. @item (org-agenda-skip-entry-if 'regexp "regular expression")
  14040. Skip current entry if the regular expression matches in the entry.
  14041. @item (org-agenda-skip-entry-if 'notregexp "regular expression")
  14042. Skip current entry unless the regular expression matches.
  14043. @item (org-agenda-skip-subtree-if 'regexp "regular expression")
  14044. Same as above, but check and skip the entire subtree.
  14045. @end table
  14046. Therefore we could also have written the search for WAITING projects
  14047. like this, even without defining a special function:
  14048. @lisp
  14049. (org-add-agenda-custom-command
  14050. '("b" todo "PROJECT"
  14051. ((org-agenda-skip-function '(org-agenda-skip-subtree-if
  14052. 'regexp ":waiting:"))
  14053. (org-agenda-overriding-header "Projects waiting for something: "))))
  14054. @end lisp
  14055. @node Extracting agenda information, Using the property API, Special agenda views, Hacking
  14056. @section Extracting agenda information
  14057. @cindex agenda, pipe
  14058. @cindex Scripts, for agenda processing
  14059. @vindex org-agenda-custom-commands
  14060. Org provides commands to access agenda information for the command
  14061. line in Emacs batch mode. This extracted information can be sent
  14062. directly to a printer, or it can be read by a program that does further
  14063. processing of the data. The first of these commands is the function
  14064. @code{org-batch-agenda}, that produces an agenda view and sends it as
  14065. ASCII text to STDOUT@. The command takes a single string as parameter.
  14066. If the string has length 1, it is used as a key to one of the commands
  14067. you have configured in @code{org-agenda-custom-commands}, basically any
  14068. key you can use after @kbd{C-c a}. For example, to directly print the
  14069. current TODO list, you could use
  14070. @example
  14071. emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
  14072. @end example
  14073. If the parameter is a string with 2 or more characters, it is used as a
  14074. tags/TODO match string. For example, to print your local shopping list
  14075. (all items with the tag @samp{shop}, but excluding the tag
  14076. @samp{NewYork}), you could use
  14077. @example
  14078. emacs -batch -l ~/.emacs \
  14079. -eval '(org-batch-agenda "+shop-NewYork")' | lpr
  14080. @end example
  14081. @noindent
  14082. You may also modify parameters on the fly like this:
  14083. @example
  14084. emacs -batch -l ~/.emacs \
  14085. -eval '(org-batch-agenda "a" \
  14086. org-agenda-span (quote month) \
  14087. org-agenda-include-diary nil \
  14088. org-agenda-files (quote ("~/org/project.org")))' \
  14089. | lpr
  14090. @end example
  14091. @noindent
  14092. which will produce a 30-day agenda, fully restricted to the Org file
  14093. @file{~/org/projects.org}, not even including the diary.
  14094. If you want to process the agenda data in more sophisticated ways, you
  14095. can use the command @code{org-batch-agenda-csv} to get a comma-separated
  14096. list of values for each agenda item. Each line in the output will
  14097. contain a number of fields separated by commas. The fields in a line
  14098. are:
  14099. @example
  14100. category @r{The category of the item}
  14101. head @r{The headline, without TODO keyword, TAGS and PRIORITY}
  14102. type @r{The type of the agenda entry, can be}
  14103. todo @r{selected in TODO match}
  14104. tagsmatch @r{selected in tags match}
  14105. diary @r{imported from diary}
  14106. deadline @r{a deadline}
  14107. scheduled @r{scheduled}
  14108. timestamp @r{appointment, selected by timestamp}
  14109. closed @r{entry was closed on date}
  14110. upcoming-deadline @r{warning about nearing deadline}
  14111. past-scheduled @r{forwarded scheduled item}
  14112. block @r{entry has date block including date}
  14113. todo @r{The TODO keyword, if any}
  14114. tags @r{All tags including inherited ones, separated by colons}
  14115. date @r{The relevant date, like 2007-2-14}
  14116. time @r{The time, like 15:00-16:50}
  14117. extra @r{String with extra planning info}
  14118. priority-l @r{The priority letter if any was given}
  14119. priority-n @r{The computed numerical priority}
  14120. @end example
  14121. @noindent
  14122. Time and date will only be given if a timestamp (or deadline/scheduled)
  14123. led to the selection of the item.
  14124. A CSV list like this is very easy to use in a post-processing script.
  14125. For example, here is a Perl program that gets the TODO list from
  14126. Emacs/Org and prints all the items, preceded by a checkbox:
  14127. @example
  14128. #!/usr/bin/perl
  14129. # define the Emacs command to run
  14130. $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
  14131. # run it and capture the output
  14132. $agenda = qx@{$cmd 2>/dev/null@};
  14133. # loop over all lines
  14134. foreach $line (split(/\n/,$agenda)) @{
  14135. # get the individual values
  14136. ($category,$head,$type,$todo,$tags,$date,$time,$extra,
  14137. $priority_l,$priority_n) = split(/,/,$line);
  14138. # process and print
  14139. print "[ ] $head\n";
  14140. @}
  14141. @end example
  14142. @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
  14143. @section Using the property API
  14144. @cindex API, for properties
  14145. @cindex properties, API
  14146. Here is a description of the functions that can be used to work with
  14147. properties.
  14148. @defun org-entry-properties &optional pom which
  14149. Get all properties of the entry at point-or-marker POM.@*
  14150. This includes the TODO keyword, the tags, time strings for deadline,
  14151. scheduled, and clocking, and any additional properties defined in the
  14152. entry. The return value is an alist. Keys may occur multiple times
  14153. if the property key was used several times.@*
  14154. POM may also be nil, in which case the current entry is used.
  14155. If WHICH is nil or `all', get all properties. If WHICH is
  14156. `special' or `standard', only get that subclass.
  14157. @end defun
  14158. @vindex org-use-property-inheritance
  14159. @findex org-insert-property-drawer
  14160. @defun org-entry-get pom property &optional inherit
  14161. Get value of PROPERTY for entry at point-or-marker POM@. By default,
  14162. this only looks at properties defined locally in the entry. If INHERIT
  14163. is non-nil and the entry does not have the property, then also check
  14164. higher levels of the hierarchy. If INHERIT is the symbol
  14165. @code{selective}, use inheritance if and only if the setting of
  14166. @code{org-use-property-inheritance} selects PROPERTY for inheritance.
  14167. @end defun
  14168. @defun org-entry-delete pom property
  14169. Delete the property PROPERTY from entry at point-or-marker POM.
  14170. @end defun
  14171. @defun org-entry-put pom property value
  14172. Set PROPERTY to VALUE for entry at point-or-marker POM.
  14173. @end defun
  14174. @defun org-buffer-property-keys &optional include-specials
  14175. Get all property keys in the current buffer.
  14176. @end defun
  14177. @defun org-insert-property-drawer
  14178. Insert a property drawer for the current entry. Also
  14179. @end defun
  14180. @defun org-entry-put-multivalued-property pom property &rest values
  14181. Set PROPERTY at point-or-marker POM to VALUES@. VALUES should be a list of
  14182. strings. They will be concatenated, with spaces as separators.
  14183. @end defun
  14184. @defun org-entry-get-multivalued-property pom property
  14185. Treat the value of the property PROPERTY as a whitespace-separated list of
  14186. values and return the values as a list of strings.
  14187. @end defun
  14188. @defun org-entry-add-to-multivalued-property pom property value
  14189. Treat the value of the property PROPERTY as a whitespace-separated list of
  14190. values and make sure that VALUE is in this list.
  14191. @end defun
  14192. @defun org-entry-remove-from-multivalued-property pom property value
  14193. Treat the value of the property PROPERTY as a whitespace-separated list of
  14194. values and make sure that VALUE is @emph{not} in this list.
  14195. @end defun
  14196. @defun org-entry-member-in-multivalued-property pom property value
  14197. Treat the value of the property PROPERTY as a whitespace-separated list of
  14198. values and check if VALUE is in this list.
  14199. @end defun
  14200. @defopt org-property-allowed-value-functions
  14201. Hook for functions supplying allowed values for a specific property.
  14202. The functions must take a single argument, the name of the property, and
  14203. return a flat list of allowed values. If @samp{:ETC} is one of
  14204. the values, use the values as completion help, but allow also other values
  14205. to be entered. The functions must return @code{nil} if they are not
  14206. responsible for this property.
  14207. @end defopt
  14208. @node Using the mapping API, , Using the property API, Hacking
  14209. @section Using the mapping API
  14210. @cindex API, for mapping
  14211. @cindex mapping entries, API
  14212. Org has sophisticated mapping capabilities to find all entries satisfying
  14213. certain criteria. Internally, this functionality is used to produce agenda
  14214. views, but there is also an API that can be used to execute arbitrary
  14215. functions for each or selected entries. The main entry point for this API
  14216. is:
  14217. @defun org-map-entries func &optional match scope &rest skip
  14218. Call FUNC at each headline selected by MATCH in SCOPE.
  14219. FUNC is a function or a Lisp form. The function will be called without
  14220. arguments, with the cursor positioned at the beginning of the headline.
  14221. The return values of all calls to the function will be collected and
  14222. returned as a list.
  14223. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  14224. does not need to preserve point. After evaluation, the cursor will be
  14225. moved to the end of the line (presumably of the headline of the
  14226. processed entry) and search continues from there. Under some
  14227. circumstances, this may not produce the wanted results. For example,
  14228. if you have removed (e.g., archived) the current (sub)tree it could
  14229. mean that the next entry will be skipped entirely. In such cases, you
  14230. can specify the position from where search should continue by making
  14231. FUNC set the variable `org-map-continue-from' to the desired buffer
  14232. position.
  14233. MATCH is a tags/property/todo match as it is used in the agenda match view.
  14234. Only headlines that are matched by this query will be considered during
  14235. the iteration. When MATCH is nil or t, all headlines will be
  14236. visited by the iteration.
  14237. SCOPE determines the scope of this command. It can be any of:
  14238. @example
  14239. nil @r{the current buffer, respecting the restriction if any}
  14240. tree @r{the subtree started with the entry at point}
  14241. region @r{The entries within the active region, if any}
  14242. file @r{the current buffer, without restriction}
  14243. file-with-archives
  14244. @r{the current buffer, and any archives associated with it}
  14245. agenda @r{all agenda files}
  14246. agenda-with-archives
  14247. @r{all agenda files with any archive files associated with them}
  14248. (file1 file2 ...)
  14249. @r{if this is a list, all files in the list will be scanned}
  14250. @end example
  14251. @noindent
  14252. The remaining args are treated as settings for the skipping facilities of
  14253. the scanner. The following items can be given here:
  14254. @vindex org-agenda-skip-function
  14255. @example
  14256. archive @r{skip trees with the archive tag}
  14257. comment @r{skip trees with the COMMENT keyword}
  14258. function or Lisp form
  14259. @r{will be used as value for @code{org-agenda-skip-function},}
  14260. @r{so whenever the function returns t, FUNC}
  14261. @r{will not be called for that entry and search will}
  14262. @r{continue from the point where the function leaves it}
  14263. @end example
  14264. @end defun
  14265. The function given to that mapping routine can really do anything you like.
  14266. It can use the property API (@pxref{Using the property API}) to gather more
  14267. information about the entry, or in order to change metadata in the entry.
  14268. Here are a couple of functions that might be handy:
  14269. @defun org-todo &optional arg
  14270. Change the TODO state of the entry. See the docstring of the functions for
  14271. the many possible values for the argument ARG.
  14272. @end defun
  14273. @defun org-priority &optional action
  14274. Change the priority of the entry. See the docstring of this function for the
  14275. possible values for ACTION.
  14276. @end defun
  14277. @defun org-toggle-tag tag &optional onoff
  14278. Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
  14279. or @code{off} will not toggle tag, but ensure that it is either on or off.
  14280. @end defun
  14281. @defun org-promote
  14282. Promote the current entry.
  14283. @end defun
  14284. @defun org-demote
  14285. Demote the current entry.
  14286. @end defun
  14287. Here is a simple example that will turn all entries in the current file with
  14288. a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
  14289. Entries in comment trees and in archive trees will be ignored.
  14290. @lisp
  14291. (org-map-entries
  14292. '(org-todo "UPCOMING")
  14293. "+TOMORROW" 'file 'archive 'comment)
  14294. @end lisp
  14295. The following example counts the number of entries with TODO keyword
  14296. @code{WAITING}, in all agenda files.
  14297. @lisp
  14298. (length (org-map-entries t "/+WAITING" 'agenda))
  14299. @end lisp
  14300. @node MobileOrg, History and Acknowledgments, Hacking, Top
  14301. @appendix MobileOrg
  14302. @cindex iPhone
  14303. @cindex MobileOrg
  14304. @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
  14305. available for iOS and for Android. @i{MobileOrg} offers offline viewing and
  14306. capture support for an Org mode system rooted on a ``real'' computer. It
  14307. does also allow you to record changes to existing entries.
  14308. The @uref{http://mobileorg.ncogni.to/, iOS implementation} for the
  14309. @i{iPhone/iPod Touch/iPad} series of devices, was developed by Richard
  14310. Moreland. Android users should check out
  14311. @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
  14312. by Matt Jones. The two implementations are not identical but offer similar
  14313. features.
  14314. This appendix describes the support Org has for creating agenda views in a
  14315. format that can be displayed by @i{MobileOrg}, and for integrating notes
  14316. captured and changes made by @i{MobileOrg} into the main system.
  14317. For changing tags and TODO states in MobileOrg, you should have set up the
  14318. customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
  14319. cover all important tags and TODO keywords, even if individual files use only
  14320. part of these. MobileOrg will also offer you states and tags set up with
  14321. in-buffer settings, but it will understand the logistics of TODO state
  14322. @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
  14323. (@pxref{Setting tags}) only for those set in these variables.
  14324. @menu
  14325. * Setting up the staging area:: Where to interact with the mobile device
  14326. * Pushing to MobileOrg:: Uploading Org files and agendas
  14327. * Pulling from MobileOrg:: Integrating captured and flagged items
  14328. @end menu
  14329. @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
  14330. @section Setting up the staging area
  14331. MobileOrg needs to interact with Emacs through a directory on a server. If you
  14332. are using a public server, you should consider to encrypt the files that are
  14333. uploaded to the server. This can be done with Org mode 7.02 and with
  14334. @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
  14335. installation on your system. To turn on encryption, set a password in
  14336. @i{MobileOrg} and, on the Emacs side, configure the variable
  14337. @code{org-mobile-use-encryption}@footnote{If you can safely store the
  14338. password in your Emacs setup, you might also want to configure
  14339. @code{org-mobile-encryption-password}. Please read the docstring of that
  14340. variable. Note that encryption will apply only to the contents of the
  14341. @file{.org} files. The file names themselves will remain visible.}.
  14342. The easiest way to create that directory is to use a free
  14343. @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
  14344. Dropbox, or if your version of MobileOrg does not support it, you can use a
  14345. webdav server. For more information, check out the documentation of MobileOrg and also this
  14346. @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
  14347. When MobileOrg first connects to your Dropbox, it will create a directory
  14348. @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
  14349. Emacs about it:
  14350. @lisp
  14351. (setq org-mobile-directory "~/Dropbox/MobileOrg")
  14352. @end lisp
  14353. Org mode has commands to put files for @i{MobileOrg} into that directory,
  14354. and to read captured notes from there.
  14355. @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
  14356. @section Pushing to MobileOrg
  14357. This operation copies all files currently listed in @code{org-mobile-files}
  14358. to the directory @code{org-mobile-directory}. By default this list contains
  14359. all agenda files (as listed in @code{org-agenda-files}), but additional files
  14360. can be included by customizing @code{org-mobile-files}. File names will be
  14361. staged with paths relative to @code{org-directory}, so all files should be
  14362. inside this directory@footnote{Symbolic links in @code{org-directory} need to
  14363. have the same name than their targets.}.
  14364. The push operation also creates a special Org file @file{agendas.org} with
  14365. all custom agenda view defined by the user@footnote{While creating the
  14366. agendas, Org mode will force ID properties on all referenced entries, so that
  14367. these entries can be uniquely identified if @i{MobileOrg} flags them for
  14368. further action. If you do not want to get these properties in so many
  14369. entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
  14370. to @code{nil}. Org mode will then rely on outline paths, in the hope that
  14371. these will be unique enough.}.
  14372. Finally, Org writes the file @file{index.org}, containing links to all other
  14373. files. @i{MobileOrg} first reads this file from the server, and then
  14374. downloads all agendas and Org files listed in it. To speed up the download,
  14375. MobileOrg will only read files whose checksums@footnote{Checksums are stored
  14376. automatically in the file @file{checksums.dat}} have changed.
  14377. @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
  14378. @section Pulling from MobileOrg
  14379. When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
  14380. files for viewing. It also appends captured entries and pointers to flagged
  14381. and changed entries to the file @file{mobileorg.org} on the server. Org has
  14382. a @emph{pull} operation that integrates this information into an inbox file
  14383. and operates on the pointers to flagged entries. Here is how it works:
  14384. @enumerate
  14385. @item
  14386. Org moves all entries found in
  14387. @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
  14388. operation.} and appends them to the file pointed to by the variable
  14389. @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
  14390. will be a top-level entry in the inbox file.
  14391. @item
  14392. After moving the entries, Org will attempt to implement the changes made in
  14393. @i{MobileOrg}. Some changes are applied directly and without user
  14394. interaction. Examples are all changes to tags, TODO state, headline and body
  14395. text that can be cleanly applied. Entries that have been flagged for further
  14396. action will receive a tag @code{:FLAGGED:}, so that they can be easily found
  14397. again. When there is a problem finding an entry or applying the change, the
  14398. pointer entry will remain in the inbox and will be marked with an error
  14399. message. You need to later resolve these issues by hand.
  14400. @item
  14401. Org will then generate an agenda view with all flagged entries. The user
  14402. should then go through these entries and do whatever actions are necessary.
  14403. If a note has been stored while flagging an entry in @i{MobileOrg}, that note
  14404. will be displayed in the echo area when the cursor is on the corresponding
  14405. agenda line.
  14406. @table @kbd
  14407. @kindex ?
  14408. @item ?
  14409. Pressing @kbd{?} in that special agenda will display the full flagging note in
  14410. another window and also push it onto the kill ring. So you could use @kbd{?
  14411. z C-y C-c C-c} to store that flagging note as a normal note in the entry.
  14412. Pressing @kbd{?} twice in succession will offer to remove the
  14413. @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
  14414. in a property). In this way you indicate that the intended processing for
  14415. this flagged entry is finished.
  14416. @end table
  14417. @end enumerate
  14418. @kindex C-c a ?
  14419. If you are not able to process all flagged entries directly, you can always
  14420. return to this agenda view@footnote{Note, however, that there is a subtle
  14421. difference. The view created automatically by @kbd{M-x org-mobile-pull
  14422. @key{RET}} is guaranteed to search all files that have been addressed by the
  14423. last pull. This might include a file that is not currently in your list of
  14424. agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
  14425. the current agenda files will be searched.} using @kbd{C-c a ?}.
  14426. @node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top
  14427. @appendix History and acknowledgments
  14428. @cindex acknowledgments
  14429. @cindex history
  14430. @cindex thanks
  14431. @section From Carsten
  14432. Org was born in 2003, out of frustration over the user interface of the Emacs
  14433. Outline mode. I was trying to organize my notes and projects, and using
  14434. Emacs seemed to be the natural way to go. However, having to remember eleven
  14435. different commands with two or three keys per command, only to hide and show
  14436. parts of the outline tree, that seemed entirely unacceptable to me. Also,
  14437. when using outlines to take notes, I constantly wanted to restructure the
  14438. tree, organizing it parallel to my thoughts and plans. @emph{Visibility
  14439. cycling} and @emph{structure editing} were originally implemented in the
  14440. package @file{outline-magic.el}, but quickly moved to the more general
  14441. @file{org.el}. As this environment became comfortable for project planning,
  14442. the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
  14443. @emph{table support}. These areas highlighted the two main goals that Org
  14444. still has today: to be a new, outline-based, plain text mode with innovative
  14445. and intuitive editing features, and to incorporate project planning
  14446. functionality directly into a notes file.
  14447. Since the first release, literally thousands of emails to me or to
  14448. @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
  14449. reports, feedback, new ideas, and sometimes patches and add-on code.
  14450. Many thanks to everyone who has helped to improve this package. I am
  14451. trying to keep here a list of the people who had significant influence
  14452. in shaping one or more aspects of Org. The list may not be
  14453. complete, if I have forgotten someone, please accept my apologies and
  14454. let me know.
  14455. Before I get to this list, a few special mentions are in order:
  14456. @table @i
  14457. @item Bastien Guerry
  14458. Bastien has written a large number of extensions to Org (most of them
  14459. integrated into the core by now), including the @LaTeX{} exporter and the plain
  14460. list parser. His support during the early days, when he basically acted as
  14461. co-maintainer, was central to the success of this project. Bastien also
  14462. invented Worg, helped establishing the Web presence of Org, and sponsored
  14463. hosting costs for the orgmode.org website.
  14464. @item Eric Schulte and Dan Davison
  14465. Eric and Dan are jointly responsible for the Org-babel system, which turns
  14466. Org into a multi-language environment for evaluating code and doing literate
  14467. programming and reproducible research.
  14468. @item John Wiegley
  14469. John has contributed a number of great ideas and patches directly to Org,
  14470. including the attachment system (@file{org-attach.el}), integration with
  14471. Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
  14472. items, habit tracking (@file{org-habits.el}), and encryption
  14473. (@file{org-crypt.el}). Also, the capture system is really an extended copy
  14474. of his great @file{remember.el}.
  14475. @item Sebastian Rose
  14476. Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
  14477. of an ignorant amateur. Sebastian has pushed this part of Org onto a much
  14478. higher level. He also wrote @file{org-info.js}, a Java script for displaying
  14479. webpages derived from Org using an Info-like or a folding interface with
  14480. single-key navigation.
  14481. @end table
  14482. @noindent See below for the full list of contributions! Again, please
  14483. let me know what I am missing here!
  14484. @section From Bastien
  14485. I (Bastien) have been maintaining Org since January 2011. This appendix
  14486. would not be complete without adding a few more acknowledgements and thanks
  14487. to Carsten's ones above.
  14488. I am first grateful to Carsten for his trust while handing me over the
  14489. maintainership of Org. His support as been great since day one of this new
  14490. adventure, and it helped a lot.
  14491. When I took over maintainership, I knew I would have to make Org more
  14492. collaborative than ever, as I would have to rely on people that are more
  14493. knowledgeable than I am on many parts of the code. Here is a list of the
  14494. persons I could rely on, they should really be considered co-maintainers,
  14495. either of the code or the community:
  14496. @table @i
  14497. @item Eric Schulte
  14498. Eric is maintaining the Babel parts of Org. His reactivity here kept me away
  14499. from worrying about possible bugs here and let me focus on other parts.
  14500. @item Nicolas Goaziou
  14501. Nicolas is maintaining the consistency of the deepest parts of Org. His work
  14502. on @file{org-element.el} and @file{org-export.el} has been outstanding, and
  14503. opened the doors for many new ideas and features.
  14504. @item Jambunathan K
  14505. Jambunathan contributed the ODT exporter, definitely a killer feature of
  14506. Org mode. He also contributed the new HTML exporter, which is another core
  14507. feature of Org. Here too, I knew I could rely on him to fix bugs in these
  14508. areas and to patiently explain the users what was the problems and solutions.
  14509. @item Achim Gratz
  14510. Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
  14511. into a flexible and conceptually clean process. He patiently coped with the
  14512. many hiccups that such a change can create for users.
  14513. @item Nick Dokos
  14514. The Org mode mailing list would not be such a nice place without Nick, who
  14515. patiently helped users so many times. It is impossible to overestimate such
  14516. a great help, and the list would not be so active without him.
  14517. @end table
  14518. I received support from so many users that it is clearly impossible to be
  14519. fair when shortlisting a few of them, but Org's history would not be
  14520. complete if the ones above were not mentioned in this manual.
  14521. @section List of contributions
  14522. @itemize @bullet
  14523. @item
  14524. @i{Russel Adams} came up with the idea for drawers.
  14525. @item
  14526. @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
  14527. @item
  14528. @i{Christophe Bataillon} created the great unicorn logo that we use on the
  14529. Org mode website.
  14530. @item
  14531. @i{Alex Bochannek} provided a patch for rounding timestamps.
  14532. @item
  14533. @i{Jan Böcker} wrote @file{org-docview.el}.
  14534. @item
  14535. @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
  14536. @item
  14537. @i{Tom Breton} wrote @file{org-choose.el}.
  14538. @item
  14539. @i{Charles Cave}'s suggestion sparked the implementation of templates
  14540. for Remember, which are now templates for capture.
  14541. @item
  14542. @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
  14543. specified time.
  14544. @item
  14545. @i{Gregory Chernov} patched support for Lisp forms into table
  14546. calculations and improved XEmacs compatibility, in particular by porting
  14547. @file{nouline.el} to XEmacs.
  14548. @item
  14549. @i{Sacha Chua} suggested copying some linking code from Planner.
  14550. @item
  14551. @i{Baoqiu Cui} contributed the DocBook exporter.
  14552. @item
  14553. @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
  14554. came up with the idea of properties, and that there should be an API for
  14555. them.
  14556. @item
  14557. @i{Nick Dokos} tracked down several nasty bugs.
  14558. @item
  14559. @i{Kees Dullemond} used to edit projects lists directly in HTML and so
  14560. inspired some of the early development, including HTML export. He also
  14561. asked for a way to narrow wide table columns.
  14562. @item
  14563. @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
  14564. the Org-Babel documentation into the manual.
  14565. @item
  14566. @i{Christian Egli} converted the documentation into Texinfo format, inspired
  14567. the agenda, patched CSS formatting into the HTML exporter, and wrote
  14568. @file{org-taskjuggler.el}.
  14569. @item
  14570. @i{David Emery} provided a patch for custom CSS support in exported
  14571. HTML agendas.
  14572. @item
  14573. @i{Nic Ferrier} contributed mailcap and XOXO support.
  14574. @item
  14575. @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
  14576. @item
  14577. @i{John Foerch} figured out how to make incremental search show context
  14578. around a match in a hidden outline tree.
  14579. @item
  14580. @i{Raimar Finken} wrote @file{org-git-line.el}.
  14581. @item
  14582. @i{Mikael Fornius} works as a mailing list moderator.
  14583. @item
  14584. @i{Austin Frank} works as a mailing list moderator.
  14585. @item
  14586. @i{Eric Fraga} drove the development of BEAMER export with ideas and
  14587. testing.
  14588. @item
  14589. @i{Barry Gidden} did proofreading the manual in preparation for the book
  14590. publication through Network Theory Ltd.
  14591. @item
  14592. @i{Niels Giesen} had the idea to automatically archive DONE trees.
  14593. @item
  14594. @i{Nicolas Goaziou} rewrote much of the plain list code.
  14595. @item
  14596. @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
  14597. @item
  14598. @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
  14599. book.
  14600. @item
  14601. @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
  14602. task state change logging, and the clocktable. His clear explanations have
  14603. been critical when we started to adopt the Git version control system.
  14604. @item
  14605. @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
  14606. patches.
  14607. @item
  14608. @i{Phil Jackson} wrote @file{org-irc.el}.
  14609. @item
  14610. @i{Scott Jaderholm} proposed footnotes, control over whitespace between
  14611. folded entries, and column view for properties.
  14612. @item
  14613. @i{Matt Jones} wrote @i{MobileOrg Android}.
  14614. @item
  14615. @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
  14616. @item
  14617. @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
  14618. provided frequent feedback and some patches.
  14619. @item
  14620. @i{Matt Lundin} has proposed last-row references for table formulas and named
  14621. invisible anchors. He has also worked a lot on the FAQ.
  14622. @item
  14623. @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
  14624. and is a prolific contributor on the mailing list with competent replies,
  14625. small fixes and patches.
  14626. @item
  14627. @i{Jason F. McBrayer} suggested agenda export to CSV format.
  14628. @item
  14629. @i{Max Mikhanosha} came up with the idea of refiling.
  14630. @item
  14631. @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
  14632. basis.
  14633. @item
  14634. @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
  14635. happy.
  14636. @item
  14637. @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
  14638. @item
  14639. @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
  14640. and being able to quickly restrict the agenda to a subtree.
  14641. @item
  14642. @i{Todd Neal} provided patches for links to Info files and Elisp forms.
  14643. @item
  14644. @i{Greg Newman} refreshed the unicorn logo into its current form.
  14645. @item
  14646. @i{Tim O'Callaghan} suggested in-file links, search options for general
  14647. file links, and TAGS.
  14648. @item
  14649. @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
  14650. version of the reference card.
  14651. @item
  14652. @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
  14653. into Japanese.
  14654. @item
  14655. @i{Oliver Oppitz} suggested multi-state TODO items.
  14656. @item
  14657. @i{Scott Otterson} sparked the introduction of descriptive text for
  14658. links, among other things.
  14659. @item
  14660. @i{Pete Phillips} helped during the development of the TAGS feature, and
  14661. provided frequent feedback.
  14662. @item
  14663. @i{Martin Pohlack} provided the code snippet to bundle character insertion
  14664. into bundles of 20 for undo.
  14665. @item
  14666. @i{T.V. Raman} reported bugs and suggested improvements.
  14667. @item
  14668. @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
  14669. control.
  14670. @item
  14671. @i{Paul Rivier} provided the basic implementation of named footnotes. He
  14672. also acted as mailing list moderator for some time.
  14673. @item
  14674. @i{Kevin Rogers} contributed code to access VM files on remote hosts.
  14675. @item
  14676. @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
  14677. conflict with @file{allout.el}.
  14678. @item
  14679. @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
  14680. extensive patches.
  14681. @item
  14682. @i{Philip Rooke} created the Org reference card, provided lots
  14683. of feedback, developed and applied standards to the Org documentation.
  14684. @item
  14685. @i{Christian Schlauer} proposed angular brackets around links, among
  14686. other things.
  14687. @item
  14688. @i{Paul Sexton} wrote @file{org-ctags.el}.
  14689. @item
  14690. Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
  14691. @file{organizer-mode.el}.
  14692. @item
  14693. @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
  14694. examples, and remote highlighting for referenced code lines.
  14695. @item
  14696. @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
  14697. now packaged into Org's @file{contrib} directory.
  14698. @item
  14699. @i{Daniel Sinder} came up with the idea of internal archiving by locking
  14700. subtrees.
  14701. @item
  14702. @i{Dale Smith} proposed link abbreviations.
  14703. @item
  14704. @i{James TD Smith} has contributed a large number of patches for useful
  14705. tweaks and features.
  14706. @item
  14707. @i{Adam Spiers} asked for global linking commands, inspired the link
  14708. extension system, added support for mairix, and proposed the mapping API.
  14709. @item
  14710. @i{Ulf Stegemann} created the table to translate special symbols to HTML,
  14711. @LaTeX{}, UTF-8, Latin-1 and ASCII.
  14712. @item
  14713. @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
  14714. with links transformation to Org syntax.
  14715. @item
  14716. @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
  14717. chapter about publishing.
  14718. @item
  14719. @i{Jambunathan K} contributed the ODT exporter.
  14720. @item
  14721. @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
  14722. enabled source code highlighting in Gnus.
  14723. @item
  14724. @i{Stefan Vollmar} organized a video-recorded talk at the
  14725. Max-Planck-Institute for Neurology. He also inspired the creation of a
  14726. concept index for HTML export.
  14727. @item
  14728. @i{J@"urgen Vollmer} contributed code generating the table of contents
  14729. in HTML output.
  14730. @item
  14731. @i{Samuel Wales} has provided important feedback and bug reports.
  14732. @item
  14733. @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
  14734. keyword.
  14735. @item
  14736. @i{David Wainberg} suggested archiving, and improvements to the linking
  14737. system.
  14738. @item
  14739. @i{Carsten Wimmer} suggested some changes and helped fix a bug in
  14740. linking to Gnus.
  14741. @item
  14742. @i{Roland Winkler} requested additional key bindings to make Org
  14743. work on a tty.
  14744. @item
  14745. @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
  14746. and contributed various ideas and code snippets.
  14747. @end itemize
  14748. @node GNU Free Documentation License, Main Index, History and Acknowledgments, Top
  14749. @appendix GNU Free Documentation License
  14750. @include doclicense.texi
  14751. @node Main Index, Key Index, GNU Free Documentation License, Top
  14752. @unnumbered Concept index
  14753. @printindex cp
  14754. @node Key Index, Command and Function Index, Main Index, Top
  14755. @unnumbered Key index
  14756. @printindex ky
  14757. @node Command and Function Index, Variable Index, Key Index, Top
  14758. @unnumbered Command and function index
  14759. @printindex fn
  14760. @node Variable Index, , Command and Function Index, Top
  14761. @unnumbered Variable index
  14762. This is not a complete index of variables and faces, only the ones that are
  14763. mentioned in the manual. For a more complete list, use @kbd{M-x
  14764. org-customize @key{RET}} and then click yourself through the tree.
  14765. @printindex vr
  14766. @bye
  14767. @c Local variables:
  14768. @c fill-column: 77
  14769. @c indent-tabs-mode: nil
  14770. @c paragraph-start: "\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
  14771. @c paragraph-separate: "\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
  14772. @c End:
  14773. @c LocalWords: webdavhost pre