org.texi 416 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427
  1. \input texinfo
  2. @c %**start of header
  3. @setfilename ../../info/org
  4. @settitle The Org Manual
  5. @set VERSION 6.18c
  6. @set DATE January 2009
  7. @dircategory Emacs
  8. @direntry
  9. * Org Mode: (org). Outline-based notes management and organizer
  10. @end direntry
  11. @c Version and Contact Info
  12. @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
  13. @set AUTHOR Carsten Dominik
  14. @set MAINTAINER Carsten Dominik
  15. @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
  16. @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
  17. @c %**end of header
  18. @finalout
  19. @c Macro definitions
  20. @c Subheadings inside a table.
  21. @macro tsubheading{text}
  22. @ifinfo
  23. @subsubheading \text\
  24. @end ifinfo
  25. @ifnotinfo
  26. @item @b{\text\}
  27. @end ifnotinfo
  28. @end macro
  29. @copying
  30. This manual is for Org (version @value{VERSION}).
  31. Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
  32. @quotation
  33. Permission is granted to copy, distribute and/or modify this document
  34. under the terms of the GNU Free Documentation License, Version 1.3 or
  35. any later version published by the Free Software Foundation; with no
  36. Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
  37. and with the Back-Cover Texts as in (a) below. A copy of the license
  38. is included in the section entitled ``GNU Free Documentation License.''
  39. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
  40. modify this GNU manual. Buying copies from the FSF supports it in
  41. developing GNU and promoting software freedom.''
  42. This document is part of a collection distributed under the GNU Free
  43. Documentation License. If you want to distribute this document
  44. separately from the collection, you can do so by adding a copy of the
  45. license to the document, as described in section 6 of the license.
  46. @end quotation
  47. @end copying
  48. @titlepage
  49. @title The Org Manual
  50. @subtitle Release @value{VERSION}
  51. @author by Carsten Dominik
  52. @c The following two commands start the copyright page.
  53. @page
  54. @vskip 0pt plus 1filll
  55. @insertcopying
  56. @end titlepage
  57. @c Output the table of contents at the beginning.
  58. @contents
  59. @ifnottex
  60. @node Top, Introduction, (dir), (dir)
  61. @top Org Mode Manual
  62. @insertcopying
  63. @end ifnottex
  64. @menu
  65. * Introduction:: Getting started
  66. * Document Structure:: A tree works like your brain
  67. * Tables:: Pure magic for quick formatting
  68. * Hyperlinks:: Notes in context
  69. * TODO Items:: Every tree branch can be a TODO item
  70. * Tags:: Tagging headlines and matching sets of tags
  71. * Properties and Columns:: Storing information about an entry
  72. * Dates and Times:: Making items useful for planning
  73. * Capture:: Creating tasks and attaching files
  74. * Agenda Views:: Collecting information into views
  75. * Embedded LaTeX:: LaTeX fragments and formulas
  76. * Exporting:: Sharing and publishing of notes
  77. * Publishing:: Create a web site of linked Org files
  78. * Miscellaneous:: All the rest which did not fit elsewhere
  79. * Extensions:: Add-ons for Org mode
  80. * Hacking:: How to hack your way around
  81. * History and Acknowledgments:: How Org came into being
  82. * Main Index:: An index of Org's concepts and features
  83. * Key Index:: Key bindings and where they are described
  84. @detailmenu
  85. --- The Detailed Node Listing ---
  86. Introduction
  87. * Summary:: Brief summary of what Org does
  88. * Installation:: How to install a downloaded version of Org
  89. * Activation:: How to activate Org for certain buffers
  90. * Feedback:: Bug reports, ideas, patches etc.
  91. * Conventions:: Type-setting conventions in the manual
  92. Document Structure
  93. * Outlines:: Org is based on Outline mode
  94. * Headlines:: How to typeset Org tree headlines
  95. * Visibility cycling:: Show and hide, much simplified
  96. * Motion:: Jumping to other headlines
  97. * Structure editing:: Changing sequence and level of headlines
  98. * Archiving:: Move done task trees to a different place
  99. * Sparse trees:: Matches embedded in context
  100. * Plain lists:: Additional structure within an entry
  101. * Drawers:: Tucking stuff away
  102. * Footnotes:: How footnotes are defined in Org's syntax
  103. * Orgstruct mode:: Structure editing outside Org
  104. Archiving
  105. * ARCHIVE tag:: Marking a tree as inactive
  106. * Moving subtrees:: Moving a tree to an archive file
  107. Tables
  108. * Built-in table editor:: Simple tables
  109. * Narrow columns:: Stop wasting space in tables
  110. * Column groups:: Grouping to trigger vertical lines
  111. * Orgtbl mode:: The table editor as minor mode
  112. * The spreadsheet:: The table editor has spreadsheet capabilities
  113. * Org Plot:: Plotting from org tables
  114. The spreadsheet
  115. * References:: How to refer to another field or range
  116. * Formula syntax for Calc:: Using Calc to compute stuff
  117. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  118. * Field formulas:: Formulas valid for a single field
  119. * Column formulas:: Formulas valid for an entire column
  120. * Editing and debugging formulas:: Fixing formulas
  121. * Updating the table:: Recomputing all dependent fields
  122. * Advanced features:: Field names, parameters and automatic recalc
  123. Hyperlinks
  124. * Link format:: How links in Org are formatted
  125. * Internal links:: Links to other places in the current file
  126. * External links:: URL-like links to the world
  127. * Handling links:: Creating, inserting and following
  128. * Using links outside Org:: Linking from my C source code?
  129. * Link abbreviations:: Shortcuts for writing complex links
  130. * Search options:: Linking to a specific location
  131. * Custom searches:: When the default search is not enough
  132. Internal links
  133. * Radio targets:: Make targets trigger links in plain text
  134. TODO Items
  135. * TODO basics:: Marking and displaying TODO entries
  136. * TODO extensions:: Workflow and assignments
  137. * Progress logging:: Dates and notes for progress
  138. * Priorities:: Some things are more important than others
  139. * Breaking down tasks:: Splitting a task into manageable pieces
  140. * Checkboxes:: Tick-off lists
  141. Extended use of TODO keywords
  142. * Workflow states:: From TODO to DONE in steps
  143. * TODO types:: I do this, Fred does the rest
  144. * Multiple sets in one file:: Mixing it all, and still finding your way
  145. * Fast access to TODO states:: Single letter selection of a state
  146. * Per-file keywords:: Different files, different requirements
  147. * Faces for TODO keywords:: Highlighting states
  148. Progress logging
  149. * Closing items:: When was this entry marked DONE?
  150. * Tracking TODO state changes:: When did the status change?
  151. Tags
  152. * Tag inheritance:: Tags use the tree structure of the outline
  153. * Setting tags:: How to assign tags to a headline
  154. * Tag searches:: Searching for combinations of tags
  155. Properties and Columns
  156. * Property syntax:: How properties are spelled out
  157. * Special properties:: Access to other Org mode features
  158. * Property searches:: Matching property values
  159. * Property inheritance:: Passing values down the tree
  160. * Column view:: Tabular viewing and editing
  161. * Property API:: Properties for Lisp programmers
  162. Column view
  163. * Defining columns:: The COLUMNS format property
  164. * Using column view:: How to create and use column view
  165. * Capturing column view:: A dynamic block for column view
  166. Defining columns
  167. * Scope of column definitions:: Where defined, where valid?
  168. * Column attributes:: Appearance and content of a column
  169. Dates and Times
  170. * Timestamps:: Assigning a time to a tree entry
  171. * Creating timestamps:: Commands which insert timestamps
  172. * Deadlines and scheduling:: Planning your work
  173. * Clocking work time:: Tracking how long you spend on a task
  174. * Effort estimates:: Planning work effort in advance
  175. * Relative timer:: Notes with a running timer
  176. Creating timestamps
  177. * The date/time prompt:: How Org mode helps you entering date and time
  178. * Custom time format:: Making dates look different
  179. Deadlines and scheduling
  180. * Inserting deadline/schedule:: Planning items
  181. * Repeated tasks:: Items that show up again and again
  182. Capture
  183. * Remember:: Capture new tasks/ideas with little interruption
  184. * Attachments:: Add files to tasks.
  185. Remember
  186. * Setting up Remember:: Some code for .emacs to get things going
  187. * Remember templates:: Define the outline of different note types
  188. * Storing notes:: Directly get the note to where it belongs
  189. * Refiling notes:: Moving a note or task to a project
  190. Agenda Views
  191. * Agenda files:: Files being searched for agenda information
  192. * Agenda dispatcher:: Keyboard access to agenda views
  193. * Built-in agenda views:: What is available out of the box?
  194. * Presentation and sorting:: How agenda items are prepared for display
  195. * Agenda commands:: Remote editing of Org trees
  196. * Custom agenda views:: Defining special searches and views
  197. * Agenda column view:: Using column view for collected entries
  198. The built-in agenda views
  199. * Weekly/daily agenda:: The calendar page with current tasks
  200. * Global TODO list:: All unfinished action items
  201. * Matching tags and properties:: Structured information with fine-tuned search
  202. * Timeline:: Time-sorted view for single file
  203. * Keyword search:: Finding entries by keyword
  204. * Stuck projects:: Find projects you need to review
  205. Presentation and sorting
  206. * Categories:: Not all tasks are equal
  207. * Time-of-day specifications:: How the agenda knows the time
  208. * Sorting of agenda items:: The order of things
  209. Custom agenda views
  210. * Storing searches:: Type once, use often
  211. * Block agenda:: All the stuff you need in a single buffer
  212. * Setting Options:: Changing the rules
  213. * Exporting Agenda Views:: Writing agendas to files
  214. * Using the agenda elsewhere:: Using agenda information in other programs
  215. Embedded LaTeX
  216. * Math symbols:: TeX macros for symbols and Greek letters
  217. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  218. * LaTeX fragments:: Complex formulas made easy
  219. * Processing LaTeX fragments:: Previewing LaTeX processing
  220. * CDLaTeX mode:: Speed up entering of formulas
  221. Exporting
  222. * Markup rules:: Which structures are recognized?
  223. * Selective export:: Using tags to select and exclude trees
  224. * Export options:: Per-file export settings
  225. * The export dispatcher:: How to access exporter commands
  226. * ASCII export:: Exporting to plain ASCII
  227. * HTML export:: Exporting to HTML
  228. * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
  229. * XOXO export:: Exporting to XOXO
  230. * iCalendar export:: Exporting in iCalendar format
  231. Markup rules
  232. * Document title:: How the document title is determined
  233. * Headings and sections:: The main structure of the exported document
  234. * Table of contents:: If, where, how to create a table of contents
  235. * Initial text:: Text before the first headline
  236. * Lists:: Plain lists are exported
  237. * Paragraphs:: What determines beginning and ending
  238. * Literal examples:: Source code and other examples
  239. * Include files:: Include the contents of a file during export
  240. * Tables exported:: Tables are exported richly
  241. * Inlined images:: How to inline images during export
  242. * Footnote markup::
  243. * Emphasis and monospace:: To bold or not to bold
  244. * TeX macros and LaTeX fragments:: Create special, rich export.
  245. * Horizontal rules:: A line across the page
  246. * Comment lines:: Some lines will not be exported
  247. HTML export
  248. * HTML Export commands:: How to invoke HTML export
  249. * Quoting HTML tags:: Using direct HTML in Org mode
  250. * Links:: Transformation of links for HTML
  251. * Images in HTML export:: How to insert figures into HTML output
  252. * Text areas in HTML export:: An alternative way to show an example
  253. * CSS support:: Changing the appearance of the output
  254. * Javascript support:: Info and Folding in a web browser
  255. LaTeX and PDF export
  256. * LaTeX/PDF export commands:: Which key invokes which commands
  257. * Quoting LaTeX code:: Incorporating literal LaTeX code
  258. * Sectioning structure:: Changing sectioning in LaTeX output
  259. * Tables in LaTeX export:: Options for exporting tables to LaTeX
  260. * Images in LaTeX export:: How to insert figures into LaTeX output
  261. Publishing
  262. * Configuration:: Defining projects
  263. * Sample configuration:: Example projects
  264. * Triggering publication:: Publication commands
  265. Configuration
  266. * Project alist:: The central configuration variable
  267. * Sources and destinations:: From here to there
  268. * Selecting files:: What files are part of the project?
  269. * Publishing action:: Setting the function doing the publishing
  270. * Publishing options:: Tweaking HTML export
  271. * Publishing links:: Which links keep working after publishing?
  272. * Project page index:: Publishing a list of project files
  273. Sample configuration
  274. * Simple example:: One-component publishing
  275. * Complex example:: A multi-component publishing example
  276. Miscellaneous
  277. * Completion:: M-TAB knows what you need
  278. * Customization:: Adapting Org to your taste
  279. * In-buffer settings:: Overview of the #+KEYWORDS
  280. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  281. * Clean view:: Getting rid of leading stars in the outline
  282. * TTY keys:: Using Org on a tty
  283. * Interaction:: Other Emacs packages
  284. * Bugs:: Things which do not work perfectly
  285. Interaction with other packages
  286. * Cooperation:: Packages Org cooperates with
  287. * Conflicts:: Packages that lead to conflicts
  288. Extensions
  289. * Extensions in the contrib directory:: These come with the Org distro
  290. * Other extensions:: These you have to find on the web.
  291. Hacking
  292. * Adding hyperlink types:: New custom link types
  293. * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
  294. * Dynamic blocks:: Automatically filled blocks
  295. * Special agenda views:: Customized views
  296. * Using the property API:: Writing programs that use entry properties
  297. * Using the mapping API:: Mapping over all or selected entries
  298. Tables and lists in arbitrary syntax
  299. * Radio tables:: Sending and receiving
  300. * A LaTeX example:: Step by step, almost a tutorial
  301. * Translator functions:: Copy and modify
  302. * Radio lists:: Doing the same for lists
  303. @end detailmenu
  304. @end menu
  305. @node Introduction, Document Structure, Top, Top
  306. @chapter Introduction
  307. @cindex introduction
  308. @menu
  309. * Summary:: Brief summary of what Org does
  310. * Installation:: How to install a downloaded version of Org
  311. * Activation:: How to activate Org for certain buffers
  312. * Feedback:: Bug reports, ideas, patches etc.
  313. * Conventions:: Type-setting conventions in the manual
  314. @end menu
  315. @node Summary, Installation, Introduction, Introduction
  316. @section Summary
  317. @cindex summary
  318. Org is a mode for keeping notes, maintaining TODO lists, and doing
  319. project planning with a fast and effective plain-text system.
  320. Org develops organizational tasks around NOTES files that contain
  321. lists or information about projects as plain text. Org is
  322. implemented on top of Outline mode, which makes it possible to keep the
  323. content of large files well structured. Visibility cycling and
  324. structure editing help to work with the tree. Tables are easily created
  325. with a built-in table editor. Org supports TODO items, deadlines,
  326. time stamps, and scheduling. It dynamically compiles entries into an
  327. agenda that utilizes and smoothly integrates much of the Emacs calendar
  328. and diary. Plain text URL-like links connect to websites, emails,
  329. Usenet messages, BBDB entries, and any files related to the projects.
  330. For printing and sharing of notes, an Org file can be exported as a
  331. structured ASCII file, as HTML, or (TODO and agenda items only) as an
  332. iCalendar file. It can also serve as a publishing tool for a set of
  333. linked web pages.
  334. An important design aspect that distinguishes Org from for example
  335. Planner/Muse is that it encourages to store every piece of information
  336. only once. In Planner, you have project pages, day pages and possibly
  337. other files, duplicating some information such as tasks. In Org,
  338. you only have notes files. In your notes you mark entries as tasks,
  339. label them with tags and timestamps. All necessary lists like a
  340. schedule for the day, the agenda for a meeting, tasks lists selected by
  341. tags etc are created dynamically when you need them.
  342. Org keeps simple things simple. When first fired up, it should
  343. feel like a straightforward, easy to use outliner. Complexity is not
  344. imposed, but a large amount of functionality is available when you need
  345. it. Org is a toolbox and can be used in different ways, for
  346. example as:
  347. @example
  348. @r{@bullet{} outline extension with visibility cycling and structure editing}
  349. @r{@bullet{} ASCII system and table editor for taking structured notes}
  350. @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
  351. @r{@bullet{} TODO list editor}
  352. @r{@bullet{} full agenda and planner with deadlines and work scheduling}
  353. @r{@bullet{} environment to implement David Allen's GTD system}
  354. @r{@bullet{} a basic database application}
  355. @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
  356. @r{@bullet{} publishing tool to create a set of interlinked webpages}
  357. @end example
  358. Org's automatic, context sensitive table editor with spreadsheet
  359. capabilities can be integrated into any major mode by activating the
  360. minor Orgtbl mode. Using a translation step, it can be used to maintain
  361. tables in arbitrary file types, for example in La@TeX{}. The structure
  362. editing and list creation capabilities can be used outside Org with
  363. the minor Orgstruct mode.
  364. @cindex FAQ
  365. There is a website for Org which provides links to the newest
  366. version of Org, as well as additional information, frequently asked
  367. questions (FAQ), links to tutorials etc. This page is located at
  368. @uref{http://orgmode.org}.
  369. @page
  370. @node Installation, Activation, Summary, Introduction
  371. @section Installation
  372. @cindex installation
  373. @cindex XEmacs
  374. @b{Important:} @i{If Org is part of the Emacs distribution or an
  375. XEmacs package, please skip this section and go directly to
  376. @ref{Activation}.}
  377. If you have downloaded Org from the Web, either as a distribution @file{.zip}
  378. or @file{.tar} file, or as a GIT archive, you must take the following steps
  379. to install it: Go into the unpacked Org distribution directory and edit the
  380. top section of the file @file{Makefile}. You must set the name of the Emacs
  381. binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
  382. directories where local Lisp and Info files are kept. If you don't have
  383. access to the system-wide directories, you can simply run Org directly from
  384. the distribution directory by adding the @file{lisp} subdirectory to the
  385. Emacs load path. To do this, add the following line to @file{.emacs}:
  386. @example
  387. (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
  388. @end example
  389. @noindent
  390. If you plan to use code from the @file{contrib} subdirectory, do a similar
  391. step for this directory:
  392. @example
  393. (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
  394. @end example
  395. @b{XEmacs users now need to install the file @file{noutline.el} from
  396. the @file{xemacs} sub-directory of the Org distribution. Use the
  397. command:}
  398. @example
  399. @b{make install-noutline}
  400. @end example
  401. @noindent Now byte-compile the Lisp files with the shell command:
  402. @example
  403. make
  404. @end example
  405. @noindent If you are running Org from the distribution directory, this is
  406. all. If you want to install into the system directories, use
  407. @example
  408. make install
  409. make install-info
  410. @end example
  411. @noindent Then add to @file{.emacs}:
  412. @lisp
  413. ;; This line only if Org is not part of the X/Emacs distribution.
  414. (require 'org-install)
  415. @end lisp
  416. Do not forget to activate Org as described in the following section.
  417. @node Activation, Feedback, Installation, Introduction
  418. @section Activation
  419. @cindex activation
  420. @cindex autoload
  421. @cindex global key bindings
  422. @cindex key bindings, global
  423. @iftex
  424. @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
  425. PDF documentation as viewed by some PDF viewers to your .emacs file, the
  426. single quote character comes out incorrectly and the code will not work.
  427. You need to fix the single quotes by hand, or copy from Info
  428. documentation.}
  429. @end iftex
  430. Add the following lines to your @file{.emacs} file. The last three lines
  431. define @emph{global} keys for the commands @command{org-store-link},
  432. @command{org-agenda}, and @command{org-iswitchb} - please choose suitable
  433. keys yourself.
  434. @lisp
  435. ;; The following lines are always needed. Choose your own keys.
  436. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
  437. (global-set-key "\C-cl" 'org-store-link)
  438. (global-set-key "\C-ca" 'org-agenda)
  439. (global-set-key "\C-cb" 'org-iswitchb)
  440. @end lisp
  441. Furthermore, you must activate @code{font-lock-mode} in Org
  442. buffers, because significant functionality depends on font-locking being
  443. active. You can do this with either one of the following two lines
  444. (XEmacs user must use the second option):
  445. @lisp
  446. (global-font-lock-mode 1) ; for all buffers
  447. (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
  448. @end lisp
  449. @cindex Org mode, turning on
  450. With this setup, all files with extension @samp{.org} will be put
  451. into Org mode. As an alternative, make the first line of a file look
  452. like this:
  453. @example
  454. MY PROJECTS -*- mode: org; -*-
  455. @end example
  456. @noindent which will select Org mode for this buffer no matter what
  457. the file's name is. See also the variable
  458. @code{org-insert-mode-line-in-empty-file}.
  459. Many commands in Org work on the region is he region is active. To make use
  460. of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in
  461. XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to
  462. do this yourself with
  463. @lisp
  464. (transient-mark-mode 1)
  465. @end lisp
  466. @node Feedback, Conventions, Activation, Introduction
  467. @section Feedback
  468. @cindex feedback
  469. @cindex bug reports
  470. @cindex maintainer
  471. @cindex author
  472. If you find problems with Org, or if you have questions, remarks, or ideas
  473. about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
  474. If you are not a member of the mailing list, your mail will be reviewed by a
  475. moderator and then passed through to the list.
  476. For bug reports, please provide as much information as possible,
  477. including the version information of Emacs (@kbd{C-h v emacs-version
  478. @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
  479. the Org related setup in @file{.emacs}. If an error occurs, a
  480. backtrace can be very useful (see below on how to create one). Often a
  481. small example file helps, along with clear information about:
  482. @enumerate
  483. @item What exactly did you do?
  484. @item What did you expect to happen?
  485. @item What happened instead?
  486. @end enumerate
  487. @noindent Thank you for helping to improve this mode.
  488. @subsubheading How to create a useful backtrace
  489. @cindex backtrace of an error
  490. If working with Org produces an error with a message you don't
  491. understand, you may have hit a bug. The best way to report this is by
  492. providing, in addition to what was mentioned above, a @emph{Backtrace}.
  493. This is information from the built-in debugger about where and how the
  494. error occurred. Here is how to produce a useful backtrace:
  495. @enumerate
  496. @item
  497. Start a fresh Emacs or XEmacs, and make sure that it will load the
  498. original Lisp code in @file{org.el} instead of the compiled version in
  499. @file{org.elc}. The backtrace contains much more information if it is
  500. produced with uncompiled code. To do this, either rename @file{org.elc}
  501. to something else before starting Emacs, or ask Emacs explicitly to load
  502. @file{org.el} by using the command line
  503. @example
  504. emacs -l /path/to/org.el
  505. @end example
  506. @item
  507. Go to the @code{Options} menu and select @code{Enter Debugger on Error}
  508. (XEmacs has this option in the @code{Troubleshooting} sub-menu).
  509. @item
  510. Do whatever you have to do to hit the error. Don't forget to
  511. document the steps you take.
  512. @item
  513. When you hit the error, a @file{*Backtrace*} buffer will appear on the
  514. screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
  515. attach it to your bug report.
  516. @end enumerate
  517. @node Conventions, , Feedback, Introduction
  518. @section Typesetting conventions used in this manual
  519. Org uses three types of keywords: TODO keywords, tags, and property
  520. names. In this manual we use the following conventions:
  521. @table @code
  522. @item TODO
  523. @itemx WAITING
  524. TODO keywords are written with all capitals, even if they are
  525. user-defined.
  526. @item boss
  527. @itemx ARCHIVE
  528. User-defined tags are written in lowercase; built-in tags with special
  529. meaning are written with all capitals.
  530. @item Release
  531. @itemx PRIORITY
  532. User-defined properties are capitalized; built-in properties with
  533. special meaning are written with all capitals.
  534. @end table
  535. @node Document Structure, Tables, Introduction, Top
  536. @chapter Document Structure
  537. @cindex document structure
  538. @cindex structure of document
  539. Org is based on outline mode and provides flexible commands to
  540. edit the structure of the document.
  541. @menu
  542. * Outlines:: Org is based on Outline mode
  543. * Headlines:: How to typeset Org tree headlines
  544. * Visibility cycling:: Show and hide, much simplified
  545. * Motion:: Jumping to other headlines
  546. * Structure editing:: Changing sequence and level of headlines
  547. * Archiving:: Move done task trees to a different place
  548. * Sparse trees:: Matches embedded in context
  549. * Plain lists:: Additional structure within an entry
  550. * Drawers:: Tucking stuff away
  551. * Footnotes:: How footnotes are defined in Org's syntax
  552. * Orgstruct mode:: Structure editing outside Org
  553. @end menu
  554. @node Outlines, Headlines, Document Structure, Document Structure
  555. @section Outlines
  556. @cindex outlines
  557. @cindex Outline mode
  558. Org is implemented on top of Outline mode. Outlines allow a
  559. document to be organized in a hierarchical structure, which (at least
  560. for me) is the best representation of notes and thoughts. An overview
  561. of this structure is achieved by folding (hiding) large parts of the
  562. document to show only the general document structure and the parts
  563. currently being worked on. Org greatly simplifies the use of
  564. outlines by compressing the entire show/hide functionality into a single
  565. command @command{org-cycle}, which is bound to the @key{TAB} key.
  566. @node Headlines, Visibility cycling, Outlines, Document Structure
  567. @section Headlines
  568. @cindex headlines
  569. @cindex outline tree
  570. Headlines define the structure of an outline tree. The headlines in
  571. Org start with one or more stars, on the left margin@footnote{See
  572. the variable @code{org-special-ctrl-a/e} to configure special behavior
  573. of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
  574. @example
  575. * Top level headline
  576. ** Second level
  577. *** 3rd level
  578. some text
  579. *** 3rd level
  580. more text
  581. * Another top level headline
  582. @end example
  583. @noindent Some people find the many stars too noisy and would prefer an
  584. outline that has whitespace followed by a single star as headline
  585. starters. @ref{Clean view} describes a setup to realize this.
  586. An empty line after the end of a subtree is considered part of it and
  587. will be hidden when the subtree is folded. However, if you leave at
  588. least two empty lines, one empty line will remain visible after folding
  589. the subtree, in order to structure the collapsed view. See the
  590. variable @code{org-cycle-separator-lines} to modify this behavior.
  591. @node Visibility cycling, Motion, Headlines, Document Structure
  592. @section Visibility cycling
  593. @cindex cycling, visibility
  594. @cindex visibility cycling
  595. @cindex trees, visibility
  596. @cindex show hidden text
  597. @cindex hide text
  598. Outlines make it possible to hide parts of the text in the buffer.
  599. Org uses just two commands, bound to @key{TAB} and
  600. @kbd{S-@key{TAB}} to change the visibility in the buffer.
  601. @cindex subtree visibility states
  602. @cindex subtree cycling
  603. @cindex folded, subtree visibility state
  604. @cindex children, subtree visibility state
  605. @cindex subtree, subtree visibility state
  606. @table @kbd
  607. @kindex @key{TAB}
  608. @item @key{TAB}
  609. @emph{Subtree cycling}: Rotate current subtree among the states
  610. @example
  611. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  612. '-----------------------------------'
  613. @end example
  614. The cursor must be on a headline for this to work@footnote{see, however,
  615. the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
  616. beginning of the buffer and the first line is not a headline, then
  617. @key{TAB} actually runs global cycling (see below)@footnote{see the
  618. option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
  619. argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
  620. @cindex global visibility states
  621. @cindex global cycling
  622. @cindex overview, global visibility state
  623. @cindex contents, global visibility state
  624. @cindex show all, global visibility state
  625. @kindex S-@key{TAB}
  626. @item S-@key{TAB}
  627. @itemx C-u @key{TAB}
  628. @emph{Global cycling}: Rotate the entire buffer among the states
  629. @example
  630. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  631. '--------------------------------------'
  632. @end example
  633. When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
  634. CONTENTS view up to headlines of level N will be shown. Note that inside
  635. tables, @kbd{S-@key{TAB}} jumps to the previous field.
  636. @cindex show all, command
  637. @kindex C-u C-u C-u @key{TAB}
  638. @item C-u C-u C-u @key{TAB}
  639. Show all, including drawers.
  640. @kindex C-c C-r
  641. @item C-c C-r
  642. Reveal context around point, showing the current entry, the following heading
  643. and the hierarchy above. Useful for working near a location that has been
  644. exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
  645. (@pxref{Agenda commands}). With a prefix argument show, on each
  646. level, all sibling headings.
  647. @kindex C-c C-x b
  648. @item C-c C-x b
  649. Show the current subtree in an indirect buffer@footnote{The indirect
  650. buffer
  651. @ifinfo
  652. (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
  653. @end ifinfo
  654. @ifnotinfo
  655. (see the Emacs manual for more information about indirect buffers)
  656. @end ifnotinfo
  657. will contain the entire buffer, but will be narrowed to the current
  658. tree. Editing the indirect buffer will also change the original buffer,
  659. but without affecting visibility in that buffer.}. With a numeric
  660. prefix argument N, go up to level N and then take that tree. If N is
  661. negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
  662. the previously used indirect buffer.
  663. @end table
  664. When Emacs first visits an Org file, the global state is set to
  665. OVERVIEW, i.e. only the top level headlines are visible. This can be
  666. configured through the variable @code{org-startup-folded}, or on a
  667. per-file basis by adding one of the following lines anywhere in the
  668. buffer:
  669. @example
  670. #+STARTUP: overview
  671. #+STARTUP: content
  672. #+STARTUP: showall
  673. @end example
  674. @noindent
  675. Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
  676. and Columns}) will get their visibility adapted accordingly. Allowed values
  677. for this property are @code{folded}, @code{children}, @code{content}, and
  678. @code{all}.
  679. @table @kbd
  680. @kindex C-u C-u @key{TAB}
  681. @item C-u C-u @key{TAB}
  682. Switch back to the startup visibility of the buffer, i.e. whatever is
  683. requested by startup options and @samp{VISIBILITY} properties in individual
  684. entries.
  685. @end table
  686. @node Motion, Structure editing, Visibility cycling, Document Structure
  687. @section Motion
  688. @cindex motion, between headlines
  689. @cindex jumping, to headlines
  690. @cindex headline navigation
  691. The following commands jump to other headlines in the buffer.
  692. @table @kbd
  693. @kindex C-c C-n
  694. @item C-c C-n
  695. Next heading.
  696. @kindex C-c C-p
  697. @item C-c C-p
  698. Previous heading.
  699. @kindex C-c C-f
  700. @item C-c C-f
  701. Next heading same level.
  702. @kindex C-c C-b
  703. @item C-c C-b
  704. Previous heading same level.
  705. @kindex C-c C-u
  706. @item C-c C-u
  707. Backward to higher level heading.
  708. @kindex C-c C-j
  709. @item C-c C-j
  710. Jump to a different place without changing the current outline
  711. visibility. Shows the document structure in a temporary buffer, where
  712. you can use the following keys to find your destination:
  713. @example
  714. @key{TAB} @r{Cycle visibility.}
  715. @key{down} / @key{up} @r{Next/previous visible headline.}
  716. @key{RET} @r{Select this location.}
  717. @kbd{/} @r{Do a Sparse-tree search}
  718. @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
  719. n / p @r{Next/previous visible headline.}
  720. f / b @r{Next/previous headline same level.}
  721. u @r{One level up.}
  722. 0-9 @r{Digit argument.}
  723. q @r{Quit}
  724. @end example
  725. See also the variable@code{org-goto-interface}.
  726. @end table
  727. @node Structure editing, Archiving, Motion, Document Structure
  728. @section Structure editing
  729. @cindex structure editing
  730. @cindex headline, promotion and demotion
  731. @cindex promotion, of subtrees
  732. @cindex demotion, of subtrees
  733. @cindex subtree, cut and paste
  734. @cindex pasting, of subtrees
  735. @cindex cutting, of subtrees
  736. @cindex copying, of subtrees
  737. @cindex subtrees, cut and paste
  738. @table @kbd
  739. @kindex M-@key{RET}
  740. @item M-@key{RET}
  741. Insert new heading with same level as current. If the cursor is in a
  742. plain list item, a new item is created (@pxref{Plain lists}). To force
  743. creation of a new headline, use a prefix argument, or first press @key{RET}
  744. to get to the beginning of the next line. When this command is used in
  745. the middle of a line, the line is split and the rest of the line becomes
  746. the new headline@footnote{If you do not want the line to be split,
  747. customize the variable @code{org-M-RET-may-split-line}.}. If the
  748. command is used at the beginning of a headline, the new headline is
  749. created before the current line. If at the beginning of any other line,
  750. the content of that line is made the new heading. If the command is
  751. used at the end of a folded subtree (i.e. behind the ellipses at the end
  752. of a headline), then a headline like the current one will be inserted
  753. after the end of the subtree.
  754. @kindex C-@key{RET}
  755. @item C-@key{RET}
  756. Just like @kbd{M-@key{RET}}, except when adding a new heading below the
  757. current heading, the new heading is placed after the body instead of before
  758. it. This command works from anywhere in the entry.
  759. @kindex M-S-@key{RET}
  760. @item M-S-@key{RET}
  761. Insert new TODO entry with same level as current heading.
  762. @kindex C-S-@key{RET}
  763. @item C-S-@key{RET}
  764. Insert new TODO entry with same level as current heading. Like
  765. @kbd{C-@key{RET}}, the new headline will be inserted after the current
  766. subtree.
  767. @kindex M-@key{left}
  768. @item M-@key{left}
  769. Promote current heading by one level.
  770. @kindex M-@key{right}
  771. @item M-@key{right}
  772. Demote current heading by one level.
  773. @kindex M-S-@key{left}
  774. @item M-S-@key{left}
  775. Promote the current subtree by one level.
  776. @kindex M-S-@key{right}
  777. @item M-S-@key{right}
  778. Demote the current subtree by one level.
  779. @kindex M-S-@key{up}
  780. @item M-S-@key{up}
  781. Move subtree up (swap with previous subtree of same
  782. level).
  783. @kindex M-S-@key{down}
  784. @item M-S-@key{down}
  785. Move subtree down (swap with next subtree of same level).
  786. @kindex C-c C-x C-w
  787. @item C-c C-x C-w
  788. Kill subtree, i.e. remove it from buffer but save in kill ring.
  789. With a numeric prefix argument N, kill N sequential subtrees.
  790. @kindex C-c C-x M-w
  791. @item C-c C-x M-w
  792. Copy subtree to kill ring. With a numeric prefix argument N, copy the N
  793. sequential subtrees.
  794. @kindex C-c C-x C-y
  795. @item C-c C-x C-y
  796. Yank subtree from kill ring. This does modify the level of the subtree to
  797. make sure the tree fits in nicely at the yank position. The yank level can
  798. also be specified with a numeric prefix argument, or by yanking after a
  799. headline marker like @samp{****}.
  800. @kindex C-y
  801. @item C-y
  802. Depending on the variables @code{org-yank-adjusted-subtrees} and
  803. @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
  804. paste subtrees folded and in a clever way, using the same command as @kbd{C-c
  805. C-x C-y}. With the default settings, level adjustment will take place and
  806. yanked trees will be folded unless doing so would swallow text previously
  807. visible. Any prefix argument to this command will force a normal @code{yank}
  808. to be executed, with the prefix passed along. A good way to force a normal
  809. yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a yank, it will yank
  810. previous kill items plainly, without adjustment and folding.
  811. @kindex C-c C-w
  812. @item C-c C-w
  813. Refile entry or region to a different location. @xref{Refiling notes}.
  814. @kindex C-c ^
  815. @item C-c ^
  816. Sort same-level entries. When there is an active region, all entries in the
  817. region will be sorted. Otherwise the children of the current headline are
  818. sorted. The command prompts for the sorting method, which can be
  819. alphabetically, numerically, by time (using the first time stamp in each
  820. entry), by priority, or by TODO keyword (in the sequence the keywords have
  821. been defined in the setup). Reverse sorting is possible as well. You can
  822. also supply your own function to extract the sorting key. With a @kbd{C-u}
  823. prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes,
  824. duplicate entries will also be removed.
  825. @kindex C-x n s
  826. @item C-x n s
  827. Narrow buffer to current subtree.
  828. @kindex C-x n w
  829. @item C-x n w
  830. Widen buffer to remove a narrowing.
  831. @kindex C-c *
  832. @item C-c *
  833. Turn a normal line or plain list item into a headline (so that it becomes a
  834. subheading at its location). Also turn a headline into a normal line by
  835. removing the stars. If there is an active region, turn all lines in the
  836. region into headlines. If the first line in the region was an item, turn
  837. only the item lines into headlines. Finally, if the first line is a
  838. headline, remove the stars from all headlines in the region.
  839. @end table
  840. @cindex region, active
  841. @cindex active region
  842. @cindex Transient mark mode
  843. When there is an active region (Transient mark mode), promotion and
  844. demotion work on all headlines in the region. To select a region of
  845. headlines, it is best to place both point and mark at the beginning of a
  846. line, mark at the beginning of the first headline, and point at the line
  847. just after the last headline to change. Note that when the cursor is
  848. inside a table (@pxref{Tables}), the Meta-Cursor keys have different
  849. functionality.
  850. @node Archiving, Sparse trees, Structure editing, Document Structure
  851. @section Archiving
  852. @cindex archiving
  853. When a project represented by a (sub)tree is finished, you may want
  854. to move the tree out of the way and to stop it from contributing to the
  855. agenda. Org mode knows two ways of archiving. You can mark a tree with
  856. the ARCHIVE tag, or you can move an entire (sub)tree to a different
  857. location.
  858. @menu
  859. * ARCHIVE tag:: Marking a tree as inactive
  860. * Moving subtrees:: Moving a tree to an archive file
  861. @end menu
  862. @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
  863. @subsection The ARCHIVE tag
  864. @cindex internal archiving
  865. A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
  866. its location in the outline tree, but behaves in the following way:
  867. @itemize @minus
  868. @item
  869. It does not open when you attempt to do so with a visibility cycling
  870. command (@pxref{Visibility cycling}). You can force cycling archived
  871. subtrees with @kbd{C-@key{TAB}}, or by setting the option
  872. @code{org-cycle-open-archived-trees}. Also normal outline commands like
  873. @code{show-all} will open archived subtrees.
  874. @item
  875. During sparse tree construction (@pxref{Sparse trees}), matches in
  876. archived subtrees are not exposed, unless you configure the option
  877. @code{org-sparse-tree-open-archived-trees}.
  878. @item
  879. During agenda view construction (@pxref{Agenda Views}), the content of
  880. archived trees is ignored unless you configure the option
  881. @code{org-agenda-skip-archived-trees}, in which case these trees will always
  882. be included. In the agenda you can press the @kbd{v} key to get archives
  883. temporarily included.
  884. @item
  885. Archived trees are not exported (@pxref{Exporting}), only the headline
  886. is. Configure the details using the variable
  887. @code{org-export-with-archived-trees}.
  888. @end itemize
  889. The following commands help managing the ARCHIVE tag:
  890. @table @kbd
  891. @kindex C-c C-x a
  892. @item C-c C-x a
  893. Toggle the ARCHIVE tag for the current headline. When the tag is set,
  894. the headline changes to a shadowed face, and the subtree below it is
  895. hidden.
  896. @kindex C-u C-c C-x a
  897. @item C-u C-c C-x a
  898. Check if any direct children of the current headline should be archived.
  899. To do this, each subtree is checked for open TODO entries. If none are
  900. found, the command offers to set the ARCHIVE tag for the child. If the
  901. cursor is @emph{not} on a headline when this command is invoked, the
  902. level 1 trees will be checked.
  903. @kindex C-@kbd{TAB}
  904. @item C-@kbd{TAB}
  905. Cycle a tree even if it is tagged with ARCHIVE.
  906. @end table
  907. @node Moving subtrees, , ARCHIVE tag, Archiving
  908. @subsection Moving subtrees
  909. @cindex external archiving
  910. Once an entire project is finished, you may want to move it to a different
  911. location. Org can move it to an @emph{Archive Sibling} in the same tree, to a
  912. different tree in the current file, or to a different file, the archive file.
  913. @table @kbd
  914. @kindex C-c C-x A
  915. @item C-c C-x A
  916. Move the current entry to the @emph{Archive Sibling}. This is a sibling of
  917. the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
  918. (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
  919. way retains a lot of its original context, including inherited tags and
  920. approximate position in the outline.
  921. @kindex C-c C-x C-s
  922. @item C-c C-x C-s
  923. Archive the subtree starting at the cursor position to the location
  924. given by @code{org-archive-location}. Context information that could be
  925. lost like the file name, the category, inherited tags, and the TODO
  926. state will be store as properties in the entry.
  927. @kindex C-u C-c C-x C-s
  928. @item C-u C-c C-x C-s
  929. Check if any direct children of the current headline could be moved to
  930. the archive. To do this, each subtree is checked for open TODO entries.
  931. If none are found, the command offers to move it to the archive
  932. location. If the cursor is @emph{not} on a headline when this command
  933. is invoked, the level 1 trees will be checked.
  934. @end table
  935. @cindex archive locations
  936. The default archive location is a file in the same directory as the
  937. current file, with the name derived by appending @file{_archive} to the
  938. current file name. For information and examples on how to change this,
  939. see the documentation string of the variable
  940. @code{org-archive-location}. There is also an in-buffer option for
  941. setting this variable, for example@footnote{For backward compatibility,
  942. the following also works: If there are several such lines in a file,
  943. each specifies the archive location for the text below it. The first
  944. such line also applies to any text before its definition. However,
  945. using this method is @emph{strongly} deprecated as it is incompatible
  946. with the outline structure of the document. The correct method for
  947. setting multiple archive locations in a buffer is using properties.}:
  948. @example
  949. #+ARCHIVE: %s_done::
  950. @end example
  951. @noindent
  952. If you would like to have a special ARCHIVE location for a single entry
  953. or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
  954. location as the value (@pxref{Properties and Columns}).
  955. When a subtree is moved, it receives a number of special properties that
  956. record context information like the file from where the entry came, it's
  957. outline path the archiving time etc. Configure the variable
  958. @code{org-archive-save-context-info} to adjust the amount of information
  959. added.
  960. @node Sparse trees, Plain lists, Archiving, Document Structure
  961. @section Sparse trees
  962. @cindex sparse trees
  963. @cindex trees, sparse
  964. @cindex folding, sparse trees
  965. @cindex occur, command
  966. An important feature of Org mode is the ability to construct @emph{sparse
  967. trees} for selected information in an outline tree, so that the entire
  968. document is folded as much as possible, but the selected information is made
  969. visible along with the headline structure above it@footnote{See also the
  970. variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
  971. @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
  972. control on how much context is shown around each match.}. Just try it out
  973. and you will see immediately how it works.
  974. Org mode contains several commands creating such trees, all these
  975. commands can be accessed through a dispatcher:
  976. @table @kbd
  977. @kindex C-c /
  978. @item C-c /
  979. This prompts for an extra key to select a sparse-tree creating command.
  980. @kindex C-c / r
  981. @item C-c / r
  982. Occur. Prompts for a regexp and shows a sparse tree with all matches. If
  983. the match is in a headline, the headline is made visible. If the match is in
  984. the body of an entry, headline and body are made visible. In order to
  985. provide minimal context, also the full hierarchy of headlines above the match
  986. is shown, as well as the headline following the match. Each match is also
  987. highlighted; the highlights disappear when the buffer is changed by an
  988. editing command@footnote{depending on the option
  989. @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
  990. When called with a @kbd{C-u} prefix argument, previous highlights are kept,
  991. so several calls to this command can be stacked.
  992. @end table
  993. @noindent
  994. For frequently used sparse trees of specific search strings, you can
  995. use the variable @code{org-agenda-custom-commands} to define fast
  996. keyboard access to specific sparse trees. These commands will then be
  997. accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
  998. For example:
  999. @lisp
  1000. (setq org-agenda-custom-commands
  1001. '(("f" occur-tree "FIXME")))
  1002. @end lisp
  1003. @noindent will define the key @kbd{C-c a f} as a shortcut for creating
  1004. a sparse tree matching the string @samp{FIXME}.
  1005. The other sparse tree commands select headings based on TODO keywords,
  1006. tags, or properties and will be discussed later in this manual.
  1007. @kindex C-c C-e v
  1008. @cindex printing sparse trees
  1009. @cindex visible text, printing
  1010. To print a sparse tree, you can use the Emacs command
  1011. @code{ps-print-buffer-with-faces} which does not print invisible parts
  1012. of the document @footnote{This does not work under XEmacs, because
  1013. XEmacs uses selective display for outlining, not text properties.}.
  1014. Or you can use the command @kbd{C-c C-e v} to export only the visible
  1015. part of the document and print the resulting file.
  1016. @node Plain lists, Drawers, Sparse trees, Document Structure
  1017. @section Plain lists
  1018. @cindex plain lists
  1019. @cindex lists, plain
  1020. @cindex lists, ordered
  1021. @cindex ordered lists
  1022. Within an entry of the outline tree, hand-formatted lists can provide
  1023. additional structure. They also provide a way to create lists of
  1024. checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
  1025. and the HTML exporter (@pxref{Exporting}) parses and formats them.
  1026. Org knows ordered lists, unordered lists, and description lists.
  1027. @itemize @bullet
  1028. @item
  1029. @emph{Unordered} list items start with @samp{-}, @samp{+}, or
  1030. @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
  1031. they will be seen as top-level headlines. Also, when you are hiding leading
  1032. stars to get a clean outline view, plain list items starting with a star are
  1033. visually indistinguishable from true headlines. In short: even though
  1034. @samp{*} is supported, it may be better to not use it for plain list items.}
  1035. as bullets.
  1036. @item
  1037. @emph{Ordered} list items start with a numeral followed by either a period or
  1038. a right parenthesis, such as @samp{1.} or @samp{1)}.
  1039. @item
  1040. @emph{Description} list items are like unordered list items, but contain the
  1041. separator @samp{ :: } to separate the description @emph{term} from the
  1042. description.
  1043. @end itemize
  1044. Items belonging to the same list must have the same indentation on the first
  1045. line. In particular, if an ordered list reaches number @samp{10.}, then the
  1046. 2--digit numbers must be written left-aligned with the other numbers in the
  1047. list. Indentation also determines the end of a list item. It ends before
  1048. the next line that is indented like the bullet/number, or less. Empty lines
  1049. are part of the previous item, so you can have several paragraphs in one
  1050. item. If you would like an empty line to terminate all currently open plain
  1051. lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
  1052. Here is an example:
  1053. @example
  1054. @group
  1055. ** Lord of the Rings
  1056. My favorite scenes are (in this order)
  1057. 1. The attack of the Rohirrim
  1058. 2. Eowyn's fight with the witch king
  1059. + this was already my favorite scene in the book
  1060. + I really like Miranda Otto.
  1061. 3. Peter Jackson being shot by Legolas
  1062. - on DVD only
  1063. He makes a really funny face when it happens.
  1064. But in the end, no individual scenes matter but the film as a whole.
  1065. Important actors in this film are:
  1066. - @b{Elijah Wood} :: He plays Frodo
  1067. - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
  1068. him very well from his role as Mikey Walsh in the Goonies.
  1069. @end group
  1070. @end example
  1071. Org supports these lists by tuning filling and wrapping commands to
  1072. deal with them correctly@footnote{Org only changes the filling
  1073. settings for Emacs. For XEmacs, you should use Kyle E. Jones'
  1074. @file{filladapt.el}. To turn this on, put into @file{.emacs}:
  1075. @code{(require 'filladapt)}}, and by exporting them properly
  1076. (@pxref{Exporting}).
  1077. The following commands act on items when the cursor is in the first line
  1078. of an item (the line with the bullet or number).
  1079. @table @kbd
  1080. @kindex @key{TAB}
  1081. @item @key{TAB}
  1082. Items can be folded just like headline levels if you set the variable
  1083. @code{org-cycle-include-plain-lists}. The level of an item is then
  1084. given by the indentation of the bullet/number. Items are always
  1085. subordinate to real headlines, however; the hierarchies remain
  1086. completely separated.
  1087. If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
  1088. fixes the indentation of the current line in a heuristic way.
  1089. @kindex M-@key{RET}
  1090. @item M-@key{RET}
  1091. Insert new item at current level. With a prefix argument, force a new
  1092. heading (@pxref{Structure editing}). If this command is used in the middle
  1093. of a line, the line is @emph{split} and the rest of the line becomes the new
  1094. item@footnote{If you do not want the line to be split, customize the variable
  1095. @code{org-M-RET-may-split-line}.}. If this command is executed in the
  1096. @emph{whitespace before a bullet or number}, the new item is created
  1097. @emph{before} the current item. If the command is executed in the white
  1098. space before the text that is part of an item but does not contain the
  1099. bullet, a bullet is added to the current line.
  1100. @kindex M-S-@key{RET}
  1101. @item M-S-@key{RET}
  1102. Insert a new item with a checkbox (@pxref{Checkboxes}).
  1103. @kindex S-@key{up}
  1104. @kindex S-@key{down}
  1105. @item S-@key{up}
  1106. @itemx S-@key{down}
  1107. Jump to the previous/next item in the current list.
  1108. @kindex M-S-@key{up}
  1109. @kindex M-S-@key{down}
  1110. @item M-S-@key{up}
  1111. @itemx M-S-@key{down}
  1112. Move the item including subitems up/down (swap with previous/next item
  1113. of same indentation). If the list is ordered, renumbering is
  1114. automatic.
  1115. @kindex M-S-@key{left}
  1116. @kindex M-S-@key{right}
  1117. @item M-S-@key{left}
  1118. @itemx M-S-@key{right}
  1119. Decrease/increase the indentation of the item, including subitems.
  1120. Initially, the item tree is selected based on current indentation.
  1121. When these commands are executed several times in direct succession,
  1122. the initially selected region is used, even if the new indentation
  1123. would imply a different hierarchy. To use the new hierarchy, break
  1124. the command chain with a cursor motion or so.
  1125. @kindex C-c C-c
  1126. @item C-c C-c
  1127. If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
  1128. state of the checkbox. If not, this command makes sure that all the
  1129. items on this list level use the same bullet. Furthermore, if this is
  1130. an ordered list, make sure the numbering is OK.
  1131. @kindex C-c -
  1132. @item C-c -
  1133. Cycle the entire list level through the different itemize/enumerate bullets
  1134. (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
  1135. argument N, select the Nth bullet from this list. If there is an active
  1136. region when calling this, all lines will be converted to list items. If the
  1137. first line already was a list item, any item markers will be removed from the
  1138. list. Finally, even without an active region, a normal line will be
  1139. converted into a list item.
  1140. @kindex S-@key{left}
  1141. @kindex S-@key{right}
  1142. @item S-@key{left}/@key{right}
  1143. Also cycle bullet styles when in the first line of an item.
  1144. @end table
  1145. @node Drawers, Footnotes, Plain lists, Document Structure
  1146. @section Drawers
  1147. @cindex drawers
  1148. @cindex visibility cycling, drawers
  1149. Sometimes you want to keep information associated with an entry, but you
  1150. normally don't want to see it. For this, Org mode has @emph{drawers}.
  1151. Drawers need to be configured with the variable
  1152. @code{org-drawers}@footnote{You can define drawers on a per-file basis
  1153. with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
  1154. look like this:
  1155. @example
  1156. ** This is a headline
  1157. Still outside the drawer
  1158. :DRAWERNAME:
  1159. This is inside the drawer.
  1160. :END:
  1161. After the drawer.
  1162. @end example
  1163. Visibility cycling (@pxref{Visibility cycling}) on the headline will
  1164. hide and show the entry, but keep the drawer collapsed to a single line.
  1165. In order to look inside the drawer, you need to move the cursor to the
  1166. drawer line and press @key{TAB} there. Org mode uses a drawer for
  1167. storing properties (@pxref{Properties and Columns}), and another one for
  1168. storing clock times (@pxref{Clocking work time}).
  1169. @node Footnotes, Orgstruct mode, Drawers, Document Structure
  1170. @section Footnotes
  1171. @cindex footnotes
  1172. Org-mode supports the creation of footnotes. In contrast to the
  1173. @file{footnote.el} package, Org-mode's footnotes are designed for work on a
  1174. larger document, not only for one-off documents like emails. The basic
  1175. syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
  1176. defined in a paragraph that is started by a footnote marker in square
  1177. brackets in column 0, no indentation allowed. The footnote reference is
  1178. simply the marker in square brackets, inside text. For example:
  1179. @example
  1180. The Org homepage[fn:1] now looks a lot better than it used to.
  1181. ...
  1182. [fn:1] The link is: http://orgmode.org
  1183. @end example
  1184. Org-mode extends the number-based syntax to @emph{named} footnotes and
  1185. optional inline definition. Using plain numbers as markers (as
  1186. @file{footnote.el} does) is supported for backward compatibility, but not
  1187. encouraged because of possible conflicts with LaTeX snippets @pxref{Embedded
  1188. LaTeX}. Here are the valid references:
  1189. @table @code
  1190. @item [1]
  1191. A plain numeric footnote marker.
  1192. @item [fn:name]
  1193. A named footnote reference, where @code{name} is a unique label word, or, for
  1194. simplicity of automatic creation, a number.
  1195. @item [fn:: This is the inline definition of this footnote]
  1196. A LaTeX-like anonymous footnote where the definition is given directly at the
  1197. reference point.
  1198. @item [fn:name: a definition]
  1199. An inline definition of a footnote, which also specifies a name for the note.
  1200. Since Org allows multiple references to the same note, you can then use use
  1201. @code{[fn:name]} to create additional references.
  1202. @end table
  1203. Footnote labels can be created automatically, or you create names yourself.
  1204. This is handled by the variable @code{org-footnote-auto-label} and its
  1205. corresponding @code{#+STARTUP} keywords, see the docstring of that variable
  1206. for details.
  1207. @noindent The following command handles footnotes:
  1208. @table @kbd
  1209. @kindex C-c C-x f
  1210. @item C-c C-x f
  1211. The footnote action command.
  1212. When the cursor is on a footnote reference, jump to the definition. When it
  1213. is at a definition, jump to the (first) reference.
  1214. Otherwise, create a new footnote. Depending on the variable
  1215. @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
  1216. setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
  1217. definition will be placed right into the text as part of the reference, or
  1218. separately into the location determined by the variable
  1219. @code{org-footnote-section}.
  1220. When this command is called with a prefix argument, a menu of additional
  1221. options is offered:
  1222. @example
  1223. s @r{Sort the footnote definitions by reference sequence. During editing,}
  1224. @r{Org makes no effort to sort footnote definitions into a particular}
  1225. @r{sequence. If you want them sorted, use this command, which will}
  1226. @r{also move entries according to @code{org-footnote-section}.}
  1227. n @r{Normalize the footnotes by collecting all definitions (including}
  1228. @r{inline definitions) into a special section, and then numbering them}
  1229. @r{in sequence. The references will then also be numbers. This is}
  1230. @r{meant to be the final step before finishing a document (e.g. sending}
  1231. @r{off an email). The exporters do this automatically, and so could}
  1232. @r{something like @code{message-send-hook}.}
  1233. d @r{Delete the footnote at point, and all definitions of and references}
  1234. @r{to it.}
  1235. @end example
  1236. @kindex C-c C-c
  1237. @item C-c C-c
  1238. If the cursor is on a footnote reference, jump to the definition. If it is a
  1239. the definition, jump back to the reference. When called at a footnote
  1240. location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
  1241. @kindex C-c C-o
  1242. @kindex mouse-1
  1243. @kindex mouse-2
  1244. @item C-c C-c @r{or} mouse-1/2
  1245. Footnote labels are also links to the corresponding definition/reference, and
  1246. you can use the usual commands to follow these links.
  1247. @end table
  1248. @node Orgstruct mode, , Footnotes, Document Structure
  1249. @section The Orgstruct minor mode
  1250. @cindex Orgstruct mode
  1251. @cindex minor mode for structure editing
  1252. If you like the intuitive way the Org mode structure editing and list
  1253. formatting works, you might want to use these commands in other modes
  1254. like Text mode or Mail mode as well. The minor mode Orgstruct mode
  1255. makes this possible. You can always toggle the mode with @kbd{M-x
  1256. orgstruct-mode}. To turn it on by default, for example in Mail mode,
  1257. use
  1258. @lisp
  1259. (add-hook 'mail-mode-hook 'turn-on-orgstruct)
  1260. @end lisp
  1261. When this mode is active and the cursor is on a line that looks to
  1262. Org like a headline of the first line of a list item, most
  1263. structure editing commands will work, even if the same keys normally
  1264. have different functionality in the major mode you are using. If the
  1265. cursor is not in one of those special lines, Orgstruct mode lurks
  1266. silently in the shadow.
  1267. @node Tables, Hyperlinks, Document Structure, Top
  1268. @chapter Tables
  1269. @cindex tables
  1270. @cindex editing tables
  1271. Org comes with a fast and intuitive table editor. Spreadsheet-like
  1272. calculations are supported in connection with the Emacs @file{calc}
  1273. package
  1274. @ifinfo
  1275. (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
  1276. @end ifinfo
  1277. @ifnotinfo
  1278. (see the Emacs Calculator manual for more information about the Emacs
  1279. calculator).
  1280. @end ifnotinfo
  1281. @menu
  1282. * Built-in table editor:: Simple tables
  1283. * Narrow columns:: Stop wasting space in tables
  1284. * Column groups:: Grouping to trigger vertical lines
  1285. * Orgtbl mode:: The table editor as minor mode
  1286. * The spreadsheet:: The table editor has spreadsheet capabilities
  1287. * Org Plot:: Plotting from org tables
  1288. @end menu
  1289. @node Built-in table editor, Narrow columns, Tables, Tables
  1290. @section The built-in table editor
  1291. @cindex table editor, built-in
  1292. Org makes it easy to format tables in plain ASCII. Any line with
  1293. @samp{|} as the first non-whitespace character is considered part of a
  1294. table. @samp{|} is also the column separator. A table might look like
  1295. this:
  1296. @example
  1297. | Name | Phone | Age |
  1298. |-------+-------+-----|
  1299. | Peter | 1234 | 17 |
  1300. | Anna | 4321 | 25 |
  1301. @end example
  1302. A table is re-aligned automatically each time you press @key{TAB} or
  1303. @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
  1304. the next field (@key{RET} to the next row) and creates new table rows
  1305. at the end of the table or before horizontal lines. The indentation
  1306. of the table is set by the first line. Any line starting with
  1307. @samp{|-} is considered as a horizontal separator line and will be
  1308. expanded on the next re-align to span the whole table width. So, to
  1309. create the above table, you would only type
  1310. @example
  1311. |Name|Phone|Age|
  1312. |-
  1313. @end example
  1314. @noindent and then press @key{TAB} to align the table and start filling in
  1315. fields. Even faster would be to type @code{|Name|Phone|Age} followed by
  1316. @kbd{C-c @key{RET}}.
  1317. When typing text into a field, Org treats @key{DEL},
  1318. @key{Backspace}, and all character keys in a special way, so that
  1319. inserting and deleting avoids shifting other fields. Also, when
  1320. typing @emph{immediately after the cursor was moved into a new field
  1321. with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
  1322. field is automatically made blank. If this behavior is too
  1323. unpredictable for you, configure the variables
  1324. @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
  1325. @table @kbd
  1326. @tsubheading{Creation and conversion}
  1327. @kindex C-c |
  1328. @item C-c |
  1329. Convert the active region to table. If every line contains at least one
  1330. TAB character, the function assumes that the material is tab separated.
  1331. If every line contains a comma, comma-separated values (CSV) are assumed.
  1332. If not, lines are split at whitespace into fields. You can use a prefix
  1333. argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
  1334. C-u} forces TAB, and a numeric argument N indicates that at least N
  1335. consecutive spaces, or alternatively a TAB will be the separator.
  1336. @*
  1337. If there is no active region, this command creates an empty Org
  1338. table. But it's easier just to start typing, like
  1339. @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
  1340. @tsubheading{Re-aligning and field motion}
  1341. @kindex C-c C-c
  1342. @item C-c C-c
  1343. Re-align the table without moving the cursor.
  1344. @c
  1345. @kindex @key{TAB}
  1346. @item @key{TAB}
  1347. Re-align the table, move to the next field. Creates a new row if
  1348. necessary.
  1349. @c
  1350. @kindex S-@key{TAB}
  1351. @item S-@key{TAB}
  1352. Re-align, move to previous field.
  1353. @c
  1354. @kindex @key{RET}
  1355. @item @key{RET}
  1356. Re-align the table and move down to next row. Creates a new row if
  1357. necessary. At the beginning or end of a line, @key{RET} still does
  1358. NEWLINE, so it can be used to split a table.
  1359. @tsubheading{Column and row editing}
  1360. @kindex M-@key{left}
  1361. @kindex M-@key{right}
  1362. @item M-@key{left}
  1363. @itemx M-@key{right}
  1364. Move the current column left/right.
  1365. @c
  1366. @kindex M-S-@key{left}
  1367. @item M-S-@key{left}
  1368. Kill the current column.
  1369. @c
  1370. @kindex M-S-@key{right}
  1371. @item M-S-@key{right}
  1372. Insert a new column to the left of the cursor position.
  1373. @c
  1374. @kindex M-@key{up}
  1375. @kindex M-@key{down}
  1376. @item M-@key{up}
  1377. @itemx M-@key{down}
  1378. Move the current row up/down.
  1379. @c
  1380. @kindex M-S-@key{up}
  1381. @item M-S-@key{up}
  1382. Kill the current row or horizontal line.
  1383. @c
  1384. @kindex M-S-@key{down}
  1385. @item M-S-@key{down}
  1386. Insert a new row above the current row. With a prefix argument, the line is
  1387. created below the current one.
  1388. @c
  1389. @kindex C-c -
  1390. @item C-c -
  1391. Insert a horizontal line below current row. With a prefix argument, the line
  1392. is created above the current line.
  1393. @c
  1394. @kindex C-c @key{RET}
  1395. @item C-c @key{RET}
  1396. Insert a horizontal line below current row. and mode the cursor into the row
  1397. below that line.
  1398. @c
  1399. @kindex C-c ^
  1400. @item C-c ^
  1401. Sort the table lines in the region. The position of point indicates the
  1402. column to be used for sorting, and the range of lines is the range
  1403. between the nearest horizontal separator lines, or the entire table. If
  1404. point is before the first column, you will be prompted for the sorting
  1405. column. If there is an active region, the mark specifies the first line
  1406. and the sorting column, while point should be in the last line to be
  1407. included into the sorting. The command prompts for the sorting type
  1408. (alphabetically, numerically, or by time). When called with a prefix
  1409. argument, alphabetic sorting will be case-sensitive.
  1410. @tsubheading{Regions}
  1411. @kindex C-c C-x M-w
  1412. @item C-c C-x M-w
  1413. Copy a rectangular region from a table to a special clipboard. Point
  1414. and mark determine edge fields of the rectangle. The process ignores
  1415. horizontal separator lines.
  1416. @c
  1417. @kindex C-c C-x C-w
  1418. @item C-c C-x C-w
  1419. Copy a rectangular region from a table to a special clipboard, and
  1420. blank all fields in the rectangle. So this is the ``cut'' operation.
  1421. @c
  1422. @kindex C-c C-x C-y
  1423. @item C-c C-x C-y
  1424. Paste a rectangular region into a table.
  1425. The upper left corner ends up in the current field. All involved fields
  1426. will be overwritten. If the rectangle does not fit into the present table,
  1427. the table is enlarged as needed. The process ignores horizontal separator
  1428. lines.
  1429. @c
  1430. @kindex M-@key{RET}
  1431. @itemx M-@kbd{RET}
  1432. Wrap several fields in a column like a paragraph. If there is an active
  1433. region, and both point and mark are in the same column, the text in the
  1434. column is wrapped to minimum width for the given number of lines. A numeric
  1435. prefix argument may be used to change the number of desired lines. If there
  1436. is no region, the current field is split at the cursor position and the text
  1437. fragment to the right of the cursor is prepended to the field one line
  1438. down. If there is no region, but you specify a prefix argument, the current
  1439. field is made blank, and the content is appended to the field above.
  1440. @tsubheading{Calculations}
  1441. @cindex formula, in tables
  1442. @cindex calculations, in tables
  1443. @cindex region, active
  1444. @cindex active region
  1445. @cindex Transient mark mode
  1446. @kindex C-c +
  1447. @item C-c +
  1448. Sum the numbers in the current column, or in the rectangle defined by
  1449. the active region. The result is shown in the echo area and can
  1450. be inserted with @kbd{C-y}.
  1451. @c
  1452. @kindex S-@key{RET}
  1453. @item S-@key{RET}
  1454. When current field is empty, copy from first non-empty field above. When not
  1455. empty, copy current field down to next row and move cursor along with it.
  1456. Depending on the variable @code{org-table-copy-increment}, integer field
  1457. values will be incremented during copy. Integers that are too large will not
  1458. be incremented. Also, a @code{0} prefix argument temporarily disables the
  1459. increment. This key is also used by CUA mode (@pxref{Cooperation}).
  1460. @tsubheading{Miscellaneous}
  1461. @kindex C-c `
  1462. @item C-c `
  1463. Edit the current field in a separate window. This is useful for fields
  1464. that are not fully visible (@pxref{Narrow columns}). When called with a
  1465. @kbd{C-u} prefix, just make the full field visible, so that it can be
  1466. edited in place.
  1467. @c
  1468. @item M-x org-table-import
  1469. Import a file as a table. The table should be TAB- or whitespace
  1470. separated. Useful, for example, to import a spreadsheet table or data
  1471. from a database, because these programs generally can write
  1472. TAB-separated text files. This command works by inserting the file into
  1473. the buffer and then converting the region to a table. Any prefix
  1474. argument is passed on to the converter, which uses it to determine the
  1475. separator.
  1476. @item C-c |
  1477. Tables can also be imported by pasting tabular text into the Org
  1478. buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
  1479. @kbd{C-c |} command (see above under @i{Creation and conversion}).
  1480. @c
  1481. @item M-x org-table-export
  1482. Export the table, by default as a TAB-separated file. Useful for data
  1483. exchange with, for example, spreadsheet or database programs. The format
  1484. used to export the file can be configured in the variable
  1485. @code{org-table-export-default-format}. You may also use properties
  1486. @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
  1487. name and the format for table export in a subtree. Org supports quite
  1488. general formats for exported tables. The exporter format is the same as the
  1489. format used by Orgtbl radio tables, see @ref{Translator functions} for a
  1490. detailed description.
  1491. @end table
  1492. If you don't like the automatic table editor because it gets in your
  1493. way on lines which you would like to start with @samp{|}, you can turn
  1494. it off with
  1495. @lisp
  1496. (setq org-enable-table-editor nil)
  1497. @end lisp
  1498. @noindent Then the only table command that still works is
  1499. @kbd{C-c C-c} to do a manual re-align.
  1500. @node Narrow columns, Column groups, Built-in table editor, Tables
  1501. @section Narrow columns
  1502. @cindex narrow columns in tables
  1503. The width of columns is automatically determined by the table editor.
  1504. Sometimes a single field or a few fields need to carry more text,
  1505. leading to inconveniently wide columns. To limit@footnote{This feature
  1506. does not work on XEmacs.} the width of a column, one field anywhere in
  1507. the column may contain just the string @samp{<N>} where @samp{N} is an
  1508. integer specifying the width of the column in characters. The next
  1509. re-align will then set the width of this column to no more than this
  1510. value.
  1511. @example
  1512. @group
  1513. |---+------------------------------| |---+--------|
  1514. | | | | | <6> |
  1515. | 1 | one | | 1 | one |
  1516. | 2 | two | ----\ | 2 | two |
  1517. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  1518. | 4 | four | | 4 | four |
  1519. |---+------------------------------| |---+--------|
  1520. @end group
  1521. @end example
  1522. @noindent
  1523. Fields that are wider become clipped and end in the string @samp{=>}.
  1524. Note that the full text is still in the buffer, it is only invisible.
  1525. To see the full text, hold the mouse over the field - a tool-tip window
  1526. will show the full content. To edit such a field, use the command
  1527. @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
  1528. open a new window with the full field. Edit it and finish with @kbd{C-c
  1529. C-c}.
  1530. When visiting a file containing a table with narrowed columns, the
  1531. necessary character hiding has not yet happened, and the table needs to
  1532. be aligned before it looks nice. Setting the option
  1533. @code{org-startup-align-all-tables} will realign all tables in a file
  1534. upon visiting, but also slow down startup. You can also set this option
  1535. on a per-file basis with:
  1536. @example
  1537. #+STARTUP: align
  1538. #+STARTUP: noalign
  1539. @end example
  1540. @node Column groups, Orgtbl mode, Narrow columns, Tables
  1541. @section Column groups
  1542. @cindex grouping columns in tables
  1543. When Org exports tables, it does so by default without vertical
  1544. lines because that is visually more satisfying in general. Occasionally
  1545. however, vertical lines can be useful to structure a table into groups
  1546. of columns, much like horizontal lines can do for groups of rows. In
  1547. order to specify column groups, you can use a special row where the
  1548. first field contains only @samp{/}. The further fields can either
  1549. contain @samp{<} to indicate that this column should start a group,
  1550. @samp{>} to indicate the end of a column, or @samp{<>} to make a column
  1551. a group of its own. Boundaries between column groups will upon export be
  1552. marked with vertical lines. Here is an example:
  1553. @example
  1554. | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1555. |---+----+-----+-----+-----+---------+------------|
  1556. | / | <> | < | | > | < | > |
  1557. | # | 1 | 1 | 1 | 1 | 1 | 1 |
  1558. | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
  1559. | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
  1560. |---+----+-----+-----+-----+---------+------------|
  1561. #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
  1562. @end example
  1563. It is also sufficient to just insert the column group starters after
  1564. every vertical line you'd like to have:
  1565. @example
  1566. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1567. |----+-----+-----+-----+---------+------------|
  1568. | / | < | | | < | |
  1569. @end example
  1570. @node Orgtbl mode, The spreadsheet, Column groups, Tables
  1571. @section The Orgtbl minor mode
  1572. @cindex Orgtbl mode
  1573. @cindex minor mode for tables
  1574. If you like the intuitive way the Org table editor works, you
  1575. might also want to use it in other modes like Text mode or Mail mode.
  1576. The minor mode Orgtbl mode makes this possible. You can always toggle
  1577. the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
  1578. example in mail mode, use
  1579. @lisp
  1580. (add-hook 'mail-mode-hook 'turn-on-orgtbl)
  1581. @end lisp
  1582. Furthermore, with some special setup, it is possible to maintain tables
  1583. in arbitrary syntax with Orgtbl mode. For example, it is possible to
  1584. construct La@TeX{} tables with the underlying ease and power of
  1585. Orgtbl mode, including spreadsheet capabilities. For details, see
  1586. @ref{Tables in arbitrary syntax}.
  1587. @node The spreadsheet, Org Plot, Orgtbl mode, Tables
  1588. @section The spreadsheet
  1589. @cindex calculations, in tables
  1590. @cindex spreadsheet capabilities
  1591. @cindex @file{calc} package
  1592. The table editor makes use of the Emacs @file{calc} package to implement
  1593. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  1594. derive fields from other fields. While fully featured, Org's
  1595. implementation is not identical to other spreadsheets. For example,
  1596. Org knows the concept of a @emph{column formula} that will be
  1597. applied to all non-header fields in a column without having to copy the
  1598. formula to each relevant field.
  1599. @menu
  1600. * References:: How to refer to another field or range
  1601. * Formula syntax for Calc:: Using Calc to compute stuff
  1602. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  1603. * Field formulas:: Formulas valid for a single field
  1604. * Column formulas:: Formulas valid for an entire column
  1605. * Editing and debugging formulas:: Fixing formulas
  1606. * Updating the table:: Recomputing all dependent fields
  1607. * Advanced features:: Field names, parameters and automatic recalc
  1608. @end menu
  1609. @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
  1610. @subsection References
  1611. @cindex references
  1612. To compute fields in the table from other fields, formulas must
  1613. reference other fields or ranges. In Org, fields can be referenced
  1614. by name, by absolute coordinates, and by relative coordinates. To find
  1615. out what the coordinates of a field are, press @kbd{C-c ?} in that
  1616. field, or press @kbd{C-c @}} to toggle the display of a grid.
  1617. @subsubheading Field references
  1618. @cindex field references
  1619. @cindex references, to fields
  1620. Formulas can reference the value of another field in two ways. Like in
  1621. any other spreadsheet, you may reference fields with a letter/number
  1622. combination like @code{B3}, meaning the 2nd field in the 3rd row.
  1623. @c Such references are always fixed to that field, they don't change
  1624. @c when you copy and paste a formula to a different field. So
  1625. @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
  1626. @noindent
  1627. Org also uses another, more general operator that looks like this:
  1628. @example
  1629. @@row$column
  1630. @end example
  1631. @noindent
  1632. Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
  1633. or relative to the current column like @samp{+1} or @samp{-2}.
  1634. The row specification only counts data lines and ignores horizontal
  1635. separator lines (hlines). You can use absolute row numbers
  1636. @samp{1}...@samp{N}, and row numbers relative to the current row like
  1637. @samp{+3} or @samp{-1}. Or specify the row relative to one of the
  1638. hlines: @samp{I} refers to the first hline@footnote{Note that only
  1639. hlines are counted that @emph{separate} table lines. If the table
  1640. starts with a hline above the header, it does not count.}, @samp{II} to
  1641. the second etc. @samp{-I} refers to the first such line above the
  1642. current line, @samp{+I} to the first such line below the current line.
  1643. You can also write @samp{III+2} which is the second data line after the
  1644. third hline in the table. Relative row numbers like @samp{-3} will not
  1645. cross hlines if the current line is too close to the hline. Instead,
  1646. the value directly at the hline is used.
  1647. @samp{0} refers to the current row and column. Also, if you omit
  1648. either the column or the row part of the reference, the current
  1649. row/column is implied.
  1650. Org's references with @emph{unsigned} numbers are fixed references
  1651. in the sense that if you use the same reference in the formula for two
  1652. different fields, the same field will be referenced each time.
  1653. Org's references with @emph{signed} numbers are floating
  1654. references because the same reference operator can reference different
  1655. fields depending on the field being calculated by the formula.
  1656. As a special case references like @samp{$LR5} and @samp{$LR12} can be used to
  1657. refer in a stable way to the 5th and 12th field in the last row of the
  1658. table.
  1659. Here are a few examples:
  1660. @example
  1661. @@2$3 @r{2nd row, 3rd column}
  1662. C2 @r{same as previous}
  1663. $5 @r{column 5 in the current row}
  1664. E& @r{same as previous}
  1665. @@2 @r{current column, row 2}
  1666. @@-1$-3 @r{the field one row up, three columns to the left}
  1667. @@-I$2 @r{field just under hline above current row, column 2}
  1668. @end example
  1669. @subsubheading Range references
  1670. @cindex range references
  1671. @cindex references, to ranges
  1672. You may reference a rectangular range of fields by specifying two field
  1673. references connected by two dots @samp{..}. If both fields are in the
  1674. current row, you may simply use @samp{$2..$7}, but if at least one field
  1675. is in a different row, you need to use the general @code{@@row$column}
  1676. format at least for the first field (i.e the reference must start with
  1677. @samp{@@} in order to be interpreted correctly). Examples:
  1678. @example
  1679. $1..$3 @r{First three fields in the current row.}
  1680. $P..$Q @r{Range, using column names (see under Advanced)}
  1681. @@2$1..@@4$3 @r{6 fields between these two fields.}
  1682. A2..C4 @r{Same as above.}
  1683. @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
  1684. @end example
  1685. @noindent Range references return a vector of values that can be fed
  1686. into Calc vector functions. Empty fields in ranges are normally
  1687. suppressed, so that the vector contains only the non-empty fields (but
  1688. see the @samp{E} mode switch below). If there are no non-empty fields,
  1689. @samp{[0]} is returned to avoid syntax errors in formulas.
  1690. @subsubheading Named references
  1691. @cindex named references
  1692. @cindex references, named
  1693. @cindex name, of column or field
  1694. @cindex constants, in calculations
  1695. @samp{$name} is interpreted as the name of a column, parameter or
  1696. constant. Constants are defined globally through the variable
  1697. @code{org-table-formula-constants}, and locally (for the file) through a
  1698. line like
  1699. @example
  1700. #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
  1701. @end example
  1702. @noindent
  1703. Also properties (@pxref{Properties and Columns}) can be used as
  1704. constants in table formulas: For a property @samp{:Xyz:} use the name
  1705. @samp{$PROP_Xyz}, and the property will be searched in the current
  1706. outline entry and in the hierarchy above it. If you have the
  1707. @file{constants.el} package, it will also be used to resolve constants,
  1708. including natural constants like @samp{$h} for Planck's constant, and
  1709. units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
  1710. supply the values of constants in two different unit systems, @code{SI}
  1711. and @code{cgs}. Which one is used depends on the value of the variable
  1712. @code{constants-unit-system}. You can use the @code{#+STARTUP} options
  1713. @code{constSI} and @code{constcgs} to set this value for the current
  1714. buffer.}. Column names and parameters can be specified in special table
  1715. lines. These are described below, see @ref{Advanced features}. All
  1716. names must start with a letter, and further consist of letters and
  1717. numbers.
  1718. @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
  1719. @subsection Formula syntax for Calc
  1720. @cindex formula syntax, Calc
  1721. @cindex syntax, of formulas
  1722. A formula can be any algebraic expression understood by the Emacs
  1723. @file{Calc} package. @b{Note that @file{calc} has the
  1724. non-standard convention that @samp{/} has lower precedence than
  1725. @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
  1726. evaluation by @code{calc-eval} (@pxref{Calling Calc from
  1727. Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
  1728. Emacs Calc Manual}),
  1729. @c FIXME: The link to the Calc manual in HTML does not work.
  1730. variable substitution takes place according to the rules described above.
  1731. @cindex vectors, in table calculations
  1732. The range vectors can be directly fed into the Calc vector functions
  1733. like @samp{vmean} and @samp{vsum}.
  1734. @cindex format specifier
  1735. @cindex mode, for @file{calc}
  1736. A formula can contain an optional mode string after a semicolon. This
  1737. string consists of flags to influence Calc and other modes during
  1738. execution. By default, Org uses the standard Calc modes (precision
  1739. 12, angular units degrees, fraction and symbolic modes off). The display
  1740. format, however, has been changed to @code{(float 5)} to keep tables
  1741. compact. The default settings can be configured using the variable
  1742. @code{org-calc-default-modes}.
  1743. @example
  1744. p20 @r{switch the internal precision to 20 digits}
  1745. n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
  1746. D R @r{angle modes: degrees, radians}
  1747. F S @r{fraction and symbolic modes}
  1748. N @r{interpret all fields as numbers, use 0 for non-numbers}
  1749. T @r{force text interpretation}
  1750. E @r{keep empty fields in ranges}
  1751. @end example
  1752. @noindent
  1753. In addition, you may provide a @code{printf} format specifier to
  1754. reformat the final result. A few examples:
  1755. @example
  1756. $1+$2 @r{Sum of first and second field}
  1757. $1+$2;%.2f @r{Same, format result to two decimals}
  1758. exp($2)+exp($1) @r{Math functions can be used}
  1759. $0;%.1f @r{Reformat current cell to 1 decimal}
  1760. ($3-32)*5/9 @r{Degrees F -> C conversion}
  1761. $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
  1762. tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
  1763. sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
  1764. vmean($2..$7) @r{Compute column range mean, using vector function}
  1765. vmean($2..$7);EN @r{Same, but treat empty fields as 0}
  1766. taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
  1767. @end example
  1768. Calc also contains a complete set of logical operations. For example
  1769. @example
  1770. if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
  1771. @end example
  1772. @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
  1773. @subsection Emacs Lisp forms as formulas
  1774. @cindex Lisp forms, as table formulas
  1775. It is also possible to write a formula in Emacs Lisp; this can be useful
  1776. for string manipulation and control structures, if Calc's
  1777. functionality is not enough. If a formula starts with a single quote
  1778. followed by an opening parenthesis, then it is evaluated as a lisp form.
  1779. The evaluation should return either a string or a number. Just as with
  1780. @file{calc} formulas, you can specify modes and a printf format after a
  1781. semicolon. With Emacs Lisp forms, you need to be conscious about the way
  1782. field references are interpolated into the form. By default, a
  1783. reference will be interpolated as a Lisp string (in double quotes)
  1784. containing the field. If you provide the @samp{N} mode switch, all
  1785. referenced elements will be numbers (non-number fields will be zero) and
  1786. interpolated as Lisp numbers, without quotes. If you provide the
  1787. @samp{L} flag, all fields will be interpolated literally, without quotes.
  1788. I.e., if you want a reference to be interpreted as a string by the Lisp
  1789. form, enclose the reference operator itself in double quotes, like
  1790. @code{"$3"}. Ranges are inserted as space-separated fields, so you can
  1791. embed them in list or vector syntax. A few examples, note how the
  1792. @samp{N} mode is used when we do computations in lisp.
  1793. @example
  1794. @r{Swap the first two characters of the content of column 1}
  1795. '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
  1796. @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}}
  1797. '(+ $1 $2);N
  1798. @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
  1799. '(apply '+ '($1..$4));N
  1800. @end example
  1801. @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
  1802. @subsection Field formulas
  1803. @cindex field formula
  1804. @cindex formula, for individual table field
  1805. To assign a formula to a particular field, type it directly into the
  1806. field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
  1807. press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
  1808. the field, the formula will be stored as the formula for this field,
  1809. evaluated, and the current field replaced with the result.
  1810. Formulas are stored in a special line starting with @samp{#+TBLFM:}
  1811. directly below the table. If you typed the equation in the 4th field of
  1812. the 3rd data line in the table, the formula will look like
  1813. @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
  1814. with the appropriate commands, @i{absolute references} (but not relative
  1815. ones) in stored formulas are modified in order to still reference the
  1816. same field. Of cause this is not true if you edit the table structure
  1817. with normal editing commands - then you must fix the equations yourself.
  1818. The left hand side of a formula may also be a named field (@pxref{Advanced
  1819. features}), or a last-row reference like @samp{$LR3}.
  1820. Instead of typing an equation into the field, you may also use the
  1821. following command
  1822. @table @kbd
  1823. @kindex C-u C-c =
  1824. @item C-u C-c =
  1825. Install a new formula for the current field. The command prompts for a
  1826. formula, with default taken from the @samp{#+TBLFM:} line, applies
  1827. it to the current field and stores it.
  1828. @end table
  1829. @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
  1830. @subsection Column formulas
  1831. @cindex column formula
  1832. @cindex formula, for table column
  1833. Often in a table, the same formula should be used for all fields in a
  1834. particular column. Instead of having to copy the formula to all fields
  1835. in that column, Org allows to assign a single formula to an entire
  1836. column. If the table contains horizontal separator hlines, everything
  1837. before the first such line is considered part of the table @emph{header}
  1838. and will not be modified by column formulas.
  1839. To assign a formula to a column, type it directly into any field in the
  1840. column, preceded by an equal sign, like @samp{=$1+$2}. When you press
  1841. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the
  1842. field, the formula will be stored as the formula for the current column,
  1843. evaluated and the current field replaced with the result. If the field
  1844. contains only @samp{=}, the previously stored formula for this column is
  1845. used. For each column, Org will only remember the most recently
  1846. used formula. In the @samp{TBLFM:} line, column formulas will look like
  1847. @samp{$4=$1+$2}.
  1848. Instead of typing an equation into the field, you may also use the
  1849. following command:
  1850. @table @kbd
  1851. @kindex C-c =
  1852. @item C-c =
  1853. Install a new formula for the current column and replace current field with
  1854. the result of the formula. The command prompts for a formula, with default
  1855. taken from the @samp{#+TBLFM} line, applies it to the current field and
  1856. stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
  1857. will apply it to that many consecutive fields in the current column.
  1858. @end table
  1859. @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
  1860. @subsection Editing and debugging formulas
  1861. @cindex formula editing
  1862. @cindex editing, of table formulas
  1863. You can edit individual formulas in the minibuffer or directly in the
  1864. field. Org can also prepare a special buffer with all active
  1865. formulas of a table. When offering a formula for editing, Org
  1866. converts references to the standard format (like @code{B3} or @code{D&})
  1867. if possible. If you prefer to only work with the internal format (like
  1868. @code{@@3$2} or @code{$4}), configure the variable
  1869. @code{org-table-use-standard-references}.
  1870. @table @kbd
  1871. @kindex C-c =
  1872. @kindex C-u C-c =
  1873. @item C-c =
  1874. @itemx C-u C-c =
  1875. Edit the formula associated with the current column/field in the
  1876. minibuffer. See @ref{Column formulas} and @ref{Field formulas}.
  1877. @kindex C-u C-u C-c =
  1878. @item C-u C-u C-c =
  1879. Re-insert the active formula (either a
  1880. field formula, or a column formula) into the current field, so that you
  1881. can edit it directly in the field. The advantage over editing in the
  1882. minibuffer is that you can use the command @kbd{C-c ?}.
  1883. @kindex C-c ?
  1884. @item C-c ?
  1885. While editing a formula in a table field, highlight the field(s)
  1886. referenced by the reference at the cursor position in the formula.
  1887. @kindex C-c @}
  1888. @item C-c @}
  1889. Toggle the display of row and column numbers for a table, using
  1890. overlays. These are updated each time the table is aligned, you can
  1891. force it with @kbd{C-c C-c}.
  1892. @kindex C-c @{
  1893. @item C-c @{
  1894. Toggle the formula debugger on and off. See below.
  1895. @kindex C-c '
  1896. @item C-c '
  1897. Edit all formulas for the current table in a special buffer, where the
  1898. formulas will be displayed one per line. If the current field has an
  1899. active formula, the cursor in the formula editor will mark it.
  1900. While inside the special buffer, Org will automatically highlight
  1901. any field or range reference at the cursor position. You may edit,
  1902. remove and add formulas, and use the following commands:
  1903. @table @kbd
  1904. @kindex C-c C-c
  1905. @kindex C-x C-s
  1906. @item C-c C-c
  1907. @itemx C-x C-s
  1908. Exit the formula editor and store the modified formulas. With @kbd{C-u}
  1909. prefix, also apply the new formulas to the entire table.
  1910. @kindex C-c C-q
  1911. @item C-c C-q
  1912. Exit the formula editor without installing changes.
  1913. @kindex C-c C-r
  1914. @item C-c C-r
  1915. Toggle all references in the formula editor between standard (like
  1916. @code{B3}) and internal (like @code{@@3$2}).
  1917. @kindex @key{TAB}
  1918. @item @key{TAB}
  1919. Pretty-print or indent lisp formula at point. When in a line containing
  1920. a lisp formula, format the formula according to Emacs Lisp rules.
  1921. Another @key{TAB} collapses the formula back again. In the open
  1922. formula, @key{TAB} re-indents just like in Emacs lisp mode.
  1923. @kindex M-@key{TAB}
  1924. @item M-@key{TAB}
  1925. Complete Lisp symbols, just like in Emacs lisp mode.
  1926. @kindex S-@key{up}
  1927. @kindex S-@key{down}
  1928. @kindex S-@key{left}
  1929. @kindex S-@key{right}
  1930. @item S-@key{up}/@key{down}/@key{left}/@key{right}
  1931. Shift the reference at point. For example, if the reference is
  1932. @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
  1933. This also works for relative references, and for hline references.
  1934. @kindex M-S-@key{up}
  1935. @kindex M-S-@key{down}
  1936. @item M-S-@key{up}/@key{down}
  1937. Move the test line for column formulas in the Org buffer up and
  1938. down.
  1939. @kindex M-@key{up}
  1940. @kindex M-@key{down}
  1941. @item M-@key{up}/@key{down}
  1942. Scroll the window displaying the table.
  1943. @kindex C-c @}
  1944. @item C-c @}
  1945. Turn the coordinate grid in the table on and off.
  1946. @end table
  1947. @end table
  1948. Making a table field blank does not remove the formula associated with
  1949. the field, because that is stored in a different line (the @samp{TBLFM}
  1950. line) - during the next recalculation the field will be filled again.
  1951. To remove a formula from a field, you have to give an empty reply when
  1952. prompted for the formula, or to edit the @samp{#+TBLFM} line.
  1953. @kindex C-c C-c
  1954. You may edit the @samp{#+TBLFM} directly and re-apply the changed
  1955. equations with @kbd{C-c C-c} in that line, or with the normal
  1956. recalculation commands in the table.
  1957. @subsubheading Debugging formulas
  1958. @cindex formula debugging
  1959. @cindex debugging, of table formulas
  1960. When the evaluation of a formula leads to an error, the field content
  1961. becomes the string @samp{#ERROR}. If you would like see what is going
  1962. on during variable substitution and calculation in order to find a bug,
  1963. turn on formula debugging in the @code{Tbl} menu and repeat the
  1964. calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
  1965. field. Detailed information will be displayed.
  1966. @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
  1967. @subsection Updating the table
  1968. @cindex recomputing table fields
  1969. @cindex updating, table
  1970. Recalculation of a table is normally not automatic, but needs to be
  1971. triggered by a command. See @ref{Advanced features} for a way to make
  1972. recalculation at least semi-automatically.
  1973. In order to recalculate a line of a table or the entire table, use the
  1974. following commands:
  1975. @table @kbd
  1976. @kindex C-c *
  1977. @item C-c *
  1978. Recalculate the current row by first applying the stored column formulas
  1979. from left to right, and all field formulas in the current row.
  1980. @c
  1981. @kindex C-u C-c *
  1982. @item C-u C-c *
  1983. @kindex C-u C-c C-c
  1984. @itemx C-u C-c C-c
  1985. Recompute the entire table, line by line. Any lines before the first
  1986. hline are left alone, assuming that these are part of the table header.
  1987. @c
  1988. @kindex C-u C-u C-c *
  1989. @kindex C-u C-u C-c C-c
  1990. @item C-u C-u C-c *
  1991. @itemx C-u C-u C-c C-c
  1992. Iterate the table by recomputing it until no further changes occur.
  1993. This may be necessary if some computed fields use the value of other
  1994. fields that are computed @i{later} in the calculation sequence.
  1995. @end table
  1996. @node Advanced features, , Updating the table, The spreadsheet
  1997. @subsection Advanced features
  1998. If you want the recalculation of fields to happen automatically, or if
  1999. you want to be able to assign @i{names} to fields and columns, you need
  2000. to reserve the first column of the table for special marking characters.
  2001. @table @kbd
  2002. @kindex C-#
  2003. @item C-#
  2004. Rotate the calculation mark in first column through the states @samp{},
  2005. @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
  2006. change all marks in the region.
  2007. @end table
  2008. Here is an example of a table that collects exam results of students and
  2009. makes use of these features:
  2010. @example
  2011. @group
  2012. |---+---------+--------+--------+--------+-------+------|
  2013. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  2014. |---+---------+--------+--------+--------+-------+------|
  2015. | ! | | P1 | P2 | P3 | Tot | |
  2016. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  2017. | ^ | | m1 | m2 | m3 | mt | |
  2018. |---+---------+--------+--------+--------+-------+------|
  2019. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  2020. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  2021. |---+---------+--------+--------+--------+-------+------|
  2022. | | Average | | | | 29.7 | |
  2023. | ^ | | | | | at | |
  2024. | $ | max=50 | | | | | |
  2025. |---+---------+--------+--------+--------+-------+------|
  2026. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
  2027. @end group
  2028. @end example
  2029. @noindent @b{Important}: Please note that for these special tables,
  2030. recalculating the table with @kbd{C-u C-c *} will only affect rows that
  2031. are marked @samp{#} or @samp{*}, and fields that have a formula assigned
  2032. to the field itself. The column formulas are not applied in rows with
  2033. empty first field.
  2034. @cindex marking characters, tables
  2035. The marking characters have the following meaning:
  2036. @table @samp
  2037. @item !
  2038. The fields in this line define names for the columns, so that you may
  2039. refer to a column as @samp{$Tot} instead of @samp{$6}.
  2040. @item ^
  2041. This row defines names for the fields @emph{above} the row. With such
  2042. a definition, any formula in the table may use @samp{$m1} to refer to
  2043. the value @samp{10}. Also, if you assign a formula to a names field, it
  2044. will be stored as @samp{$name=...}.
  2045. @item _
  2046. Similar to @samp{^}, but defines names for the fields in the row
  2047. @emph{below}.
  2048. @item $
  2049. Fields in this row can define @emph{parameters} for formulas. For
  2050. example, if a field in a @samp{$} row contains @samp{max=50}, then
  2051. formulas in this table can refer to the value 50 using @samp{$max}.
  2052. Parameters work exactly like constants, only that they can be defined on
  2053. a per-table basis.
  2054. @item #
  2055. Fields in this row are automatically recalculated when pressing
  2056. @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
  2057. is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
  2058. lines will be left alone by this command.
  2059. @item *
  2060. Selects this line for global recalculation with @kbd{C-u C-c *}, but
  2061. not for automatic recalculation. Use this when automatic
  2062. recalculation slows down editing too much.
  2063. @item
  2064. Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
  2065. All lines that should be recalculated should be marked with @samp{#}
  2066. or @samp{*}.
  2067. @item /
  2068. Do not export this line. Useful for lines that contain the narrowing
  2069. @samp{<N>} markers.
  2070. @end table
  2071. Finally, just to whet your appetite on what can be done with the
  2072. fantastic @file{calc} package, here is a table that computes the Taylor
  2073. series of degree @code{n} at location @code{x} for a couple of
  2074. functions.
  2075. @example
  2076. @group
  2077. |---+-------------+---+-----+--------------------------------------|
  2078. | | Func | n | x | Result |
  2079. |---+-------------+---+-----+--------------------------------------|
  2080. | # | exp(x) | 1 | x | 1 + x |
  2081. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  2082. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  2083. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  2084. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  2085. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  2086. |---+-------------+---+-----+--------------------------------------|
  2087. #+TBLFM: $5=taylor($2,$4,$3);n3
  2088. @end group
  2089. @end example
  2090. @page
  2091. @node Org Plot, , The spreadsheet, Tables
  2092. @section Org Plot
  2093. @cindex graph, in tables
  2094. @cindex plot tables using gnuplot
  2095. Org Plot can produce 2D and 3D graphs of information stored in org tables
  2096. using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
  2097. @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
  2098. this in action ensure that you have both Gnuplot and Gnuplot-mode installed
  2099. on your system, then call @code{org-plot/gnuplot} on the following table.
  2100. @example
  2101. @group
  2102. #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
  2103. | Sede | Max cites | H-index |
  2104. |-----------+-----------+---------|
  2105. | Chile | 257.72 | 21.39 |
  2106. | Leeds | 165.77 | 19.68 |
  2107. | Sao Paolo | 71.00 | 11.50 |
  2108. | Stockholm | 134.19 | 14.33 |
  2109. | Morelia | 257.56 | 17.67 |
  2110. @end group
  2111. @end example
  2112. Notice that Org Plot is smart enough to apply the tables headers as labels.
  2113. Further control over the labels, type, content, and appearance of plots can
  2114. be exercised through the @code{#+Plot:} lines preceding a table. See below
  2115. for a complete list of Org plot options. For more information and examples
  2116. see the org-plot tutorial at
  2117. @uref{http://legito.org/worg/org-tutorials/org-plot.php}.
  2118. @subsubheading Plot Options
  2119. @table @code
  2120. @item set
  2121. Specify any @file{gnuplot} option to be set when graphing.
  2122. @item title
  2123. Specify the title of the plot.
  2124. @item ind
  2125. Specify which column of the table to use as the @code{x} axis.
  2126. @item deps
  2127. Specify the columns to graph as a lisp style list, surrounded by parenthesis
  2128. and separated by spaces for example @code{dep:(3 4)} to graph the third and
  2129. fourth columns (defaults to graphing all other columns aside from the ind
  2130. column).
  2131. @item type
  2132. Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
  2133. @item with
  2134. Specify a @code{with} option to be inserted for every col being plotted
  2135. (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
  2136. Defaults to 'lines'.
  2137. @item file
  2138. If you want to plot to a file specify the @code{"path/to/desired/output-file"}.
  2139. @item labels
  2140. List of labels to be used for the deps (defaults to column headers if they
  2141. exist).
  2142. @item line
  2143. Specify an entire line to be inserted in the gnuplot script.
  2144. @item map
  2145. When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
  2146. flat mapping rather than a @code{3d} slope.
  2147. @item timefmt
  2148. Specify format of org-mode timestamps as they will be parsed by gnuplot.
  2149. Defaults to '%Y-%m-%d-%H:%M:%S'.
  2150. @item script
  2151. If you want total control you can specify a script file (place the file name
  2152. between double quotes) which will be used to plot. Before plotting, every
  2153. instance of @code{$datafile} in the specified script will be replaced with
  2154. the path to the generated data file. Note even if you set this option you
  2155. may still want to specify the plot type, as that can impact the content of
  2156. the data file.
  2157. @end table
  2158. @node Hyperlinks, TODO Items, Tables, Top
  2159. @chapter Hyperlinks
  2160. @cindex hyperlinks
  2161. Like HTML, Org provides links inside a file, external links to
  2162. other files, Usenet articles, emails, and much more.
  2163. @menu
  2164. * Link format:: How links in Org are formatted
  2165. * Internal links:: Links to other places in the current file
  2166. * External links:: URL-like links to the world
  2167. * Handling links:: Creating, inserting and following
  2168. * Using links outside Org:: Linking from my C source code?
  2169. * Link abbreviations:: Shortcuts for writing complex links
  2170. * Search options:: Linking to a specific location
  2171. * Custom searches:: When the default search is not enough
  2172. @end menu
  2173. @node Link format, Internal links, Hyperlinks, Hyperlinks
  2174. @section Link format
  2175. @cindex link format
  2176. @cindex format, of links
  2177. Org will recognize plain URL-like links and activate them as
  2178. clickable links. The general link format, however, looks like this:
  2179. @example
  2180. [[link][description]] @r{or alternatively} [[link]]
  2181. @end example
  2182. Once a link in the buffer is complete (all brackets present), Org
  2183. will change the display so that @samp{description} is displayed instead
  2184. of @samp{[[link][description]]} and @samp{link} is displayed instead of
  2185. @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
  2186. which by default is an underlined face. You can directly edit the
  2187. visible part of a link. Note that this can be either the @samp{link}
  2188. part (if there is no description) or the @samp{description} part. To
  2189. edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
  2190. cursor on the link.
  2191. If you place the cursor at the beginning or just behind the end of the
  2192. displayed text and press @key{BACKSPACE}, you will remove the
  2193. (invisible) bracket at that location. This makes the link incomplete
  2194. and the internals are again displayed as plain text. Inserting the
  2195. missing bracket hides the link internals again. To show the
  2196. internal structure of all links, use the menu entry
  2197. @code{Org->Hyperlinks->Literal links}.
  2198. @node Internal links, External links, Link format, Hyperlinks
  2199. @section Internal links
  2200. @cindex internal links
  2201. @cindex links, internal
  2202. @cindex targets, for links
  2203. If the link does not look like a URL, it is considered to be internal in
  2204. the current file. Links such as @samp{[[My Target]]} or @samp{[[My
  2205. Target][Find my target]]} lead to a text search in the current file.
  2206. The link can be followed with @kbd{C-c C-o} when the cursor is on the
  2207. link, or with a mouse click (@pxref{Handling links}). The preferred
  2208. match for such a link is a dedicated target: the same string in double
  2209. angular brackets. Targets may be located anywhere; sometimes it is
  2210. convenient to put them into a comment line. For example
  2211. @example
  2212. # <<My Target>>
  2213. @end example
  2214. @noindent In HTML export (@pxref{HTML export}), such targets will become
  2215. named anchors for direct access through @samp{http} links@footnote{Note that
  2216. text before the first headline is usually not exported, so the first such
  2217. target should be after the first headline, or in the line directly before the
  2218. first headline.}.
  2219. If no dedicated target exists, Org will search for the words in the
  2220. link. In the above example the search would be for @samp{my target}.
  2221. Links starting with a star like @samp{*My Target} restrict the search to
  2222. headlines. When searching, Org mode will first try an exact match, but
  2223. then move on to more and more lenient searches. For example, the link
  2224. @samp{[[*My Targets]]} will find any of the following:
  2225. @example
  2226. ** My targets
  2227. ** TODO my targets are bright
  2228. ** my 20 targets are
  2229. @end example
  2230. To insert a link targeting a headline, in-buffer completion can be used.
  2231. Just type a star followed by a few optional letters into the buffer and
  2232. press @kbd{M-@key{TAB}}. All headlines in the current buffer will be
  2233. offered as completions. @xref{Handling links}, for more commands
  2234. creating links.
  2235. Following a link pushes a mark onto Org's own mark ring. You can
  2236. return to the previous position with @kbd{C-c &}. Using this command
  2237. several times in direct succession goes back to positions recorded
  2238. earlier.
  2239. @menu
  2240. * Radio targets:: Make targets trigger links in plain text
  2241. @end menu
  2242. @node Radio targets, , Internal links, Internal links
  2243. @subsection Radio targets
  2244. @cindex radio targets
  2245. @cindex targets, radio
  2246. @cindex links, radio targets
  2247. Org can automatically turn any occurrences of certain target names
  2248. in normal text into a link. So without explicitly creating a link, the
  2249. text connects to the target radioing its position. Radio targets are
  2250. enclosed by triple angular brackets. For example, a target @samp{<<<My
  2251. Target>>>} causes each occurrence of @samp{my target} in normal text to
  2252. become activated as a link. The Org file is scanned automatically
  2253. for radio targets only when the file is first loaded into Emacs. To
  2254. update the target list during editing, press @kbd{C-c C-c} with the
  2255. cursor on or at a target.
  2256. @node External links, Handling links, Internal links, Hyperlinks
  2257. @section External links
  2258. @cindex links, external
  2259. @cindex external links
  2260. @cindex links, external
  2261. @cindex Gnus links
  2262. @cindex BBDB links
  2263. @cindex IRC links
  2264. @cindex URL links
  2265. @cindex file links
  2266. @cindex VM links
  2267. @cindex RMAIL links
  2268. @cindex WANDERLUST links
  2269. @cindex MH-E links
  2270. @cindex USENET links
  2271. @cindex SHELL links
  2272. @cindex Info links
  2273. @cindex elisp links
  2274. Org supports links to files, websites, Usenet and email messages,
  2275. BBDB database entries and links to both IRC conversations and their
  2276. logs. External links are URL-like locators. They start with a short
  2277. identifying string followed by a colon. There can be no space after
  2278. the colon. The following list shows examples for each link type.
  2279. @example
  2280. http://www.astro.uva.nl/~dominik @r{on the web}
  2281. file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
  2282. /home/dominik/images/jupiter.jpg @r{same as above}
  2283. file:papers/last.pdf @r{file, relative path}
  2284. ./papers/last.pdf @r{same as above}
  2285. file:projects.org @r{another org file}
  2286. file:projects.org::some words @r{text search in org file}
  2287. file:projects.org::*task title @r{heading search in org file}
  2288. id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
  2289. news:comp.emacs @r{Usenet link}
  2290. mailto:adent@@galaxy.net @r{Mail link}
  2291. vm:folder @r{VM folder link}
  2292. vm:folder#id @r{VM message link}
  2293. vm://myself@@some.where.org/folder#id @r{VM on remote machine}
  2294. wl:folder @r{WANDERLUST folder link}
  2295. wl:folder#id @r{WANDERLUST message link}
  2296. mhe:folder @r{MH-E folder link}
  2297. mhe:folder#id @r{MH-E message link}
  2298. rmail:folder @r{RMAIL folder link}
  2299. rmail:folder#id @r{RMAIL message link}
  2300. gnus:group @r{Gnus group link}
  2301. gnus:group#id @r{Gnus article link}
  2302. bbdb:R.*Stallman @r{BBDB link (with regexp)}
  2303. irc:/irc.com/#emacs/bob @r{IRC link}
  2304. shell:ls *.org @r{A shell command}
  2305. elisp:org-agenda @r{Interactive elisp command}
  2306. elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
  2307. @end example
  2308. A link should be enclosed in double brackets and may contain a
  2309. descriptive text to be displayed instead of the URL (@pxref{Link
  2310. format}), for example:
  2311. @example
  2312. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  2313. @end example
  2314. @noindent
  2315. If the description is a file name or URL that points to an image, HTML
  2316. export (@pxref{HTML export}) will inline the image as a clickable
  2317. button. If there is no description at all and the link points to an
  2318. image,
  2319. that image will be inlined into the exported HTML file.
  2320. @cindex angular brackets, around links
  2321. @cindex plain text external links
  2322. Org also finds external links in the normal text and activates them
  2323. as links. If spaces must be part of the link (for example in
  2324. @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
  2325. about the end of the link, enclose them in angular brackets.
  2326. @node Handling links, Using links outside Org, External links, Hyperlinks
  2327. @section Handling links
  2328. @cindex links, handling
  2329. Org provides methods to create a link in the correct syntax, to
  2330. insert it into an Org file, and to follow the link.
  2331. @table @kbd
  2332. @kindex C-c l
  2333. @cindex storing links
  2334. @item C-c l
  2335. Store a link to the current location. This is a @emph{global} command (you
  2336. must create the key binding yourself) which can be used in any buffer to
  2337. create a link. The link will be stored for later insertion into an Org
  2338. buffer (see below).
  2339. For Org files, if there is a @samp{<<target>>} at the cursor, the link points
  2340. to the target. Otherwise it points to the current headline, either by text
  2341. (unsafe), or, if @file{org-id.el} is loaded and @code{org-link-to-org-use-id}
  2342. is set, by ID property.
  2343. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the link will
  2344. indicate the current article/entry. For W3 and W3M buffers, the link goes to
  2345. the current URL. For IRC links, if you set the variable
  2346. @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a
  2347. @samp{file:/} style link to the relevant point in the logs for the current
  2348. conversation. Otherwise an @samp{irc:/} style link to the user/channel/server
  2349. under the point will be stored.
  2350. For any other files, the link will point to the file, with a search string
  2351. (@pxref{Search options}) pointing to the contents of the current line. If
  2352. there is an active region, the selected words will form the basis of the
  2353. search string. If the automatically created link is not working correctly or
  2354. accurately enough, you can write custom functions to select the search string
  2355. and to do the search for particular file types - see @ref{Custom searches}.
  2356. The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}.
  2357. @c
  2358. @kindex C-c C-l
  2359. @cindex link completion
  2360. @cindex completion, of links
  2361. @cindex inserting links
  2362. @item C-c C-l
  2363. Insert a link. This prompts for a link to be inserted into the buffer. You
  2364. can just type a link, using text for an internal link, or one of the link
  2365. type prefixes mentioned in the examples above. All links stored during the
  2366. current session are part of the history for this prompt, so you can access
  2367. them with @key{up} and @key{down} (or @kbd{M-p/n}). Completion, on the other
  2368. hand, will help you to insert valid link prefixes like @samp{http:} or
  2369. @samp{ftp:}, including the prefixes defined through link abbreviations
  2370. (@pxref{Link abbreviations}). The link will be inserted into the
  2371. buffer@footnote{After insertion of a stored link, the link will be removed
  2372. from the list of stored links. To keep it in the list later use, use a
  2373. triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
  2374. @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
  2375. If some text was selected when this command is called, the selected text
  2376. becomes the default description.@* Note that you don't have to use this
  2377. command to insert a link. Links in Org are plain text, and you can type
  2378. or paste them straight into the buffer. By using this command, the links are
  2379. automatically enclosed in double brackets, and you will be asked for the
  2380. optional descriptive text.
  2381. @c
  2382. @c If the link is a @samp{file:} link and
  2383. @c the linked file is located in the same directory as the current file or
  2384. @c a subdirectory of it, the path of the file will be inserted relative to
  2385. @c the current directory.
  2386. @c
  2387. @kindex C-u C-c C-l
  2388. @cindex file name completion
  2389. @cindex completion, of file names
  2390. @item C-u C-c C-l
  2391. When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
  2392. a file will be inserted and you may use file name completion to select
  2393. the name of the file. The path to the file is inserted relative to the
  2394. directory of the current org file, if the linked file is in the current
  2395. directory or in a sub-directory of it, or if the path is written relative
  2396. to the current directory using @samp{../}. Otherwise an absolute path
  2397. is used, if possible with @samp{~/} for your home directory. You can
  2398. force an absolute path with two @kbd{C-u} prefixes.
  2399. @c
  2400. @item C-c C-l @r{(with cursor on existing link)}
  2401. When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
  2402. link and description parts of the link.
  2403. @c
  2404. @cindex following links
  2405. @kindex C-c C-o
  2406. @item C-c C-o
  2407. Open link at point. This will launch a web browser for URLs (using
  2408. @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
  2409. the corresponding links, and execute the command in a shell link. When the
  2410. cursor is on an internal link, this commands runs the corresponding search.
  2411. When the cursor is on a TAG list in a headline, it creates the corresponding
  2412. TAGS view. If the cursor is on a time stamp, it compiles the agenda for that
  2413. date. Furthermore, it will visit text and remote files in @samp{file:} links
  2414. with Emacs and select a suitable application for local non-text files.
  2415. Classification of files is based on file extension only. See option
  2416. @code{org-file-apps}. If you want to override the default application and
  2417. visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
  2418. opening in Emacs, use a @kbd{C-u C-u} prefix.
  2419. @c
  2420. @kindex mouse-2
  2421. @kindex mouse-1
  2422. @item mouse-2
  2423. @itemx mouse-1
  2424. On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
  2425. would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
  2426. @c
  2427. @kindex mouse-3
  2428. @item mouse-3
  2429. Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
  2430. internal links to be displayed in another window@footnote{See the
  2431. variable @code{org-display-internal-link-with-indirect-buffer}}.
  2432. @c
  2433. @cindex mark ring
  2434. @kindex C-c %
  2435. @item C-c %
  2436. Push the current position onto the mark ring, to be able to return
  2437. easily. Commands following an internal link do this automatically.
  2438. @c
  2439. @cindex links, returning to
  2440. @kindex C-c &
  2441. @item C-c &
  2442. Jump back to a recorded position. A position is recorded by the
  2443. commands following internal links, and by @kbd{C-c %}. Using this
  2444. command several times in direct succession moves through a ring of
  2445. previously recorded positions.
  2446. @c
  2447. @kindex C-c C-x C-n
  2448. @kindex C-c C-x C-p
  2449. @cindex links, finding next/previous
  2450. @item C-c C-x C-n
  2451. @itemx C-c C-x C-p
  2452. Move forward/backward to the next link in the buffer. At the limit of
  2453. the buffer, the search fails once, and then wraps around. The key
  2454. bindings for this are really too long, you might want to bind this also
  2455. to @kbd{C-n} and @kbd{C-p}
  2456. @lisp
  2457. (add-hook 'org-load-hook
  2458. (lambda ()
  2459. (define-key 'org-mode-map "\C-n" 'org-next-link)
  2460. (define-key 'org-mode-map "\C-p" 'org-previous-link)))
  2461. @end lisp
  2462. @end table
  2463. @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
  2464. @section Using links outside Org
  2465. You can insert and follow links that have Org syntax not only in
  2466. Org, but in any Emacs buffer. For this, you should create two
  2467. global commands, like this (please select suitable global keys
  2468. yourself):
  2469. @lisp
  2470. (global-set-key "\C-c L" 'org-insert-link-global)
  2471. (global-set-key "\C-c o" 'org-open-at-point-global)
  2472. @end lisp
  2473. @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
  2474. @section Link abbreviations
  2475. @cindex link abbreviations
  2476. @cindex abbreviation, links
  2477. Long URLs can be cumbersome to type, and often many similar links are
  2478. needed in a document. For this you can use link abbreviations. An
  2479. abbreviated link looks like this
  2480. @example
  2481. [[linkword:tag][description]]
  2482. @end example
  2483. @noindent
  2484. where the tag is optional. Such abbreviations are resolved according to
  2485. the information in the variable @code{org-link-abbrev-alist} that
  2486. relates the linkwords to replacement text. Here is an example:
  2487. @lisp
  2488. @group
  2489. (setq org-link-abbrev-alist
  2490. '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
  2491. ("google" . "http://www.google.com/search?q=")
  2492. ("ads" . "http://adsabs.harvard.edu/cgi-bin/
  2493. nph-abs_connect?author=%s&db_key=AST")))
  2494. @end group
  2495. @end lisp
  2496. If the replacement text contains the string @samp{%s}, it will be
  2497. replaced with the tag. Otherwise the tag will be appended to the string
  2498. in order to create the link. You may also specify a function that will
  2499. be called with the tag as the only argument to create the link.
  2500. With the above setting, you could link to a specific bug with
  2501. @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
  2502. @code{[[google:OrgMode]]} and find out what the Org author is
  2503. doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
  2504. If you need special abbreviations just for a single Org buffer, you
  2505. can define them in the file with
  2506. @example
  2507. #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
  2508. #+LINK: google http://www.google.com/search?q=%s
  2509. @end example
  2510. @noindent
  2511. In-buffer completion @pxref{Completion} can be used after @samp{[} to
  2512. complete link abbreviations.
  2513. @node Search options, Custom searches, Link abbreviations, Hyperlinks
  2514. @section Search options in file links
  2515. @cindex search option in file links
  2516. @cindex file links, searching
  2517. File links can contain additional information to make Emacs jump to a
  2518. particular location in the file when following a link. This can be a
  2519. line number or a search option after a double@footnote{For backward
  2520. compatibility, line numbers can also follow a single colon.} colon. For
  2521. example, when the command @kbd{C-c l} creates a link (@pxref{Handling
  2522. links}) to a file, it encodes the words in the current line as a search
  2523. string that can be used to find this line back later when following the
  2524. link with @kbd{C-c C-o}.
  2525. Here is the syntax of the different ways to attach a search to a file
  2526. link, together with an explanation:
  2527. @example
  2528. [[file:~/code/main.c::255]]
  2529. [[file:~/xx.org::My Target]]
  2530. [[file:~/xx.org::*My Target]]
  2531. [[file:~/xx.org::/regexp/]]
  2532. @end example
  2533. @table @code
  2534. @item 255
  2535. Jump to line 255.
  2536. @item My Target
  2537. Search for a link target @samp{<<My Target>>}, or do a text search for
  2538. @samp{my target}, similar to the search in internal links, see
  2539. @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
  2540. link will become an HTML reference to the corresponding named anchor in
  2541. the linked file.
  2542. @item *My Target
  2543. In an Org file, restrict search to headlines.
  2544. @item /regexp/
  2545. Do a regular expression search for @code{regexp}. This uses the Emacs
  2546. command @code{occur} to list all matches in a separate window. If the
  2547. target file is in Org mode, @code{org-occur} is used to create a
  2548. sparse tree with the matches.
  2549. @c If the target file is a directory,
  2550. @c @code{grep} will be used to search all files in the directory.
  2551. @end table
  2552. As a degenerate case, a file link with an empty file name can be used
  2553. to search the current file. For example, @code{[[file:::find me]]} does
  2554. a search for @samp{find me} in the current file, just as
  2555. @samp{[[find me]]} would.
  2556. @node Custom searches, , Search options, Hyperlinks
  2557. @section Custom Searches
  2558. @cindex custom search strings
  2559. @cindex search strings, custom
  2560. The default mechanism for creating search strings and for doing the
  2561. actual search related to a file link may not work correctly in all
  2562. cases. For example, BibTeX database files have many entries like
  2563. @samp{year="1993"} which would not result in good search strings,
  2564. because the only unique identification for a BibTeX entry is the
  2565. citation key.
  2566. If you come across such a problem, you can write custom functions to set
  2567. the right search string for a particular file type, and to do the search
  2568. for the string in the file. Using @code{add-hook}, these functions need
  2569. to be added to the hook variables
  2570. @code{org-create-file-search-functions} and
  2571. @code{org-execute-file-search-functions}. See the docstring for these
  2572. variables for more information. Org actually uses this mechanism
  2573. for Bib@TeX{} database files, and you can use the corresponding code as
  2574. an implementation example. See the file @file{org-bibtex.el}.
  2575. @node TODO Items, Tags, Hyperlinks, Top
  2576. @chapter TODO Items
  2577. @cindex TODO items
  2578. Org mode does not maintain TODO lists as separate documents@footnote{Of
  2579. course, you can make a document that contains only long lists of TODO items,
  2580. but this is not required.}. Instead, TODO items are an integral part of the
  2581. notes file, because TODO items usually come up while taking notes! With Org
  2582. mode, simply mark any entry in a tree as being a TODO item. In this way,
  2583. information is not duplicated, and the entire context from which the TODO
  2584. item emerged is always present.
  2585. Of course, this technique for managing TODO items scatters them
  2586. throughout your notes file. Org mode compensates for this by providing
  2587. methods to give you an overview of all the things that you have to do.
  2588. @menu
  2589. * TODO basics:: Marking and displaying TODO entries
  2590. * TODO extensions:: Workflow and assignments
  2591. * Progress logging:: Dates and notes for progress
  2592. * Priorities:: Some things are more important than others
  2593. * Breaking down tasks:: Splitting a task into manageable pieces
  2594. * Checkboxes:: Tick-off lists
  2595. @end menu
  2596. @node TODO basics, TODO extensions, TODO Items, TODO Items
  2597. @section Basic TODO functionality
  2598. Any headline becomes a TODO item when it starts with the word
  2599. @samp{TODO}, for example:
  2600. @example
  2601. *** TODO Write letter to Sam Fortune
  2602. @end example
  2603. @noindent
  2604. The most important commands to work with TODO entries are:
  2605. @table @kbd
  2606. @kindex C-c C-t
  2607. @cindex cycling, of TODO states
  2608. @item C-c C-t
  2609. Rotate the TODO state of the current item among
  2610. @example
  2611. ,-> (unmarked) -> TODO -> DONE --.
  2612. '--------------------------------'
  2613. @end example
  2614. The same rotation can also be done ``remotely'' from the timeline and
  2615. agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
  2616. @kindex C-u C-c C-t
  2617. @item C-u C-c C-t
  2618. Select a specific keyword using completion or (if it has been set up)
  2619. the fast selection interface. For the latter, you need to assign keys
  2620. to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
  2621. more information.
  2622. @kindex S-@key{right}
  2623. @kindex S-@key{left}
  2624. @item S-@key{right}
  2625. @itemx S-@key{left}
  2626. Select the following/preceding TODO state, similar to cycling. Useful
  2627. mostly if more than two TODO states are possible (@pxref{TODO
  2628. extensions}).
  2629. @kindex C-c C-v
  2630. @kindex C-c / t
  2631. @cindex sparse tree, for TODO
  2632. @item C-c C-v
  2633. @itemx C-c / t
  2634. View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
  2635. the entire buffer, but shows all TODO items and the headings hierarchy
  2636. above them. With a prefix argument, search for a specific TODO. You will be
  2637. prompted for the keyword, and you can also give a list of keywords like
  2638. @code{KWD1|KWD2|...}. With numeric prefix argument N, show the tree for the
  2639. Nth keyword in the variable @code{org-todo-keywords}. With two prefix
  2640. arguments, find all TODO and DONE entries.
  2641. @kindex C-c a t
  2642. @item C-c a t
  2643. Show the global TODO list. Collects the TODO items from all agenda
  2644. files (@pxref{Agenda Views}) into a single buffer. The new buffer will
  2645. be in @code{agenda-mode}, which provides commands to examine and
  2646. manipulate the TODO entries from the new buffer (@pxref{Agenda
  2647. commands}). @xref{Global TODO list}, for more information.
  2648. @kindex S-M-@key{RET}
  2649. @item S-M-@key{RET}
  2650. Insert a new TODO entry below the current one.
  2651. @end table
  2652. @noindent
  2653. Changing a TODO state can also trigger tag changes. See the docstring of the
  2654. option @code{org-todo-state-tags-triggers} for details.
  2655. @node TODO extensions, Progress logging, TODO basics, TODO Items
  2656. @section Extended use of TODO keywords
  2657. @cindex extended TODO keywords
  2658. By default, marked TODO entries have one of only two states: TODO and
  2659. DONE. Org mode allows you to classify TODO items in more complex ways
  2660. with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
  2661. special setup, the TODO keyword system can work differently in different
  2662. files.
  2663. Note that @i{tags} are another way to classify headlines in general and
  2664. TODO items in particular (@pxref{Tags}).
  2665. @menu
  2666. * Workflow states:: From TODO to DONE in steps
  2667. * TODO types:: I do this, Fred does the rest
  2668. * Multiple sets in one file:: Mixing it all, and still finding your way
  2669. * Fast access to TODO states:: Single letter selection of a state
  2670. * Per-file keywords:: Different files, different requirements
  2671. * Faces for TODO keywords:: Highlighting states
  2672. @end menu
  2673. @node Workflow states, TODO types, TODO extensions, TODO extensions
  2674. @subsection TODO keywords as workflow states
  2675. @cindex TODO workflow
  2676. @cindex workflow states as TODO keywords
  2677. You can use TODO keywords to indicate different @emph{sequential} states
  2678. in the process of working on an item, for example@footnote{Changing
  2679. this variable only becomes effective after restarting Org mode in a
  2680. buffer.}:
  2681. @lisp
  2682. (setq org-todo-keywords
  2683. '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
  2684. @end lisp
  2685. The vertical bar separates the TODO keywords (states that @emph{need
  2686. action}) from the DONE states (which need @emph{no further action}). If
  2687. you don't provide the separator bar, the last state is used as the DONE
  2688. state.
  2689. @cindex completion, of TODO keywords
  2690. With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
  2691. to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
  2692. also use a numeric prefix argument to quickly select a specific state. For
  2693. example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
  2694. Or you can use @kbd{S-left} to go backward through the sequence. If you
  2695. define many keywords, you can use in-buffer completion
  2696. (@pxref{Completion}) or even a special one-key selection scheme
  2697. (@pxref{Fast access to TODO states}) to insert these words into the
  2698. buffer. Changing a TODO state can be logged with a timestamp, see
  2699. @ref{Tracking TODO state changes} for more information.
  2700. @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
  2701. @subsection TODO keywords as types
  2702. @cindex TODO types
  2703. @cindex names as TODO keywords
  2704. @cindex types as TODO keywords
  2705. The second possibility is to use TODO keywords to indicate different
  2706. @emph{types} of action items. For example, you might want to indicate
  2707. that items are for ``work'' or ``home''. Or, when you work with several
  2708. people on a single project, you might want to assign action items
  2709. directly to persons, by using their names as TODO keywords. This would
  2710. be set up like this:
  2711. @lisp
  2712. (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
  2713. @end lisp
  2714. In this case, different keywords do not indicate a sequence, but rather
  2715. different types. So the normal work flow would be to assign a task to a
  2716. person, and later to mark it DONE. Org mode supports this style by adapting
  2717. the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
  2718. @kbd{t} command in the timeline and agenda buffers.}. When used several
  2719. times in succession, it will still cycle through all names, in order to first
  2720. select the right type for a task. But when you return to the item after some
  2721. time and execute @kbd{C-c C-t} again, it will switch from any name directly
  2722. to DONE. Use prefix arguments or completion to quickly select a specific
  2723. name. You can also review the items of a specific TODO type in a sparse tree
  2724. by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things
  2725. Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items
  2726. from all agenda files into a single buffer, you would use the numeric prefix
  2727. argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
  2728. @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
  2729. @subsection Multiple keyword sets in one file
  2730. @cindex TODO keyword sets
  2731. Sometimes you may want to use different sets of TODO keywords in
  2732. parallel. For example, you may want to have the basic
  2733. @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
  2734. separate state indicating that an item has been canceled (so it is not
  2735. DONE, but also does not require action). Your setup would then look
  2736. like this:
  2737. @lisp
  2738. (setq org-todo-keywords
  2739. '((sequence "TODO" "|" "DONE")
  2740. (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
  2741. (sequence "|" "CANCELED")))
  2742. @end lisp
  2743. The keywords should all be different, this helps Org mode to keep track
  2744. of which subsequence should be used for a given entry. In this setup,
  2745. @kbd{C-c C-t} only operates within a subsequence, so it switches from
  2746. @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
  2747. (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
  2748. select the correct sequence. Besides the obvious ways like typing a
  2749. keyword or using completion, you may also apply the following commands:
  2750. @table @kbd
  2751. @kindex C-S-@key{right}
  2752. @kindex C-S-@key{left}
  2753. @item C-S-@key{right}
  2754. @itemx C-S-@key{left}
  2755. These keys jump from one TODO subset to the next. In the above example,
  2756. @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to
  2757. @code{REPORT}, and any of the words in the second row to @code{CANCELED}.
  2758. @kindex S-@key{right}
  2759. @kindex S-@key{left}
  2760. @item S-@key{right}
  2761. @itemx S-@key{left}
  2762. @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through
  2763. @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}}
  2764. would switch from @code{DONE} to @code{REPORT} in the example above.
  2765. @end table
  2766. @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
  2767. @subsection Fast access to TODO states
  2768. If you would like to quickly change an entry to an arbitrary TODO state
  2769. instead of cycling through the states, you can set up keys for
  2770. single-letter access to the states. This is done by adding the section
  2771. key after each keyword, in parenthesis. For example:
  2772. @lisp
  2773. (setq org-todo-keywords
  2774. '((sequence "TODO(t)" "|" "DONE(d)")
  2775. (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
  2776. (sequence "|" "CANCELED(c)")))
  2777. @end lisp
  2778. If you then press @code{C-u C-c C-t} followed by the selection key, the
  2779. entry will be switched to this state. @key{SPC} can be used to remove
  2780. any TODO keyword from an entry. Should you like this way of selecting
  2781. TODO states a lot, you might want to set the variable
  2782. @code{org-use-fast-todo-selection} to @code{t} and make this behavior
  2783. the default. Check also the variable
  2784. @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
  2785. state through the tags interface (@pxref{Setting tags}), in case you
  2786. like to mingle the two concepts.
  2787. @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
  2788. @subsection Setting up keywords for individual files
  2789. @cindex keyword options
  2790. @cindex per-file keywords
  2791. It can be very useful to use different aspects of the TODO mechanism in
  2792. different files. For file-local settings, you need to add special lines
  2793. to the file which set the keywords and interpretation for that file
  2794. only. For example, to set one of the two examples discussed above, you
  2795. need one of the following lines, starting in column zero anywhere in the
  2796. file:
  2797. @example
  2798. #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
  2799. @end example
  2800. or
  2801. @example
  2802. #+TYP_TODO: Fred Sara Lucy Mike | DONE
  2803. @end example
  2804. A setup for using several sets in parallel would be:
  2805. @example
  2806. #+SEQ_TODO: TODO | DONE
  2807. #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
  2808. #+SEQ_TODO: | CANCELED
  2809. @end example
  2810. @cindex completion, of option keywords
  2811. @kindex M-@key{TAB}
  2812. @noindent To make sure you are using the correct keyword, type
  2813. @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
  2814. @cindex DONE, final TODO keyword
  2815. Remember that the keywords after the vertical bar (or the last keyword
  2816. if no bar is there) must always mean that the item is DONE (although you
  2817. may use a different word). After changing one of these lines, use
  2818. @kbd{C-c C-c} with the cursor still in the line to make the changes
  2819. known to Org mode@footnote{Org mode parses these lines only when
  2820. Org mode is activated after visiting a file. @kbd{C-c C-c} with the
  2821. cursor in a line starting with @samp{#+} is simply restarting Org mode
  2822. for the current buffer.}.
  2823. @node Faces for TODO keywords, , Per-file keywords, TODO extensions
  2824. @subsection Faces for TODO keywords
  2825. @cindex faces, for TODO keywords
  2826. Org mode highlights TODO keywords with special faces: @code{org-todo}
  2827. for keywords indicating that an item still has to be acted upon, and
  2828. @code{org-done} for keywords indicating that an item is finished. If
  2829. you are using more than 2 different states, you might want to use
  2830. special faces for some of them. This can be done using the variable
  2831. @code{org-todo-keyword-faces}. For example:
  2832. @lisp
  2833. @group
  2834. (setq org-todo-keyword-faces
  2835. '(("TODO" . org-warning)
  2836. ("DEFERRED" . shadow)
  2837. ("CANCELED" . (:foreground "blue" :weight bold))))
  2838. @end group
  2839. @end lisp
  2840. While using a list with face properties as shown for CANCELED
  2841. @emph{should} work, this does not aways seem to be the case. If
  2842. necessary, define a special face and use that.
  2843. @page
  2844. @node Progress logging, Priorities, TODO extensions, TODO Items
  2845. @section Progress logging
  2846. @cindex progress logging
  2847. @cindex logging, of progress
  2848. Org mode can automatically record a time stamp and possibly a note when
  2849. you mark a TODO item as DONE, or even each time you change the state of
  2850. a TODO item. This system is highly configurable, settings can be on a
  2851. per-keyword basis and can be localized to a file or even a subtree. For
  2852. information on how to clock working time for a task, see @ref{Clocking
  2853. work time}.
  2854. @menu
  2855. * Closing items:: When was this entry marked DONE?
  2856. * Tracking TODO state changes:: When did the status change?
  2857. @end menu
  2858. @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
  2859. @subsection Closing items
  2860. The most basic logging is to keep track of @emph{when} a certain TODO
  2861. item was finished. This is achieved with@footnote{The corresponding
  2862. in-buffer setting is: @code{#+STARTUP: logdone}}.
  2863. @lisp
  2864. (setq org-log-done 'time)
  2865. @end lisp
  2866. @noindent
  2867. Then each time you turn an entry from a TODO (not-done) state into any
  2868. of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
  2869. just after the headline. If you turn the entry back into a TODO item
  2870. through further state cycling, that line will be removed again. If you
  2871. want to record a note along with the timestamp, use@footnote{The
  2872. corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
  2873. @lisp
  2874. (setq org-log-done 'note)
  2875. @end lisp
  2876. @noindent
  2877. You will then be prompted for a note, and that note will be stored below
  2878. the entry with a @samp{Closing Note} heading.
  2879. In the timeline (@pxref{Timeline}) and in the agenda
  2880. (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
  2881. display the TODO items with a @samp{CLOSED} timestamp on each day,
  2882. giving you an overview of what has been done.
  2883. @node Tracking TODO state changes, , Closing items, Progress logging
  2884. @subsection Tracking TODO state changes
  2885. When TODO keywords are used as workflow states (@pxref{Workflow
  2886. states}), you might want to keep track of when a state change occurred
  2887. and maybe take a note about this change. Since it is normally too much
  2888. to record a note for every state, Org mode expects configuration on a
  2889. per-keyword basis for this. This is achieved by adding special markers
  2890. @samp{!} (for a time stamp) and @samp{@@} (for a note) in parenthesis
  2891. after each keyword. For example, with the setting
  2892. @lisp
  2893. (setq org-todo-keywords
  2894. '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
  2895. @end lisp
  2896. @noindent
  2897. you not only define global TODO keywords and fast access keys, but also
  2898. request that a time is recorded when the entry is turned into
  2899. DONE@footnote{It is possible that Org mode will record two time stamps
  2900. when you are using both @code{org-log-done} and state change logging.
  2901. However, it will never prompt for two notes - if you have configured
  2902. both, the state change recording note will take precedence and cancel
  2903. the @samp{Closing Note}.}, and that a note is recorded when switching to
  2904. WAIT or CANCELED. The setting for WAIT is even more special: The
  2905. @samp{!} after the slash means that in addition to the note taken when
  2906. entering the state, a time stamp should be recorded when @i{leaving} the
  2907. WAIT state, if and only if the @i{target} state does not configure
  2908. logging for entering it. So it has no effect when switching from WAIT
  2909. to DONE, because DONE is configured to record a timestamp only. But
  2910. when switching from WAIT back to TODO, the @samp{/!} in the WAIT
  2911. setting now triggers a timestamp even though TODO has no logging
  2912. configured.
  2913. You can use the exact same syntax for setting logging preferences local
  2914. to a buffer:
  2915. @example
  2916. #+SEQ_TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
  2917. @end example
  2918. In order to define logging settings that are local to a subtree or a
  2919. single item, define a LOGGING property in this entry. Any non-empty
  2920. LOGGING property resets all logging settings to nil. You may then turn
  2921. on logging for this specific tree using STARTUP keywords like
  2922. @code{lognotedone} or @code{logrepeat}, as well as adding state specific
  2923. settings like @code{TODO(!)}. For example
  2924. @example
  2925. * TODO Log each state with only a time
  2926. :PROPERTIES:
  2927. :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
  2928. :END:
  2929. * TODO Only log when switching to WAIT, and when repeating
  2930. :PROPERTIES:
  2931. :LOGGING: WAIT(@@) logrepeat
  2932. :END:
  2933. * TODO No logging at all
  2934. :PROPERTIES:
  2935. :LOGGING: nil
  2936. :END:
  2937. @end example
  2938. @node Priorities, Breaking down tasks, Progress logging, TODO Items
  2939. @section Priorities
  2940. @cindex priorities
  2941. If you use Org mode extensively, you may end up enough TODO items that
  2942. it starts to make sense to prioritize them. Prioritizing can be done by
  2943. placing a @emph{priority cookie} into the headline of a TODO item, like
  2944. this
  2945. @example
  2946. *** TODO [#A] Write letter to Sam Fortune
  2947. @end example
  2948. @noindent
  2949. By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
  2950. @samp{C}. @samp{A} is the highest priority. An entry without a cookie
  2951. is treated as priority @samp{B}. Priorities make a difference only in
  2952. the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
  2953. no inherent meaning to Org mode.
  2954. Priorities can be attached to any outline tree entries; they do not need
  2955. to be TODO items.
  2956. @table @kbd
  2957. @kindex @kbd{C-c ,}
  2958. @item @kbd{C-c ,}
  2959. Set the priority of the current headline. The command prompts for a
  2960. priority character @samp{A}, @samp{B} or @samp{C}. When you press
  2961. @key{SPC} instead, the priority cookie is removed from the headline.
  2962. The priorities can also be changed ``remotely'' from the timeline and
  2963. agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
  2964. @c
  2965. @kindex S-@key{up}
  2966. @kindex S-@key{down}
  2967. @item S-@key{up}
  2968. @itemx S-@key{down}
  2969. Increase/decrease priority of current headline@footnote{See also the
  2970. option @code{org-priority-start-cycle-with-default'}.}. Note that these
  2971. keys are also used to modify time stamps (@pxref{Creating timestamps}).
  2972. Furthermore, these keys are also used by CUA mode (@pxref{Conflicts}).
  2973. @end table
  2974. You can change the range of allowed priorities by setting the variables
  2975. @code{org-highest-priority}, @code{org-lowest-priority}, and
  2976. @code{org-default-priority}. For an individual buffer, you may set
  2977. these values (highest, lowest, default) like this (please make sure that
  2978. the highest priority is earlier in the alphabet than the lowest
  2979. priority):
  2980. @example
  2981. #+PRIORITIES: A C B
  2982. @end example
  2983. @node Breaking down tasks, Checkboxes, Priorities, TODO Items
  2984. @section Breaking tasks down into subtasks
  2985. @cindex tasks, breaking down
  2986. It is often advisable to break down large tasks into smaller, manageable
  2987. subtasks. You can do this by creating an outline tree below a TODO item,
  2988. with detailed subtasks on the tree@footnote{To keep subtasks out of the
  2989. global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
  2990. the overview over the fraction of subtasks that are already completed, insert
  2991. either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
  2992. be updates each time the todo status of a child changes. For example:
  2993. @example
  2994. * Organize Party [33%]
  2995. ** TODO Call people [1/2]
  2996. *** TODO Peter
  2997. *** DONE Sarah
  2998. ** TODO Buy food
  2999. ** DONE Talk to neighbor
  3000. @end example
  3001. If you would like a TODO entry to automatically change to DONE when all
  3002. children are done, you can use the following setup:
  3003. @example
  3004. (defun org-summary-todo (n-done n-not-done)
  3005. "Switch entry to DONE when all subentries are done, to TODO otherwise."
  3006. (let (org-log-done org-log-states) ; turn off logging
  3007. (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
  3008. (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
  3009. @end example
  3010. Another possibility is the use of checkboxes to identify (a hierarchy of) a
  3011. large number of subtasks (@pxref{Checkboxes}).
  3012. @node Checkboxes, , Breaking down tasks, TODO Items
  3013. @section Checkboxes
  3014. @cindex checkboxes
  3015. Every item in a plain list (@pxref{Plain lists}) can be made into a
  3016. checkbox by starting it with the string @samp{[ ]}. This feature is
  3017. similar to TODO items (@pxref{TODO Items}), but is more lightweight.
  3018. Checkboxes are not included into the global TODO list, so they are often
  3019. great to split a task into a number of simple steps. Or you can use
  3020. them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
  3021. use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
  3022. Here is an example of a checkbox list.
  3023. @example
  3024. * TODO Organize party [2/4]
  3025. - [-] call people [1/3]
  3026. - [ ] Peter
  3027. - [X] Sarah
  3028. - [ ] Sam
  3029. - [X] order food
  3030. - [ ] think about what music to play
  3031. - [X] talk to the neighbors
  3032. @end example
  3033. Checkboxes work hierarchically, so if a checkbox item has children that
  3034. are checkboxes, toggling one of the children checkboxes will make the
  3035. parent checkbox reflect if none, some, or all of the children are
  3036. checked.
  3037. @cindex statistics, for checkboxes
  3038. @cindex checkbox statistics
  3039. The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
  3040. cookies indicating how many checkboxes present in this entry have been
  3041. checked off, and the total number of checkboxes are present. This can
  3042. give you an idea on how many checkboxes remain, even without opening a
  3043. folded entry. The cookies can be placed into a headline or into (the
  3044. first line of) a plain list item. Each cookie covers all checkboxes
  3045. structurally below the headline/item on which the cookie appear. You
  3046. have to insert the cookie yourself by typing either @samp{[/]} or
  3047. @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as in
  3048. the examples above. With @samp{[%]} you get information about the
  3049. percentage of checkboxes checked (in the above example, this would be
  3050. @samp{[50%]} and @samp{[33%]}, respectively).
  3051. @noindent The following commands work with checkboxes:
  3052. @table @kbd
  3053. @kindex C-c C-c
  3054. @item C-c C-c
  3055. Toggle checkbox at point. With a prefix argument, set it to @samp{[-]},
  3056. which is considered to be an intermediate state.
  3057. @kindex C-c C-x C-b
  3058. @item C-c C-x C-b
  3059. Toggle checkbox at point.
  3060. @itemize @minus
  3061. @item
  3062. If there is an active region, toggle the first checkbox in the region
  3063. and set all remaining boxes to the same status as the first. If you
  3064. want to toggle all boxes in the region independently, use a prefix
  3065. argument.
  3066. @item
  3067. If the cursor is in a headline, toggle checkboxes in the region between
  3068. this headline and the next (so @emph{not} the entire subtree).
  3069. @item
  3070. If there is no active region, just toggle the checkbox at point.
  3071. @end itemize
  3072. @kindex M-S-@key{RET}
  3073. @item M-S-@key{RET}
  3074. Insert a new item with a checkbox.
  3075. This works only if the cursor is already in a plain list item
  3076. (@pxref{Plain lists}).
  3077. @kindex C-c #
  3078. @item C-c #
  3079. Update the checkbox statistics in the current outline entry. When
  3080. called with a @kbd{C-u} prefix, update the entire file. Checkbox
  3081. statistic cookies are updated automatically if you toggle checkboxes
  3082. with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you
  3083. delete boxes or add/change them by hand, use this command to get things
  3084. back into sync. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
  3085. @end table
  3086. @node Tags, Properties and Columns, TODO Items, Top
  3087. @chapter Tags
  3088. @cindex tags
  3089. @cindex headline tagging
  3090. @cindex matching, tags
  3091. @cindex sparse tree, tag based
  3092. An excellent way to implement labels and contexts for cross-correlating
  3093. information is to assign @i{tags} to headlines. Org mode has extensive
  3094. support for tags.
  3095. Every headline can contain a list of tags; they occur at the end of the
  3096. headline. Tags are normal words containing letters, numbers, @samp{_}, and
  3097. @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
  3098. @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
  3099. Tags will by default get a bold face with the same color as the headline.
  3100. You may specify special faces for specific tags using the variable
  3101. @code{org-tag-faces}, much in the same way as you can do for TODO keywords
  3102. (@pxref{Faces for TODO keywords}).
  3103. @menu
  3104. * Tag inheritance:: Tags use the tree structure of the outline
  3105. * Setting tags:: How to assign tags to a headline
  3106. * Tag searches:: Searching for combinations of tags
  3107. @end menu
  3108. @node Tag inheritance, Setting tags, Tags, Tags
  3109. @section Tag inheritance
  3110. @cindex tag inheritance
  3111. @cindex inheritance, of tags
  3112. @cindex sublevels, inclusion into tags match
  3113. @i{Tags} make use of the hierarchical structure of outline trees. If a
  3114. heading has a certain tag, all subheadings will inherit the tag as
  3115. well. For example, in the list
  3116. @example
  3117. * Meeting with the French group :work:
  3118. ** Summary by Frank :boss:notes:
  3119. *** TODO Prepare slides for him :action:
  3120. @end example
  3121. @noindent
  3122. the final heading will have the tags @samp{:work:}, @samp{:boss:},
  3123. @samp{:notes:}, and @samp{:action:} even though the final heading is not
  3124. explicitly marked with those tags. You can also set tags that all entries in
  3125. a file should inherit as if these tags would be defined in a hypothetical
  3126. level zero that surrounds the entire file.
  3127. @example
  3128. #+FILETAGS: :Peter:Boss:Secret:
  3129. @end example
  3130. @noindent
  3131. To limit tag inheritance to specific tags, or to turn it off entirely, use
  3132. the variables @code{org-use-tag-inheritance} and
  3133. @code{org-tags-exclude-from-inheritance}.
  3134. When a headline matches during a tags search while tag inheritance is turned
  3135. on, all the sublevels in the same tree will (for a simple match form) match
  3136. as well@footnote{This is only true if the search does not involve more
  3137. complex tests including properties (@pxref{Property searches}).}. The list
  3138. of matches may then become very long. If you only want to see the first tags
  3139. match in a subtree, configure the variable
  3140. @code{org-tags-match-list-sublevels} (not recommended).
  3141. @node Setting tags, Tag searches, Tag inheritance, Tags
  3142. @section Setting tags
  3143. @cindex setting tags
  3144. @cindex tags, setting
  3145. @kindex M-@key{TAB}
  3146. Tags can simply be typed into the buffer at the end of a headline.
  3147. After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
  3148. also a special command for inserting tags:
  3149. @table @kbd
  3150. @kindex C-c C-q
  3151. @item C-c C-q
  3152. @cindex completion, of tags
  3153. Enter new tags for the current headline. Org mode will either offer
  3154. completion or a special single-key interface for setting tags, see
  3155. below. After pressing @key{RET}, the tags will be inserted and aligned
  3156. to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
  3157. tags in the current buffer will be aligned to that column, just to make
  3158. things look nice. TAGS are automatically realigned after promotion,
  3159. demotion, and TODO state changes (@pxref{TODO basics}).
  3160. @kindex C-c C-c
  3161. @item C-c C-c
  3162. When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
  3163. @end table
  3164. Org will support tag insertion based on a @emph{list of tags}. By
  3165. default this list is constructed dynamically, containing all tags
  3166. currently used in the buffer. You may also globally specify a hard list
  3167. of tags with the variable @code{org-tag-alist}. Finally you can set
  3168. the default tags for a given file with lines like
  3169. @example
  3170. #+TAGS: @@work @@home @@tennisclub
  3171. #+TAGS: laptop car pc sailboat
  3172. @end example
  3173. If you have globally defined your preferred set of tags using the
  3174. variable @code{org-tag-alist}, but would like to use a dynamic tag list
  3175. in a specific file, add an empty TAGS option line to that file:
  3176. @example
  3177. #+TAGS:
  3178. @end example
  3179. By default Org mode uses the standard minibuffer completion facilities for
  3180. entering tags. However, it also implements another, quicker, tag selection
  3181. method called @emph{fast tag selection}. This allows you to select and
  3182. deselect tags with just a single key press. For this to work well you should
  3183. assign unique letters to most of your commonly used tags. You can do this
  3184. globally by configuring the variable @code{org-tag-alist} in your
  3185. @file{.emacs} file. For example, you may find the need to tag many items in
  3186. different files with @samp{:@@home:}. In this case you can set something
  3187. like:
  3188. @lisp
  3189. (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
  3190. @end lisp
  3191. @noindent If the tag is only relevant to the file you are working on then you
  3192. can, instead, set the TAGS option line as:
  3193. @example
  3194. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
  3195. @end example
  3196. @noindent
  3197. You can also group together tags that are mutually exclusive. By using
  3198. braces, as in:
  3199. @example
  3200. #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
  3201. @end example
  3202. @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
  3203. and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
  3204. @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
  3205. these lines to activate any changes.
  3206. @noindent
  3207. To set these mutually exclusive groups in the variable @code{org-mode-alist}
  3208. you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
  3209. of the braces. The previous example would be set globally by the following
  3210. configuration:
  3211. @lisp
  3212. (setq org-tag-alist '((:startgroup . nil)
  3213. ("@@work" . ?w) ("@@home" . ?h)
  3214. ("@@tennisclub" . ?t)
  3215. (:endgroup . nil)
  3216. ("laptop" . ?l) ("pc" . ?p)))
  3217. @end lisp
  3218. If at least one tag has a selection key then pressing @kbd{C-c C-c} will
  3219. automatically present you with a special interface, listing inherited tags,
  3220. the tags of the current headline, and a list of all valid tags with
  3221. corresponding keys@footnote{Keys will automatically be assigned to tags which
  3222. have no configured keys.}. In this interface, you can use the following
  3223. keys:
  3224. @table @kbd
  3225. @item a-z...
  3226. Pressing keys assigned to tags will add or remove them from the list of
  3227. tags in the current line. Selecting a tag in a group of mutually
  3228. exclusive tags will turn off any other tags from that group.
  3229. @kindex @key{TAB}
  3230. @item @key{TAB}
  3231. Enter a tag in the minibuffer, even if the tag is not in the predefined
  3232. list. You will be able to complete on all tags present in the buffer.
  3233. @kindex @key{SPC}
  3234. @item @key{SPC}
  3235. Clear all tags for this line.
  3236. @kindex @key{RET}
  3237. @item @key{RET}
  3238. Accept the modified set.
  3239. @item C-g
  3240. Abort without installing changes.
  3241. @item q
  3242. If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
  3243. @item !
  3244. Turn off groups of mutually exclusive tags. Use this to (as an
  3245. exception) assign several tags from such a group.
  3246. @item C-c
  3247. Toggle auto-exit after the next change (see below).
  3248. If you are using expert mode, the first @kbd{C-c} will display the
  3249. selection window.
  3250. @end table
  3251. @noindent
  3252. This method lets you assign tags to a headline with very few keys. With
  3253. the above setup, you could clear the current tags and set @samp{@@home},
  3254. @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
  3255. C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
  3256. @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
  3257. alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
  3258. @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
  3259. @key{RET} @key{RET}}.
  3260. If you find that most of the time, you need only a single key press to
  3261. modify your list of tags, set the variable
  3262. @code{org-fast-tag-selection-single-key}. Then you no longer have to
  3263. press @key{RET} to exit fast tag selection - it will immediately exit
  3264. after the first change. If you then occasionally need more keys, press
  3265. @kbd{C-c} to turn off auto-exit for the current tag selection process
  3266. (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
  3267. C-c}). If you set the variable to the value @code{expert}, the special
  3268. window is not even shown for single-key tag selection, it comes up only
  3269. when you press an extra @kbd{C-c}.
  3270. @node Tag searches, , Setting tags, Tags
  3271. @section Tag searches
  3272. @cindex tag searches
  3273. @cindex searching for tags
  3274. Once a system of tags has been set up, it can be used to collect related
  3275. information into special lists.
  3276. @table @kbd
  3277. @kindex C-c \
  3278. @kindex C-c / T
  3279. @item C-c \
  3280. @itemx C-c / T
  3281. Create a sparse tree with all headlines matching a tags search. With a
  3282. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  3283. @kindex C-c a m
  3284. @item C-c a m
  3285. Create a global list of tag matches from all agenda files.
  3286. @xref{Matching tags and properties}.
  3287. @kindex C-c a M
  3288. @item C-c a M
  3289. Create a global list of tag matches from all agenda files, but check
  3290. only TODO items and force checking subitems (see variable
  3291. @code{org-tags-match-list-sublevels}).
  3292. @end table
  3293. @cindex Boolean logic, for tag searches
  3294. A @i{tags} search string can use Boolean operators @samp{&} for AND and
  3295. @samp{|} for OR. @samp{&} binds more strongly than @samp{|}.
  3296. Parenthesis are currently not implemented. A tag may also be preceded
  3297. by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
  3298. positive selection. The AND operator @samp{&} is optional when @samp{+}
  3299. or @samp{-} is present. Examples:
  3300. @table @samp
  3301. @item +work-boss
  3302. Select headlines tagged @samp{:work:}, but discard those also tagged
  3303. @samp{:boss:}.
  3304. @item work|laptop
  3305. Selects lines tagged @samp{:work:} or @samp{:laptop:}.
  3306. @item work|laptop&night
  3307. Like before, but require the @samp{:laptop:} lines to be tagged also
  3308. @samp{:night:}.
  3309. @end table
  3310. @cindex TODO keyword matching, with tags search
  3311. You may also test for TODO keywords (@pxref{TODO extensions}) and properties
  3312. (@pxref{Properties and Columns}) at the same time as matching tags. For a
  3313. guide on how to match properties, see @ref{Property searches}. To match a
  3314. specific TODO keyword, include an expression like @samp{+TODO="NEXT"} as one
  3315. of the terms in a tags search.
  3316. There is also the possibility to end the tags part of the match (which may
  3317. include several terms connected with @samp{|}) with a @samp{/} and then
  3318. specify a Boolean expression just for TODO keywords. The syntax is then
  3319. similar to the tag matches, but should be applied with consideration: For
  3320. example, a positive selection on several TODO keywords can not meaningfully
  3321. be combined with boolean AND. However, @emph{negative selection} combined
  3322. with AND can be meaningful. To make sure that only lines are checked that
  3323. actually have any TODO keyword (resulting in a speed-up), use @kbd{C-c a M},
  3324. or equivalently start the TODO part after the slash with @samp{!}. Examples:
  3325. @table @samp
  3326. @item work+TODO="WAITING"
  3327. Select @samp{:work:}-tagged TODO lines with the specific TODO
  3328. keyword @samp{WAITING}.
  3329. @item work+TODO="WAITING"|home+TODO="WAITING"
  3330. Waiting tasks both at work and at home.
  3331. @item work/WAITING
  3332. Same as the first example.
  3333. @item work/!-WAITING-NEXT
  3334. Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
  3335. nor @samp{NEXT}
  3336. @item work/!+WAITING|+NEXT
  3337. Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
  3338. @samp{NEXT}.
  3339. @end table
  3340. @cindex regular expressions, with tags search
  3341. Any element of the tag/todo match can be a regular expression - in this
  3342. case it must be enclosed in curly braces. For example,
  3343. @samp{work+@{^boss.*@}} matches headlines that contain the tag
  3344. @samp{:work:} and any tag @i{starting} with @samp{boss}. You may also use a
  3345. regular expression in @samp{TODO=@{^W@}} which would match TODO keywords
  3346. starting with the letter @samp{W}.
  3347. @cindex level, require for tags/property match
  3348. @cindex category, require for tags/property match
  3349. You can also require a headline to be of a certain level or category, by
  3350. writing instead of any TAG an expression like @samp{LEVEL=3} or
  3351. @samp{CATEGORY="work"}, respectively. For example, a search
  3352. @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the
  3353. tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE.
  3354. Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
  3355. other properties will slow down the search.
  3356. @node Properties and Columns, Dates and Times, Tags, Top
  3357. @chapter Properties and Columns
  3358. @cindex properties
  3359. Properties are a set of key-value pairs associated with an entry. There
  3360. are two main applications for properties in Org mode. First, properties
  3361. are like tags, but with a value. Second, you can use properties to
  3362. implement (very basic) database capabilities in an Org buffer. For
  3363. an example of the first application, imagine maintaining a file where
  3364. you document bugs and plan releases of a piece of software. Instead of
  3365. using tags like @code{:release_1:}, @code{:release_2:}, one can use a
  3366. property, say @code{:Release:}, that in different subtrees has different
  3367. values, such as @code{1.0} or @code{2.0}. For an example of the second
  3368. application of properties, imagine keeping track of your music CDs,
  3369. where properties could be things such as the album artist, date of
  3370. release, number of tracks, and so on.
  3371. Properties can be conveniently edited and viewed in column view
  3372. (@pxref{Column view}).
  3373. @menu
  3374. * Property syntax:: How properties are spelled out
  3375. * Special properties:: Access to other Org mode features
  3376. * Property searches:: Matching property values
  3377. * Property inheritance:: Passing values down the tree
  3378. * Column view:: Tabular viewing and editing
  3379. * Property API:: Properties for Lisp programmers
  3380. @end menu
  3381. @node Property syntax, Special properties, Properties and Columns, Properties and Columns
  3382. @section Property syntax
  3383. @cindex property syntax
  3384. @cindex drawer, for properties
  3385. Properties are key-value pairs. They need to be inserted into a special
  3386. drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
  3387. is specified on a single line, with the key (surrounded by colons)
  3388. first, and the value after it. Here is an example:
  3389. @example
  3390. * CD collection
  3391. ** Classic
  3392. *** Goldberg Variations
  3393. :PROPERTIES:
  3394. :Title: Goldberg Variations
  3395. :Composer: J.S. Bach
  3396. :Artist: Glen Gould
  3397. :Publisher: Deutsche Grammphon
  3398. :NDisks: 1
  3399. :END:
  3400. @end example
  3401. You may define the allowed values for a particular property @samp{:Xyz:}
  3402. by setting a property @samp{:Xyz_ALL:}. This special property is
  3403. @emph{inherited}, so if you set it in a level 1 entry, it will apply to
  3404. the entire tree. When allowed values are defined, setting the
  3405. corresponding property becomes easier and is less prone to typing
  3406. errors. For the example with the CD collection, we can predefine
  3407. publishers and the number of disks in a box like this:
  3408. @example
  3409. * CD collection
  3410. :PROPERTIES:
  3411. :NDisks_ALL: 1 2 3 4
  3412. :Publisher_ALL: "Deutsche Grammophon" Philips EMI
  3413. :END:
  3414. @end example
  3415. If you want to set properties that can be inherited by any entry in a
  3416. file, use a line like
  3417. @example
  3418. #+PROPERTY: NDisks_ALL 1 2 3 4
  3419. @end example
  3420. Property values set with the global variable
  3421. @code{org-global-properties} can be inherited by all entries in all
  3422. Org files.
  3423. @noindent
  3424. The following commands help to work with properties:
  3425. @table @kbd
  3426. @kindex M-@key{TAB}
  3427. @item M-@key{TAB}
  3428. After an initial colon in a line, complete property keys. All keys used
  3429. in the current file will be offered as possible completions.
  3430. @kindex C-c C-x p
  3431. @item C-c C-x p
  3432. Set a property. This prompts for a property name and a value. If
  3433. necessary, the property drawer is created as well.
  3434. @item M-x org-insert-property-drawer
  3435. Insert a property drawer into the current entry. The drawer will be
  3436. inserted early in the entry, but after the lines with planning
  3437. information like deadlines.
  3438. @kindex C-c C-c
  3439. @item C-c C-c
  3440. With the cursor in a property drawer, this executes property commands.
  3441. @item C-c C-c s
  3442. Set a property in the current entry. Both the property and the value
  3443. can be inserted using completion.
  3444. @kindex S-@key{right}
  3445. @kindex S-@key{left}
  3446. @item S-@key{left}/@key{right}
  3447. Switch property at point to the next/previous allowed value.
  3448. @item C-c C-c d
  3449. Remove a property from the current entry.
  3450. @item C-c C-c D
  3451. Globally remove a property, from all entries in the current file.
  3452. @item C-c C-c c
  3453. Compute the property at point, using the operator and scope from the
  3454. nearest column format definition.
  3455. @end table
  3456. @node Special properties, Property searches, Property syntax, Properties and Columns
  3457. @section Special properties
  3458. @cindex properties, special
  3459. Special properties provide alternative access method to Org mode
  3460. features discussed in the previous chapters, like the TODO state or the
  3461. priority of an entry. This interface exists so that you can include
  3462. these states into columns view (@pxref{Column view}), or to use them in
  3463. queries. The following property names are special and should not be
  3464. used as keys in the properties drawer:
  3465. @example
  3466. TODO @r{The TODO keyword of the entry.}
  3467. TAGS @r{The tags defined directly in the headline.}
  3468. ALLTAGS @r{All tags, including inherited ones.}
  3469. PRIORITY @r{The priority of the entry, a string with a single letter.}
  3470. DEADLINE @r{The deadline time string, without the angular brackets.}
  3471. SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
  3472. TIMESTAMP @r{The first keyword-less time stamp in the entry.}
  3473. TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
  3474. CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
  3475. @r{must be run first to compute the values.}
  3476. @end example
  3477. @node Property searches, Property inheritance, Special properties, Properties and Columns
  3478. @section Property searches
  3479. @cindex properties, searching
  3480. @cindex searching, of properties
  3481. To create sparse trees and special lists with selection based on properties,
  3482. the same commands are used as for tag searches (@pxref{Tag searches}), and
  3483. the same logic applies. For example, here is a search string:
  3484. @example
  3485. +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
  3486. +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
  3487. @end example
  3488. @noindent
  3489. The type of comparison will depend on how the comparison value is written:
  3490. @itemize @minus
  3491. @item
  3492. If the comparison value is a plain number, a numerical comparison is done,
  3493. and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
  3494. @samp{>=}, and @samp{<>}.
  3495. @item
  3496. If the comparison value is enclosed in double
  3497. quotes, a string comparison is done, and the same operators are allowed.
  3498. @item
  3499. If the comparison value is enclosed in double quotes @emph{and} angular
  3500. brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
  3501. assumed to be date/time specifications in the standard Org way, and the
  3502. comparison will be done accordingly. Special values that will be recognized
  3503. are @code{"<now>"} for now (including time), and @code{"<today>"}, and
  3504. @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
  3505. specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
  3506. @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
  3507. respectively, can be used.
  3508. @item
  3509. If the comparison value is enclosed
  3510. in curly braces, a regexp match is performed, with @samp{=} meaning that the
  3511. regexp matches the property value, and @samp{<>} meaning that it does not
  3512. match.
  3513. @end itemize
  3514. So the search string in the example finds entries tagged @samp{:work:} but
  3515. not @samp{:boss:}, which also have a priority value @samp{A}, a
  3516. @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
  3517. property that is numerically smaller than 2, a @samp{:With:} property that is
  3518. matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
  3519. on or after October 11, 2008.
  3520. You can configure Org mode to use property inheritance during a search, but
  3521. beware that this can slow down searches considerably. See @ref{Property
  3522. inheritance} for details.
  3523. There is also a special command for creating sparse trees based on a
  3524. single property:
  3525. @table @kbd
  3526. @kindex C-c / p
  3527. @item C-c / p
  3528. Create a sparse tree based on the value of a property. This first
  3529. prompts for the name of a property, and then for a value. A sparse tree
  3530. is created with all entries that define this property with the given
  3531. value. If you enclose the value into curly braces, it is interpreted as
  3532. a regular expression and matched against the property values.
  3533. @end table
  3534. @node Property inheritance, Column view, Property searches, Properties and Columns
  3535. @section Property Inheritance
  3536. @cindex properties, inheritance
  3537. @cindex inheritance, of properties
  3538. The outline structure of Org mode documents lends itself for an
  3539. inheritance model of properties: If the parent in a tree has a certain
  3540. property, the children can inherit this property. Org mode does not
  3541. turn this on by default, because it can slow down property searches
  3542. significantly and is often not needed. However, if you find inheritance
  3543. useful, you can turn it on by setting the variable
  3544. @code{org-use-property-inheritance}. It may be set to @code{t}, to make
  3545. all properties inherited from the parent, to a list of properties
  3546. that should be inherited, or to a regular expression that matches
  3547. inherited properties.
  3548. Org mode has a few properties for which inheritance is hard-coded, at
  3549. least for the special applications for which they are used:
  3550. @table @code
  3551. @item COLUMNS
  3552. The @code{:COLUMNS:} property defines the format of column view
  3553. (@pxref{Column view}). It is inherited in the sense that the level
  3554. where a @code{:COLUMNS:} property is defined is used as the starting
  3555. point for a column view table, independently of the location in the
  3556. subtree from where columns view is turned on.
  3557. @item CATEGORY
  3558. For agenda view, a category set through a @code{:CATEGORY:} property
  3559. applies to the entire subtree.
  3560. @item ARCHIVE
  3561. For archiving, the @code{:ARCHIVE:} property may define the archive
  3562. location for the entire subtree (@pxref{Moving subtrees}).
  3563. @item LOGGING
  3564. The LOGGING property may define logging settings for an entry or a
  3565. subtree (@pxref{Tracking TODO state changes}).
  3566. @end table
  3567. @node Column view, Property API, Property inheritance, Properties and Columns
  3568. @section Column view
  3569. A great way to view and edit properties in an outline tree is
  3570. @emph{column view}. In column view, each outline item is turned into a
  3571. table row. Columns in this table provide access to properties of the
  3572. entries. Org mode implements columns by overlaying a tabular structure
  3573. over the headline of each item. While the headlines have been turned
  3574. into a table row, you can still change the visibility of the outline
  3575. tree. For example, you get a compact table by switching to CONTENTS
  3576. view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
  3577. is active), but you can still open, read, and edit the entry below each
  3578. headline. Or, you can switch to column view after executing a sparse
  3579. tree command and in this way get a table only for the selected items.
  3580. Column view also works in agenda buffers (@pxref{Agenda Views}) where
  3581. queries have collected selected items, possibly from a number of files.
  3582. @menu
  3583. * Defining columns:: The COLUMNS format property
  3584. * Using column view:: How to create and use column view
  3585. * Capturing column view:: A dynamic block for column view
  3586. @end menu
  3587. @node Defining columns, Using column view, Column view, Column view
  3588. @subsection Defining columns
  3589. @cindex column view, for properties
  3590. @cindex properties, column view
  3591. Setting up a column view first requires defining the columns. This is
  3592. done by defining a column format line.
  3593. @menu
  3594. * Scope of column definitions:: Where defined, where valid?
  3595. * Column attributes:: Appearance and content of a column
  3596. @end menu
  3597. @node Scope of column definitions, Column attributes, Defining columns, Defining columns
  3598. @subsubsection Scope of column definitions
  3599. To define a column format for an entire file, use a line like
  3600. @example
  3601. #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  3602. @end example
  3603. To specify a format that only applies to a specific tree, add a
  3604. @code{:COLUMNS:} property to the top node of that tree, for example:
  3605. @example
  3606. ** Top node for columns view
  3607. :PROPERTIES:
  3608. :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  3609. :END:
  3610. @end example
  3611. If a @code{:COLUMNS:} property is present in an entry, it defines columns
  3612. for the entry itself, and for the entire subtree below it. Since the
  3613. column definition is part of the hierarchical structure of the document,
  3614. you can define columns on level 1 that are general enough for all
  3615. sublevels, and more specific columns further down, when you edit a
  3616. deeper part of the tree.
  3617. @node Column attributes, , Scope of column definitions, Defining columns
  3618. @subsubsection Column attributes
  3619. A column definition sets the attributes of a column. The general
  3620. definition looks like this:
  3621. @example
  3622. %[width]property[(title)][@{summary-type@}]
  3623. @end example
  3624. @noindent
  3625. Except for the percent sign and the property name, all items are
  3626. optional. The individual parts have the following meaning:
  3627. @example
  3628. width @r{An integer specifying the width of the column in characters.}
  3629. @r{If omitted, the width will be determined automatically.}
  3630. property @r{The property that should be edited in this column.}
  3631. (title) @r{The header text for the column. If omitted, the}
  3632. @r{property name is used.}
  3633. @{summary-type@} @r{The summary type. If specified, the column values for}
  3634. @r{parent nodes are computed from the children.}
  3635. @r{Supported summary types are:}
  3636. @{+@} @r{Sum numbers in this column.}
  3637. @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
  3638. @{$@} @r{Currency, short for @samp{+;%.2f}.}
  3639. @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
  3640. @{X@} @r{Checkbox status, [X] if all children are [X].}
  3641. @{X/@} @r{Checkbox status, [n/m].}
  3642. @{X%@} @r{Checkbox status, [n%].}
  3643. @end example
  3644. @noindent
  3645. Here is an example for a complete columns definition, along with allowed
  3646. values.
  3647. @example
  3648. :COLUMNS: %20ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line - it is wrapped here only because of formatting constraints.}
  3649. %10Time_Estimate@{:@} %CLOCKSUM
  3650. :Owner_ALL: Tammy Mark Karl Lisa Don
  3651. :Status_ALL: "In progress" "Not started yet" "Finished" ""
  3652. :Approved_ALL: "[ ]" "[X]"
  3653. @end example
  3654. The first column, @samp{%25ITEM}, means the first 25 characters of the
  3655. item itself, i.e. of the headline. You probably always should start the
  3656. column definition with the @samp{ITEM} specifier. The other specifiers
  3657. create columns @samp{Owner} with a list of names as allowed values, for
  3658. @samp{Status} with four different possible values, and for a checkbox
  3659. field @samp{Approved}. When no width is given after the @samp{%}
  3660. character, the column will be exactly as wide as it needs to be in order
  3661. to fully display all values. The @samp{Approved} column does have a
  3662. modified title (@samp{Approved?}, with a question mark). Summaries will
  3663. be created for the @samp{Time_Estimate} column by adding time duration
  3664. expressions like HH:MM, and for the @samp{Approved} column, by providing
  3665. an @samp{[X]} status if all children have been checked. The
  3666. @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
  3667. in the subtree.
  3668. @node Using column view, Capturing column view, Defining columns, Column view
  3669. @subsection Using column view
  3670. @table @kbd
  3671. @tsubheading{Turning column view on and off}
  3672. @kindex C-c C-x C-c
  3673. @item C-c C-x C-c
  3674. Create the column view for the local environment. This command searches
  3675. the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
  3676. a format. When one is found, the column view table is established for
  3677. the entire tree, starting from the entry that contains the @code{:COLUMNS:}
  3678. property. If none is found, the format is taken from the @code{#+COLUMNS}
  3679. line or from the variable @code{org-columns-default-format}, and column
  3680. view is established for the current entry and its subtree.
  3681. @kindex r
  3682. @item r
  3683. Recreate the column view, to include recent changes made in the buffer.
  3684. @kindex g
  3685. @item g
  3686. Same as @kbd{r}.
  3687. @kindex q
  3688. @item q
  3689. Exit column view.
  3690. @tsubheading{Editing values}
  3691. @item @key{left} @key{right} @key{up} @key{down}
  3692. Move through the column view from field to field.
  3693. @kindex S-@key{left}
  3694. @kindex S-@key{right}
  3695. @item S-@key{left}/@key{right}
  3696. Switch to the next/previous allowed value of the field. For this, you
  3697. have to have specified allowed values for a property.
  3698. @item 1..9,0
  3699. Directly select the nth allowed value, @kbd{0} selects the 10th value.
  3700. @kindex n
  3701. @kindex p
  3702. @itemx n / p
  3703. Same as @kbd{S-@key{left}/@key{right}}
  3704. @kindex e
  3705. @item e
  3706. Edit the property at point. For the special properties, this will
  3707. invoke the same interface that you normally use to change that
  3708. property. For example, when editing a TAGS property, the tag completion
  3709. or fast selection interface will pop up.
  3710. @kindex C-c C-c
  3711. @item C-c C-c
  3712. When there is a checkbox at point, toggle it.
  3713. @kindex v
  3714. @item v
  3715. View the full value of this property. This is useful if the width of
  3716. the column is smaller than that of the value.
  3717. @kindex a
  3718. @item a
  3719. Edit the list of allowed values for this property. If the list is found
  3720. in the hierarchy, the modified values is stored there. If no list is
  3721. found, the new value is stored in the first entry that is part of the
  3722. current column view.
  3723. @tsubheading{Modifying the table structure}
  3724. @kindex <
  3725. @kindex >
  3726. @item < / >
  3727. Make the column narrower/wider by one character.
  3728. @kindex S-M-@key{right}
  3729. @item S-M-@key{right}
  3730. Insert a new column, to the left of the current column.
  3731. @kindex S-M-@key{left}
  3732. @item S-M-@key{left}
  3733. Delete the current column.
  3734. @end table
  3735. @node Capturing column view, , Using column view, Column view
  3736. @subsection Capturing column view
  3737. Since column view is just an overlay over a buffer, it cannot be
  3738. exported or printed directly. If you want to capture a column view, use
  3739. this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
  3740. of this block looks like this:
  3741. @cindex #+BEGIN: columnview
  3742. @example
  3743. * The column view
  3744. #+BEGIN: columnview :hlines 1 :id "label"
  3745. #+END:
  3746. @end example
  3747. @noindent This dynamic block has the following parameters:
  3748. @table @code
  3749. @item :id
  3750. This is most important parameter. Column view is a feature that is
  3751. often localized to a certain (sub)tree, and the capture block might be
  3752. in a different location in the file. To identify the tree whose view to
  3753. capture, you can use 3 values:
  3754. @example
  3755. local @r{use the tree in which the capture block is located}
  3756. global @r{make a global view, including all headings in the file}
  3757. "file:path-to-file"
  3758. @r{run column view at the top of this file}
  3759. "ID" @r{call column view in the tree that has an @code{:ID:}}
  3760. @r{property with the value @i{label}. You can use}
  3761. @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
  3762. @r{the current entry and copy it to the kill-ring.}
  3763. @end example
  3764. @item :hlines
  3765. When @code{t}, insert a hline after every line. When a number N, insert
  3766. a hline before each headline with level @code{<= N}.
  3767. @item :vlines
  3768. When set to @code{t}, enforce column groups to get vertical lines.
  3769. @item :maxlevel
  3770. When set to a number, don't capture entries below this level.
  3771. @item :skip-empty-rows
  3772. When set to @code{t}, skip row where the only non-empty specifier of the
  3773. column view is @code{ITEM}.
  3774. @end table
  3775. @noindent
  3776. The following commands insert or update the dynamic block:
  3777. @table @kbd
  3778. @kindex C-c C-x i
  3779. @item C-c C-x i
  3780. Insert a dynamic block capturing a column view. You will be prompted
  3781. for the scope or id of the view.
  3782. @kindex C-c C-c
  3783. @item C-c C-c
  3784. @kindex C-c C-x C-u
  3785. @itemx C-c C-x C-u
  3786. Update dynamical block at point. The cursor needs to be in the
  3787. @code{#+BEGIN} line of the dynamic block.
  3788. @kindex C-u C-c C-x C-u
  3789. @item C-u C-c C-x C-u
  3790. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  3791. you have several clock table blocks in a buffer.
  3792. @end table
  3793. You can add formulas to the column view table and you may add plotting
  3794. instructions in front of the table - these will survive an update of the
  3795. block. If there is a @code{#+TBLFM:} after the table, the table will
  3796. actually be recalculated automatically after an update.
  3797. @node Property API, , Column view, Properties and Columns
  3798. @section The Property API
  3799. @cindex properties, API
  3800. @cindex API, for properties
  3801. There is a full API for accessing and changing properties. This API can
  3802. be used by Emacs Lisp programs to work with properties and to implement
  3803. features based on them. For more information see @ref{Using the
  3804. property API}.
  3805. @node Dates and Times, Capture, Properties and Columns, Top
  3806. @chapter Dates and Times
  3807. @cindex dates
  3808. @cindex times
  3809. @cindex time stamps
  3810. @cindex date stamps
  3811. To assist project planning, TODO items can be labeled with a date and/or
  3812. a time. The specially formatted string carrying the date and time
  3813. information is called a @emph{timestamp} in Org mode. This may be a
  3814. little confusing because timestamp is often used as indicating when
  3815. something was created or last changed. However, in Org mode this term
  3816. is used in a much wider sense.
  3817. @menu
  3818. * Timestamps:: Assigning a time to a tree entry
  3819. * Creating timestamps:: Commands which insert timestamps
  3820. * Deadlines and scheduling:: Planning your work
  3821. * Clocking work time:: Tracking how long you spend on a task
  3822. * Effort estimates:: Planning work effort in advance
  3823. * Relative timer:: Notes with a running timer
  3824. @end menu
  3825. @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
  3826. @section Timestamps, deadlines and scheduling
  3827. @cindex time stamps
  3828. @cindex ranges, time
  3829. @cindex date stamps
  3830. @cindex deadlines
  3831. @cindex scheduling
  3832. A time stamp is a specification of a date (possibly with time or a range
  3833. of times) in a special format, either @samp{<2003-09-16 Tue>} or
  3834. @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
  3835. 12:00-12:30>}@footnote{This is the standard ISO date/time format. To
  3836. use an alternative format, see @ref{Custom time format}.}. A time stamp
  3837. can appear anywhere in the headline or body of an Org tree entry. Its
  3838. presence causes entries to be shown on specific dates in the agenda
  3839. (@pxref{Weekly/daily agenda}). We distinguish:
  3840. @table @var
  3841. @item Plain time stamp; Event; Appointment
  3842. @cindex timestamp
  3843. A simple time stamp just assigns a date/time to an item. This is just
  3844. like writing down an appointment or event in a paper agenda. In the
  3845. timeline and agenda displays, the headline of an entry associated with a
  3846. plain time stamp will be shown exactly on that date.
  3847. @example
  3848. * Meet Peter at the movies <2006-11-01 Wed 19:15>
  3849. * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
  3850. @end example
  3851. @item Time stamp with repeater interval
  3852. @cindex timestamp, with repeater interval
  3853. A time stamp may contain a @emph{repeater interval}, indicating that it
  3854. applies not only on the given date, but again and again after a certain
  3855. interval of N days (d), weeks (w), months(m), or years(y). The
  3856. following will show up in the agenda every Wednesday:
  3857. @example
  3858. * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
  3859. @end example
  3860. @item Diary-style sexp entries
  3861. For more complex date specifications, Org mode supports using the
  3862. special sexp diary entries implemented in the Emacs calendar/diary
  3863. package. For example
  3864. @example
  3865. * The nerd meeting on every 2nd Thursday of the month
  3866. <%%(diary-float t 4 2)>
  3867. @end example
  3868. @item Time/Date range
  3869. @cindex timerange
  3870. @cindex date range
  3871. Two time stamps connected by @samp{--} denote a range. The headline
  3872. will be shown on the first and last day of the range, and on any dates
  3873. that are displayed and fall in the range. Here is an example:
  3874. @example
  3875. ** Meeting in Amsterdam
  3876. <2004-08-23 Mon>--<2004-08-26 Thu>
  3877. @end example
  3878. @item Inactive time stamp
  3879. @cindex timestamp, inactive
  3880. @cindex inactive timestamp
  3881. Just like a plain time stamp, but with square brackets instead of
  3882. angular ones. These time stamps are inactive in the sense that they do
  3883. @emph{not} trigger an entry to show up in the agenda.
  3884. @example
  3885. * Gillian comes late for the fifth time [2006-11-01 Wed]
  3886. @end example
  3887. @end table
  3888. @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
  3889. @section Creating timestamps
  3890. @cindex creating timestamps
  3891. @cindex timestamps, creating
  3892. For Org mode to recognize time stamps, they need to be in the specific
  3893. format. All commands listed below produce time stamps in the correct
  3894. format.
  3895. @table @kbd
  3896. @kindex C-c .
  3897. @item C-c .
  3898. Prompt for a date and insert a corresponding time stamp. When the cursor is
  3899. at an existing time stamp in the buffer, the command is used to modify this
  3900. timestamp instead of inserting a new one. When this command is used twice in
  3901. succession, a time range is inserted.
  3902. @c
  3903. @kindex C-u C-c .
  3904. @item C-u C-c .
  3905. Like @kbd{C-c .}, but use the alternative format which contains date
  3906. and time. The default time can be rounded to multiples of 5 minutes,
  3907. see the option @code{org-time-stamp-rounding-minutes}.
  3908. @c
  3909. @kindex C-c !
  3910. @item C-c !
  3911. Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
  3912. an agenda entry.
  3913. @c
  3914. @kindex C-c <
  3915. @item C-c <
  3916. Insert a time stamp corresponding to the cursor date in the Calendar.
  3917. @c
  3918. @kindex C-c >
  3919. @item C-c >
  3920. Access the Emacs calendar for the current date. If there is a
  3921. timestamp in the current line, go to the corresponding date
  3922. instead.
  3923. @c
  3924. @kindex C-c C-o
  3925. @item C-c C-o
  3926. Access the agenda for the date given by the time stamp or -range at
  3927. point (@pxref{Weekly/daily agenda}).
  3928. @c
  3929. @kindex S-@key{left}
  3930. @kindex S-@key{right}
  3931. @item S-@key{left}
  3932. @itemx S-@key{right}
  3933. Change date at cursor by one day. These key bindings conflict with
  3934. CUA mode (@pxref{Conflicts}).
  3935. @c
  3936. @kindex S-@key{up}
  3937. @kindex S-@key{down}
  3938. @item S-@key{up}
  3939. @itemx S-@key{down}
  3940. Change the item under the cursor in a timestamp. The cursor can be on a
  3941. year, month, day, hour or minute. Note that if the cursor is in a
  3942. headline and not at a time stamp, these same keys modify the priority of
  3943. an item. (@pxref{Priorities}). The key bindings also conflict with
  3944. CUA mode (@pxref{Conflicts}).
  3945. @c
  3946. @kindex C-c C-y
  3947. @cindex evaluate time range
  3948. @item C-c C-y
  3949. Evaluate a time range by computing the difference between start and end.
  3950. With a prefix argument, insert result after the time range (in a table: into
  3951. the following column).
  3952. @end table
  3953. @menu
  3954. * The date/time prompt:: How Org mode helps you entering date and time
  3955. * Custom time format:: Making dates look different
  3956. @end menu
  3957. @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
  3958. @subsection The date/time prompt
  3959. @cindex date, reading in minibuffer
  3960. @cindex time, reading in minibuffer
  3961. When Org mode prompts for a date/time, the default is shown as an ISO
  3962. date, and the prompt therefore seems to ask for an ISO date. But it
  3963. will in fact accept any string containing some date and/or time
  3964. information, and it is really smart about interpreting your input. You
  3965. can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
  3966. copied from an email message. Org mode will find whatever information
  3967. is in there and derive anything you have not specified from the
  3968. @emph{default date and time}. The default is usually the current date
  3969. and time, but when modifying an existing time stamp, or when entering
  3970. the second stamp of a range, it is taken from the stamp in the buffer.
  3971. When filling in information, Org mode assumes that most of the time you
  3972. will want to enter a date in the future: If you omit the month/year and
  3973. the given day/month is @i{before} today, it will assume that you mean a
  3974. future date@footnote{See the variable
  3975. @code{org-read-date-prefer-future}.}.
  3976. For example, let's assume that today is @b{June 13, 2006}. Here is how
  3977. various inputs will be interpreted, the items filled in by Org mode are
  3978. in @b{bold}.
  3979. @example
  3980. 3-2-5 --> 2003-02-05
  3981. 14 --> @b{2006}-@b{06}-14
  3982. 12 --> @b{2006}-@b{07}-12
  3983. Fri --> nearest Friday (defaultdate or later)
  3984. sep 15 --> @b{2006}-09-15
  3985. feb 15 --> @b{2007}-02-15
  3986. sep 12 9 --> 2009-09-12
  3987. 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
  3988. 22 sept 0:34 --> @b{2006}-09-22 0:34
  3989. w4 --> ISO week for of the current year @b{2006}
  3990. 2012 w4 fri --> Friday of ISO week 4 in 2012
  3991. 2012-w04-5 --> Same as above
  3992. @end example
  3993. Furthermore you can specify a relative date by giving, as the
  3994. @emph{first} thing in the input: a plus/minus sign, a number and a
  3995. letter [dwmy] to indicate change in days weeks, months, years. With a
  3996. single plus or minus, the date is always relative to today. With a
  3997. double plus or minus, it is relative to the default date. If instead of
  3998. a single letter, you use the abbreviation of day name, the date will be
  3999. the nth such day. E.g.
  4000. @example
  4001. +0 --> today
  4002. . --> today
  4003. +4d --> four days from today
  4004. +4 --> same as above
  4005. +2w --> two weeks from today
  4006. ++5 --> five days from default date
  4007. +2tue --> second tuesday from now.
  4008. @end example
  4009. The function understands English month and weekday abbreviations. If
  4010. you want to use unabbreviated names and/or other languages, configure
  4011. the variables @code{parse-time-months} and @code{parse-time-weekdays}.
  4012. @cindex calendar, for selecting date
  4013. Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
  4014. you don't need/want the calendar, configure the variable
  4015. @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
  4016. prompt, either by clicking on a date in the calendar, or by pressing
  4017. @key{RET}, the date selected in the calendar will be combined with the
  4018. information entered at the prompt. You can control the calendar fully
  4019. from the minibuffer:
  4020. @kindex <
  4021. @kindex >
  4022. @kindex mouse-1
  4023. @kindex S-@key{right}
  4024. @kindex S-@key{left}
  4025. @kindex S-@key{down}
  4026. @kindex S-@key{up}
  4027. @kindex M-S-@key{right}
  4028. @kindex M-S-@key{left}
  4029. @kindex @key{RET}
  4030. @example
  4031. > / < @r{Scroll calendar forward/backward by one month.}
  4032. mouse-1 @r{Select date by clicking on it.}
  4033. S-@key{right}/@key{left} @r{One day forward/backward.}
  4034. S-@key{down}/@key{up} @r{One week forward/backward.}
  4035. M-S-@key{right}/@key{left} @r{One month forward/backward.}
  4036. @key{RET} @r{Choose date in calendar.}
  4037. @end example
  4038. The actions of the date/time prompt may seem complex, but I assure you they
  4039. will grow on you, and you will start getting annoyed by pretty much any other
  4040. way of entering a date/time out there. To help you understand what is going
  4041. on, the current interpretation of your input will be displayed live in the
  4042. minibuffer@footnote{If you find this distracting, turn the display of with
  4043. @code{org-read-date-display-live}.}.
  4044. @node Custom time format, , The date/time prompt, Creating timestamps
  4045. @subsection Custom time format
  4046. @cindex custom date/time format
  4047. @cindex time format, custom
  4048. @cindex date format, custom
  4049. Org mode uses the standard ISO notation for dates and times as it is
  4050. defined in ISO 8601. If you cannot get used to this and require another
  4051. representation of date and time to keep you happy, you can get it by
  4052. customizing the variables @code{org-display-custom-times} and
  4053. @code{org-time-stamp-custom-formats}.
  4054. @table @kbd
  4055. @kindex C-c C-x C-t
  4056. @item C-c C-x C-t
  4057. Toggle the display of custom formats for dates and times.
  4058. @end table
  4059. @noindent
  4060. Org mode needs the default format for scanning, so the custom date/time
  4061. format does not @emph{replace} the default format - instead it is put
  4062. @emph{over} the default format using text properties. This has the
  4063. following consequences:
  4064. @itemize @bullet
  4065. @item
  4066. You cannot place the cursor onto a time stamp anymore, only before or
  4067. after.
  4068. @item
  4069. The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
  4070. each component of a time stamp. If the cursor is at the beginning of
  4071. the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
  4072. just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
  4073. time will be changed by one minute.
  4074. @item
  4075. If the time stamp contains a range of clock times or a repeater, these
  4076. will not be overlayed, but remain in the buffer as they were.
  4077. @item
  4078. When you delete a time stamp character-by-character, it will only
  4079. disappear from the buffer after @emph{all} (invisible) characters
  4080. belonging to the ISO timestamp have been removed.
  4081. @item
  4082. If the custom time stamp format is longer than the default and you are
  4083. using dates in tables, table alignment will be messed up. If the custom
  4084. format is shorter, things do work as expected.
  4085. @end itemize
  4086. @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
  4087. @section Deadlines and scheduling
  4088. A time stamp may be preceded by special keywords to facilitate planning:
  4089. @table @var
  4090. @item DEADLINE
  4091. @cindex DEADLINE keyword
  4092. Meaning: the task (most likely a TODO item, though not necessarily) is supposed
  4093. to be finished on that date.
  4094. On the deadline date, the task will be listed in the agenda. In
  4095. addition, the agenda for @emph{today} will carry a warning about the
  4096. approaching or missed deadline, starting
  4097. @code{org-deadline-warning-days} before the due date, and continuing
  4098. until the entry is marked DONE. An example:
  4099. @example
  4100. *** TODO write article about the Earth for the Guide
  4101. The editor in charge is [[bbdb:Ford Prefect]]
  4102. DEADLINE: <2004-02-29 Sun>
  4103. @end example
  4104. You can specify a different lead time for warnings for a specific
  4105. deadlines using the following syntax. Here is an example with a warning
  4106. period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
  4107. @item SCHEDULED
  4108. @cindex SCHEDULED keyword
  4109. Meaning: you are planning to start working on that task on the given
  4110. date.
  4111. The headline will be listed under the given date@footnote{It will still
  4112. be listed on that date after it has been marked DONE. If you don't like
  4113. this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
  4114. addition, a reminder that the scheduled date has passed will be present
  4115. in the compilation for @emph{today}, until the entry is marked DONE.
  4116. I.e., the task will automatically be forwarded until completed.
  4117. @example
  4118. *** TODO Call Trillian for a date on New Years Eve.
  4119. SCHEDULED: <2004-12-25 Sat>
  4120. @end example
  4121. @noindent
  4122. @b{Important:} Scheduling an item in Org mode should @i{not} be
  4123. understood in the same way that we understand @i{scheduling a meeting}.
  4124. Setting a date for a meeting is just a simple appointment, you should
  4125. mark this entry with a simple plain time stamp, to get this item shown
  4126. on the date where it applies. This is a frequent mis-understanding from
  4127. Org-users. In Org mode, @i{scheduling} means setting a date when you
  4128. want to start working on an action item.
  4129. @end table
  4130. You may use time stamps with repeaters in scheduling and deadline
  4131. entries. Org mode will issue early and late warnings based on the
  4132. assumption that the time stamp represents the @i{nearest instance} of
  4133. the repeater. However, the use of diary sexp entries like
  4134. @c
  4135. @code{<%%(diary-float t 42)>}
  4136. @c
  4137. in scheduling and deadline timestamps is limited. Org mode does not
  4138. know enough about the internals of each sexp function to issue early and
  4139. late warnings. However, it will show the item on each day where the
  4140. sexp entry matches.
  4141. @menu
  4142. * Inserting deadline/schedule:: Planning items
  4143. * Repeated tasks:: Items that show up again and again
  4144. @end menu
  4145. @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
  4146. @subsection Inserting deadlines or schedules
  4147. The following commands allow to quickly insert a deadline or to schedule
  4148. an item:
  4149. @table @kbd
  4150. @c
  4151. @kindex C-c C-d
  4152. @item C-c C-d
  4153. Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
  4154. happen in the line directly following the headline. When called with a
  4155. prefix arg, an existing deadline will be removed from the entry.
  4156. @c FIXME Any CLOSED timestamp will be removed.????????
  4157. @c
  4158. @kindex C-c / d
  4159. @cindex sparse tree, for deadlines
  4160. @item C-c / d
  4161. Create a sparse tree with all deadlines that are either past-due, or
  4162. which will become due within @code{org-deadline-warning-days}.
  4163. With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
  4164. prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
  4165. all deadlines due tomorrow.
  4166. @c
  4167. @kindex C-c C-s
  4168. @item C-c C-s
  4169. Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
  4170. happen in the line directly following the headline. Any CLOSED
  4171. timestamp will be removed. When called with a prefix argument, remove
  4172. the scheduling date from the entry.
  4173. @c
  4174. @kindex C-c C-x C-k
  4175. @kindex k a
  4176. @kindex k s
  4177. @item C-c C-x C-k
  4178. Mark the current entry for agenda action. After you have marked the entry
  4179. like this, you can open the agenda or the calendar to find an appropriate
  4180. date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
  4181. schedule the marked item.
  4182. @end table
  4183. @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
  4184. @subsection Repeated tasks
  4185. Some tasks need to be repeated again and again. Org mode helps to
  4186. organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
  4187. or plain time stamp. In the following example
  4188. @example
  4189. ** TODO Pay the rent
  4190. DEADLINE: <2005-10-01 Sat +1m>
  4191. @end example
  4192. the @code{+1m} is a repeater; the intended interpretation is that the
  4193. task has a deadline on <2005-10-01> and repeats itself every (one) month
  4194. starting from that time. If you need both a repeater and a special
  4195. warning period in a deadline entry, the repeater comes first and the
  4196. warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
  4197. Deadlines and scheduled items produce entries in the agenda when they
  4198. are over-due, so it is important to be able to mark such an entry as
  4199. completed once you have done so. When you mark a DEADLINE or a SCHEDULE
  4200. with the TODO keyword DONE, it will no longer produce entries in the
  4201. agenda. The problem with this is, however, that then also the
  4202. @emph{next} instance of the repeated entry will not be active. Org mode
  4203. deals with this in the following way: When you try to mark such an entry
  4204. DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
  4205. time stamp by the repeater interval, and immediately set the entry state
  4206. back to TODO. In the example above, setting the state to DONE would
  4207. actually switch the date like this:
  4208. @example
  4209. ** TODO Pay the rent
  4210. DEADLINE: <2005-11-01 Tue +1m>
  4211. @end example
  4212. A timestamp@footnote{You can change this using the option
  4213. @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
  4214. @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
  4215. will also be prompted for a note.} will be added under the deadline, to keep
  4216. a record that you actually acted on the previous instance of this deadline.
  4217. As a consequence of shifting the base date, this entry will no longer be
  4218. visible in the agenda when checking past dates, but all future instances
  4219. will be visible.
  4220. With the @samp{+1m} cookie, the date shift will always be exactly one
  4221. month. So if you have not payed the rent for three months, marking this
  4222. entry DONE will still keep it as an overdue deadline. Depending on the
  4223. task, this may not be the best way to handle it. For example, if you
  4224. forgot to call you father for 3 weeks, it does not make sense to call
  4225. him 3 times in a single day to make up for it. Finally, there are tasks
  4226. like changing batteries which should always repeat a certain time
  4227. @i{after} the last time you did it. For these tasks, Org mode has
  4228. special repeaters markers with @samp{++} and @samp{.+}. For example:
  4229. @example
  4230. ** TODO Call Father
  4231. DEADLINE: <2008-02-10 Sun ++1w>
  4232. Marking this DONE will shift the date by at least one week,
  4233. but also by as many weeks as it takes to get this date into
  4234. the future. However, it stays on a Sunday, even if you called
  4235. and marked it done on Saturday.
  4236. ** TODO Check the batteries in the smoke detectors
  4237. DEADLINE: <2005-11-01 Tue .+1m>
  4238. Marking this DONE will shift the date to one month after
  4239. today.
  4240. @end example
  4241. You may have both scheduling and deadline information for a specific
  4242. task - just make sure that the repeater intervals on both are the same.
  4243. @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
  4244. @section Clocking work time
  4245. Org mode allows you to clock the time you spent on specific tasks in a
  4246. project. When you start working on an item, you can start the clock.
  4247. When you stop working on that task, or when you mark the task done, the
  4248. clock is stopped and the corresponding time interval is recorded. It
  4249. also computes the total time spent on each subtree of a project.
  4250. @table @kbd
  4251. @kindex C-c C-x C-i
  4252. @item C-c C-x C-i
  4253. Start the clock on the current item (clock-in). This inserts the CLOCK
  4254. keyword together with a timestamp. If this is not the first clocking of
  4255. this item, the multiple CLOCK lines will be wrapped into a
  4256. @code{:CLOCK:} drawer (see also the variable
  4257. @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
  4258. select the task from a list of recently clocked tasks. With two @kbd{C-u
  4259. C-u} prefixes, clock into the task at point and mark it as the default task.
  4260. The default task will always be available when selecting a clocking task,
  4261. with letter @kbd{d}.
  4262. @kindex C-c C-x C-o
  4263. @item C-c C-x C-o
  4264. Stop the clock (clock-out). This inserts another timestamp at the same
  4265. location where the clock was last started. It also directly computes
  4266. the resulting time in inserts it after the time range as @samp{=>
  4267. HH:MM}. See the variable @code{org-log-note-clock-out} for the
  4268. possibility to record an additional note together with the clock-out
  4269. time stamp@footnote{The corresponding in-buffer setting is:
  4270. @code{#+STARTUP: lognoteclock-out}}.
  4271. @kindex C-c C-y
  4272. @item C-c C-y
  4273. Recompute the time interval after changing one of the time stamps. This
  4274. is only necessary if you edit the time stamps directly. If you change
  4275. them with @kbd{S-@key{cursor}} keys, the update is automatic.
  4276. @kindex C-c C-t
  4277. @item C-c C-t
  4278. Changing the TODO state of an item to DONE automatically stops the clock
  4279. if it is running in this same item.
  4280. @kindex C-c C-x C-x
  4281. @item C-c C-x C-x
  4282. Cancel the current clock. This is useful if a clock was started by
  4283. mistake, or if you ended up working on something else.
  4284. @kindex C-c C-x C-j
  4285. @item C-c C-x C-j
  4286. Jump to the entry that contains the currently running clock. With a
  4287. @kbd{C-u} prefix arg, select the target task from a list of recently clocked
  4288. tasks.
  4289. @kindex C-c C-x C-d
  4290. @item C-c C-x C-d
  4291. Display time summaries for each subtree in the current buffer. This
  4292. puts overlays at the end of each headline, showing the total time
  4293. recorded under that heading, including the time of any subheadings. You
  4294. can use visibility cycling to study the tree, but the overlays disappear
  4295. when you change the buffer (see variable
  4296. @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
  4297. @kindex C-c C-x C-r
  4298. @item C-c C-x C-r
  4299. Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
  4300. report as an Org mode table into the current file. When the cursor is
  4301. at an existing clock table, just update it. When called with a prefix
  4302. argument, jump to the first clock report in the current document and
  4303. update it.
  4304. @cindex #+BEGIN: clocktable
  4305. @example
  4306. #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
  4307. #+END: clocktable
  4308. @end example
  4309. @noindent
  4310. If such a block already exists at point, its content is replaced by the
  4311. new table. The @samp{BEGIN} line can specify options:
  4312. @example
  4313. :maxlevel @r{Maximum level depth to which times are listed in the table.}
  4314. :emphasize @r{When @code{t}, emphasize level one and level two items}
  4315. :scope @r{The scope to consider. This can be any of the following:}
  4316. nil @r{the current buffer or narrowed region}
  4317. file @r{the full current buffer}
  4318. subtree @r{the subtree where the clocktable is located}
  4319. treeN @r{the surrounding level N tree, for example @code{tree3}}
  4320. tree @r{the surrounding level 1 tree}
  4321. agenda @r{all agenda files}
  4322. ("file"..) @r{scan these files}
  4323. file-with-archives @r{current file and its archives}
  4324. agenda-with-archives @r{all agenda files, including archives}
  4325. :block @r{The time block to consider. This block is specified either}
  4326. @r{absolute, or relative to the current time and may be any of}
  4327. @r{these formats:}
  4328. 2007-12-31 @r{New year eve 2007}
  4329. 2007-12 @r{December 2007}
  4330. 2007-W50 @r{ISO-week 50 in 2007}
  4331. 2007 @r{the year 2007}
  4332. today, yesterday, today-N @r{a relative day}
  4333. thisweek, lastweek, thisweek-N @r{a relative week}
  4334. thismonth, lastmonth, thismonth-N @r{a relative month}
  4335. thisyear, lastyear, thisyear-N @r{a relative year}
  4336. @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
  4337. :tstart @r{A time string specifying when to start considering times}
  4338. :tend @r{A time string specifying when to stop considering times}
  4339. :step @r{@code{week} or @code{day}, to split the table into chunks.}
  4340. @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
  4341. :link @r{Link the item headlines in the table to their origins}
  4342. :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
  4343. @r{As a special case, @samp{:formula %} adds column with % time.}
  4344. @r{If you do not specify a formula here, any existing formula}
  4345. @r{below the clock table will survive updates and be evaluated.}
  4346. @end example
  4347. So to get a clock summary of the current level 1 tree, for the current
  4348. day, you could write
  4349. @example
  4350. #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
  4351. #+END: clocktable
  4352. @end example
  4353. and to use a specific time range you could write@footnote{Note that all
  4354. parameters must be specified in a single line - the line is broken here
  4355. only to fit it onto the manual.}
  4356. @example
  4357. #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
  4358. :tend "<2006-08-10 Thu 12:00>"
  4359. #+END: clocktable
  4360. @end example
  4361. A summary of the current subtree with % times would be
  4362. @example
  4363. #+BEGIN: clocktable :scope subtree :link t :formula %
  4364. #+END: clocktable
  4365. @end example
  4366. @kindex C-c C-c
  4367. @item C-c C-c
  4368. @kindex C-c C-x C-u
  4369. @itemx C-c C-x C-u
  4370. Update dynamical block at point. The cursor needs to be in the
  4371. @code{#+BEGIN} line of the dynamic block.
  4372. @kindex C-u C-c C-x C-u
  4373. @item C-u C-c C-x C-u
  4374. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  4375. you have several clock table blocks in a buffer.
  4376. @kindex S-@key{left}
  4377. @kindex S-@key{right}
  4378. @item S-@key{left}
  4379. @itemx S-@key{right}
  4380. Shift the current @code{:block} interval and update the table. The cursor
  4381. needs to be in the @code{#+BEGIN: clocktable} line for this command. If
  4382. @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
  4383. @end table
  4384. The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
  4385. the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
  4386. worked on or closed during a day.
  4387. @node Effort estimates, Relative timer, Clocking work time, Dates and Times
  4388. @section Effort estimates
  4389. @cindex effort estimates
  4390. If you want to plan your work in a very detailed way, or if you need to
  4391. produce offers with quotations of the estimated work effort, you may want to
  4392. assign effort estimates to entries. If you are also clocking your work, you
  4393. may later want to compare the planned effort with the actual working time, a
  4394. great way to improve planning estimates. Effort estimates are stored in a
  4395. special property @samp{Effort}@footnote{You may change the property being
  4396. used with the variable @code{org-effort-property}.}. Clearly the best way to
  4397. work with effort estimates is through column view (@pxref{Column view}). You
  4398. should start by setting up discrete values for effort estimates, and a
  4399. @code{COLUMNS} format that displays these values together with clock sums (if
  4400. you want to clock your time). For a specific buffer you can use
  4401. @example
  4402. #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
  4403. #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
  4404. @end example
  4405. @noindent
  4406. or, even better, you can set up these values globally by customizing the
  4407. variables @code{org-global-properties} and @code{org-columns-default-format}.
  4408. In particular if you want to use this setup also in the agenda, a global
  4409. setup may be advised.
  4410. The way to assign estimates to individual items is then to switch to column
  4411. mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
  4412. value. The values you enter will immediately be summed up in the hierarchy.
  4413. In the column next to it, any clocked time will be displayed.
  4414. If you switch to column view in the daily/weekly agenda, the effort column
  4415. will summarize the estimated work effort for each day@footnote{Please note
  4416. the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
  4417. column view}).}, and you can use this to find space in your schedule. To get
  4418. an overview of the entire part of the day that is committed, you can set the
  4419. option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
  4420. appointments on a day that take place over a specified time interval will
  4421. then also be added to the load estimate of the day.
  4422. Effort estimates can be used in secondary agenda filtering that is triggered
  4423. with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
  4424. these estimates defined consistently, two or three key presses will narrow
  4425. down the list to stuff that fits into an available time slot.
  4426. @node Relative timer, , Effort estimates, Dates and Times
  4427. @section Taking notes with a relative timer
  4428. @cindex relative timer
  4429. When taking notes during, for example, a meeting or a video viewing, it can
  4430. be useful to have access to times relative to a starting time. Org provides
  4431. such a relative timer and make it easy to create timed notes.
  4432. @table @kbd
  4433. @kindex C-c C-x .
  4434. @item C-c C-x .
  4435. Insert a relative time into the buffer. The first time you use this, the
  4436. timer will be started. When called with a prefix argument, the timer is
  4437. restarted.
  4438. @kindex C-c C-x -
  4439. @item C-c C-x -
  4440. Insert a description list item with the current relative time. With a prefix
  4441. argument, first reset the timer to 0.
  4442. @kindex M-@key{RET}
  4443. @item M-@key{RET}
  4444. Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
  4445. new timer items.
  4446. @kindex C-c C-x ,
  4447. @item C-c C-x ,
  4448. Pause the timer, or continue it if it is already paused. With prefix
  4449. argument, stop it entirely.
  4450. @kindex C-u C-c C-x ,
  4451. @item C-u C-c C-x ,
  4452. Stop the timer. After this, you can only start a new timer, not continue the
  4453. old one. This command also removes the timer from the mode line.
  4454. @kindex C-c C-x 0
  4455. @item C-c C-x 0
  4456. Reset the timer without inserting anything into the buffer. By default, the
  4457. timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
  4458. specific starting offset. The user is prompted for the offset, with a
  4459. default taken from a timer string at point, if any, So this can be used to
  4460. restart taking notes after a break in the process. When called with a double
  4461. prefix argument @kbd{C-c C-u}, change all timer strings in the active region
  4462. by a certain amount. This can be used to fix timer strings if the timer was
  4463. not started at exactly the right moment.
  4464. @end table
  4465. @node Capture, Agenda Views, Dates and Times, Top
  4466. @chapter Capture
  4467. @cindex capture
  4468. An important part of any organization system is the ability to quickly
  4469. capture new ideas and tasks, and to associate reference material with them.
  4470. Org uses the @file{remember} package to create tasks, and stores files
  4471. related to a task (@i{attachments}) in a special directory.
  4472. @menu
  4473. * Remember:: Capture new tasks/ideas with little interruption
  4474. * Attachments:: Add files to tasks.
  4475. @end menu
  4476. @node Remember, Attachments, Capture, Capture
  4477. @section Remember
  4478. @cindex @file{remember.el}
  4479. The @i{Remember} package by John Wiegley lets you store quick notes with
  4480. little interruption of your work flow. See
  4481. @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
  4482. information. It is an excellent way to add new notes and tasks to
  4483. Org files. Org significantly expands the possibilities of
  4484. @i{remember}: You may define templates for different note types, and
  4485. associate target files and headlines with specific templates. It also
  4486. allows you to select the location where a note should be stored
  4487. interactively, on the fly.
  4488. @menu
  4489. * Setting up Remember:: Some code for .emacs to get things going
  4490. * Remember templates:: Define the outline of different note types
  4491. * Storing notes:: Directly get the note to where it belongs
  4492. * Refiling notes:: Moving a note or task to a project
  4493. @end menu
  4494. @node Setting up Remember, Remember templates, Remember, Remember
  4495. @subsection Setting up Remember
  4496. The following customization will tell @i{remember} to use org files as
  4497. target, and to create annotations compatible with Org links.
  4498. @example
  4499. (org-remember-insinuate)
  4500. (setq org-directory "~/path/to/my/orgfiles/")
  4501. (setq org-default-notes-file (concat org-directory "/notes.org"))
  4502. (define-key global-map "\C-cr" 'org-remember)
  4503. @end example
  4504. The last line binds the command @code{org-remember} to a global
  4505. key@footnote{Please select your own key, @kbd{C-c r} is only a
  4506. suggestion.}. @code{org-remember} basically just calls @code{remember},
  4507. but it makes a few things easier: If there is an active region, it will
  4508. automatically copy the region into the remember buffer. It also allows
  4509. to jump to the buffer and location where remember notes are being
  4510. stored: Just call @code{org-remember} with a prefix argument. If you
  4511. use two prefix arguments, Org jumps to the location where the last
  4512. remember note was stored.
  4513. The remember buffer will actually use @code{org-mode} as its major mode, so
  4514. that all editing features of Org-mode are available. In addition to this, a
  4515. minor mode @code{org-remember-mode} is turned on, for the single purpose that
  4516. you can use its keymap @code{org-remember-mode-map} to overwrite some of
  4517. Org-mode's key bindings.
  4518. You can also call @code{org-remember} in a special way from the agenda,
  4519. using the @kbd{k r} key combination. With this access, any time stamps
  4520. inserted by the selected remember template (see below) will default to
  4521. the cursor date in the agenda, rather than to the current date.
  4522. @node Remember templates, Storing notes, Setting up Remember, Remember
  4523. @subsection Remember templates
  4524. @cindex templates, for remember
  4525. In combination with Org, you can use templates to generate
  4526. different types of @i{remember} notes. For example, if you would like
  4527. to use one template to create general TODO entries, another one for
  4528. journal entries, and a third one for collecting random ideas, you could
  4529. use:
  4530. @example
  4531. (setq org-remember-templates
  4532. '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
  4533. ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
  4534. ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
  4535. @end example
  4536. @noindent In these entries, the first string is just a name, and the
  4537. character specifies how to select the template. It is useful if the
  4538. character is also the first letter of the name. The next string specifies
  4539. the template. Two more (optional) strings give the file in which, and the
  4540. headline under which the new note should be stored. The file (if not present
  4541. or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
  4542. @code{org-remember-default-headline}. If the file name is not an absolute
  4543. path, it will be interpreted relative to @code{org-directory}. The heading
  4544. can also be the symbols @code{top} or @code{bottom} to send note as level 1
  4545. entries to the beginning or end of the file, respectively.
  4546. An optional sixth element specifies the contexts in which the user can select
  4547. the template. This element can be a list of major modes or a function.
  4548. @code{org-remember} will first check whether the function returns @code{t} or
  4549. if we are in any of the listed major mode, and exclude templates for which
  4550. this condition is not fulfilled. Templates that do not specify this element
  4551. at all, or that use @code{nil} or @code{t} as a value will always be
  4552. selectable.
  4553. So for example:
  4554. @example
  4555. (setq org-remember-templates
  4556. '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
  4557. ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check)
  4558. ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
  4559. @end example
  4560. The first template will only be available when invoking @code{org-remember}
  4561. from an buffer in @code{emacs-lisp-mode}. The second template will only be
  4562. available when the function @code{my-check} returns @code{t}. The third
  4563. template will be proposed in any context.
  4564. When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
  4565. something, Org will prompt for a key to select the template (if you have
  4566. more than one template) and then prepare the buffer like
  4567. @example
  4568. * TODO
  4569. [[file:link to where you called remember]]
  4570. @end example
  4571. @noindent
  4572. During expansion of the template, special @kbd{%}-escapes allow dynamic
  4573. insertion of content:
  4574. @example
  4575. %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.}
  4576. @r{You may specify a default value and a completion table with}
  4577. @r{%^@{prompt|default|completion2|completion3...@}}
  4578. @r{The arrow keys access a prompt-specific history.}
  4579. %a @r{annotation, normally the link created with @code{org-store-link}}
  4580. %A @r{like @code{%a}, but prompt for the description part}
  4581. %i @r{initial content, the region when remember is called with C-u.}
  4582. @r{The entire text will be indented like @code{%i} itself.}
  4583. %t @r{time stamp, date only}
  4584. %T @r{time stamp with date and time}
  4585. %u, %U @r{like the above, but inactive time stamps}
  4586. %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
  4587. @r{You may define a prompt like @code{%^@{Birthday@}t}}
  4588. %n @r{user name (taken from @code{user-full-name})}
  4589. %c @r{Current kill ring head.}
  4590. %x @r{Content of the X clipboard.}
  4591. %^C @r{Interactive selection of which kill or clip to use.}
  4592. %^L @r{Like @code{%^C}, but insert as link.}
  4593. %^g @r{prompt for tags, with completion on tags in target file.}
  4594. %k @r{title of currently clocked task}
  4595. %K @r{link to currently clocked task}
  4596. %^G @r{prompt for tags, with completion all tags in all agenda files.}
  4597. %^@{prop@}p @r{Prompt the user for a value for property @code{prop}}
  4598. %:keyword @r{specific information for certain link types, see below}
  4599. %[pathname] @r{insert the contents of the file given by @code{pathname}}
  4600. %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result}
  4601. %! @r{immediately store note after completing the template}
  4602. @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
  4603. %& @r{jump to target location immediately after storing note}
  4604. @end example
  4605. @noindent
  4606. For specific link types, the following keywords will be
  4607. defined@footnote{If you define your own link types (@pxref{Adding
  4608. hyperlink types}), any property you store with
  4609. @code{org-store-link-props} can be accessed in remember templates in a
  4610. similar way.}:
  4611. @example
  4612. Link type | Available keywords
  4613. -------------------+----------------------------------------------
  4614. bbdb | %:name %:company
  4615. bbdb | %::server %:port %:nick
  4616. vm, wl, mh, rmail | %:type %:subject %:message-id
  4617. | %:from %:fromname %:fromaddress
  4618. | %:to %:toname %:toaddress
  4619. | %: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}.}}
  4620. gnus | %:group, @r{for messages also all email fields}
  4621. w3, w3m | %:url
  4622. info | %:file %:node
  4623. calendar | %:date"
  4624. @end example
  4625. @noindent
  4626. To place the cursor after template expansion use:
  4627. @example
  4628. %? @r{After completing the template, position cursor here.}
  4629. @end example
  4630. @noindent
  4631. If you change your mind about which template to use, call
  4632. @code{org-remember} in the remember buffer. You may then select a new
  4633. template that will be filled with the previous context information.
  4634. @node Storing notes, Refiling notes, Remember templates, Remember
  4635. @subsection Storing notes
  4636. When you are finished preparing a note with @i{remember}, you have to press
  4637. @kbd{C-c C-c} to file the note away. If you have started the clock in the
  4638. remember buffer, you will first be asked if you want to clock out
  4639. now@footnote{To avoid this query, configure the variable
  4640. @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
  4641. will continue to run after the note was filed away.
  4642. The handler will then store the note in the file and under the headline
  4643. specified in the template, or it will use the default file and headlines.
  4644. The window configuration will be restored, sending you back to the working
  4645. context before the call to @code{remember}. To re-use the location found
  4646. during the last call to @code{remember}, exit the remember buffer with
  4647. @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}.
  4648. Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
  4649. the currently clocked item.
  4650. If you want to store the note directly to a different place, use
  4651. @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the
  4652. variable @code{org-remember-store-without-prompt} to make this behavior
  4653. the default.}. The handler will then first prompt for a target file -
  4654. if you press @key{RET}, the value specified for the template is used.
  4655. Then the command offers the headings tree of the selected file, with the
  4656. cursor position at the default headline (if you had specified one in the
  4657. template). You can either immediately press @key{RET} to get the note
  4658. placed there. Or you can use the following keys to find a different
  4659. location:
  4660. @example
  4661. @key{TAB} @r{Cycle visibility.}
  4662. @key{down} / @key{up} @r{Next/previous visible headline.}
  4663. n / p @r{Next/previous visible headline.}
  4664. f / b @r{Next/previous headline same level.}
  4665. u @r{One level up.}
  4666. @c 0-9 @r{Digit argument.}
  4667. @end example
  4668. @noindent
  4669. Pressing @key{RET} or @key{left} or @key{right}
  4670. then leads to the following result.
  4671. @multitable @columnfractions 0.2 0.15 0.65
  4672. @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
  4673. @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
  4674. @item @tab @tab depending on @code{org-reverse-note-order}.
  4675. @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
  4676. @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
  4677. @item @tab @tab depending on @code{org-reverse-note-order}.
  4678. @item not on headline @tab @key{RET}
  4679. @tab at cursor position, level taken from context.
  4680. @end multitable
  4681. Before inserting the text into a tree, the function ensures that the text has
  4682. a headline, i.e. a first line that starts with a @samp{*}. If not, a
  4683. headline is constructed from the current date. If you have indented the text
  4684. of the note below the headline, the indentation will be adapted if inserting
  4685. the note into the tree requires demotion from level 1.
  4686. @node Refiling notes, , Storing notes, Remember
  4687. @subsection Refiling notes
  4688. @cindex refiling notes
  4689. Remember is usually used to quickly capture notes and tasks into one or
  4690. a few capture lists. When reviewing the captured data, you may want to
  4691. refile some of the entries into a different list, for example into a
  4692. project. Cutting, finding the right location and then pasting the note
  4693. is cumbersome. To simplify this process, you can use the following
  4694. special command:
  4695. @table @kbd
  4696. @kindex C-c C-w
  4697. @item C-c C-w
  4698. Refile the entry or region at point. This command offers possible locations
  4699. for refiling the entry and lets you select one with completion. The item (or
  4700. all items in the region) is filed below the target heading as a subitem.
  4701. Depending on @code{org-reverse-note-order}, it will be either the first or
  4702. last subitem.@*
  4703. By default, all level 1 headlines in the current buffer are considered to be
  4704. targets, but you can have more complex definitions across a number of files.
  4705. See the variable @code{org-refile-targets} for details. If you would like to
  4706. select a location via a file-path-like completion along the outline path, see
  4707. the variables @code{org-refile-use-outline-path} and
  4708. @code{org-outline-path-complete-in-steps}.
  4709. @kindex C-u C-c C-w
  4710. @item C-u C-c C-w
  4711. Use the refile interface to jump to a heading.
  4712. @kindex C-u C-u C-c C-w
  4713. @item C-u C-u C-c C-w
  4714. Jump to the location where @code{org-refile} last moved a tree to.
  4715. @end table
  4716. @node Attachments, , Remember, Capture
  4717. @section Attachments
  4718. @cindex attachments
  4719. It is often useful to associate reference material with an outline node/task.
  4720. Small chunks of plain text can simply be stored in the subtree of a project.
  4721. Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
  4722. files that live elsewhere on your computer or in the cloud, like emails or
  4723. source code files belonging to a project. Another method is @i{attachments},
  4724. which are files located in a directory belonging to an outline node. Org
  4725. uses directories named by the unique ID of each entry. These directories are
  4726. located in the @file{data} directory which lives in the same directory where
  4727. your org-file lives@footnote{If you move entries or Org-files from one
  4728. directory to the next, you may want to configure @code{org-attach-directory}
  4729. to contain an absolute path.}. If you initialize this directory with
  4730. @code{git-init}, Org will automatically commit changes when it sees them.
  4731. The attachment system has been contributed to Org by John Wiegley.
  4732. In cases where this seems better, you can also attach a directory of your
  4733. choice to an entry. You can also make children inherit the attachment
  4734. directory from a parent, so that an entire subtree uses the same attached
  4735. directory.
  4736. @noindent The following commands deal with attachments.
  4737. @table @kbd
  4738. @kindex C-c C-a
  4739. @item C-c C-a
  4740. The dispatcher for commands related to the attachment system. After these
  4741. keys, a list of commands is displayed and you need to press an additional key
  4742. to select a command:
  4743. @table @kbd
  4744. @kindex C-c C-a a
  4745. @item a
  4746. Select a file and move it into the task's attachment directory. The file
  4747. will be copied, moved, or linked, depending on @code{org-attach-method}.
  4748. Note that hard links are not supported on all systems.
  4749. @kindex C-c C-a c
  4750. @kindex C-c C-a m
  4751. @kindex C-c C-a l
  4752. @item c/m/l
  4753. Attach a file using the copy/move/link method.
  4754. Note that hard links are not supported on all systems.
  4755. @kindex C-c C-a n
  4756. @item n
  4757. Create a new attachment as an Emacs buffer.
  4758. @kindex C-c C-a z
  4759. @item z
  4760. Synchronize the current task with its attachment directory, in case you added
  4761. attachments yourself.
  4762. @kindex C-c C-a o
  4763. @item o
  4764. Open current task's attachment. If there are more than one, prompt for a
  4765. file name first. Opening will follow the rules set by @code{org-file-apps}.
  4766. For more details, see the information on following hyperlinks
  4767. (@pxref{Handling links}).
  4768. @kindex C-c C-a O
  4769. @item O
  4770. Also open the attachment, but force opening the file in Emacs.
  4771. @kindex C-c C-a f
  4772. @item f
  4773. Open the current task's attachment directory.
  4774. @kindex C-c C-a F
  4775. @item F
  4776. Also open the directory, but force using @code{dired} in Emacs.
  4777. @kindex C-c C-a d
  4778. @item d
  4779. Select and delete a single attachment.
  4780. @kindex C-c C-a D
  4781. @item D
  4782. Delete all of a task's attachments. A safer way is to open the directory in
  4783. dired and delete from there.
  4784. @kindex C-c C-a s
  4785. @item C-c C-a s
  4786. Set a specific directory as the entry's attachment directory. This works by
  4787. putting the directory path into the @code{ATTACH_DIR} property.
  4788. @kindex C-c C-a i
  4789. @item C-c C-a i
  4790. Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
  4791. same directory for attachments as the parent.
  4792. @end table
  4793. @end table
  4794. @node Agenda Views, Embedded LaTeX, Capture, Top
  4795. @chapter Agenda Views
  4796. @cindex agenda views
  4797. Due to the way Org works, TODO items, time-stamped items, and
  4798. tagged headlines can be scattered throughout a file or even a number of
  4799. files. To get an overview of open action items, or of events that are
  4800. important for a particular date, this information must be collected,
  4801. sorted and displayed in an organized way.
  4802. Org can select items based on various criteria, and display them
  4803. in a separate buffer. Seven different view types are provided:
  4804. @itemize @bullet
  4805. @item
  4806. an @emph{agenda} that is like a calendar and shows information
  4807. for specific dates,
  4808. @item
  4809. a @emph{TODO list} that covers all unfinished
  4810. action items,
  4811. @item
  4812. a @emph{match view}, showings headlines based on the tags, properties and
  4813. TODO state associated with them,
  4814. @item
  4815. a @emph{timeline view} that shows all events in a single Org file,
  4816. in time-sorted view,
  4817. @item
  4818. a @emph{keyword search view} that shows all entries from multiple files
  4819. that contain specified keywords.
  4820. @item
  4821. a @emph{stuck projects view} showing projects that currently don't move
  4822. along, and
  4823. @item
  4824. @emph{custom views} that are special tag/keyword searches and
  4825. combinations of different views.
  4826. @end itemize
  4827. @noindent
  4828. The extracted information is displayed in a special @emph{agenda
  4829. buffer}. This buffer is read-only, but provides commands to visit the
  4830. corresponding locations in the original Org files, and even to
  4831. edit these files remotely.
  4832. Two variables control how the agenda buffer is displayed and whether the
  4833. window configuration is restored when the agenda exits:
  4834. @code{org-agenda-window-setup} and
  4835. @code{org-agenda-restore-windows-after-quit}.
  4836. @menu
  4837. * Agenda files:: Files being searched for agenda information
  4838. * Agenda dispatcher:: Keyboard access to agenda views
  4839. * Built-in agenda views:: What is available out of the box?
  4840. * Presentation and sorting:: How agenda items are prepared for display
  4841. * Agenda commands:: Remote editing of Org trees
  4842. * Custom agenda views:: Defining special searches and views
  4843. * Agenda column view:: Using column view for collected entries
  4844. @end menu
  4845. @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
  4846. @section Agenda files
  4847. @cindex agenda files
  4848. @cindex files for agenda
  4849. The information to be shown is normally collected from all @emph{agenda
  4850. files}, the files listed in the variable
  4851. @code{org-agenda-files}@footnote{If the value of that variable is not a
  4852. list, but a single file name, then the list of agenda files will be
  4853. maintained in that external file.}. If a directory is part of this list,
  4854. all files with the extension @file{.org} in this directory will be part
  4855. of the list.
  4856. Thus even if you only work with a single Org file, this file should
  4857. be put into that list@footnote{When using the dispatcher, pressing
  4858. @kbd{<} before selecting a command will actually limit the command to
  4859. the current file, and ignore @code{org-agenda-files} until the next
  4860. dispatcher command.}. You can customize @code{org-agenda-files}, but
  4861. the easiest way to maintain it is through the following commands
  4862. @cindex files, adding to agenda list
  4863. @table @kbd
  4864. @kindex C-c [
  4865. @item C-c [
  4866. Add current file to the list of agenda files. The file is added to
  4867. the front of the list. If it was already in the list, it is moved to
  4868. the front. With a prefix argument, file is added/moved to the end.
  4869. @kindex C-c ]
  4870. @item C-c ]
  4871. Remove current file from the list of agenda files.
  4872. @kindex C-,
  4873. @kindex C-'
  4874. @item C-,
  4875. @itemx C-'
  4876. Cycle through agenda file list, visiting one file after the other.
  4877. @kindex M-x org-iswitchb
  4878. @item M-x org-iswitchb
  4879. Command to use an @code{iswitchb}-like interface to switch to and between Org
  4880. buffers.
  4881. @end table
  4882. @noindent
  4883. The Org menu contains the current list of files and can be used
  4884. to visit any of them.
  4885. If you would like to focus the agenda temporarily onto a file not in
  4886. this list, or onto just one file in the list or even only a subtree in a
  4887. file, this can be done in different ways. For a single agenda command,
  4888. you may press @kbd{<} once or several times in the dispatcher
  4889. (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
  4890. extended period, use the following commands:
  4891. @table @kbd
  4892. @kindex C-c C-x <
  4893. @item C-c C-x <
  4894. Permanently restrict the agenda to the current subtree. When with a
  4895. prefix argument, or with the cursor before the first headline in a file,
  4896. the agenda scope is set to the entire file. This restriction remains in
  4897. effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
  4898. or @kbd{>} in the agenda dispatcher. If there is a window displaying an
  4899. agenda view, the new restriction takes effect immediately.
  4900. @kindex C-c C-x >
  4901. @item C-c C-x >
  4902. Remove the permanent restriction created by @kbd{C-c C-x <}.
  4903. @end table
  4904. @noindent
  4905. When working with @file{Speedbar}, you can use the following commands in
  4906. the Speedbar frame:
  4907. @table @kbd
  4908. @kindex <
  4909. @item < @r{in the speedbar frame}
  4910. Permanently restrict the agenda to the item at the cursor in the
  4911. Speedbar frame, either an Org file or a subtree in such a file.
  4912. If there is a window displaying an agenda view, the new restriction takes
  4913. effect immediately.
  4914. @kindex >
  4915. @item > @r{in the speedbar frame}
  4916. Lift the restriction again.
  4917. @end table
  4918. @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
  4919. @section The agenda dispatcher
  4920. @cindex agenda dispatcher
  4921. @cindex dispatching agenda commands
  4922. The views are created through a dispatcher that should be bound to a
  4923. global key, for example @kbd{C-c a} (@pxref{Installation}). In the
  4924. following we will assume that @kbd{C-c a} is indeed how the dispatcher
  4925. is accessed and list keyboard access to commands accordingly. After
  4926. pressing @kbd{C-c a}, an additional letter is required to execute a
  4927. command. The dispatcher offers the following default commands:
  4928. @table @kbd
  4929. @item a
  4930. Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
  4931. @item t @r{/} T
  4932. Create a list of all TODO items (@pxref{Global TODO list}).
  4933. @item m @r{/} M
  4934. Create a list of headlines matching a TAGS expression (@pxref{Matching
  4935. tags and properties}).
  4936. @item L
  4937. Create the timeline view for the current buffer (@pxref{Timeline}).
  4938. @item s
  4939. Create a list of entries selected by a boolean expression of keywords
  4940. and/or regular expressions that must or must not occur in the entry.
  4941. @item /
  4942. Search for a regular expression in all agenda files and additionally in
  4943. the files listed in @code{org-agenda-multi-occur-extra-files}. This
  4944. uses the Emacs command @code{multi-occur}. A prefix argument can be
  4945. used to specify the number of context lines for each match, default is
  4946. 1.
  4947. @item # @r{/} !
  4948. Create a list of stuck projects (@pxref{Stuck projects}).
  4949. @item <
  4950. Restrict an agenda command to the current buffer@footnote{For backward
  4951. compatibility, you can also press @kbd{1} to restrict to the current
  4952. buffer.}. After pressing @kbd{<}, you still need to press the character
  4953. selecting the command.
  4954. @item < <
  4955. If there is an active region, restrict the following agenda command to
  4956. the region. Otherwise, restrict it to the current subtree@footnote{For
  4957. backward compatibility, you can also press @kbd{0} to restrict to the
  4958. current buffer.}. After pressing @kbd{< <}, you still need to press the
  4959. character selecting the command.
  4960. @end table
  4961. You can also define custom commands that will be accessible through the
  4962. dispatcher, just like the default commands. This includes the
  4963. possibility to create extended agenda buffers that contain several
  4964. blocks together, for example the weekly agenda, the global TODO list and
  4965. a number of special tags matches. @xref{Custom agenda views}.
  4966. @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
  4967. @section The built-in agenda views
  4968. In this section we describe the built-in views.
  4969. @menu
  4970. * Weekly/daily agenda:: The calendar page with current tasks
  4971. * Global TODO list:: All unfinished action items
  4972. * Matching tags and properties:: Structured information with fine-tuned search
  4973. * Timeline:: Time-sorted view for single file
  4974. * Keyword search:: Finding entries by keyword
  4975. * Stuck projects:: Find projects you need to review
  4976. @end menu
  4977. @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
  4978. @subsection The weekly/daily agenda
  4979. @cindex agenda
  4980. @cindex weekly agenda
  4981. @cindex daily agenda
  4982. The purpose of the weekly/daily @emph{agenda} is to act like a page of a
  4983. paper agenda, showing all the tasks for the current week or day.
  4984. @table @kbd
  4985. @cindex org-agenda, command
  4986. @kindex C-c a a
  4987. @item C-c a a
  4988. Compile an agenda for the current week from a list of org files. The agenda
  4989. shows the entries for each day. With a numeric prefix@footnote{For backward
  4990. compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
  4991. listed before the agenda. This feature is deprecated, use the dedicated TODO
  4992. list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
  4993. C-c a a}) you may set the number of days to be displayed (see also the
  4994. variable @code{org-agenda-ndays})
  4995. @end table
  4996. Remote editing from the agenda buffer means, for example, that you can
  4997. change the dates of deadlines and appointments from the agenda buffer.
  4998. The commands available in the Agenda buffer are listed in @ref{Agenda
  4999. commands}.
  5000. @subsubheading Calendar/Diary integration
  5001. @cindex calendar integration
  5002. @cindex diary integration
  5003. Emacs contains the calendar and diary by Edward M. Reingold. The
  5004. calendar displays a three-month calendar with holidays from different
  5005. countries and cultures. The diary allows you to keep track of
  5006. anniversaries, lunar phases, sunrise/set, recurrent appointments
  5007. (weekly, monthly) and more. In this way, it is quite complementary to
  5008. Org. It can be very useful to combine output from Org with
  5009. the diary.
  5010. In order to include entries from the Emacs diary into Org mode's
  5011. agenda, you only need to customize the variable
  5012. @lisp
  5013. (setq org-agenda-include-diary t)
  5014. @end lisp
  5015. @noindent After that, everything will happen automatically. All diary
  5016. entries including holidays, anniversaries etc will be included in the
  5017. agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
  5018. @key{RET} can be used from the agenda buffer to jump to the diary
  5019. file in order to edit existing diary entries. The @kbd{i} command to
  5020. insert new entries for the current date works in the agenda buffer, as
  5021. well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
  5022. Sunrise/Sunset times, show lunar phases and to convert to other
  5023. calendars, respectively. @kbd{c} can be used to switch back and forth
  5024. between calendar and agenda.
  5025. If you are using the diary only for sexp entries and holidays, it is
  5026. faster to not use the above setting, but instead to copy or even move
  5027. the entries into an Org file. Org mode evaluates diary-style sexp
  5028. entries, and does it faster because there is no overhead for first
  5029. creating the diary display. Note that the sexp entries must start at
  5030. the left margin, no white space is allowed before them. For example,
  5031. the following segment of an Org file will be processed and entries
  5032. will be made in the agenda:
  5033. @example
  5034. * Birthdays and similar stuff
  5035. #+CATEGORY: Holiday
  5036. %%(org-calendar-holiday) ; special function for holiday names
  5037. #+CATEGORY: Ann
  5038. %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
  5039. %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
  5040. @end example
  5041. @subsubheading Appointment reminders
  5042. @cindex @file{appt.el}
  5043. @cindex appointment reminders
  5044. Org can interact with Emacs appointments notification facility.
  5045. To add all the appointments of your agenda files, use the command
  5046. @code{org-agenda-to-appt}. This commands also lets you filter through
  5047. the list of your appointments and add only those belonging to a specific
  5048. category or matching a regular expression. See the docstring for
  5049. details.
  5050. @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
  5051. @subsection The global TODO list
  5052. @cindex global TODO list
  5053. @cindex TODO list, global
  5054. The global TODO list contains all unfinished TODO items, formatted and
  5055. collected into a single place.
  5056. @table @kbd
  5057. @kindex C-c a t
  5058. @item C-c a t
  5059. Show the global TODO list. This collects the TODO items from all
  5060. agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
  5061. @code{agenda-mode}, so there are commands to examine and manipulate
  5062. the TODO entries directly from that buffer (@pxref{Agenda commands}).
  5063. @kindex C-c a T
  5064. @item C-c a T
  5065. @cindex TODO keyword matching
  5066. Like the above, but allows selection of a specific TODO keyword. You
  5067. can also do this by specifying a prefix argument to @kbd{C-c a t}. With
  5068. a @kbd{C-u} prefix you are prompted for a keyword, and you may also
  5069. specify several keywords by separating them with @samp{|} as boolean OR
  5070. operator. With a numeric prefix, the Nth keyword in
  5071. @code{org-todo-keywords} is selected.
  5072. @kindex r
  5073. The @kbd{r} key in the agenda buffer regenerates it, and you can give
  5074. a prefix argument to this command to change the selected TODO keyword,
  5075. for example @kbd{3 r}. If you often need a search for a specific
  5076. keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
  5077. Matching specific TODO keywords can also be done as part of a tags
  5078. search (@pxref{Tag searches}).
  5079. @end table
  5080. Remote editing of TODO items means that you can change the state of a
  5081. TODO entry with a single key press. The commands available in the
  5082. TODO list are described in @ref{Agenda commands}.
  5083. @cindex sublevels, inclusion into TODO list
  5084. Normally the global TODO list simply shows all headlines with TODO
  5085. keywords. This list can become very long. There are two ways to keep
  5086. it more compact:
  5087. @itemize @minus
  5088. @item
  5089. Some people view a TODO item that has been @emph{scheduled} for
  5090. execution (@pxref{Timestamps}) as no longer @emph{open}. Configure the
  5091. variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled
  5092. items from the global TODO list.
  5093. @item
  5094. TODO items may have sublevels to break up the task into subtasks. In
  5095. such cases it may be enough to list only the highest level TODO headline
  5096. and omit the sublevels from the global list. Configure the variable
  5097. @code{org-agenda-todo-list-sublevels} to get this behavior.
  5098. @end itemize
  5099. @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
  5100. @subsection Matching tags and properties
  5101. @cindex matching, of tags
  5102. @cindex matching, of properties
  5103. @cindex tags view
  5104. @cindex match view
  5105. If headlines in the agenda files are marked with @emph{tags}
  5106. (@pxref{Tags}), you can select headlines based on the tags that apply
  5107. to them and collect them into an agenda buffer.
  5108. @table @kbd
  5109. @kindex C-c a m
  5110. @item C-c a m
  5111. Produce a list of all headlines that match a given set of tags. The
  5112. command prompts for a selection criterion, which is a boolean logic
  5113. expression with tags, like @samp{+work+urgent-withboss} or
  5114. @samp{work|home} (@pxref{Tags}). If you often need a specific search,
  5115. define a custom command for it (@pxref{Agenda dispatcher}).
  5116. @kindex C-c a M
  5117. @item C-c a M
  5118. Like @kbd{C-c a m}, but only select headlines that are also TODO items
  5119. and force checking subitems (see variable
  5120. @code{org-tags-match-list-sublevels}). Matching specific TODO keywords
  5121. together with a tags match is also possible, see @ref{Tag searches}.
  5122. @end table
  5123. The commands available in the tags list are described in @ref{Agenda
  5124. commands}.
  5125. @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
  5126. @subsection Timeline for a single file
  5127. @cindex timeline, single file
  5128. @cindex time-sorted view
  5129. The timeline summarizes all time-stamped items from a single Org mode
  5130. file in a @emph{time-sorted view}. The main purpose of this command is
  5131. to give an overview over events in a project.
  5132. @table @kbd
  5133. @kindex C-c a L
  5134. @item C-c a L
  5135. Show a time-sorted view of the org file, with all time-stamped items.
  5136. When called with a @kbd{C-u} prefix, all unfinished TODO entries
  5137. (scheduled or not) are also listed under the current date.
  5138. @end table
  5139. @noindent
  5140. The commands available in the timeline buffer are listed in
  5141. @ref{Agenda commands}.
  5142. @node Keyword search, Stuck projects, Timeline, Built-in agenda views
  5143. @subsection Keyword search
  5144. @cindex keyword search
  5145. @cindex searching, for keywords
  5146. This agenda view is a general text search facility for Org mode entries.
  5147. It is particularly useful to find notes.
  5148. @table @kbd
  5149. @kindex C-c a s
  5150. @item C-c a s
  5151. This is a special search that lets you select entries by keywords or
  5152. regular expression, using a boolean logic. For example, the search
  5153. string
  5154. @example
  5155. +computer +wifi -ethernet -@{8\.11[bg]@}
  5156. @end example
  5157. @noindent
  5158. will search for note entries that contain the keywords @code{computer}
  5159. and @code{wifi}, but not the keyword @code{ethernet}, and which are also
  5160. not matched by the regular expression @code{8\.11[bg]}, meaning to
  5161. exclude both 8.11b and 8.11g.
  5162. Note that in addition to the agenda files, this command will also search
  5163. the files listed in @code{org-agenda-text-search-extra-files}.
  5164. @end table
  5165. @node Stuck projects, , Keyword search, Built-in agenda views
  5166. @subsection Stuck projects
  5167. If you are following a system like David Allen's GTD to organize your
  5168. work, one of the ``duties'' you have is a regular review to make sure
  5169. that all projects move along. A @emph{stuck} project is a project that
  5170. has no defined next actions, so it will never show up in the TODO lists
  5171. Org mode produces. During the review, you need to identify such
  5172. projects and define next actions for them.
  5173. @table @kbd
  5174. @kindex C-c a #
  5175. @item C-c a #
  5176. List projects that are stuck.
  5177. @kindex C-c a !
  5178. @item C-c a !
  5179. Customize the variable @code{org-stuck-projects} to define what a stuck
  5180. project is and how to find it.
  5181. @end table
  5182. You almost certainly will have to configure this view before it will
  5183. work for you. The built-in default assumes that all your projects are
  5184. level-2 headlines, and that a project is not stuck if it has at least
  5185. one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
  5186. Let's assume that you, in your own way of using Org mode, identify
  5187. projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
  5188. indicate a project that should not be considered yet. Let's further
  5189. assume that the TODO keyword DONE marks finished projects, and that NEXT
  5190. and TODO indicate next actions. The tag @@SHOP indicates shopping and
  5191. is a next action even without the NEXT tag. Finally, if the project
  5192. contains the special word IGNORE anywhere, it should not be listed
  5193. either. In this case you would start by identifying eligible projects
  5194. with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
  5195. TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
  5196. are not stuck. The correct customization for this is
  5197. @lisp
  5198. (setq org-stuck-projects
  5199. '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
  5200. "\\<IGNORE\\>"))
  5201. @end lisp
  5202. @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
  5203. @section Presentation and sorting
  5204. @cindex presentation, of agenda items
  5205. Before displaying items in an agenda view, Org mode visually prepares
  5206. the items and sorts them. Each item occupies a single line. The line
  5207. starts with a @emph{prefix} that contains the @emph{category}
  5208. (@pxref{Categories}) of the item and other important information. You can
  5209. customize the prefix using the option @code{org-agenda-prefix-format}.
  5210. The prefix is followed by a cleaned-up version of the outline headline
  5211. associated with the item.
  5212. @menu
  5213. * Categories:: Not all tasks are equal
  5214. * Time-of-day specifications:: How the agenda knows the time
  5215. * Sorting of agenda items:: The order of things
  5216. @end menu
  5217. @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
  5218. @subsection Categories
  5219. @cindex category
  5220. The category is a broad label assigned to each agenda item. By default,
  5221. the category is simply derived from the file name, but you can also
  5222. specify it with a special line in the buffer, like this@footnote{For
  5223. backward compatibility, the following also works: If there are several
  5224. such lines in a file, each specifies the category for the text below it.
  5225. The first category also applies to any text before the first CATEGORY
  5226. line. However, using this method is @emph{strongly} deprecated as it is
  5227. incompatible with the outline structure of the document. The correct
  5228. method for setting multiple categories in a buffer is using a
  5229. property.}:
  5230. @example
  5231. #+CATEGORY: Thesis
  5232. @end example
  5233. @noindent
  5234. If you would like to have a special CATEGORY for a single entry or a
  5235. (sub)tree, give the entry a @code{:CATEGORY:} property with the
  5236. special category you want to apply as the value.
  5237. @noindent
  5238. The display in the agenda buffer looks best if the category is not
  5239. longer than 10 characters.
  5240. @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
  5241. @subsection Time-of-day specifications
  5242. @cindex time-of-day specification
  5243. Org mode checks each agenda item for a time-of-day specification. The
  5244. time can be part of the time stamp that triggered inclusion into the
  5245. agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
  5246. ranges can be specified with two time stamps, like
  5247. @c
  5248. @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
  5249. In the headline of the entry itself, a time(range) may also appear as
  5250. plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
  5251. integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
  5252. specifications in diary entries are recognized as well.
  5253. For agenda display, Org mode extracts the time and displays it in a
  5254. standard 24 hour format as part of the prefix. The example times in
  5255. the previous paragraphs would end up in the agenda like this:
  5256. @example
  5257. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  5258. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  5259. 19:00...... The Vogon reads his poem
  5260. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  5261. @end example
  5262. @cindex time grid
  5263. If the agenda is in single-day mode, or for the display of today, the
  5264. timed entries are embedded in a time grid, like
  5265. @example
  5266. 8:00...... ------------------
  5267. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  5268. 10:00...... ------------------
  5269. 12:00...... ------------------
  5270. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  5271. 14:00...... ------------------
  5272. 16:00...... ------------------
  5273. 18:00...... ------------------
  5274. 19:00...... The Vogon reads his poem
  5275. 20:00...... ------------------
  5276. 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
  5277. @end example
  5278. The time grid can be turned on and off with the variable
  5279. @code{org-agenda-use-time-grid}, and can be configured with
  5280. @code{org-agenda-time-grid}.
  5281. @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
  5282. @subsection Sorting of agenda items
  5283. @cindex sorting, of agenda items
  5284. @cindex priorities, of agenda items
  5285. Before being inserted into a view, the items are sorted. How this is
  5286. done depends on the type of view.
  5287. @itemize @bullet
  5288. @item
  5289. For the daily/weekly agenda, the items for each day are sorted. The
  5290. default order is to first collect all items containing an explicit
  5291. time-of-day specification. These entries will be shown at the beginning
  5292. of the list, as a @emph{schedule} for the day. After that, items remain
  5293. grouped in categories, in the sequence given by @code{org-agenda-files}.
  5294. Within each category, items are sorted by priority (@pxref{Priorities}),
  5295. which is composed of the base priority (2000 for priority @samp{A}, 1000
  5296. for @samp{B}, and 0 for @samp{C}), plus additional increments for
  5297. overdue scheduled or deadline items.
  5298. @item
  5299. For the TODO list, items remain in the order of categories, but within
  5300. each category, sorting takes place according to priority
  5301. (@pxref{Priorities}).
  5302. @item
  5303. For tags matches, items are not sorted at all, but just appear in the
  5304. sequence in which they are found in the agenda files.
  5305. @end itemize
  5306. Sorting can be customized using the variable
  5307. @code{org-agenda-sorting-strategy}, and may also include criteria based on
  5308. the estimated effort of an entry (@pxref{Effort estimates}).
  5309. @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
  5310. @section Commands in the agenda buffer
  5311. @cindex commands, in agenda buffer
  5312. Entries in the agenda buffer are linked back to the org file or diary
  5313. file where they originate. You are not allowed to edit the agenda
  5314. buffer itself, but commands are provided to show and jump to the
  5315. original entry location, and to edit the org-files ``remotely'' from
  5316. the agenda buffer. In this way, all information is stored only once,
  5317. removing the risk that your agenda and note files may diverge.
  5318. Some commands can be executed with mouse clicks on agenda lines. For
  5319. the other commands, the cursor needs to be in the desired line.
  5320. @table @kbd
  5321. @tsubheading{Motion}
  5322. @cindex motion commands in agenda
  5323. @kindex n
  5324. @item n
  5325. Next line (same as @key{up} and @kbd{C-p}).
  5326. @kindex p
  5327. @item p
  5328. Previous line (same as @key{down} and @kbd{C-n}).
  5329. @tsubheading{View/Go to org file}
  5330. @kindex mouse-3
  5331. @kindex @key{SPC}
  5332. @item mouse-3
  5333. @itemx @key{SPC}
  5334. Display the original location of the item in another window.
  5335. With prefix arg, make sure that the entire entry is made visible in the
  5336. outline, not only the heading.
  5337. @c
  5338. @kindex L
  5339. @item L
  5340. Display original location and recenter that window.
  5341. @c
  5342. @kindex mouse-2
  5343. @kindex mouse-1
  5344. @kindex @key{TAB}
  5345. @item mouse-2
  5346. @itemx mouse-1
  5347. @itemx @key{TAB}
  5348. Go to the original location of the item in another window. Under Emacs
  5349. 22, @kbd{mouse-1} will also works for this.
  5350. @c
  5351. @kindex @key{RET}
  5352. @itemx @key{RET}
  5353. Go to the original location of the item and delete other windows.
  5354. @c
  5355. @kindex f
  5356. @item f
  5357. Toggle Follow mode. In Follow mode, as you move the cursor through
  5358. the agenda buffer, the other window always shows the corresponding
  5359. location in the org file. The initial setting for this mode in new
  5360. agenda buffers can be set with the variable
  5361. @code{org-agenda-start-with-follow-mode}.
  5362. @c
  5363. @kindex b
  5364. @item b
  5365. Display the entire subtree of the current item in an indirect buffer. With a
  5366. numeric prefix argument N, go up to level N and then take that tree. If N is
  5367. negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
  5368. previously used indirect buffer.
  5369. @c
  5370. @kindex l
  5371. @item l
  5372. Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
  5373. logging was on (variable @code{org-log-done}) are shown in the agenda, as are
  5374. entries that have been clocked on that day. You can configure the entry
  5375. types that should be included in log mode using the variable
  5376. @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
  5377. all possible logbook entries, including state changes. When called with two
  5378. prefix args @kbd{C-u C-u}, show only logging information, nothing else.
  5379. @c
  5380. @kindex v
  5381. @item v
  5382. Toggle Archives mode. In archives mode, trees that are marked
  5383. @code{ARCHIVED} are also scanned when producing the agenda. When you call
  5384. this command with a @kbd{C-u} prefix argument, even all archive files are
  5385. included. To exit archives mode, press @kbd{v} again.
  5386. @c
  5387. @kindex R
  5388. @item R
  5389. Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will
  5390. always show a table with the clocked times for the timespan and file scope
  5391. covered by the current agenda view. The initial setting for this mode in new
  5392. agenda buffers can be set with the variable
  5393. @code{org-agenda-start-with-clockreport-mode}.
  5394. @tsubheading{Change display}
  5395. @cindex display changing, in agenda
  5396. @kindex o
  5397. @item o
  5398. Delete other windows.
  5399. @c
  5400. @kindex d
  5401. @kindex w
  5402. @kindex m
  5403. @kindex y
  5404. @item d w m y
  5405. Switch to day/week/month/year view. When switching to day or week view,
  5406. this setting becomes the default for subsequent agenda commands. Since
  5407. month and year views are slow to create, they do not become the default.
  5408. A numeric prefix argument may be used to jump directly to a specific day
  5409. of the year, ISO week, month, or year, respectively. For example,
  5410. @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
  5411. setting day, week, or month view, a year may be encoded in the prefix
  5412. argument as well. For example, @kbd{200712 w} will jump to week 12 in
  5413. 2007. If such a year specification has only one or two digits, it will
  5414. be mapped to the interval 1938-2037.
  5415. @c
  5416. @kindex D
  5417. @item D
  5418. Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
  5419. @c
  5420. @kindex G
  5421. @item G
  5422. Toggle the time grid on and off. See also the variables
  5423. @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
  5424. @c
  5425. @kindex r
  5426. @item r
  5427. Recreate the agenda buffer, for example to reflect the changes
  5428. after modification of the time stamps of items with S-@key{left} and
  5429. S-@key{right}. When the buffer is the global TODO list, a prefix
  5430. argument is interpreted to create a selective list for a specific TODO
  5431. keyword.
  5432. @kindex g
  5433. @item g
  5434. Same as @kbd{r}.
  5435. @c
  5436. @kindex s
  5437. @kindex C-x C-s
  5438. @item s
  5439. @itemx C-x C-s
  5440. Save all Org buffers in the current Emacs session.
  5441. @c
  5442. @kindex @key{right}
  5443. @item @key{right}
  5444. Display the following @code{org-agenda-ndays} days. For example, if
  5445. the display covers a week, switch to the following week. With prefix
  5446. arg, go forward that many times @code{org-agenda-ndays} days.
  5447. @c
  5448. @kindex @key{left}
  5449. @item @key{left}
  5450. Display the previous dates.
  5451. @c
  5452. @kindex .
  5453. @item .
  5454. Go to today.
  5455. @c
  5456. @kindex C-c C-x C-c
  5457. @item C-c C-x C-c
  5458. Invoke column view (@pxref{Column view}) in the agenda buffer. The column
  5459. view format is taken from the entry at point, or (if there is no entry at
  5460. point), from the first entry in the agenda view. So whatever the format for
  5461. that entry would be in the original buffer (taken from a property, from a
  5462. @code{#+COLUMNS} line, or from the default variable
  5463. @code{org-columns-default-format}), will be used in the agenda.
  5464. @tsubheading{Secondary filtering and query editing}
  5465. @cindex filtering, by tag and effort, in agenda
  5466. @cindex tag filtering, in agenda
  5467. @cindex effort filtering, in agenda
  5468. @cindex query editing, in agenda
  5469. @kindex /
  5470. @item /
  5471. Filter the current agenda view with respect to a tag and/or effort estimates.
  5472. The difference between this and a custom agenda commands is that filtering is
  5473. very fast, so that you can switch quickly between different filters without
  5474. having to recreate the agenda.
  5475. You will be prompted for a tag selection letter. Pressing @key{TAB} at that
  5476. prompt will offer use completion to select a tag (including any tags that do
  5477. not have a selection character). The command then hides all entries that do
  5478. not contain or inherit this tag. When called with prefix arg, remove the
  5479. entries that @emph{do} have the tag. A second @kbd{/} at the prompt will
  5480. turn off the filter and unhide any hidden entries. If the first key you
  5481. press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
  5482. requiring or forbidding the selected additional tag. Instead of pressing
  5483. @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\}
  5484. command.
  5485. In order to filter for effort estimates, you should set-up allowed
  5486. efforts globally, for example
  5487. @lisp
  5488. (setq org-global-properties
  5489. '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
  5490. @end lisp
  5491. You can then filter for an effort by first typing an operator, one of @kbd{<},
  5492. @kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in
  5493. your array of allowed values, where @kbd{0} means the 10th value. The filter
  5494. will then restrict to entries with effort smaller-or-equal, equal, or
  5495. larger-or-equal than the selected value. If the digits 0-9 are not used as
  5496. fast access keys to tags, you can also simply press the index digit directly
  5497. without an operator. In this case, @kbd{<} will be assumed.
  5498. @kindex \
  5499. @item \
  5500. Narrow the current agenda filter by an additional condition. When called with
  5501. prefix arg, remove the entries that @emph{do} have the tag, or that do match
  5502. the effort criterion. You can achieve the same effect by pressing @kbd{+} or
  5503. @kbd{-} as the first key after the @kbd{/} command.
  5504. @kindex [
  5505. @kindex ]
  5506. @kindex @{
  5507. @kindex @}
  5508. @item [ ] @{ @}
  5509. In the @i{search view} (@pxref{Keyword search}), these keys add new search
  5510. words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and
  5511. @kbd{@}}) to the query string. The opening bracket/brace will add a positive
  5512. search term prefixed by @samp{+}, indicating that this search term @i{must}
  5513. occur/match in the entry. The closing bracket/brace will add a negative
  5514. search term which @i{must not} occur/match in the entry for it to be
  5515. selected.
  5516. @tsubheading{Remote editing}
  5517. @cindex remote editing, from agenda
  5518. @item 0-9
  5519. Digit argument.
  5520. @c
  5521. @cindex undoing remote-editing events
  5522. @cindex remote editing, undo
  5523. @kindex C-_
  5524. @item C-_
  5525. Undo a change due to a remote editing command. The change is undone
  5526. both in the agenda buffer and in the remote buffer.
  5527. @c
  5528. @kindex t
  5529. @item t
  5530. Change the TODO state of the item, both in the agenda and in the
  5531. original org file.
  5532. @c
  5533. @kindex C-k
  5534. @item C-k
  5535. Delete the current agenda item along with the entire subtree belonging
  5536. to it in the original Org file. If the text to be deleted remotely
  5537. is longer than one line, the kill needs to be confirmed by the user. See
  5538. variable @code{org-agenda-confirm-kill}.
  5539. @c
  5540. @kindex a
  5541. @item a
  5542. Toggle the ARCHIVE tag for the current headline.
  5543. @c
  5544. @kindex A
  5545. @item A
  5546. Move the subtree corresponding to the current entry to its @emph{Archive
  5547. Sibling}.
  5548. @c
  5549. @kindex $
  5550. @item $
  5551. Archive the subtree corresponding to the current headline. This means the
  5552. entry will be moved to the configured archive location, most likely a
  5553. different file.
  5554. @c
  5555. @kindex T
  5556. @item T
  5557. Show all tags associated with the current item. This is useful if you have
  5558. turned off @code{org-agenda-show-inherited-tags}, but still want to see all
  5559. tags of a headline occasionally.
  5560. @c
  5561. @kindex :
  5562. @item :
  5563. Set tags for the current headline. If there is an active region in the
  5564. agenda, change a tag for all headings in the region.
  5565. @c
  5566. @kindex ,
  5567. @item ,
  5568. Set the priority for the current item. Org mode prompts for the
  5569. priority character. If you reply with @key{SPC}, the priority cookie
  5570. is removed from the entry.
  5571. @c
  5572. @kindex P
  5573. @item P
  5574. Display weighted priority of current item.
  5575. @c
  5576. @kindex +
  5577. @kindex S-@key{up}
  5578. @item +
  5579. @itemx S-@key{up}
  5580. Increase the priority of the current item. The priority is changed in
  5581. the original buffer, but the agenda is not resorted. Use the @kbd{r}
  5582. key for this.
  5583. @c
  5584. @kindex -
  5585. @kindex S-@key{down}
  5586. @item -
  5587. @itemx S-@key{down}
  5588. Decrease the priority of the current item.
  5589. @c
  5590. @kindex C-c C-a
  5591. @item C-c C-a
  5592. Dispatcher for all command related to attachments.
  5593. @c
  5594. @kindex C-c C-s
  5595. @item C-c C-s
  5596. Schedule this item
  5597. @c
  5598. @kindex C-c C-d
  5599. @item C-c C-d
  5600. Set a deadline for this item.
  5601. @c
  5602. @kindex k
  5603. @item k
  5604. Agenda actions, to set dates for selected items to the cursor date.
  5605. This command also works in the calendar! The command prompts for an
  5606. additional key:
  5607. @example
  5608. m @r{Mark the entry at point for action. You can also make entries}
  5609. @r{in Org files with @kbd{C-c C-x C-k}.}
  5610. d @r{Set the deadline of the marked entry to the date at point.}
  5611. s @r{Schedule the marked entry at the date at point.}
  5612. r @r{Call @code{org-remember} with the cursor date as default date.}
  5613. @end example
  5614. Press @kbd{r} afterward to refresh the agenda and see the effect of the
  5615. command.
  5616. @c
  5617. @kindex S-@key{right}
  5618. @item S-@key{right}
  5619. Change the time stamp associated with the current line by one day into the
  5620. future. With a numeric prefix argument, change it by that many days. For
  5621. example, @kbd{3 6 5 S-@key{right}} will change it by a year. The stamp is
  5622. changed in the original org file, but the change is not directly reflected in
  5623. the agenda buffer. Use the @kbd{r} key to update the buffer.
  5624. @c
  5625. @kindex S-@key{left}
  5626. @item S-@key{left}
  5627. Change the time stamp associated with the current line by one day
  5628. into the past.
  5629. @c
  5630. @kindex >
  5631. @item >
  5632. Change the time stamp associated with the current line to today.
  5633. The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
  5634. on my keyboard.
  5635. @c
  5636. @kindex I
  5637. @item I
  5638. Start the clock on the current item. If a clock is running already, it
  5639. is stopped first.
  5640. @c
  5641. @kindex O
  5642. @item O
  5643. Stop the previously started clock.
  5644. @c
  5645. @kindex X
  5646. @item X
  5647. Cancel the currently running clock.
  5648. @kindex J
  5649. @item J
  5650. Jump to the running clock in another window.
  5651. @tsubheading{Calendar commands}
  5652. @cindex calendar commands, from agenda
  5653. @kindex c
  5654. @item c
  5655. Open the Emacs calendar and move to the date at the agenda cursor.
  5656. @c
  5657. @item c
  5658. When in the calendar, compute and show the Org mode agenda for the
  5659. date at the cursor.
  5660. @c
  5661. @cindex diary entries, creating from agenda
  5662. @kindex i
  5663. @item i
  5664. Insert a new entry into the diary. Prompts for the type of entry
  5665. (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
  5666. entry in the diary, just as @kbd{i d} etc. would do in the calendar.
  5667. The date is taken from the cursor position.
  5668. @c
  5669. @kindex M
  5670. @item M
  5671. Show the phases of the moon for the three months around current date.
  5672. @c
  5673. @kindex S
  5674. @item S
  5675. Show sunrise and sunset times. The geographical location must be set
  5676. with calendar variables, see documentation of the Emacs calendar.
  5677. @c
  5678. @kindex C
  5679. @item C
  5680. Convert the date at cursor into many other cultural and historic
  5681. calendars.
  5682. @c
  5683. @kindex H
  5684. @item H
  5685. Show holidays for three month around the cursor date.
  5686. @item M-x org-export-icalendar-combine-agenda-files
  5687. Export a single iCalendar file containing entries from all agenda files.
  5688. This is a globally available command, and also available in the agenda menu.
  5689. @tsubheading{Exporting to a file}
  5690. @kindex C-x C-w
  5691. @item C-x C-w
  5692. @cindex exporting agenda views
  5693. @cindex agenda views, exporting
  5694. Write the agenda view to a file. Depending on the extension of the
  5695. selected file name, the view will be exported as HTML (extension
  5696. @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
  5697. plain text (any other extension). Use the variable
  5698. @code{org-agenda-exporter-settings} to set options for @file{ps-print}
  5699. and for @file{htmlize} to be used during export.
  5700. @tsubheading{Quit and Exit}
  5701. @kindex q
  5702. @item q
  5703. Quit agenda, remove the agenda buffer.
  5704. @c
  5705. @kindex x
  5706. @cindex agenda files, removing buffers
  5707. @item x
  5708. Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
  5709. for the compilation of the agenda. Buffers created by the user to
  5710. visit org files will not be removed.
  5711. @end table
  5712. @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views
  5713. @section Custom agenda views
  5714. @cindex custom agenda views
  5715. @cindex agenda views, custom
  5716. Custom agenda commands serve two purposes: to store and quickly access
  5717. frequently used TODO and tags searches, and to create special composite
  5718. agenda buffers. Custom agenda commands will be accessible through the
  5719. dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
  5720. @menu
  5721. * Storing searches:: Type once, use often
  5722. * Block agenda:: All the stuff you need in a single buffer
  5723. * Setting Options:: Changing the rules
  5724. * Exporting Agenda Views:: Writing agendas to files
  5725. * Using the agenda elsewhere:: Using agenda information in other programs
  5726. @end menu
  5727. @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
  5728. @subsection Storing searches
  5729. The first application of custom searches is the definition of keyboard
  5730. shortcuts for frequently used searches, either creating an agenda
  5731. buffer, or a sparse tree (the latter covering of course only the current
  5732. buffer).
  5733. @kindex C-c a C
  5734. Custom commands are configured in the variable
  5735. @code{org-agenda-custom-commands}. You can customize this variable, for
  5736. example by pressing @kbd{C-c a C}. You can also directly set it with
  5737. Emacs Lisp in @file{.emacs}. The following example contains all valid
  5738. search types:
  5739. @lisp
  5740. @group
  5741. (setq org-agenda-custom-commands
  5742. '(("w" todo "WAITING")
  5743. ("W" todo-tree "WAITING")
  5744. ("u" tags "+boss-urgent")
  5745. ("v" tags-todo "+boss-urgent")
  5746. ("U" tags-tree "+boss-urgent")
  5747. ("f" occur-tree "\\<FIXME\\>")
  5748. ("h" . "HOME+Name tags searches") ; description for "h" prefix
  5749. ("hl" tags "+home+Lisa")
  5750. ("hp" tags "+home+Peter")
  5751. ("hk" tags "+home+Kim")))
  5752. @end group
  5753. @end lisp
  5754. @noindent
  5755. The initial string in each entry defines the keys you have to press
  5756. after the dispatcher command @kbd{C-c a} in order to access the command.
  5757. Usually this will be just a single character, but if you have many
  5758. similar commands, you can also define two-letter combinations where the
  5759. first character is the same in several combinations and serves as a
  5760. prefix key@footnote{You can provide a description for a prefix key by
  5761. inserting a cons cell with the prefix and the description.}. The second
  5762. parameter is the search type, followed by the string or regular
  5763. expression to be used for the matching. The example above will
  5764. therefore define:
  5765. @table @kbd
  5766. @item C-c a w
  5767. as a global search for TODO entries with @samp{WAITING} as the TODO
  5768. keyword
  5769. @item C-c a W
  5770. as the same search, but only in the current buffer and displaying the
  5771. results as a sparse tree
  5772. @item C-c a u
  5773. as a global tags search for headlines marked @samp{:boss:} but not
  5774. @samp{:urgent:}
  5775. @item C-c a v
  5776. as the same search as @kbd{C-c a u}, but limiting the search to
  5777. headlines that are also TODO items
  5778. @item C-c a U
  5779. as the same search as @kbd{C-c a u}, but only in the current buffer and
  5780. displaying the result as a sparse tree
  5781. @item C-c a f
  5782. to create a sparse tree (again: current buffer only) with all entries
  5783. containing the word @samp{FIXME}
  5784. @item C-c a h
  5785. as a prefix command for a HOME tags search where you have to press an
  5786. additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
  5787. Peter, or Kim) as additional tag to match.
  5788. @end table
  5789. @node Block agenda, Setting Options, Storing searches, Custom agenda views
  5790. @subsection Block agenda
  5791. @cindex block agenda
  5792. @cindex agenda, with block views
  5793. Another possibility is the construction of agenda views that comprise
  5794. the results of @emph{several} commands, each of which creates a block in
  5795. the agenda buffer. The available commands include @code{agenda} for the
  5796. daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
  5797. for the global TODO list (as constructed with @kbd{C-c a t}), and the
  5798. matching commands discussed above: @code{todo}, @code{tags}, and
  5799. @code{tags-todo}. Here are two examples:
  5800. @lisp
  5801. @group
  5802. (setq org-agenda-custom-commands
  5803. '(("h" "Agenda and Home-related tasks"
  5804. ((agenda "")
  5805. (tags-todo "home")
  5806. (tags "garden")))
  5807. ("o" "Agenda and Office-related tasks"
  5808. ((agenda "")
  5809. (tags-todo "work")
  5810. (tags "office")))))
  5811. @end group
  5812. @end lisp
  5813. @noindent
  5814. This will define @kbd{C-c a h} to create a multi-block view for stuff
  5815. you need to attend to at home. The resulting agenda buffer will contain
  5816. your agenda for the current week, all TODO items that carry the tag
  5817. @samp{home}, and also all lines tagged with @samp{garden}. Finally the
  5818. command @kbd{C-c a o} provides a similar view for office tasks.
  5819. @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
  5820. @subsection Setting options for custom commands
  5821. @cindex options, for custom agenda views
  5822. Org mode contains a number of variables regulating agenda construction
  5823. and display. The global variables define the behavior for all agenda
  5824. commands, including the custom commands. However, if you want to change
  5825. some settings just for a single custom view, you can do so. Setting
  5826. options requires inserting a list of variable names and values at the
  5827. right spot in @code{org-agenda-custom-commands}. For example:
  5828. @lisp
  5829. @group
  5830. (setq org-agenda-custom-commands
  5831. '(("w" todo "WAITING"
  5832. ((org-agenda-sorting-strategy '(priority-down))
  5833. (org-agenda-prefix-format " Mixed: ")))
  5834. ("U" tags-tree "+boss-urgent"
  5835. ((org-show-following-heading nil)
  5836. (org-show-hierarchy-above nil)))
  5837. ("N" search ""
  5838. ((org-agenda-files '("~org/notes.org"))
  5839. (org-agenda-text-search-extra-files nil)))))
  5840. @end group
  5841. @end lisp
  5842. @noindent
  5843. Now the @kbd{C-c a w} command will sort the collected entries only by
  5844. priority, and the prefix format is modified to just say @samp{ Mixed: }
  5845. instead of giving the category of the entry. The sparse tags tree of
  5846. @kbd{C-c a U} will now turn out ultra-compact, because neither the
  5847. headline hierarchy above the match, nor the headline following the match
  5848. will be shown. The command @kbd{C-c a N} will do a text search limited
  5849. to only a single file.
  5850. For command sets creating a block agenda,
  5851. @code{org-agenda-custom-commands} has two separate spots for setting
  5852. options. You can add options that should be valid for just a single
  5853. command in the set, and options that should be valid for all commands in
  5854. the set. The former are just added to the command entry, the latter
  5855. must come after the list of command entries. Going back to the block
  5856. agenda example (@pxref{Block agenda}), let's change the sorting strategy
  5857. for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
  5858. the results for GARDEN tags query in the opposite order,
  5859. @code{priority-up}. This would look like this:
  5860. @lisp
  5861. @group
  5862. (setq org-agenda-custom-commands
  5863. '(("h" "Agenda and Home-related tasks"
  5864. ((agenda)
  5865. (tags-todo "home")
  5866. (tags "garden"
  5867. ((org-agenda-sorting-strategy '(priority-up)))))
  5868. ((org-agenda-sorting-strategy '(priority-down))))
  5869. ("o" "Agenda and Office-related tasks"
  5870. ((agenda)
  5871. (tags-todo "work")
  5872. (tags "office")))))
  5873. @end group
  5874. @end lisp
  5875. As you see, the values and parenthesis setting is a little complex.
  5876. When in doubt, use the customize interface to set this variable - it
  5877. fully supports its structure. Just one caveat: When setting options in
  5878. this interface, the @emph{values} are just lisp expressions. So if the
  5879. value is a string, you need to add the double quotes around the value
  5880. yourself.
  5881. @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views
  5882. @subsection Exporting Agenda Views
  5883. @cindex agenda views, exporting
  5884. If you are away from your computer, it can be very useful to have a
  5885. printed version of some agenda views to carry around. Org mode can
  5886. export custom agenda views as plain text, HTML@footnote{You need to
  5887. install Hrvoje Niksic's @file{htmlize.el}.} postscript, and iCalendar
  5888. files. If you want to do this only occasionally, use the command
  5889. @table @kbd
  5890. @kindex C-x C-w
  5891. @item C-x C-w
  5892. @cindex exporting agenda views
  5893. @cindex agenda views, exporting
  5894. Write the agenda view to a file. Depending on the extension of the
  5895. selected file name, the view will be exported as HTML (extension
  5896. @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
  5897. iCalendar (extension @file{.ics}), or plain text (any other extension).
  5898. Use the variable @code{org-agenda-exporter-settings} to
  5899. set options for @file{ps-print} and for @file{htmlize} to be used during
  5900. export, for example
  5901. @lisp
  5902. (setq org-agenda-exporter-settings
  5903. '((ps-number-of-columns 2)
  5904. (ps-landscape-mode t)
  5905. (htmlize-output-type 'css)))
  5906. @end lisp
  5907. @end table
  5908. If you need to export certain agenda views frequently, you can associate
  5909. any custom agenda command with a list of output file names
  5910. @footnote{If you want to store standard views like the weekly agenda
  5911. or the global TODO list as well, you need to define custom commands for
  5912. them in order to be able to specify file names.}. Here is an example
  5913. that first does define custom commands for the agenda and the global
  5914. todo list, together with a number of files to which to export them.
  5915. Then we define two block agenda commands and specify file names for them
  5916. as well. File names can be relative to the current working directory,
  5917. or absolute.
  5918. @lisp
  5919. @group
  5920. (setq org-agenda-custom-commands
  5921. '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
  5922. ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
  5923. ("h" "Agenda and Home-related tasks"
  5924. ((agenda "")
  5925. (tags-todo "home")
  5926. (tags "garden"))
  5927. nil
  5928. ("~/views/home.html"))
  5929. ("o" "Agenda and Office-related tasks"
  5930. ((agenda)
  5931. (tags-todo "work")
  5932. (tags "office"))
  5933. nil
  5934. ("~/views/office.ps" "~/calendars/office.ics"))))
  5935. @end group
  5936. @end lisp
  5937. The extension of the file name determines the type of export. If it is
  5938. @file{.html}, Org mode will use the @file{htmlize.el} package to convert
  5939. the buffer to HTML and save it to this file name. If the extension is
  5940. @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
  5941. postscript output. If the extension is @file{.ics}, iCalendar export is
  5942. run export over all files that were used to construct the agenda, and
  5943. limit the export to entries listed in the agenda now. Any other
  5944. extension produces a plain ASCII file.
  5945. The export files are @emph{not} created when you use one of those
  5946. commands interactively because this might use too much overhead.
  5947. Instead, there is a special command to produce @emph{all} specified
  5948. files in one step:
  5949. @table @kbd
  5950. @kindex C-c a e
  5951. @item C-c a e
  5952. Export all agenda views that have export file names associated with
  5953. them.
  5954. @end table
  5955. You can use the options section of the custom agenda commands to also
  5956. set options for the export commands. For example:
  5957. @lisp
  5958. (setq org-agenda-custom-commands
  5959. '(("X" agenda ""
  5960. ((ps-number-of-columns 2)
  5961. (ps-landscape-mode t)
  5962. (org-agenda-prefix-format " [ ] ")
  5963. (org-agenda-with-colors nil)
  5964. (org-agenda-remove-tags t))
  5965. ("theagenda.ps"))))
  5966. @end lisp
  5967. @noindent
  5968. This command sets two options for the postscript exporter, to make it
  5969. print in two columns in landscape format - the resulting page can be cut
  5970. in two and then used in a paper agenda. The remaining settings modify
  5971. the agenda prefix to omit category and scheduling information, and
  5972. instead include a checkbox to check off items. We also remove the tags
  5973. to make the lines compact, and we don't want to use colors for the
  5974. black-and-white printer. Settings specified in
  5975. @code{org-agenda-exporter-settings} will also apply, but the settings
  5976. in @code{org-agenda-custom-commands} take precedence.
  5977. @noindent
  5978. From the command line you may also use
  5979. @example
  5980. emacs -f org-batch-store-agenda-views -kill
  5981. @end example
  5982. @noindent
  5983. or, if you need to modify some parameters@footnote{Quoting may depend on the
  5984. system you use, please check th FAQ for examples.}
  5985. @example
  5986. emacs -eval '(org-batch-store-agenda-views \
  5987. org-agenda-ndays 30 \
  5988. org-agenda-start-day "2007-11-01" \
  5989. org-agenda-include-diary nil \
  5990. org-agenda-files (quote ("~/org/project.org")))' \
  5991. -kill
  5992. @end example
  5993. @noindent
  5994. which will create the agenda views restricted to the file
  5995. @file{~/org/project.org}, without diary entries and with 30 days
  5996. extent.
  5997. @node Using the agenda elsewhere, , Exporting Agenda Views, Custom agenda views
  5998. @subsection Using agenda information outside of Org
  5999. @cindex agenda, pipe
  6000. @cindex Scripts, for agenda processing
  6001. Org provides commands to access agenda information for the command
  6002. line in emacs batch mode. This extracted information can be sent
  6003. directly to a printer, or it can be read by a program that does further
  6004. processing of the data. The first of these commands is the function
  6005. @code{org-batch-agenda}, that produces an agenda view and sends it as
  6006. ASCII text to STDOUT. The command takes a single string as parameter.
  6007. If the string has length 1, it is used as a key to one of the commands
  6008. you have configured in @code{org-agenda-custom-commands}, basically any
  6009. key you can use after @kbd{C-c a}. For example, to directly print the
  6010. current TODO list, you could use
  6011. @example
  6012. emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
  6013. @end example
  6014. If the parameter is a string with 2 or more characters, it is used as a
  6015. tags/todo match string. For example, to print your local shopping list
  6016. (all items with the tag @samp{shop}, but excluding the tag
  6017. @samp{NewYork}), you could use
  6018. @example
  6019. emacs -batch -l ~/.emacs \
  6020. -eval '(org-batch-agenda "+shop-NewYork")' | lpr
  6021. @end example
  6022. @noindent
  6023. You may also modify parameters on the fly like this:
  6024. @example
  6025. emacs -batch -l ~/.emacs \
  6026. -eval '(org-batch-agenda "a" \
  6027. org-agenda-ndays 30 \
  6028. org-agenda-include-diary nil \
  6029. org-agenda-files (quote ("~/org/project.org")))' \
  6030. | lpr
  6031. @end example
  6032. @noindent
  6033. which will produce a 30 day agenda, fully restricted to the Org file
  6034. @file{~/org/projects.org}, not even including the diary.
  6035. If you want to process the agenda data in more sophisticated ways, you
  6036. can use the command @code{org-batch-agenda-csv} to get a comma-separated
  6037. list of values for each agenda item. Each line in the output will
  6038. contain a number of fields separated by commas. The fields in a line
  6039. are:
  6040. @example
  6041. category @r{The category of the item}
  6042. head @r{The headline, without TODO kwd, TAGS and PRIORITY}
  6043. type @r{The type of the agenda entry, can be}
  6044. todo @r{selected in TODO match}
  6045. tagsmatch @r{selected in tags match}
  6046. diary @r{imported from diary}
  6047. deadline @r{a deadline}
  6048. scheduled @r{scheduled}
  6049. timestamp @r{appointment, selected by timestamp}
  6050. closed @r{entry was closed on date}
  6051. upcoming-deadline @r{warning about nearing deadline}
  6052. past-scheduled @r{forwarded scheduled item}
  6053. block @r{entry has date block including date}
  6054. todo @r{The TODO keyword, if any}
  6055. tags @r{All tags including inherited ones, separated by colons}
  6056. date @r{The relevant date, like 2007-2-14}
  6057. time @r{The time, like 15:00-16:50}
  6058. extra @r{String with extra planning info}
  6059. priority-l @r{The priority letter if any was given}
  6060. priority-n @r{The computed numerical priority}
  6061. @end example
  6062. @noindent
  6063. Time and date will only be given if a timestamp (or deadline/scheduled)
  6064. lead to the selection of the item.
  6065. A CSV list like this is very easy to use in a post processing script.
  6066. For example, here is a Perl program that gets the TODO list from
  6067. Emacs/Org and prints all the items, preceded by a checkbox:
  6068. @example
  6069. @group
  6070. #!/usr/bin/perl
  6071. # define the Emacs command to run
  6072. $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
  6073. # run it and capture the output
  6074. $agenda = qx@{$cmd 2>/dev/null@};
  6075. # loop over all lines
  6076. foreach $line (split(/\n/,$agenda)) @{
  6077. # get the individual values
  6078. ($category,$head,$type,$todo,$tags,$date,$time,$extra,
  6079. $priority_l,$priority_n) = split(/,/,$line);
  6080. # process and print
  6081. print "[ ] $head\n";
  6082. @}
  6083. @end group
  6084. @end example
  6085. @node Agenda column view, , Custom agenda views, Agenda Views
  6086. @section Using column view in the agenda
  6087. @cindex column view, in agenda
  6088. @cindex agenda, column view
  6089. Column view (@pxref{Column view}) is normally used to view and edit
  6090. properties embedded in the hierarchical structure of an Org file. It can be
  6091. quite useful to use column view also from the agenda, where entries are
  6092. collected by certain criteria.
  6093. @table @kbd
  6094. @kindex C-c C-x C-c
  6095. @item C-c C-x C-c
  6096. Turn on column view in the agenda.
  6097. @end table
  6098. To understand how to use this properly, it is important to realize that the
  6099. entries in the agenda are no longer in their proper outline environment.
  6100. This causes the following issues:
  6101. @enumerate
  6102. @item
  6103. Org needs to make a decision which @code{COLUMNS} format to use. Since the
  6104. entries in the agenda are collected from different files, and different files
  6105. may have different @code{COLUMNS} formats, this is a non-trivial problem.
  6106. Org first checks if the variable @code{org-overriding-columns-format} is
  6107. currently set, and if yes takes the format from there. Otherwise it takes
  6108. the format associated with the first item in the agenda, or, if that item
  6109. does not have a specific format (defined in a property, or in it's file), it
  6110. uses @code{org-columns-default-format}.
  6111. @item
  6112. If any of the columns has a summary type defined (@pxref{Column attributes}),
  6113. turning on column view in the agenda will visit all relevant agenda files and
  6114. make sure that the computations of this property are up to date. This is
  6115. also true for the special @code{CLOCKSUM} property. Org will then sum the
  6116. values displayed in the agenda. In the daily/weekly agenda, the sums will
  6117. cover a single day, in all other views they cover the entire block. It is
  6118. vital to realize that the agenda may show the same entry @emph{twice} (for
  6119. example as scheduled and as a deadline), and it may show two entries from the
  6120. same hierarchy (for example a @emph{parent} and it's @emph{child}). In these
  6121. cases, the summation in the agenda will lead to incorrect results because
  6122. some values will count double.
  6123. @item
  6124. When the column view in the agenda shows the @code{CLOCKSUM}, that is always
  6125. the entire clocked time for this item. So even in the daily/weekly agenda,
  6126. the clocksum listed in column view may originate from times outside the
  6127. current view. This has the advantage that you can compare these values with
  6128. a column listing the planned total effort for a task - one of the major
  6129. applications for column view in the agenda. If you want information about
  6130. clocked time in the displayed period use clock table mode (press @kbd{R} in
  6131. the agenda).
  6132. @end enumerate
  6133. @node Embedded LaTeX, Exporting, Agenda Views, Top
  6134. @chapter Embedded LaTeX
  6135. @cindex @TeX{} interpretation
  6136. @cindex La@TeX{} interpretation
  6137. Plain ASCII is normally sufficient for almost all note taking. One
  6138. exception, however, are scientific notes which need to be able to contain
  6139. mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
  6140. is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
  6141. features described here as ``La@TeX{}'' are really from @TeX{}, but for
  6142. simplicity I am blurring this distinction.} is widely used to typeset
  6143. scientific documents. Org mode supports embedding La@TeX{} code into its
  6144. files, because many academics are used to reading La@TeX{} source code, and
  6145. because it can be readily processed into images for HTML production.
  6146. It is not necessary to mark La@TeX{} macros and code in any special way.
  6147. If you observe a few conventions, Org mode knows how to find it and what
  6148. to do with it.
  6149. @menu
  6150. * Math symbols:: TeX macros for symbols and Greek letters
  6151. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  6152. * LaTeX fragments:: Complex formulas made easy
  6153. * Processing LaTeX fragments:: Previewing LaTeX processing
  6154. * CDLaTeX mode:: Speed up entering of formulas
  6155. @end menu
  6156. @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
  6157. @section Math symbols
  6158. @cindex math symbols
  6159. @cindex TeX macros
  6160. You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
  6161. indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
  6162. for these macros is available, just type @samp{\} and maybe a few letters,
  6163. and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
  6164. code, Org mode allows these macros to be present without surrounding math
  6165. delimiters, for example:
  6166. @example
  6167. Angles are written as Greek letters \alpha, \beta and \gamma.
  6168. @end example
  6169. During HTML export (@pxref{HTML export}), these symbols are translated
  6170. into the proper syntax for HTML, for the above examples this is
  6171. @samp{&alpha;} and @samp{&rarr;}, respectively. If you need such a symbol
  6172. inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
  6173. @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
  6174. @section Subscripts and superscripts
  6175. @cindex subscript
  6176. @cindex superscript
  6177. Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
  6178. and subscripts. Again, these can be used without embedding them in
  6179. math-mode delimiters. To increase the readability of ASCII text, it is
  6180. not necessary (but OK) to surround multi-character sub- and superscripts
  6181. with curly braces. For example
  6182. @example
  6183. The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
  6184. the sun is R_@{sun@} = 6.96 x 10^8 m.
  6185. @end example
  6186. To avoid interpretation as raised or lowered text, you can quote
  6187. @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
  6188. During HTML export (@pxref{HTML export}), subscript and superscripts
  6189. are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
  6190. @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
  6191. @section LaTeX fragments
  6192. @cindex LaTeX fragments
  6193. With symbols, sub- and superscripts, HTML is pretty much at its end when
  6194. it comes to representing mathematical formulas@footnote{Yes, there is
  6195. MathML, but that is not yet fully supported by many browsers, and there
  6196. is no decent converter for turning La@TeX{} or ASCII representations of
  6197. formulas into MathML. So for the time being, converting formulas into
  6198. images seems the way to go.}. More complex expressions need a dedicated
  6199. formula processor. To this end, Org mode can contain arbitrary La@TeX{}
  6200. fragments. It provides commands to preview the typeset result of these
  6201. fragments, and upon export to HTML, all fragments will be converted to
  6202. images and inlined into the HTML document@footnote{The La@TeX{} export
  6203. will not use images for displaying La@TeX{} fragments but include these
  6204. fragments directly into the La@TeX{} code.}. For this to work you
  6205. need to be on a system with a working La@TeX{} installation. You also
  6206. need the @file{dvipng} program, available at
  6207. @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
  6208. will be used when processing a fragment can be configured with the
  6209. variable @code{org-format-latex-header}.
  6210. La@TeX{} fragments don't need any special marking at all. The following
  6211. snippets will be identified as La@TeX{} source code:
  6212. @itemize @bullet
  6213. @item
  6214. Environments of any kind. The only requirement is that the
  6215. @code{\begin} statement appears on a new line, preceded by only
  6216. whitespace.
  6217. @item
  6218. Text within the usual La@TeX{} math delimiters. To avoid conflicts with
  6219. currency specifications, single @samp{$} characters are only recognized as
  6220. math delimiters if the enclosed text contains at most two line breaks, is
  6221. directly attached to the @samp{$} characters with no whitespace in between,
  6222. and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
  6223. For the other delimiters, there is no such restriction, so when in doubt, use
  6224. @samp{\(...\)} as inline math delimiters.
  6225. @end itemize
  6226. @noindent For example:
  6227. @example
  6228. \begin@{equation@} % arbitrary environments,
  6229. x=\sqrt@{b@} % even tables, figures
  6230. \end@{equation@} % etc
  6231. If $a^2=b$ and \( b=2 \), then the solution must be
  6232. either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
  6233. @end example
  6234. @noindent
  6235. If you need any of the delimiter ASCII sequences for other purposes, you
  6236. can configure the option @code{org-format-latex-options} to deselect the
  6237. ones you do not wish to have interpreted by the La@TeX{} converter.
  6238. @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
  6239. @section Processing LaTeX fragments
  6240. @cindex LaTeX fragments, preview
  6241. La@TeX{} fragments can be processed to produce a preview images of the
  6242. typeset expressions:
  6243. @table @kbd
  6244. @kindex C-c C-x C-l
  6245. @item C-c C-x C-l
  6246. Produce a preview image of the La@TeX{} fragment at point and overlay it
  6247. over the source code. If there is no fragment at point, process all
  6248. fragments in the current entry (between two headlines). When called
  6249. with a prefix argument, process the entire subtree. When called with
  6250. two prefix arguments, or when the cursor is before the first headline,
  6251. process the entire buffer.
  6252. @kindex C-c C-c
  6253. @item C-c C-c
  6254. Remove the overlay preview images.
  6255. @end table
  6256. During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
  6257. converted into images and inlined into the document if the following
  6258. setting is active:
  6259. @lisp
  6260. (setq org-export-with-LaTeX-fragments t)
  6261. @end lisp
  6262. @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
  6263. @section Using CDLaTeX to enter math
  6264. @cindex CDLaTeX
  6265. CDLaTeX mode is a minor mode that is normally used in combination with a
  6266. major La@TeX{} mode like AUCTeX in order to speed-up insertion of
  6267. environments and math templates. Inside Org mode, you can make use of
  6268. some of the features of CDLaTeX mode. You need to install
  6269. @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
  6270. AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
  6271. Don't use CDLaTeX mode itself under Org mode, but use the light
  6272. version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
  6273. on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
  6274. Org files with
  6275. @lisp
  6276. (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
  6277. @end lisp
  6278. When this mode is enabled, the following features are present (for more
  6279. details see the documentation of CDLaTeX mode):
  6280. @itemize @bullet
  6281. @kindex C-c @{
  6282. @item
  6283. Environment templates can be inserted with @kbd{C-c @{}.
  6284. @item
  6285. @kindex @key{TAB}
  6286. The @key{TAB} key will do template expansion if the cursor is inside a
  6287. La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
  6288. inside such a fragment, see the documentation of the function
  6289. @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
  6290. expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
  6291. correctly inside the first brace. Another @key{TAB} will get you into
  6292. the second brace. Even outside fragments, @key{TAB} will expand
  6293. environment abbreviations at the beginning of a line. For example, if
  6294. you write @samp{equ} at the beginning of a line and press @key{TAB},
  6295. this abbreviation will be expanded to an @code{equation} environment.
  6296. To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
  6297. @item
  6298. @kindex _
  6299. @kindex ^
  6300. Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
  6301. characters together with a pair of braces. If you use @key{TAB} to move
  6302. out of the braces, and if the braces surround only a single character or
  6303. macro, they are removed again (depending on the variable
  6304. @code{cdlatex-simplify-sub-super-scripts}).
  6305. @item
  6306. @kindex `
  6307. Pressing the backquote @kbd{`} followed by a character inserts math
  6308. macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
  6309. after the backquote, a help window will pop up.
  6310. @item
  6311. @kindex '
  6312. Pressing the normal quote @kbd{'} followed by another character modifies
  6313. the symbol before point with an accent or a font. If you wait more than
  6314. 1.5 seconds after the backquote, a help window will pop up. Character
  6315. modification will work only inside La@TeX{} fragments, outside the quote
  6316. is normal.
  6317. @end itemize
  6318. @node Exporting, Publishing, Embedded LaTeX, Top
  6319. @chapter Exporting
  6320. @cindex exporting
  6321. Org mode documents can be exported into a variety of other formats. For
  6322. printing and sharing of notes, ASCII export produces a readable and
  6323. simple version of an Org file. HTML export allows you to publish a
  6324. notes file on the web, while the XOXO format provides a solid base for
  6325. exchange with a broad range of other applications. La@TeX{} export lets
  6326. you use Org mode and its structured editing functions to easily create
  6327. La@TeX{} files. To incorporate entries with associated times like
  6328. deadlines or appointments into a desktop calendar program like iCal,
  6329. Org mode can also produce extracts in the iCalendar format. Currently
  6330. Org mode only supports export, not import of these different formats.
  6331. Org supports export of selected regions when @code{transient-mark-mode} is
  6332. enabled (default in Emacs 23).
  6333. @menu
  6334. * Markup rules:: Which structures are recognized?
  6335. * Selective export:: Using tags to select and exclude trees
  6336. * Export options:: Per-file export settings
  6337. * The export dispatcher:: How to access exporter commands
  6338. * ASCII export:: Exporting to plain ASCII
  6339. * HTML export:: Exporting to HTML
  6340. * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
  6341. * XOXO export:: Exporting to XOXO
  6342. * iCalendar export:: Exporting in iCalendar format
  6343. @end menu
  6344. @node Markup rules, Selective export, Exporting, Exporting
  6345. @section Markup rules
  6346. When exporting Org mode documents, the exporter tries to reflect the
  6347. structure of the document as accurately as possible in the back-end. Since
  6348. export targets like HTML or La@TeX{} allow much richer formatting, Org mode
  6349. has rules how to prepare text for rich export. This section summarizes the
  6350. markup rule used in an Org mode buffer.
  6351. @menu
  6352. * Document title:: How the document title is determined
  6353. * Headings and sections:: The main structure of the exported document
  6354. * Table of contents:: If, where, how to create a table of contents
  6355. * Initial text:: Text before the first headline
  6356. * Lists:: Plain lists are exported
  6357. * Paragraphs:: What determines beginning and ending
  6358. * Literal examples:: Source code and other examples
  6359. * Include files:: Include the contents of a file during export
  6360. * Tables exported:: Tables are exported richly
  6361. * Inlined images:: How to inline images during export
  6362. * Footnote markup::
  6363. * Emphasis and monospace:: To bold or not to bold
  6364. * TeX macros and LaTeX fragments:: Create special, rich export.
  6365. * Horizontal rules:: A line across the page
  6366. * Comment lines:: Some lines will not be exported
  6367. @end menu
  6368. @node Document title, Headings and sections, Markup rules, Markup rules
  6369. @subheading Document title
  6370. @cindex document title, markup rules
  6371. @noindent
  6372. The title of the exported document is taken from the special line
  6373. @example
  6374. #+TITLE: This is the title of the document
  6375. @end example
  6376. @noindent
  6377. If this line does not exist, the title is derived from the first non-empty,
  6378. non-comment line in the buffer. If no such line exists, or if you have
  6379. turned off exporting of the text before the first headline (see below), the
  6380. title will be the file name without extension.
  6381. If you are exporting only a subtree by marking is as the region, the heading
  6382. of the subtree will become the title of the document. If the subtree has a
  6383. property @code{EXPORT_TITLE}, that will take precedence.
  6384. @node Headings and sections, Table of contents, Document title, Markup rules
  6385. @subheading Headings and sections
  6386. @cindex headings and sections, markup rules
  6387. The outline structure of the document as described in @ref{Document
  6388. Structure} forms the basis for defining sections of the exported document.
  6389. However, since the outline structure is also used for (for example) lists of
  6390. tasks, only the first three outline levels will be used as headings. Deeper
  6391. levels will become itemized lists. You can change the location of this
  6392. switch, globally by setting the variable @code{org-headline-levels}, or on a
  6393. per file basis with a line
  6394. @example
  6395. #+OPTIONS: H:4
  6396. @end example
  6397. @node Table of contents, Initial text, Headings and sections, Markup rules
  6398. @subheading Table of contents
  6399. @cindex table of contents, markup rules
  6400. The table of contents is normally inserted directly before the first headline
  6401. of the file. If you would like to get it to a different location, insert the
  6402. string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
  6403. location. The depth of the table of contents is by default the same as the
  6404. number of headline levels, but you can choose a smaller number or turn off
  6405. the table of contents entirely by configuring the variable
  6406. @code{org-export-with-toc}, or on a per-file basis with a line like
  6407. @example
  6408. #+OPTIONS: toc:2 (only to two levels in TOC)
  6409. #+OPTIONS: toc:nil (no TOC at all)
  6410. @end example
  6411. @node Initial text, Lists, Table of contents, Markup rules
  6412. @subheading Text before the first headline
  6413. @cindex text before first headline, markup rules
  6414. @cindex #+TEXT
  6415. Org mode normally exports the text before the first headline, and even uses
  6416. the first line as the document title. The text will be fully marked up. If
  6417. you need to include literal HTML or La@TeX{} code, use the special constructs
  6418. described below in the sections for the individual exporters.
  6419. Some people like to use the space before the first headline for setup and
  6420. internal links and therefore would like to control the exported text before
  6421. the first headline in a different way. You can do so by setting the variable
  6422. @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
  6423. basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
  6424. @noindent
  6425. If you still want to have some text before the first headline, use the
  6426. @code{#+TEXT} construct:
  6427. @example
  6428. #+OPTIONS: skip:t
  6429. #+TEXT: This text will go before the *first* headline.
  6430. #+TEXT: [TABLE-OF-CONTENTS]
  6431. #+TEXT: This goes between the table of contents and the first headline
  6432. @end example
  6433. @node Lists, Paragraphs, Initial text, Markup rules
  6434. @subheading Lists
  6435. @cindex lists, markup rules
  6436. Plain lists as described in @ref{Plain lists} are translated to the back-ends
  6437. syntax for such lists. Most back-ends support unordered, ordered, and
  6438. description lists.
  6439. @node Paragraphs, Literal examples, Lists, Markup rules
  6440. @subheading Paragraphs, line breaks, and quoting
  6441. @cindex paragraphs, markup rules
  6442. Paragraphs are separated by at least one empty line. If you need to enforce
  6443. a line break within a paragraph, use @samp{\\} at the end of a line.
  6444. To keep the line breaks in a region, but otherwise use normal formatting, you
  6445. can use this construct, which can also be used to format poetry.
  6446. @example
  6447. #+BEGIN_VERSE
  6448. Great clouds overhead
  6449. Tiny black birds rise and fall
  6450. Snow covers Emacs
  6451. -- AlexSchroeder
  6452. #+END_VERSE
  6453. @end example
  6454. When quoting a passage from another document, it is customary to format this
  6455. as a paragraph that is indented on both the left and the right margin. You
  6456. can include quotations in Org mode documents like this:
  6457. @example
  6458. #+BEGIN_QUOTE
  6459. Everything should be made as simple as possible,
  6460. but not any simpler -- Albert Einstein
  6461. #+END_QUOTE
  6462. @end example
  6463. @node Literal examples, Include files, Paragraphs, Markup rules
  6464. @subheading Literal examples
  6465. @cindex literal examples, markup rules
  6466. @cindex code line refenences, markup rules
  6467. You can include literal examples that should not be subjected to
  6468. markup. Such examples will be typeset in monospace, so this is well suited
  6469. for source code and similar examples.
  6470. @cindex #+BEGIN_EXAMPLE
  6471. @example
  6472. #+BEGIN_EXAMPLE
  6473. Some example from a text file.
  6474. #+END_EXAMPLE
  6475. @end example
  6476. For simplicity when using small examples, you can also start the example
  6477. lines with a colon followed by a space. There may also be additional
  6478. whitespace before the colon:
  6479. @example
  6480. Here is an example
  6481. : Some example from a text file.
  6482. @end example
  6483. @cindex formatting source code, markup rules
  6484. If the example is source code from a programming language, or any other text
  6485. that can be marked up by font-lock in Emacs, you can ask for the example to
  6486. look like the fontified Emacs buffer@footnote{Currently this works only for
  6487. the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or
  6488. later.}. This is done with the @samp{src} block, where you also need to
  6489. specify the name of the major mode that should be used to fontify the
  6490. example:
  6491. @cindex #+BEGIN_SRC
  6492. @example
  6493. #+BEGIN_SRC emacs-lisp
  6494. (defun org-xor (a b)
  6495. "Exclusive or."
  6496. (if a (not b) b))
  6497. #+END_SRC
  6498. @end example
  6499. Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
  6500. switch to the end of the @code{BEGIN} line, to get the lines of the example
  6501. numbered. If you use a @code{+n} switch, the numbering from the previous
  6502. numbered snippet will be continued in the current one. In literal examples,
  6503. Org will interpret strings like @samp{(ref:name)} as labels, and use them as
  6504. targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference
  6505. name enclosed in single parenthesis). In HTML, hoovering the mouse over such
  6506. a link will remote-highlight the corresponding code line, which is kind of
  6507. cool. If the example/src snippet is numbered, you can also add a @code{-r}
  6508. switch. Then labels will be @i{removed} from the source code and the links
  6509. will be @i{replaced}@footnote{If you want to explain the use of such labels
  6510. themelves in org-mode example code, you can use the @code{-k} switch to make
  6511. sure they are not touched.} with line numbers from the code listing. Here is
  6512. an example:
  6513. @example
  6514. #+BEGIN_SRC emacs-lisp -n -r
  6515. (save-excursion (ref:sc)
  6516. (goto-char (point-min)) (ref:jump)
  6517. #+END SRC
  6518. In line [[(sc)]] we remember the current positon. [[(jump)][Line (jump)]]
  6519. jumps to point-min.
  6520. @end example
  6521. If the syntax for the label format conflicts with the language syntax, use a
  6522. @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
  6523. -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
  6524. HTML export also allows examples to be publishes as text areas, @pxref{Text
  6525. areas in HTML export}
  6526. @table @kbd
  6527. @kindex C-c '
  6528. @item C-c '
  6529. Edit the source code example at point in its native mode. This works by
  6530. switching to an indirect buffer, narrowing the buffer and switching to the
  6531. other mode. You need to exit by pressing @kbd{C-c '} again@footnote{Upon
  6532. exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to
  6533. keep them from being interpreted by Org as outline nodes or special
  6534. comments. These commas will be striped for editing with @kbd{C-c '}, and
  6535. also for export.}. Fixed-width
  6536. regions (where each line starts with a colon followed by a space) will be
  6537. edited using @code{artist-mode}@footnote{You may select a different-mode with
  6538. the variable @code{org-edit-fixed-width-region-mode}.} to allow creating
  6539. ASCII drawings easily. Using this command in an empty line will create a new
  6540. fixed-width region.
  6541. @kindex C-c l
  6542. @item C-c l
  6543. Calling @code{org-store-link} while editing a source code example in a
  6544. temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
  6545. that it is unique in the current buffer, and insert it with the proper
  6546. formatting like @samp{(ref:label)} at the end of the current line. Then the
  6547. label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
  6548. @end table
  6549. @node Include files, Tables exported, Literal examples, Markup rules
  6550. @subheading Include files
  6551. @cindex include files, markup rules
  6552. During export, you can include the content of another file. For example, to
  6553. include your .emacs file, you could use:
  6554. @cindex #+INCLUDE
  6555. @example
  6556. #+INCLUDE: "~/.emacs" src emacs-lisp
  6557. @end example
  6558. The optional second and third parameter are the markup (@samp{quote},
  6559. @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
  6560. language for formatting the contents. The markup is optional, if it is not
  6561. given, the text will be assumed to be in Org mode format and will be
  6562. processed normally. The include line will also allow additional keyword
  6563. parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
  6564. first line and for each following line, as well as any options accepted by
  6565. the selected markup. For example, to include a file as an item, use
  6566. @example
  6567. #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
  6568. @end example
  6569. @table @kbd
  6570. @kindex C-c '
  6571. @item C-c '
  6572. Visit the include file at point.
  6573. @end table
  6574. @node Tables exported, Inlined images, Include files, Markup rules
  6575. @subheading Tables
  6576. @cindex tables, markup rules
  6577. Both the native Org mode tables (@pxref{Tables}) and tables formatted with
  6578. the @file{table.el} package will be exported properly. For Org mode tables,
  6579. the lines before the first horizontal separator line will become table header
  6580. lines. You can use the following lines somewhere before the table to assign
  6581. a caption and a label for cross references:
  6582. @example
  6583. #+CAPTION: This is the caption for the next table (or link)
  6584. #+LABEL: tbl:basic-data
  6585. @end example
  6586. @node Inlined images, Footnote markup, Tables exported, Markup rules
  6587. @subheading Inlined Images
  6588. @cindex inlined images, markup rules
  6589. Some backends (HTML and LaTeX) allow to directly include images into the
  6590. exported document. Org does this, if a link to an image files does not have
  6591. a description part, for example @code{[[./img/a.jpg]]}. If you wish to
  6592. define a caption for the image and maybe a label for internal cross
  6593. references, you can use (before, but close to the link)
  6594. @example
  6595. #+CAPTION: This is the caption for the next figure link (or table)
  6596. #+LABEL: fig:SED-HR4049
  6597. @end example
  6598. You may also define additional attributes for the figure. As this is
  6599. backend-specific, see the sections about the individual backends for more
  6600. information.
  6601. @node Footnote markup, Emphasis and monospace, Inlined images, Markup rules
  6602. @subheading Footnote markup
  6603. @cindex footnotes, markup rules
  6604. @cindex @file{footnote.el}
  6605. Footnotes defined in the way descriped in @ref{Footnotes} will be exported by
  6606. all backends. Org does allow multiple references to the same note, and
  6607. different backends support this to varying degree.
  6608. @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
  6609. @subheading Emphasis and monospace
  6610. @cindex underlined text, markup rules
  6611. @cindex bold text, markup rules
  6612. @cindex italic text, markup rules
  6613. @cindex verbatim text, markup rules
  6614. @cindex code text, markup rules
  6615. @cindex strike-through text, markup rules
  6616. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
  6617. and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
  6618. in the code and verbatim string is not processed for Org mode specific
  6619. syntax, it is exported verbatim.
  6620. @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
  6621. @subheading @TeX{} macros and La@TeX{} fragments
  6622. @cindex LaTeX fragments, markup rules
  6623. @cindex TeX macros, markup rules
  6624. @cindex HTML entities
  6625. @cindex LaTeX entities
  6626. A @TeX{}-like syntax is used to specify special characters. Where possible,
  6627. these will be transformed into the native format of the exporter back-end.
  6628. Strings like @code{\alpha} will be exported as @code{&alpha;} in the HTML
  6629. output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
  6630. @code{\nbsp} will become @code{&nbsp;} in HTML and @code{~} in La@TeX{}.
  6631. This applies for a large number of entities, with names taken from both HTML
  6632. and La@TeX{}, see the variable @code{org-html-entities} for the complete
  6633. list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
  6634. after having typed the backslash and maybe a few characters
  6635. (@pxref{Completion}).
  6636. La@TeX{} fragments are converted into images for HTML export, and they are
  6637. written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}.
  6638. Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
  6639. @samp{...} are all converted into special commands creating hyphens of
  6640. different lengths or a compact set of dots.
  6641. @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
  6642. @subheading Horizontal rules
  6643. @cindex horizontal rules, markup rules
  6644. A line consisting of only dashes, and at least 5 of them, will be
  6645. exported as a horizontal line (@samp{<hr/>} in HTML).
  6646. @node Comment lines, , Horizontal rules, Markup rules
  6647. @subheading Comment lines
  6648. @cindex comment lines
  6649. @cindex exporting, not
  6650. Lines starting with @samp{#} in column zero are treated as comments and will
  6651. never be exported. Also entire subtrees starting with the word
  6652. @samp{COMMENT} will never be exported. Finally, regions surrounded by
  6653. @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
  6654. @table @kbd
  6655. @kindex C-c ;
  6656. @item C-c ;
  6657. Toggle the COMMENT keyword at the beginning of an entry.
  6658. @end table
  6659. @node Selective export, Export options, Markup rules, Exporting
  6660. @section Selective export
  6661. @cindex export, selective by tags
  6662. You may use tags to select the parts of a document that should be exported,
  6663. or to exclude parts from export. This behavior is governed by two variables:
  6664. @code{org-export-select-tags} and @code{org-export-exclude-tags}.
  6665. Org first checks if any of the @emph{select} tags is present in the buffer.
  6666. If yes, all trees that do not carry one of these tags will be excluded. If a
  6667. selected tree is a subtree, the heading hierarchy above it will also be
  6668. selected for export, but not the text below those headings.
  6669. @noindent
  6670. If none of the select tags is found, the whole buffer will be selected for
  6671. export.
  6672. @noindent
  6673. Finally, all subtrees that are marked by any of the @emph{exclude} tags will
  6674. be removed from the export buffer.
  6675. @node Export options, The export dispatcher, Selective export, Exporting
  6676. @section Export options
  6677. @cindex options, for export
  6678. @cindex completion, of option keywords
  6679. The exporter recognizes special lines in the buffer which provide
  6680. additional information. These lines may be put anywhere in the file.
  6681. The whole set of lines can be inserted into the buffer with @kbd{C-c
  6682. C-e t}. For individual lines, a good way to make sure the keyword is
  6683. correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
  6684. (@pxref{Completion}).
  6685. @table @kbd
  6686. @kindex C-c C-e t
  6687. @item C-c C-e t
  6688. Insert template with export options, see example below.
  6689. @end table
  6690. @cindex #+TITLE:
  6691. @cindex #+AUTHOR:
  6692. @cindex #+DATE:
  6693. @cindex #+EMAIL:
  6694. @cindex #+LANGUAGE:
  6695. @cindex #+TEXT:
  6696. @cindex #+OPTIONS:
  6697. @cindex #+LINK_UP:
  6698. @cindex #+LINK_HOME:
  6699. @cindex #+EXPORT_SELECT_TAGS:
  6700. @cindex #+EXPORT_EXCLUDE_TAGS:
  6701. @example
  6702. #+TITLE: the title to be shown (default is the buffer name)
  6703. #+AUTHOR: the author (default taken from @code{user-full-name})
  6704. #+DATE: A date, fixed, of a format string for @code{format-time-string}
  6705. #+EMAIL: his/her email address (default from @code{user-mail-address})
  6706. #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
  6707. #+TEXT: Some descriptive text to be inserted at the beginning.
  6708. #+TEXT: Several lines may be given.
  6709. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
  6710. #+LINK_UP: the ``up'' link of an exported page
  6711. #+LINK_HOME: the ``home'' link of an exported page
  6712. #+EXPORT_SELECT_TAGS: Tags that select a tree for export
  6713. #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
  6714. @end example
  6715. @noindent
  6716. The OPTIONS line is a compact@footnote{If you want to configure many options
  6717. this way, you can use several OPTIONS lines.} form to specify export settings. Here
  6718. you can:
  6719. @cindex headline levels
  6720. @cindex section-numbers
  6721. @cindex table of contents
  6722. @cindex line-break preservation
  6723. @cindex quoted HTML tags
  6724. @cindex fixed-width sections
  6725. @cindex tables
  6726. @cindex @TeX{}-like syntax for sub- and superscripts
  6727. @cindex footnotes
  6728. @cindex special strings
  6729. @cindex emphasized text
  6730. @cindex @TeX{} macros
  6731. @cindex La@TeX{} fragments
  6732. @cindex author info, in export
  6733. @cindex time info, in export
  6734. @example
  6735. H: @r{set the number of headline levels for export}
  6736. num: @r{turn on/off section-numbers}
  6737. toc: @r{turn on/off table of contents, or set level limit (integer)}
  6738. \n: @r{turn on/off line-break-preservation}
  6739. @@: @r{turn on/off quoted HTML tags}
  6740. :: @r{turn on/off fixed-width sections}
  6741. |: @r{turn on/off tables}
  6742. ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
  6743. @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
  6744. @r{the simple @code{a_b} will be left as it is.}
  6745. -: @r{turn on/off conversion of special strings.}
  6746. f: @r{turn on/off footnotes like this[1].}
  6747. todo: @r{turn on/off inclusion of TODO keywords into exported text}
  6748. pri: @r{turn on/off priority cookies}
  6749. tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
  6750. <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
  6751. *: @r{turn on/off emphasized text (bold, italic, underlined)}
  6752. TeX: @r{turn on/off simple @TeX{} macros in plain text}
  6753. LaTeX: @r{turn on/off La@TeX{} fragments}
  6754. skip: @r{turn on/off skipping the text before the first heading}
  6755. author: @r{turn on/off inclusion of author name/email into exported file}
  6756. creator: @r{turn on/off inclusion of creator info into exported file}
  6757. timestamp: @r{turn on/off inclusion creation time into exported file}
  6758. d: @r{turn on/off inclusion of drawers}
  6759. @end example
  6760. These options take effect in both the HTML and La@TeX{} export, except
  6761. for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
  6762. @code{nil} for the La@TeX{} export.
  6763. When exporting only a single subtree by selecting it with @kbd{C-c @@} before
  6764. calling an export command, the subtree can overrule some of the file's export
  6765. settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
  6766. @code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}.
  6767. @node The export dispatcher, ASCII export, Export options, Exporting
  6768. @section The export dispatcher
  6769. @cindex dispatcher, for export commands
  6770. All export commands can be reached using the export dispatcher, which is a
  6771. prefix key that prompts for an additional key specifying the command.
  6772. Normally the entire file is exported, but if there is an active region that
  6773. contains one outline tree, the first heading is used as document title and
  6774. the subtrees are exported.
  6775. @table @kbd
  6776. @kindex C-c C-e
  6777. @item C-c C-e
  6778. Dispatcher for export and publishing commands. Displays a help-window
  6779. listing the additional key(s) needed to launch an export or publishing
  6780. command. The prefix arg is passed through to the exporter. A double prefix
  6781. @kbd{C-u C-u} causes most commands to be executed in the background, in a
  6782. separate emacs process@footnote{To make this behavior the default, customize
  6783. the variable @code{org-export-run-in-background}.}.
  6784. @kindex C-c C-e v
  6785. @item C-c C-e v
  6786. Like @kbd{C-c C-e}, but only export the text that is currently visible
  6787. (i.e. not hidden by outline visibility).
  6788. @kindex C-u C-u C-c C-e
  6789. @item C-u C-u C-c C-e
  6790. Call an the exporter, but reverse the setting of
  6791. @code{org-export-run-in-background}, i.e. request background processing if
  6792. not set, or force processing in the current Emacs process if st.
  6793. @end table
  6794. @node ASCII export, HTML export, The export dispatcher, Exporting
  6795. @section ASCII export
  6796. @cindex ASCII export
  6797. ASCII export produces a simple and very readable version of an Org mode
  6798. file.
  6799. @cindex region, active
  6800. @cindex active region
  6801. @cindex transient-mark-mode
  6802. @table @kbd
  6803. @kindex C-c C-e a
  6804. @item C-c C-e a
  6805. Export as ASCII file. For an org file @file{myfile.org}, the ASCII file
  6806. will be @file{myfile.txt}. The file will be overwritten without
  6807. warning. If there is an active region@footnote{this requires
  6808. @code{transient-mark-mode} to be turned on}, only the region will be
  6809. exported. If the selected region is a single tree@footnote{To select the
  6810. current subtree, use @kbd{C-c @@}.}, the tree head will
  6811. become the document title. If the tree head entry has or inherits an
  6812. @code{EXPORT_FILE_NAME} property, that name will be used for the
  6813. export.
  6814. @kindex C-c C-e v a
  6815. @item C-c C-e v a
  6816. Export only the visible part of the document.
  6817. @end table
  6818. @cindex headline levels, for exporting
  6819. In the exported version, the first 3 outline levels will become
  6820. headlines, defining a general document structure. Additional levels
  6821. will be exported as itemized lists. If you want that transition to occur
  6822. at a different level, specify it with a prefix argument. For example,
  6823. @example
  6824. @kbd{C-1 C-c C-e a}
  6825. @end example
  6826. @noindent
  6827. creates only top level headlines and does the rest as items. When
  6828. headlines are converted to items, the indentation of the text following
  6829. the headline is changed to fit nicely under the item. This is done with
  6830. the assumption that the first body line indicates the base indentation of
  6831. the body text. Any indentation larger than this is adjusted to preserve
  6832. the layout relative to the first line. Should there be lines with less
  6833. indentation than the first, these are left alone.
  6834. @node HTML export, LaTeX and PDF export, ASCII export, Exporting
  6835. @section HTML export
  6836. @cindex HTML export
  6837. Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
  6838. HTML formatting, in ways similar to John Gruber's @emph{markdown}
  6839. language, but with additional support for tables.
  6840. @menu
  6841. * HTML Export commands:: How to invoke HTML export
  6842. * Quoting HTML tags:: Using direct HTML in Org mode
  6843. * Links:: Transformation of links for HTML
  6844. * Images in HTML export:: How to insert figures into HTML output
  6845. * Text areas in HTML export:: An alternative way to show an example
  6846. * CSS support:: Changing the appearance of the output
  6847. * Javascript support:: Info and Folding in a web browser
  6848. @end menu
  6849. @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
  6850. @subsection HTML export commands
  6851. @cindex region, active
  6852. @cindex active region
  6853. @cindex transient-mark-mode
  6854. @table @kbd
  6855. @kindex C-c C-e h
  6856. @item C-c C-e h
  6857. Export as HTML file @file{myfile.html}. For an org file @file{myfile.org},
  6858. the ASCII file will be @file{myfile.html}. The file will be overwritten
  6859. without warning. If there is an active region@footnote{this requires
  6860. @code{transient-mark-mode} to be turned on}, only the region will be
  6861. exported. If the selected region is a single tree@footnote{To select the
  6862. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  6863. title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
  6864. property, that name will be used for the export.
  6865. @kindex C-c C-e b
  6866. @item C-c C-e b
  6867. Export as HTML file and immediately open it with a browser.
  6868. @kindex C-c C-e H
  6869. @item C-c C-e H
  6870. Export to a temporary buffer, do not create a file.
  6871. @kindex C-c C-e R
  6872. @item C-c C-e R
  6873. Export the active region to a temporary buffer. With a prefix argument, do
  6874. not produce the file header and footer, but just the plain HTML section for
  6875. the region. This is good for cut-and-paste operations.
  6876. @kindex C-c C-e v h
  6877. @kindex C-c C-e v b
  6878. @kindex C-c C-e v H
  6879. @kindex C-c C-e v R
  6880. @item C-c C-e v h
  6881. @item C-c C-e v b
  6882. @item C-c C-e v H
  6883. @item C-c C-e v R
  6884. Export only the visible part of the document.
  6885. @item M-x org-export-region-as-html
  6886. Convert the region to HTML under the assumption that it was Org mode
  6887. syntax before. This is a global command that can be invoked in any
  6888. buffer.
  6889. @item M-x org-replace-region-by-HTML
  6890. Replace the active region (assumed to be in Org mode syntax) by HTML
  6891. code.
  6892. @end table
  6893. @cindex headline levels, for exporting
  6894. In the exported version, the first 3 outline levels will become headlines,
  6895. defining a general document structure. Additional levels will be exported as
  6896. itemized lists. If you want that transition to occur at a different level,
  6897. specify it with a numeric prefix argument. For example,
  6898. @example
  6899. @kbd{C-2 C-c C-e b}
  6900. @end example
  6901. @noindent
  6902. creates two levels of headings and does the rest as items.
  6903. @node Quoting HTML tags, Links, HTML Export commands, HTML export
  6904. @subsection Quoting HTML tags
  6905. Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
  6906. @samp{&gt;} in HTML export. If you want to include simple HTML tags
  6907. which should be interpreted as such, mark them with @samp{@@} as in
  6908. @samp{@@<b>bold text@@</b>}. Note that this really works only for
  6909. simple tags. For more extensive HTML that should be copied verbatim to
  6910. the exported file use either
  6911. @example
  6912. #+HTML: Literal HTML code for export
  6913. @end example
  6914. @noindent or
  6915. @cindex #+BEGIN_HTML
  6916. @example
  6917. #+BEGIN_HTML
  6918. All lines between these markers are exported literally
  6919. #+END_HTML
  6920. @end example
  6921. @node Links, Images in HTML export, Quoting HTML tags, HTML export
  6922. @subsection Links
  6923. @cindex links, in HTML export
  6924. @cindex internal links, in HTML export
  6925. @cindex external links, in HTML export
  6926. Internal links (@pxref{Internal links}) will continue to work in HTML. This
  6927. does include automatic links created by radio targets (@pxref{Radio
  6928. targets}). Links to external files will still work if the target file is on
  6929. the same @i{relative} path as the published Org file. Links to other
  6930. @file{.org} files will be translated into HTML links under the assumption
  6931. that an HTML version also exists of the linked file, at the same relative
  6932. path. @samp{id:} links can then be used to jump to specific entries across
  6933. files. For information related to linking files while publishing them to a
  6934. publishing directory see @ref{Publishing links}.
  6935. If you want to specify attributes for links, you can do so using a special
  6936. @code{#+ATTR_HTML} line to define attributes that will be added to the
  6937. @code{<a>} or @code{<img>} tags. Here is an example that sets @code{alt} and
  6938. @code{title} attributes for an inlined image:
  6939. @example
  6940. #+ATTR_HTML: alt="This is image A" title="Image with no action"
  6941. [[./img/a.jpg]]
  6942. @end example
  6943. @node Images in HTML export, Text areas in HTML export, Links, HTML export
  6944. @subsection Images
  6945. @cindex images, inline in HTML
  6946. @cindex inlining images in HTML
  6947. HTML export can inline images given as links in the Org file, and
  6948. it can make an image the clickable part of a link. By
  6949. default@footnote{but see the variable
  6950. @code{org-export-html-inline-images}}, images are inlined if a link does
  6951. not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
  6952. while @samp{[[file:myimg.jpg][the image]]} will just produce a link
  6953. @samp{the image} that points to the image. If the description part
  6954. itself is a @code{file:} link or a @code{http:} URL pointing to an
  6955. image, this image will be inlined and activated so that clicking on the
  6956. image will activate the link. For example, to include a thumbnail that
  6957. will link to a high resolution version of the image, you could use:
  6958. @example
  6959. [[file:highres.jpg][file:thumb.jpg]]
  6960. @end example
  6961. @noindent
  6962. and you could use @code{http} addresses just as well.
  6963. @node Text areas in HTML export, CSS support, Images in HTML export, HTML export
  6964. @subsection Text areas
  6965. @cindex text areas, in HTML
  6966. An alternative way to publish literal code examples in HTML is to use text
  6967. areas, where the example can even be edited before pasting it into an
  6968. application. It is triggered by a @code{-t} switch at an @code{example} or
  6969. @code{src} block. Using this switch disables any options for syntax and
  6970. label highlighting, and line numbering, which may be present. You may also
  6971. use @code{-h} and @code{-w} switches to specify the height and width of the
  6972. text area, which default to the number of lines in the example, and 80,
  6973. respectively. For example
  6974. @example
  6975. #+BEGIN_EXAMPLE -t -w 40
  6976. (defun org-xor (a b)
  6977. "Exclusive or."
  6978. (if a (not b) b))
  6979. #+END_EXAMPLE
  6980. @end example
  6981. @node CSS support, Javascript support, Text areas in HTML export, HTML export
  6982. @subsection CSS support
  6983. @cindex CSS, for HTML export
  6984. @cindex HTML export, CSS
  6985. You can also give style information for the exported file. The HTML exporter
  6986. assigns the following special CSS classes to appropriate parts of the
  6987. document - your style specifications may change these, in addition to any of
  6988. the standard classes like for headlines, tables etc.
  6989. @example
  6990. .todo @r{TODO keywords}
  6991. .done @r{the DONE keyword}
  6992. .timestamp @r{time stamp}
  6993. .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
  6994. .tag @r{tag in a headline}
  6995. .target @r{target for links}
  6996. div.figure @r{how to format an inlined image}
  6997. .linenr @r{the line number in a code example}
  6998. .code-highlighted @r{for highlighting referenced code lines}
  6999. @end example
  7000. Each exported files contains a compact default style that defines these
  7001. classes in a basic way@footnote{This style is defined in the constant
  7002. @code{org-export-html-style-default}, which you should not modify. To turn
  7003. inclusion of these defaults off, customize
  7004. @code{org-export-html-style-include-default}}. You may overwrite these
  7005. settings, or add to them by using the variables @code{org-export-html-style}
  7006. (for Org-wide settings) and @code{org-export-html-style-extra} (for more
  7007. granular settings, like file-local settings). To set the latter variable
  7008. individually for each file, you can use
  7009. @example
  7010. #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  7011. @end example
  7012. @noindent
  7013. For longer style definitions, you can use several such lines. You could also
  7014. directly write a @code{<style>} @code{</style>} section in this way, without
  7015. referring to an external file.
  7016. @c FIXME: More about header and footer styles
  7017. @c FIXME: Talk about links and targets.
  7018. @node Javascript support, , CSS support, HTML export
  7019. @subsection Javascript supported display of web pages
  7020. @emph{Sebastian Rose} has written a JavaScript program especially designed to
  7021. enhance the web viewing experience of HTML files created with Org. This
  7022. program allows you to view large files in two different ways. The first one
  7023. is an @emph{Info}-like mode where each section is displayed separately and
  7024. navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
  7025. as well, press @kbd{?} for an overview of the available keys). The second
  7026. view type is a @emph{folding} view much like Org provides inside Emacs. The
  7027. script is available at @url{http://orgmode.org/org-info.js} and you can find
  7028. the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
  7029. We are serving the script from our site, but if you use it a lot, you might
  7030. not want to be dependent on @url{orgmode.org} and prefer to install a local
  7031. copy on your own web server.
  7032. To use the script, you need to make sure that the @file{org-jsinfo.el} module
  7033. gets loaded. It should be loaded by default, but you can try @kbd{M-x
  7034. customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
  7035. this is indeed the case. All it then takes to make use of the program is
  7036. adding a single line to the Org file:
  7037. @example
  7038. #+INFOJS_OPT: view:info toc:nil
  7039. @end example
  7040. @noindent
  7041. If this line is found, the HTML header will automatically contain the code
  7042. needed to invoke the script. Using the line above, you can set the following
  7043. viewing options:
  7044. @example
  7045. path: @r{The path to the script. The default is to grab the script from}
  7046. @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
  7047. @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
  7048. view: @r{Initial view when website is first shown. Possible values are:}
  7049. info @r{Info-like interface with one section per page.}
  7050. overview @r{Folding interface, initially showing only top-level.}
  7051. content @r{Folding interface, starting with all headlines visible.}
  7052. showall @r{Folding interface, all headlines and text visible.}
  7053. sdepth: @r{Maximum headline level that will still become an independent}
  7054. @r{section for info and folding modes. The default is taken from}
  7055. @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
  7056. @r{If this is smaller than in @code{org-headline-levels}, each}
  7057. @r{info/folding section can still contain children headlines.}
  7058. toc: @r{Should the table of content @emph{initially} be visible?}
  7059. @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.}
  7060. tdepth: @r{The depth of the table of contents. The defaults are taken from}
  7061. @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
  7062. ftoc: @r{Does the css of the page specify a fixed position for the toc?}
  7063. @r{If yes, the toc will never be displayed as a section.}
  7064. ltoc: @r{Should there be short contents (children) in each section?}
  7065. mouse: @r{Headings are highlighted when the mouse is over them. Should be}
  7066. @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
  7067. buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
  7068. @r{default), only one such button will be present.}
  7069. @end example
  7070. You can choose default values for these options by customizing the variable
  7071. @code{org-infojs-options}. If you always want to apply the script to your
  7072. pages, configure the variable @code{org-export-html-use-infojs}.
  7073. @node LaTeX and PDF export, XOXO export, HTML export, Exporting
  7074. @section LaTeX and PDF export
  7075. @cindex LaTeX export
  7076. @cindex PDF export
  7077. Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
  7078. further processing, this backend is also used to produce PDF output. Since
  7079. the LaTeX output uses @file{hyperref} to implement links and cross
  7080. references, the PDF output file will be fully linked.
  7081. @menu
  7082. * LaTeX/PDF export commands:: Which key invokes which commands
  7083. * Quoting LaTeX code:: Incorporating literal LaTeX code
  7084. * Sectioning structure:: Changing sectioning in LaTeX output
  7085. * Tables in LaTeX export:: Options for exporting tables to LaTeX
  7086. * Images in LaTeX export:: How to insert figures into LaTeX output
  7087. @end menu
  7088. @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
  7089. @subsection LaTeX export commands
  7090. @cindex region, active
  7091. @cindex active region
  7092. @cindex transient-mark-mode
  7093. @table @kbd
  7094. @kindex C-c C-e l
  7095. @item C-c C-e l
  7096. Export as La@TeX{} file @file{myfile.tex}. For an org file
  7097. @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
  7098. be overwritten without warning. If there is an active region@footnote{this
  7099. requires @code{transient-mark-mode} to be turned on}, only the region will be
  7100. exported. If the selected region is a single tree@footnote{To select the
  7101. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  7102. title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
  7103. property, that name will be used for the export.
  7104. @kindex C-c C-e L
  7105. @item C-c C-e L
  7106. Export to a temporary buffer, do not create a file.
  7107. @kindex C-c C-e v l
  7108. @kindex C-c C-e v L
  7109. @item C-c C-e v l
  7110. @item C-c C-e v L
  7111. Export only the visible part of the document.
  7112. @item M-x org-export-region-as-latex
  7113. Convert the region to La@TeX{} under the assumption that it was Org mode
  7114. syntax before. This is a global command that can be invoked in any
  7115. buffer.
  7116. @item M-x org-replace-region-by-latex
  7117. Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
  7118. code.
  7119. @kindex C-c C-e p
  7120. @item C-c C-e p
  7121. Export as LaTeX and then process to PDF.
  7122. @kindex C-c C-e d
  7123. @item C-c C-e d
  7124. Export as LaTeX and then process to PDF, then open the resulting PDF file.
  7125. @end table
  7126. @cindex headline levels, for exporting
  7127. In the exported version, the first 3 outline levels will become
  7128. headlines, defining a general document structure. Additional levels
  7129. will be exported as description lists. The exporter can ignore them or
  7130. convert them to a custom string depending on
  7131. @code{org-latex-low-levels}.
  7132. If you want that transition to occur at a different level, specify it
  7133. with a numeric prefix argument. For example,
  7134. @example
  7135. @kbd{C-2 C-c C-e l}
  7136. @end example
  7137. @noindent
  7138. creates two levels of headings and does the rest as items.
  7139. @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
  7140. @subsection Quoting LaTeX code
  7141. Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
  7142. inserted into the La@TeX{} file. This includes simple macros like
  7143. @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
  7144. you can add special code that should only be present in La@TeX{} export with
  7145. the following constructs:
  7146. @example
  7147. #+LaTeX: Literal LaTeX code for export
  7148. @end example
  7149. @noindent or
  7150. @cindex #+BEGIN_LaTeX
  7151. @example
  7152. #+BEGIN_LaTeX
  7153. All lines between these markers are exported literally
  7154. #+END_LaTeX
  7155. @end example
  7156. @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
  7157. @subsection Sectioning structure
  7158. @cindex LaTeX class
  7159. @cindex LaTeX sectioning structure
  7160. By default, the La@TeX{} output uses the class @code{article}.
  7161. You can change this globally by setting a different value for
  7162. @code{org-export-latex-default-class} or locally by adding an option like
  7163. @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
  7164. property that applies when exporting a region containing only this (sub)tree.
  7165. The class should be listed in @code{org-export-latex-classes}, where you can
  7166. also define the sectioning structure for each class, as well as defining
  7167. additional classes.
  7168. @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
  7169. @subsection Tables in LaTeX export
  7170. @cindex tables, in LaTeX export
  7171. For LaTeX export of a table, you can specify a label and a caption
  7172. (@pxref{Tables exported}). You can also use the @code{ATTR_LaTeX} line to
  7173. request a longtable environment for the table, so that it may span several
  7174. pages:
  7175. @example
  7176. #+CAPTION: A long table
  7177. #+LABEL: tbl:long
  7178. #+ATTR_LaTeX: longtable
  7179. | ..... | ..... |
  7180. | ..... | ..... |
  7181. @end example
  7182. @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export
  7183. @subsection Images in LaTeX export
  7184. @cindex images, inline in LaTeX
  7185. @cindex inlining images in LaTeX
  7186. Images that are linked to without a description part in the link, like
  7187. @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
  7188. output files resulting from LaTeX output. Org will use an
  7189. @code{\includegraphics} macro to insert the image. If you have specified a
  7190. caption and/or a label as described in @ref{Markup rules}, the figure will
  7191. be wrapped into a @code{figure} environment and thus become a floating
  7192. element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the
  7193. options that can be used in the optional argument of the
  7194. @code{\includegraphics} macro.
  7195. @example
  7196. #+CAPTION: The black-body emission of the disk around HR 4049
  7197. #+LABEL: fig:SED-HR4049
  7198. #+ATTR_LaTeX: width=5cm,angle=90
  7199. [[./img/sed-hr4049.pdf]]
  7200. @end example
  7201. If you need references to a label created in this way, write
  7202. @samp{\ref@{fig:SED-HR4049@}} just like in LaTeX. The default settings will
  7203. recognize files types that can be included as images during processing by
  7204. pdflatex (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
  7205. files in a different way, you may need to customize the variable
  7206. @code{org-export-latex-inline-image-extensions}.
  7207. @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting
  7208. @section XOXO export
  7209. @cindex XOXO export
  7210. Org mode contains an exporter that produces XOXO-style output.
  7211. Currently, this exporter only handles the general outline structure and
  7212. does not interpret any additional Org mode features.
  7213. @table @kbd
  7214. @kindex C-c C-e x
  7215. @item C-c C-e x
  7216. Export as XOXO file @file{myfile.html}.
  7217. @kindex C-c C-e v
  7218. @item C-c C-e v x
  7219. Export only the visible part of the document.
  7220. @end table
  7221. @node iCalendar export, , XOXO export, Exporting
  7222. @section iCalendar export
  7223. @cindex iCalendar export
  7224. Some people like to use Org mode for keeping track of projects, but still
  7225. prefer a standard calendar application for anniversaries and appointments.
  7226. In this case it can be useful to have deadlines and other time-stamped items
  7227. in Org files show up in the calendar application. Org mode can export
  7228. calendar information in the standard iCalendar format. If you also want to
  7229. have TODO entries included in the export, configure the variable
  7230. @code{org-icalendar-include-todo}. iCalendar export will export plain time
  7231. stamps as VEVENT, and TODO items as VTODO. It will also create events from
  7232. deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO
  7233. items will be used to set the start and due dates for the todo
  7234. entry@footnote{See the variables @code{org-icalendar-use-deadline} and
  7235. @code{org-icalendar-use-scheduled}.}. As categories, it will use the tags
  7236. locally defined in the heading, and the file/tree category@footnote{To add
  7237. inherited tags or the TODO state, configure the variable
  7238. @code{org-icalendar-categories}.}.
  7239. The iCalendar standard requires each entry to have a globally unique
  7240. identifier (UID). Org creates these identifiers during export. If you set
  7241. the variable @code{org-icalendar-store-UID}, the UID will be stored in the
  7242. @code{:ID:} property of the entry and re-used next time you report this
  7243. entry. Since a single entry can give rise to multiple iCalendar entries (as
  7244. a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
  7245. prefixes to the UID, depending on what triggered the inclusion of the entry.
  7246. In this way the UID remains unique, but a synchronization program can still
  7247. figure out from which entry all the different instances originate.
  7248. @table @kbd
  7249. @kindex C-c C-e i
  7250. @item C-c C-e i
  7251. Create iCalendar entries for the current file and store them in the same
  7252. directory, using a file extension @file{.ics}.
  7253. @kindex C-c C-e I
  7254. @item C-c C-e I
  7255. Like @kbd{C-c C-e i}, but do this for all files in
  7256. @code{org-agenda-files}. For each of these files, a separate iCalendar
  7257. file will be written.
  7258. @kindex C-c C-e c
  7259. @item C-c C-e c
  7260. Create a single large iCalendar file from all files in
  7261. @code{org-agenda-files} and write it to the file given by
  7262. @code{org-combined-agenda-icalendar-file}.
  7263. @end table
  7264. The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
  7265. property can be inherited from higher in the hierarchy if you configure
  7266. @code{org-use-property-inheritance} accordingly.} properties if the selected
  7267. entries have them. If not, the summary will be derived from the headline,
  7268. and the description from the body (limited to
  7269. @code{org-icalendar-include-body} characters).
  7270. How this calendar is best read and updated, that depends on the application
  7271. you are using. The FAQ covers this issue.
  7272. @node Publishing, Miscellaneous, Exporting, Top
  7273. @chapter Publishing
  7274. @cindex publishing
  7275. Org includes@footnote{@file{org-publish.el} is not distributed with
  7276. Emacs 21, if you are still using Emacs 21, you need you need to download
  7277. this file separately.} a publishing management system that allows you to
  7278. configure automatic HTML conversion of @emph{projects} composed of
  7279. interlinked org files. This system is called @emph{org-publish}. You can
  7280. also configure org-publish to automatically upload your exported HTML
  7281. pages and related attachments, such as images and source code files, to
  7282. a web server. Org-publish turns Org into a web-site authoring tool.
  7283. You can also use Org-publish to convert files into La@TeX{}, or even
  7284. combine HTML and La@TeX{} conversion so that files are available in both
  7285. formats on the server@footnote{Since La@TeX{} files on a server are not
  7286. that helpful, you surely want to perform further conversion on them --
  7287. e.g. convert them to @code{PDF} format.}.
  7288. Org-publish has been contributed to Org by David O'Toole.
  7289. @menu
  7290. * Configuration:: Defining projects
  7291. * Sample configuration:: Example projects
  7292. * Triggering publication:: Publication commands
  7293. @end menu
  7294. @node Configuration, Sample configuration, Publishing, Publishing
  7295. @section Configuration
  7296. Publishing needs significant configuration to specify files, destination
  7297. and many other properties of a project.
  7298. @menu
  7299. * Project alist:: The central configuration variable
  7300. * Sources and destinations:: From here to there
  7301. * Selecting files:: What files are part of the project?
  7302. * Publishing action:: Setting the function doing the publishing
  7303. * Publishing options:: Tweaking HTML export
  7304. * Publishing links:: Which links keep working after publishing?
  7305. * Project page index:: Publishing a list of project files
  7306. @end menu
  7307. @node Project alist, Sources and destinations, Configuration, Configuration
  7308. @subsection The variable @code{org-publish-project-alist}
  7309. @cindex org-publish-project-alist
  7310. @cindex projects, for publishing
  7311. Org-publish is configured almost entirely through setting the value of
  7312. one variable, called @code{org-publish-project-alist}.
  7313. Each element of the list configures one project, and may be in one of
  7314. the two following forms:
  7315. @lisp
  7316. ("project-name" :property value :property value ...)
  7317. @r{or}
  7318. ("project-name" :components ("project-name" "project-name" ...))
  7319. @end lisp
  7320. In both cases, projects are configured by specifying property values.
  7321. A project defines the set of files that will be published, as well as
  7322. the publishing configuration to use when publishing those files. When
  7323. a project takes the second form listed above, the individual members
  7324. of the ``components'' property are taken to be components of the
  7325. project, which group together files requiring different publishing
  7326. options. When you publish such a ``meta-project'' all the components
  7327. will also publish. The @code{:components} are published in the sequence
  7328. provided.
  7329. @node Sources and destinations, Selecting files, Project alist, Configuration
  7330. @subsection Sources and destinations for files
  7331. @cindex directories, for publishing
  7332. Most properties are optional, but some should always be set. In
  7333. particular, org-publish needs to know where to look for source files,
  7334. and where to put published files.
  7335. @multitable @columnfractions 0.3 0.7
  7336. @item @code{:base-directory}
  7337. @tab Directory containing publishing source files
  7338. @item @code{:publishing-directory}
  7339. @tab Directory (possibly remote) where output files will be published.
  7340. @item @code{:preparation-function}
  7341. @tab Function called before starting the publishing process, for example to
  7342. run @code{make} for updating files to be published.
  7343. @item @code{:completion-function}
  7344. @tab Function called after finishing the publishing process, for example to
  7345. change permissions of the resulting files.
  7346. @end multitable
  7347. @noindent
  7348. @node Selecting files, Publishing action, Sources and destinations, Configuration
  7349. @subsection Selecting files
  7350. @cindex files, selecting for publishing
  7351. By default, all files with extension @file{.org} in the base directory
  7352. are considered part of the project. This can be modified by setting the
  7353. properties
  7354. @multitable @columnfractions 0.25 0.75
  7355. @item @code{:base-extension}
  7356. @tab Extension (without the dot!) of source files. This actually is a
  7357. regular expression.
  7358. @item @code{:exclude}
  7359. @tab Regular expression to match file names that should not be
  7360. published, even though they have been selected on the basis of their
  7361. extension.
  7362. @item @code{:include}
  7363. @tab List of files to be included regardless of @code{:base-extension}
  7364. and @code{:exclude}.
  7365. @end multitable
  7366. @node Publishing action, Publishing options, Selecting files, Configuration
  7367. @subsection Publishing action
  7368. @cindex action, for publishing
  7369. Publishing means that a file is copied to the destination directory and
  7370. possibly transformed in the process. The default transformation is to export
  7371. Org files as HTML files, and this is done by the function
  7372. @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
  7373. export}). But you also can publish your files in La@TeX{} by using the
  7374. function @code{org-publish-org-to-latex} instead, or as PDF files using
  7375. @code{org-publish-org-to-pdf}. Other files like images only need to be
  7376. copied to the publishing destination. For non-Org files, you need to provide
  7377. your own publishing function:
  7378. @multitable @columnfractions 0.3 0.7
  7379. @item @code{:publishing-function}
  7380. @tab Function executing the publication of a file. This may also be a
  7381. list of functions, which will all be called in turn.
  7382. @end multitable
  7383. The function must accept two arguments: a property list containing at
  7384. least a @code{:publishing-directory} property, and the name of the file
  7385. to be published. It should take the specified file, make the necessary
  7386. transformation (if any) and place the result into the destination folder.
  7387. You can write your own publishing function, but @code{org-publish}
  7388. provides one for attachments (files that only need to be copied):
  7389. @code{org-publish-attachment}.
  7390. @node Publishing options, Publishing links, Publishing action, Configuration
  7391. @subsection Options for the HTML/LaTeX exporters
  7392. @cindex options, for publishing
  7393. The property list can be used to set many export options for the HTML
  7394. and La@TeX{} exporters. In most cases, these properties correspond to user
  7395. variables in Org. The table below lists these properties along
  7396. with the variable they belong to. See the documentation string for the
  7397. respective variable for details.
  7398. @multitable @columnfractions 0.32 0.68
  7399. @item @code{:link-up} @tab @code{org-export-html-link-up}
  7400. @item @code{:link-home} @tab @code{org-export-html-link-home}
  7401. @item @code{:language} @tab @code{org-export-default-language}
  7402. @item @code{:customtime} @tab @code{org-display-custom-times}
  7403. @item @code{:headline-levels} @tab @code{org-export-headline-levels}
  7404. @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
  7405. @item @code{:section-number-format} @tab @code{org-export-section-number-format}
  7406. @item @code{:table-of-contents} @tab @code{org-export-with-toc}
  7407. @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
  7408. @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
  7409. @item @code{:emphasize} @tab @code{org-export-with-emphasize}
  7410. @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
  7411. @item @code{:special-strings} @tab @code{org-export-with-special-strings}
  7412. @item @code{:footnotes} @tab @code{org-export-with-footnotes}
  7413. @item @code{:drawers} @tab @code{org-export-with-drawers}
  7414. @item @code{:tags} @tab @code{org-export-with-tags}
  7415. @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
  7416. @item @code{:priority} @tab @code{org-export-with-priority}
  7417. @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
  7418. @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
  7419. @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
  7420. @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
  7421. @item @code{:timestamps} @tab @code{org-export-with-timestamps}
  7422. @item @code{:author-info} @tab @code{org-export-author-info}
  7423. @item @code{:creator-info} @tab @code{org-export-creator-info}
  7424. @item @code{:tables} @tab @code{org-export-with-tables}
  7425. @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
  7426. @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
  7427. @item @code{:style} @tab @code{org-export-html-style}
  7428. @item @code{:style-extra} @tab @code{org-export-html-style-extra}
  7429. @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
  7430. @item @code{:inline-images} @tab @code{org-export-html-inline-images}
  7431. @item @code{:html-extension} @tab @code{org-export-html-extension}
  7432. @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
  7433. @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
  7434. @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
  7435. @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
  7436. @item @code{:preamble} @tab @code{org-export-html-preamble}
  7437. @item @code{:postamble} @tab @code{org-export-html-postamble}
  7438. @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
  7439. @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
  7440. @item @code{:author} @tab @code{user-full-name}
  7441. @item @code{:email} @tab @code{user-mail-address}
  7442. @item @code{:select-tags} @tab @code{org-export-select-tags}
  7443. @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
  7444. @end multitable
  7445. If you use several email addresses, separate them by a semi-column.
  7446. Most of the @code{org-export-with-*} variables have the same effect in
  7447. both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
  7448. @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
  7449. La@TeX{} export.
  7450. When a property is given a value in @code{org-publish-project-alist},
  7451. its setting overrides the value of the corresponding user variable (if
  7452. any) during publishing. Options set within a file (@pxref{Export
  7453. options}), however, override everything.
  7454. @node Publishing links, Project page index, Publishing options, Configuration
  7455. @subsection Links between published files
  7456. @cindex links, publishing
  7457. To create a link from one Org file to another, you would use
  7458. something like @samp{[[file:foo.org][The foo]]} or simply
  7459. @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link
  7460. becomes a link to @file{foo.html}. In this way, you can interlink the
  7461. pages of your "org web" project and the links will work as expected when
  7462. you publish them to HTML.
  7463. You may also link to related files, such as images. Provided you are
  7464. careful with relative pathnames, and provided you have also configured
  7465. @code{org-publish} to upload the related files, these links will work
  7466. too. See @ref{Complex example} for an example of this usage.
  7467. Sometime an Org file to be published may contain links that are
  7468. only valid in your production environment, but not in the publishing
  7469. location. In this case, use the property
  7470. @multitable @columnfractions 0.4 0.6
  7471. @item @code{:link-validation-function}
  7472. @tab Function to validate links
  7473. @end multitable
  7474. @noindent
  7475. to define a function for checking link validity. This function must
  7476. accept two arguments, the file name and a directory relative to which
  7477. the file name is interpreted in the production environment. If this
  7478. function returns @code{nil}, then the HTML generator will only insert a
  7479. description into the HTML file, but no link. One option for this
  7480. function is @code{org-publish-validate-link} which checks if the given
  7481. file is part of any project in @code{org-publish-project-alist}.
  7482. @node Project page index, , Publishing links, Configuration
  7483. @subsection Project page index
  7484. @cindex index, of published pages
  7485. The following properties may be used to control publishing of an
  7486. index of files or summary page for a given project.
  7487. @multitable @columnfractions 0.25 0.75
  7488. @item @code{:auto-index}
  7489. @tab When non-nil, publish an index during org-publish-current-project or
  7490. org-publish-all.
  7491. @item @code{:index-filename}
  7492. @tab Filename for output of index. Defaults to @file{index.org} (which
  7493. becomes @file{index.html}).
  7494. @item @code{:index-title}
  7495. @tab Title of index page. Defaults to name of file.
  7496. @item @code{:index-function}
  7497. @tab Plug-in function to use for generation of index.
  7498. Defaults to @code{org-publish-org-index}, which generates a plain list
  7499. of links to all files in the project.
  7500. @end multitable
  7501. @node Sample configuration, Triggering publication, Configuration, Publishing
  7502. @section Sample configuration
  7503. Below we provide two example configurations. The first one is a simple
  7504. project publishing only a set of Org files. The second example is
  7505. more complex, with a multi-component project.
  7506. @menu
  7507. * Simple example:: One-component publishing
  7508. * Complex example:: A multi-component publishing example
  7509. @end menu
  7510. @node Simple example, Complex example, Sample configuration, Sample configuration
  7511. @subsection Example: simple publishing configuration
  7512. This example publishes a set of Org files to the @file{public_html}
  7513. directory on the local machine.
  7514. @lisp
  7515. (setq org-publish-project-alist
  7516. '(("org"
  7517. :base-directory "~/org/"
  7518. :publishing-directory "~/public_html"
  7519. :section-numbers nil
  7520. :table-of-contents nil
  7521. :style "<link rel=\"stylesheet\"
  7522. href=\"../other/mystyle.css\"
  7523. type=\"text/css\">")))
  7524. @end lisp
  7525. @node Complex example, , Simple example, Sample configuration
  7526. @subsection Example: complex publishing configuration
  7527. This more complicated example publishes an entire website, including
  7528. org files converted to HTML, image files, emacs lisp source code, and
  7529. style sheets. The publishing-directory is remote and private files are
  7530. excluded.
  7531. To ensure that links are preserved, care should be taken to replicate
  7532. your directory structure on the web server, and to use relative file
  7533. paths. For example, if your org files are kept in @file{~/org} and your
  7534. publishable images in @file{~/images}, you'd link to an image with
  7535. @c
  7536. @example
  7537. file:../images/myimage.png
  7538. @end example
  7539. @c
  7540. On the web server, the relative path to the image should be the
  7541. same. You can accomplish this by setting up an "images" folder in the
  7542. right place on the web server, and publishing images to it.
  7543. @lisp
  7544. (setq org-publish-project-alist
  7545. '(("orgfiles"
  7546. :base-directory "~/org/"
  7547. :base-extension "org"
  7548. :publishing-directory "/ssh:user@@host:~/html/notebook/"
  7549. :publishing-function org-publish-org-to-html
  7550. :exclude "PrivatePage.org" ;; regexp
  7551. :headline-levels 3
  7552. :section-numbers nil
  7553. :table-of-contents nil
  7554. :style "<link rel=\"stylesheet\"
  7555. href=\"../other/mystyle.css\" type=\"text/css\">"
  7556. :auto-preamble t
  7557. :auto-postamble nil)
  7558. ("images"
  7559. :base-directory "~/images/"
  7560. :base-extension "jpg\\|gif\\|png"
  7561. :publishing-directory "/ssh:user@@host:~/html/images/"
  7562. :publishing-function org-publish-attachment)
  7563. ("other"
  7564. :base-directory "~/other/"
  7565. :base-extension "css\\|el"
  7566. :publishing-directory "/ssh:user@@host:~/html/other/"
  7567. :publishing-function org-publish-attachment)
  7568. ("website" :components ("orgfiles" "images" "other"))))
  7569. @end lisp
  7570. @node Triggering publication, , Sample configuration, Publishing
  7571. @section Triggering publication
  7572. Once org-publish is properly configured, you can publish with the
  7573. following functions:
  7574. @table @kbd
  7575. @item C-c C-e C
  7576. Prompt for a specific project and publish all files that belong to it.
  7577. @item C-c C-e P
  7578. Publish the project containing the current file.
  7579. @item C-c C-e F
  7580. Publish only the current file.
  7581. @item C-c C-e A
  7582. Publish all projects.
  7583. @end table
  7584. Org uses timestamps to track when a file has changed. The above
  7585. functions normally only publish changed files. You can override this and
  7586. force publishing of all files by giving a prefix argument.
  7587. @node Miscellaneous, Extensions, Publishing, Top
  7588. @chapter Miscellaneous
  7589. @menu
  7590. * Completion:: M-TAB knows what you need
  7591. * Customization:: Adapting Org to your taste
  7592. * In-buffer settings:: Overview of the #+KEYWORDS
  7593. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  7594. * Clean view:: Getting rid of leading stars in the outline
  7595. * TTY keys:: Using Org on a tty
  7596. * Interaction:: Other Emacs packages
  7597. * Bugs:: Things which do not work perfectly
  7598. @end menu
  7599. @node Completion, Customization, Miscellaneous, Miscellaneous
  7600. @section Completion
  7601. @cindex completion, of @TeX{} symbols
  7602. @cindex completion, of TODO keywords
  7603. @cindex completion, of dictionary words
  7604. @cindex completion, of option keywords
  7605. @cindex completion, of tags
  7606. @cindex completion, of property keys
  7607. @cindex completion, of link abbreviations
  7608. @cindex @TeX{} symbol completion
  7609. @cindex TODO keywords completion
  7610. @cindex dictionary word completion
  7611. @cindex option keyword completion
  7612. @cindex tag completion
  7613. @cindex link abbreviations, completion of
  7614. Org supports in-buffer completion. This type of completion does
  7615. not make use of the minibuffer. You simply type a few letters into
  7616. the buffer and use the key to complete text right there.
  7617. @table @kbd
  7618. @kindex M-@key{TAB}
  7619. @item M-@key{TAB}
  7620. Complete word at point
  7621. @itemize @bullet
  7622. @item
  7623. At the beginning of a headline, complete TODO keywords.
  7624. @item
  7625. After @samp{\}, complete @TeX{} symbols supported by the exporter.
  7626. @item
  7627. After @samp{*}, complete headlines in the current buffer so that they
  7628. can be used in search links like @samp{[[*find this headline]]}.
  7629. @item
  7630. After @samp{:} in a headline, complete tags. The list of tags is taken
  7631. from the variable @code{org-tag-alist} (possibly set through the
  7632. @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
  7633. dynamically from all tags used in the current buffer.
  7634. @item
  7635. After @samp{:} and not in a headline, complete property keys. The list
  7636. of keys is constructed dynamically from all keys used in the current
  7637. buffer.
  7638. @item
  7639. After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
  7640. @item
  7641. After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
  7642. @samp{OPTIONS} which set file-specific options for Org mode. When the
  7643. option keyword is already complete, pressing @kbd{M-@key{TAB}} again
  7644. will insert example settings for this keyword.
  7645. @item
  7646. In the line after @samp{#+STARTUP: }, complete startup keywords,
  7647. i.e. valid keys for this line.
  7648. @item
  7649. Elsewhere, complete dictionary words using Ispell.
  7650. @end itemize
  7651. @end table
  7652. @node Customization, In-buffer settings, Completion, Miscellaneous
  7653. @section Customization
  7654. @cindex customization
  7655. @cindex options, for customization
  7656. @cindex variables, for customization
  7657. There are more than 180 variables that can be used to customize
  7658. Org. For the sake of compactness of the manual, I am not
  7659. describing the variables here. A structured overview of customization
  7660. variables is available with @kbd{M-x org-customize}. Or select
  7661. @code{Browse Org Group} from the @code{Org->Customization} menu. Many
  7662. settings can also be activated on a per-file basis, by putting special
  7663. lines into the buffer (@pxref{In-buffer settings}).
  7664. @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
  7665. @section Summary of in-buffer settings
  7666. @cindex in-buffer settings
  7667. @cindex special keywords
  7668. Org mode uses special lines in the buffer to define settings on a
  7669. per-file basis. These lines start with a @samp{#+} followed by a
  7670. keyword, a colon, and then individual words defining a setting. Several
  7671. setting words can be in the same line, but you can also have multiple
  7672. lines for the keyword. While these settings are described throughout
  7673. the manual, here is a summary. After changing any of those lines in the
  7674. buffer, press @kbd{C-c C-c} with the cursor still in the line to
  7675. activate the changes immediately. Otherwise they become effective only
  7676. when the file is visited again in a new Emacs session.
  7677. @table @kbd
  7678. @item #+ARCHIVE: %s_done::
  7679. This line sets the archive location for the agenda file. It applies for
  7680. all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
  7681. of the file. The first such line also applies to any entries before it.
  7682. The corresponding variable is @code{org-archive-location}.
  7683. @item #+CATEGORY:
  7684. This line sets the category for the agenda file. The category applies
  7685. for all subsequent lines until the next @samp{#+CATEGORY} line, or the
  7686. end of the file. The first such line also applies to any entries before it.
  7687. @item #+COLUMNS: %25ITEM .....
  7688. Set the default format for columns view. This format applies when
  7689. columns view is invoked in location where no @code{COLUMNS} property
  7690. applies.
  7691. @item #+CONSTANTS: name1=value1 ...
  7692. Set file-local values for constants to be used in table formulas. This
  7693. line set the local variable @code{org-table-formula-constants-local}.
  7694. The global version of this variable is
  7695. @code{org-table-formula-constants}.
  7696. @item #+FILETAGS: :tag1:tag2:tag3:
  7697. Set tags that can be inherited by any entry in the file, including the
  7698. top-level entries.
  7699. @item #+DRAWERS: NAME1 .....
  7700. Set the file-local set of drawers. The corresponding global variable is
  7701. @code{org-drawers}.
  7702. @item #+LINK: linkword replace
  7703. These lines (several are allowed) specify link abbreviations.
  7704. @xref{Link abbreviations}. The corresponding variable is
  7705. @code{org-link-abbrev-alist}.
  7706. @item #+PRIORITIES: highest lowest default
  7707. This line sets the limits and the default for the priorities. All three
  7708. must be either letters A-Z or numbers 0-9. The highest priority must
  7709. have a lower ASCII number that the lowest priority.
  7710. @item #+PROPERTY: Property_Name Value
  7711. This line sets a default inheritance value for entries in the current
  7712. buffer, most useful for specifying the allowed values of a property.
  7713. @item #+SETUPFILE: file
  7714. This line defines a file that holds more in-buffer setup. Normally this is
  7715. entirely ignored. Only when the buffer is parsed for option-setting lines
  7716. (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
  7717. settings line, or when exporting), then the contents of this file are parsed
  7718. as if they had been included in the buffer. In particular, the file can be
  7719. any other Org mode file with internal setup. You can visit the file the
  7720. cursor is in the line with @kbd{C-c '}.
  7721. @item #+STARTUP:
  7722. This line sets options to be used at startup of Org mode, when an
  7723. Org file is being visited. The first set of options deals with the
  7724. initial visibility of the outline tree. The corresponding variable for
  7725. global default settings is @code{org-startup-folded}, with a default
  7726. value @code{t}, which means @code{overview}.
  7727. @cindex @code{overview}, STARTUP keyword
  7728. @cindex @code{content}, STARTUP keyword
  7729. @cindex @code{showall}, STARTUP keyword
  7730. @example
  7731. overview @r{top-level headlines only}
  7732. content @r{all headlines}
  7733. showall @r{no folding at all, show everything}
  7734. @end example
  7735. Then there are options for aligning tables upon visiting a file. This
  7736. is useful in files containing narrowed table columns. The corresponding
  7737. variable is @code{org-startup-align-all-tables}, with a default value
  7738. @code{nil}.
  7739. @cindex @code{align}, STARTUP keyword
  7740. @cindex @code{noalign}, STARTUP keyword
  7741. @example
  7742. align @r{align all tables}
  7743. noalign @r{don't align tables on startup}
  7744. @end example
  7745. Logging closing and reinstating TODO items, and clock intervals
  7746. (variables @code{org-log-done}, @code{org-log-note-clock-out}, and
  7747. @code{org-log-repeat}) can be configured using these options.
  7748. @cindex @code{logdone}, STARTUP keyword
  7749. @cindex @code{lognotedone}, STARTUP keyword
  7750. @cindex @code{nologdone}, STARTUP keyword
  7751. @cindex @code{lognoteclock-out}, STARTUP keyword
  7752. @cindex @code{nolognoteclock-out}, STARTUP keyword
  7753. @cindex @code{logrepeat}, STARTUP keyword
  7754. @cindex @code{lognoterepeat}, STARTUP keyword
  7755. @cindex @code{nologrepeat}, STARTUP keyword
  7756. @example
  7757. logdone @r{record a timestamp when an item is marked DONE}
  7758. lognotedone @r{record timestamp and a note when DONE}
  7759. nologdone @r{don't record when items are marked DONE}
  7760. logrepeat @r{record a time when reinstating a repeating item}
  7761. lognoterepeat @r{record a note when reinstating a repeating item}
  7762. nologrepeat @r{do not record when reinstating repeating item}
  7763. lognoteclock-out @r{record a note when clocking out}
  7764. nolognoteclock-out @r{don't record a note when clocking out}
  7765. @end example
  7766. Here are the options for hiding leading stars in outline headings, and for
  7767. indenting outlines. The corresponding variables are
  7768. @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
  7769. default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
  7770. @cindex @code{hidestars}, STARTUP keyword
  7771. @cindex @code{showstars}, STARTUP keyword
  7772. @cindex @code{odd}, STARTUP keyword
  7773. @cindex @code{even}, STARTUP keyword
  7774. @example
  7775. hidestars @r{make all but one of the stars starting a headline invisible.}
  7776. showstars @r{show all stars starting a headline}
  7777. indent @r{virtual indentation according to outline level}
  7778. noindent @r{no virtual indentation according to outline level}
  7779. odd @r{allow only odd outline levels (1,3,...)}
  7780. oddeven @r{allow all outline levels}
  7781. @end example
  7782. To turn on custom format overlays over time stamps (variables
  7783. @code{org-put-time-stamp-overlays} and
  7784. @code{org-time-stamp-overlay-formats}), use
  7785. @cindex @code{customtime}, STARTUP keyword
  7786. @example
  7787. customtime @r{overlay custom time format}
  7788. @end example
  7789. The following options influence the table spreadsheet (variable
  7790. @code{constants-unit-system}).
  7791. @cindex @code{constcgs}, STARTUP keyword
  7792. @cindex @code{constSI}, STARTUP keyword
  7793. @example
  7794. constcgs @r{@file{constants.el} should use the c-g-s unit system}
  7795. constSI @r{@file{constants.el} should use the SI unit system}
  7796. @end example
  7797. To influence footnote settings, use the following keywords. The
  7798. corresponding variables are @code{org-footnote-define-inline} and
  7799. @code{org-footnote-auto-label}.
  7800. @cindex @code{fninline}, STARTUP keyword
  7801. @cindex @code{fnnoinline}, STARTUP keyword
  7802. @cindex @code{fnlocal}, STARTUP keyword
  7803. @cindex @code{fnprompt}, STARTUP keyword
  7804. @cindex @code{fnauto}, STARTUP keyword
  7805. @cindex @code{fnconfirm}, STARTUP keyword
  7806. @cindex @code{fnplain}, STARTUP keyword
  7807. @example
  7808. fninline @r{define footnotes inline}
  7809. fnnoinline @r{define footnotes in separate section}
  7810. fnlocal @r{define footnotes near first reference, but not inline}
  7811. fnprompt @r{prompt for footnote labels}
  7812. fnauto @r{create [fn:1]-like labels automatically (default)}
  7813. fnconfirm @r{offer automatic label for editing or confirmation}
  7814. fnplain @r{create [1]-like labels automatically}
  7815. @end example
  7816. @item #+TAGS: TAG1(c1) TAG2(c2)
  7817. These lines (several such lines are allowed) specify the valid tags in
  7818. this file, and (potentially) the corresponding @emph{fast tag selection}
  7819. keys. The corresponding variable is @code{org-tag-alist}.
  7820. @item #+TBLFM:
  7821. This line contains the formulas for the table directly above the line.
  7822. @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:
  7823. These lines provide settings for exporting files. For more details see
  7824. @ref{Export options}.
  7825. @item #+SEQ_TODO: #+TYP_TODO:
  7826. These lines set the TODO keywords and their interpretation in the
  7827. current file. The corresponding variables are @code{org-todo-keywords}
  7828. and @code{org-todo-interpretation}.
  7829. @end table
  7830. @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
  7831. @section The very busy C-c C-c key
  7832. @kindex C-c C-c
  7833. @cindex C-c C-c, overview
  7834. The key @kbd{C-c C-c} has many purposes in Org, which are all
  7835. mentioned scattered throughout this manual. One specific function of
  7836. this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
  7837. other circumstances it means something like @emph{Hey Org, look
  7838. here and update according to what you see here}. Here is a summary of
  7839. what this means in different contexts.
  7840. @itemize @minus
  7841. @item
  7842. If there are highlights in the buffer from the creation of a sparse
  7843. tree, or from clock display, remove these highlights.
  7844. @item
  7845. If the cursor is in one of the special @code{#+KEYWORD} lines, this
  7846. triggers scanning the buffer for these lines and updating the
  7847. information.
  7848. @item
  7849. If the cursor is inside a table, realign the table. This command
  7850. works even if the automatic table editor has been turned off.
  7851. @item
  7852. If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
  7853. the entire table.
  7854. @item
  7855. If the cursor is inside a table created by the @file{table.el} package,
  7856. activate that table.
  7857. @item
  7858. If the current buffer is a remember buffer, close the note and file it.
  7859. With a prefix argument, file it, without further interaction, to the
  7860. default location.
  7861. @item
  7862. If the cursor is on a @code{<<<target>>>}, update radio targets and
  7863. corresponding links in this buffer.
  7864. @item
  7865. If the cursor is in a property line or at the start or end of a property
  7866. drawer, offer property commands.
  7867. @item
  7868. If the cursor is at a footnote reference, go to the corresponding
  7869. definition, and vice versa.
  7870. @item
  7871. If the cursor is in a plain list item with a checkbox, toggle the status
  7872. of the checkbox.
  7873. @item
  7874. If the cursor is on a numbered item in a plain list, renumber the
  7875. ordered list.
  7876. @item
  7877. If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
  7878. block is updated.
  7879. @end itemize
  7880. @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
  7881. @section A cleaner outline view
  7882. @cindex hiding leading stars
  7883. @cindex dynamic indentation
  7884. @cindex odd-levels-only outlines
  7885. @cindex clean outline view
  7886. Some people find it noisy and distracting that the Org headlines are starting
  7887. with a potentially large number of stars, and that text below the headlines
  7888. is not indented. This is not really a problem when you are writing a book
  7889. where the outline headings are really section headlines. However, in a more
  7890. list-oriented outline, it is clear that an indented structure is a lot
  7891. cleaner, as can be seen by comparing the two columns in the following
  7892. example:
  7893. @example
  7894. @group
  7895. * Top level headline | * Top level headline
  7896. ** Second level | * Second level
  7897. *** 3rd level | * 3rd level
  7898. some text | some text
  7899. *** 3rd level | * 3rd level
  7900. more text | more text
  7901. * Another top level headline | * Another top level headline
  7902. @end group
  7903. @end example
  7904. @noindent
  7905. It is non-trivial to make such a look work in Emacs, but Org contains three
  7906. separate features that, combined, achieve just that.
  7907. @enumerate
  7908. @item
  7909. @emph{Indentation of text below headlines}@*
  7910. You may indent text below each headline to make the left boundary line up
  7911. with the headline, like
  7912. @example
  7913. *** 3rd level
  7914. more text, now indented
  7915. @end example
  7916. A good way to get this indentation is by hand, and Org supports this with
  7917. paragraph filling, line wrapping, and structure editing@footnote{See also the
  7918. variable @code{org-adapt-indentation}.} preserving or adapting the
  7919. indentation appropriate. A different approach would be to have a way to
  7920. automatically indent lines according to outline structure by adding overlays
  7921. or text properties. But I have not yet found a robust and efficient way to
  7922. do this in large files.
  7923. @item
  7924. @emph{Hiding leading stars}@* You can modify the display in such a way that
  7925. all leading stars become invisible. To do this in a global way, configure
  7926. the variable @code{org-hide-leading-stars} or change this on a per-file basis
  7927. with
  7928. @example
  7929. #+STARTUP: hidestars
  7930. @end example
  7931. @noindent
  7932. Note that the opposite behavior is selected with @code{showstars}.
  7933. With hidden stars, the tree becomes:
  7934. @example
  7935. @group
  7936. * Top level headline
  7937. * Second level
  7938. * 3rd level
  7939. ...
  7940. @end group
  7941. @end example
  7942. @noindent
  7943. Note that the leading stars are not truly replaced by whitespace, they
  7944. are only fontified with the face @code{org-hide} that uses the
  7945. background color as font color. If you are not using either white or
  7946. black background, you may have to customize this face to get the wanted
  7947. effect. Another possibility is to set this font such that the extra
  7948. stars are @i{almost} invisible, for example using the color
  7949. @code{grey90} on a white background.
  7950. @item
  7951. Things become cleaner still if you skip all the even levels and use only odd
  7952. levels 1, 3, 5..., effectively adding two stars to go from one outline level
  7953. to the next. In this way we get the outline view shown at the beginning of
  7954. this section. In order to make the structure editing and export commands
  7955. handle this convention correctly, configure the variable
  7956. @code{org-odd-levels-only}, or set this on a per-file basis with one of the
  7957. following lines:
  7958. @example
  7959. #+STARTUP: odd
  7960. #+STARTUP: oddeven
  7961. @end example
  7962. You can convert an Org file from single-star-per-level to the
  7963. double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
  7964. RET} in that file. The reverse operation is @kbd{M-x
  7965. org-convert-to-oddeven-levels}.
  7966. @end enumerate
  7967. @node TTY keys, Interaction, Clean view, Miscellaneous
  7968. @section Using Org on a tty
  7969. @cindex tty key bindings
  7970. Because Org contains a large number of commands, by default much of
  7971. Org's core commands are bound to keys that are generally not
  7972. accessible on a tty, such as the cursor keys (@key{left}, @key{right},
  7973. @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
  7974. together with modifiers like @key{Meta} and/or @key{Shift}. To access
  7975. these commands on a tty when special keys are unavailable, the following
  7976. alternative bindings can be used. The tty bindings below will likely be
  7977. more cumbersome; you may find for some of the bindings below that a
  7978. customized work-around suits you better. For example, changing a time
  7979. stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
  7980. tty you would rather use @kbd{C-c .} to re-insert the timestamp.
  7981. @multitable @columnfractions 0.15 0.2 0.2
  7982. @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
  7983. @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
  7984. @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
  7985. @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
  7986. @item @kbd{M-@key{right}} @tab @kbd{C-c C-x i} @tab @kbd{@key{Esc} @key{right}}
  7987. @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
  7988. @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
  7989. @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
  7990. @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
  7991. @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
  7992. @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
  7993. @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
  7994. @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
  7995. @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
  7996. @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
  7997. @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
  7998. @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
  7999. @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
  8000. @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
  8001. @end multitable
  8002. @node Interaction, Bugs, TTY keys, Miscellaneous
  8003. @section Interaction with other packages
  8004. @cindex packages, interaction with other
  8005. Org lives in the world of GNU Emacs and interacts in various ways
  8006. with other code out there.
  8007. @menu
  8008. * Cooperation:: Packages Org cooperates with
  8009. * Conflicts:: Packages that lead to conflicts
  8010. @end menu
  8011. @node Cooperation, Conflicts, Interaction, Interaction
  8012. @subsection Packages that Org cooperates with
  8013. @table @asis
  8014. @cindex @file{calc.el}
  8015. @item @file{calc.el} by Dave Gillespie
  8016. Org uses the Calc package for implementing spreadsheet
  8017. functionality in its tables (@pxref{The spreadsheet}). Org
  8018. checks for the availability of Calc by looking for the function
  8019. @code{calc-eval} which should be autoloaded in your setup if Calc has
  8020. been installed properly. As of Emacs 22, Calc is part of the Emacs
  8021. distribution. Another possibility for interaction between the two
  8022. packages is using Calc for embedded calculations. @xref{Embedded Mode,
  8023. , Embedded Mode, Calc, GNU Emacs Calc Manual}.
  8024. @cindex @file{constants.el}
  8025. @item @file{constants.el} by Carsten Dominik
  8026. In a table formula (@pxref{The spreadsheet}), it is possible to use
  8027. names for natural constants or units. Instead of defining your own
  8028. constants in the variable @code{org-table-formula-constants}, install
  8029. the @file{constants} package which defines a large number of constants
  8030. and units, and lets you use unit prefixes like @samp{M} for
  8031. @samp{Mega} etc. You will need version 2.0 of this package, available
  8032. at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
  8033. the function @code{constants-get}, which has to be autoloaded in your
  8034. setup. See the installation instructions in the file
  8035. @file{constants.el}.
  8036. @item @file{cdlatex.el} by Carsten Dominik
  8037. @cindex @file{cdlatex.el}
  8038. Org mode can make use of the CDLaTeX package to efficiently enter
  8039. La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
  8040. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
  8041. @cindex @file{imenu.el}
  8042. Imenu allows menu access to an index of items in a file. Org mode
  8043. supports Imenu - all you need to do to get the index is the following:
  8044. @lisp
  8045. (add-hook 'org-mode-hook
  8046. (lambda () (imenu-add-to-menubar "Imenu")))
  8047. @end lisp
  8048. By default the index is two levels deep - you can modify the depth using
  8049. the option @code{org-imenu-depth}.
  8050. @item @file{remember.el} by John Wiegley
  8051. @cindex @file{remember.el}
  8052. Org cooperates with remember, see @ref{Remember}.
  8053. @file{Remember.el} is not part of Emacs, find it on the web.
  8054. @item @file{speedbar.el} by Eric M. Ludlam
  8055. @cindex @file{speedbar.el}
  8056. Speedbar is a package that creates a special frame displaying files and
  8057. index items in files. Org mode supports Speedbar and allows you to
  8058. drill into Org files directly from the Speedbar. It also allows to
  8059. restrict the scope of agenda commands to a file or a subtree by using
  8060. the command @kbd{<} in the Speedbar frame.
  8061. @cindex @file{table.el}
  8062. @item @file{table.el} by Takaaki Ota
  8063. @kindex C-c C-c
  8064. @cindex table editor, @file{table.el}
  8065. @cindex @file{table.el}
  8066. Complex ASCII tables with automatic line wrapping, column- and
  8067. row-spanning, and alignment can be created using the Emacs table
  8068. package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
  8069. and also part of Emacs 22).
  8070. When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
  8071. will call @command{table-recognize-table} and move the cursor into the
  8072. table. Inside a table, the keymap of Org mode is inactive. In order
  8073. to execute Org mode-related commands, leave the table.
  8074. @table @kbd
  8075. @kindex C-c C-c
  8076. @item C-c C-c
  8077. Recognize @file{table.el} table. Works when the cursor is in a
  8078. table.el table.
  8079. @c
  8080. @kindex C-c ~
  8081. @item C-c ~
  8082. Insert a table.el table. If there is already a table at point, this
  8083. command converts it between the table.el format and the Org mode
  8084. format. See the documentation string of the command
  8085. @code{org-convert-table} for the restrictions under which this is
  8086. possible.
  8087. @end table
  8088. @file{table.el} is part of Emacs 22.
  8089. @cindex @file{footnote.el}
  8090. @item @file{footnote.el} by Steven L. Baur
  8091. Org mode recognizes numerical footnotes as provided by this package.
  8092. However, Org-mode also has its own footnote support (@pxref{Footnotes}),
  8093. which makes using @file{footnote.el} unnecessary.
  8094. @end table
  8095. @node Conflicts, , Cooperation, Interaction
  8096. @subsection Packages that lead to conflicts with Org mode
  8097. @table @asis
  8098. @cindex @file{allout.el}
  8099. @item @file{allout.el} by Ken Manheimer
  8100. Startup of Org may fail with the error message
  8101. @code{(wrong-type-argument keymapp nil)} when there is an outdated
  8102. version @file{allout.el} on the load path, for example the version
  8103. distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will
  8104. disappear. If for some reason you cannot do this, make sure that org.el
  8105. is loaded @emph{before} @file{allout.el}, for example by putting
  8106. @code{(require 'org)} early enough into your @file{.emacs} file.
  8107. @cindex @file{CUA.el}
  8108. @item @file{CUA.el} by Kim. F. Storm
  8109. Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by
  8110. CUA mode (as well as pc-select-mode and s-region-mode) to select and
  8111. extend the region. If you want to use one of these packages along with
  8112. Org, configure the variable @code{org-replace-disputed-keys}. When
  8113. set, Org will move the following key bindings in Org files, and
  8114. in the agenda buffer (but not during date selection).
  8115. @example
  8116. S-UP -> M-p S-DOWN -> M-n
  8117. S-LEFT -> M-- S-RIGHT -> M-+
  8118. @end example
  8119. Yes, these are unfortunately more difficult to remember. If you want
  8120. to have other replacement keys, look at the variable
  8121. @code{org-disputed-keys}.
  8122. @item @file{windmove.el} by Hovav Shacham
  8123. @cindex @file{windmove.el}
  8124. Also this package uses the @kbd{S-<cursor>} keys, so everything written
  8125. in the paragraph above about CUA mode also applies here.
  8126. @end table
  8127. @node Bugs, , Interaction, Miscellaneous
  8128. @section Bugs
  8129. @cindex bugs
  8130. Here is a list of things that should work differently, but which I
  8131. have found too hard to fix.
  8132. @itemize @bullet
  8133. @item
  8134. If a table field starts with a link, and if the corresponding table
  8135. column is narrowed (@pxref{Narrow columns}) to a width too small to
  8136. display the link, the field would look entirely empty even though it is
  8137. not. To prevent this, Org throws an error. The work-around is to
  8138. make the column wide enough to fit the link, or to add some text (at
  8139. least 2 characters) before the link in the same field.
  8140. @item
  8141. Narrowing table columns does not work on XEmacs, because the
  8142. @code{format} function does not transport text properties.
  8143. @item
  8144. Text in an entry protected with the @samp{QUOTE} keyword should not
  8145. autowrap.
  8146. @item
  8147. When the application called by @kbd{C-c C-o} to open a file link fails
  8148. (for example because the application does not exist or refuses to open
  8149. the file), it does so silently. No error message is displayed.
  8150. @item
  8151. Recalculating a table line applies the formulas from left to right.
  8152. If a formula uses @emph{calculated} fields further down the row,
  8153. multiple recalculation may be needed to get all fields consistent. You
  8154. may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to
  8155. recalculate until convergence.
  8156. @item
  8157. The exporters work well, but could be made more efficient.
  8158. @end itemize
  8159. @node Extensions, Hacking, Miscellaneous, Top
  8160. @appendix Extensions
  8161. This appendix lists the extension modules that have been written for Org.
  8162. Many of these extensions live in the @file{contrib} directory of the Org
  8163. distribution, others are available somewhere on the web.
  8164. @menu
  8165. * Extensions in the contrib directory:: These come with the Org distro
  8166. * Other extensions:: These you have to find on the web.
  8167. @end menu
  8168. @node Extensions in the contrib directory, Other extensions, Extensions, Extensions
  8169. @section Extensions in the @file{contrib} directory
  8170. A number of extension are distributed with Org when you download it from its
  8171. homepage. Please note that these extensions are @emph{not} distributed as
  8172. part of Emacs, so if you use Org as delivered with Emacs, you still need to
  8173. go to @url{http://orgmode.org} to get access to these modules.
  8174. @table @asis
  8175. @item @file{org-annotate-file.el} by @i{Philip Jackson}
  8176. Annotate a file with org syntax, in a separate file, with links back to the
  8177. annotated file.
  8178. @item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German}
  8179. Call @i{remember} directly from Firefox/Opera, or from Adobe Reader. When
  8180. activating a special link or bookmark, Emacs receives a trigger to create a
  8181. note with a link back to the website. Requires some setup, a detailed
  8182. description is in @file{contrib/packages/org-annotation-helper}.
  8183. @item @file{org-bookmark.el} by @i{Tokuya Kameshima}
  8184. Support for links to Emacs bookmarks.
  8185. @item @file{org-depend.el} by @i{Carsten Dominik}
  8186. TODO dependencies for Org-mode. Make TODO state changes in one entry trigger
  8187. changes in another, or be blocked by the state of another entry. Also,
  8188. easily create chains of TODO items with exactly one active item at any time.
  8189. @item @file{org-elisp-symbol.el} by @i{Bastien Guerry}
  8190. Org links to emacs-lisp symbols. This can create annotated links that
  8191. exactly point to the definition location of a variable of function.
  8192. @item @file{org-eval.el} by @i{Carsten Dominik}
  8193. The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows text to
  8194. be included in a document that is the result of evaluating some code. Other
  8195. scripting languages like @code{perl} can be supported with this package as
  8196. well.
  8197. @item @file{org-eval-light.el} by @i{Eric Schulte}
  8198. User-controlled evaluation of code in an Org buffer.
  8199. @item @file{org-exp-blocks.el} by @i{Eric Schulte}
  8200. Preprocess user-defined blocks for export.
  8201. @item @file{org-expiry.el} by @i{Bastien Guerry}
  8202. Expiry mechanism for Org entries.
  8203. @item @file{org-indent.el} by @i{Carsten Dominik}
  8204. Dynamic indentation of Org outlines. The plan is to indent an outline
  8205. according to level, but so far this is too hard for a proper and stable
  8206. implementation. Still, it works somewhat.
  8207. @item @file{org-interactive-query.el} by @i{Christopher League}
  8208. Interactive modification of tags queries. After running a general query in
  8209. Org, this package allows to narrow down the results by adding more tags or
  8210. keywords.
  8211. @item @file{org-mairix.el} by @i{Georg C. F. Greve}
  8212. Hook mairix search into Org for different MUAs.
  8213. @item @file{org-man.el} by @i{Carsten Dominik}
  8214. Support for links to manpages in Org-mode.
  8215. @item @file{org-mtags.el} by @i{Carsten Dominik}
  8216. Support for some Muse-like tags in Org-mode. This package allows you to
  8217. write @code{<example>} and @code{<src>} and other syntax copied from Emacs
  8218. Muse, right inside an Org file. The goal here is to make it easy to publish
  8219. the same file using either org-publish or Muse.
  8220. @item @file{org-panel.el} by @i{Lennart Borgman}
  8221. Simplified and display-aided access to some Org commands.
  8222. @item @file{org-registry.el} by @i{Bastien Guerry}
  8223. A registry for Org links, to find out from where links point to a given file
  8224. or location.
  8225. @item @file{org2rem.el} by @i{Bastien Guerry}
  8226. Convert org appointments into reminders for the @file{remind} program.
  8227. @item @file{org-screen.el} by @i{Andrew Hyatt}
  8228. Visit screen sessions through Org-mode links.
  8229. @item @file{org-toc.el} by @i{Bastien Guerry}
  8230. Table of contents in a separate buffer, with fast access to sections and easy
  8231. visibility cycling.
  8232. @item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy}
  8233. Convert Org-mode tables to SQL insertions. Documentation for this can be
  8234. found on the Worg pages.
  8235. @end table
  8236. @node Other extensions, , Extensions in the contrib directory, Extensions
  8237. @section Other extensions
  8238. @i{TO BE DONE}
  8239. @node Hacking, History and Acknowledgments, Extensions, Top
  8240. @appendix Hacking
  8241. This appendix covers some aspects where users can extend the functionality of
  8242. Org.
  8243. @menu
  8244. * Adding hyperlink types:: New custom link types
  8245. * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
  8246. * Dynamic blocks:: Automatically filled blocks
  8247. * Special agenda views:: Customized views
  8248. * Using the property API:: Writing programs that use entry properties
  8249. * Using the mapping API:: Mapping over all or selected entries
  8250. @end menu
  8251. @node Adding hyperlink types, Tables in arbitrary syntax, Hacking, Hacking
  8252. @section Adding hyperlink types
  8253. @cindex hyperlinks, adding new types
  8254. Org has a large number of hyperlink types built-in
  8255. (@pxref{Hyperlinks}). If you would like to add new link types, it
  8256. provides an interface for doing so. Let's look at an example file
  8257. @file{org-man.el} that will add support for creating links like
  8258. @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
  8259. emacs:
  8260. @lisp
  8261. ;;; org-man.el - Support for links to manpages in Org
  8262. (require 'org)
  8263. (org-add-link-type "man" 'org-man-open)
  8264. (add-hook 'org-store-link-functions 'org-man-store-link)
  8265. (defcustom org-man-command 'man
  8266. "The Emacs command to be used to display a man page."
  8267. :group 'org-link
  8268. :type '(choice (const man) (const woman)))
  8269. (defun org-man-open (path)
  8270. "Visit the manpage on PATH.
  8271. PATH should be a topic that can be thrown at the man command."
  8272. (funcall org-man-command path))
  8273. (defun org-man-store-link ()
  8274. "Store a link to a manpage."
  8275. (when (memq major-mode '(Man-mode woman-mode))
  8276. ;; This is a man page, we do make this link
  8277. (let* ((page (org-man-get-page-name))
  8278. (link (concat "man:" page))
  8279. (description (format "Manpage for %s" page)))
  8280. (org-store-link-props
  8281. :type "man"
  8282. :link link
  8283. :description description))))
  8284. (defun org-man-get-page-name ()
  8285. "Extract the page name from the buffer name."
  8286. ;; This works for both `Man-mode' and `woman-mode'.
  8287. (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
  8288. (match-string 1 (buffer-name))
  8289. (error "Cannot create link to this man page")))
  8290. (provide 'org-man)
  8291. ;;; org-man.el ends here
  8292. @end lisp
  8293. @noindent
  8294. You would activate this new link type in @file{.emacs} with
  8295. @lisp
  8296. (require 'org-man)
  8297. @end lisp
  8298. @noindent
  8299. Let's go through the file and see what it does.
  8300. @enumerate
  8301. @item
  8302. It does @code{(require 'org)} to make sure that @file{org.el} has been
  8303. loaded.
  8304. @item
  8305. The next line calls @code{org-add-link-type} to define a new link type
  8306. with prefix @samp{man}. The call also contains the name of a function
  8307. that will be called to follow such a link.
  8308. @item
  8309. The next line adds a function to @code{org-store-link-functions}, in
  8310. order to allow the command @kbd{C-c l} to record a useful link in a
  8311. buffer displaying a man page.
  8312. @end enumerate
  8313. The rest of the file defines the necessary variables and functions.
  8314. First there is a customization variable that determines which emacs
  8315. command should be used to display man pages. There are two options,
  8316. @code{man} and @code{woman}. Then the function to follow a link is
  8317. defined. It gets the link path as an argument - in this case the link
  8318. path is just a topic for the manual command. The function calls the
  8319. value of @code{org-man-command} to display the man page.
  8320. Finally the function @code{org-man-store-link} is defined. When you try
  8321. to store a link with @kbd{C-c l}, also this function will be called to
  8322. try to make a link. The function must first decide if it is supposed to
  8323. create the link for this buffer type, we do this by checking the value
  8324. of the variable @code{major-mode}. If not, the function must exit and
  8325. return the value @code{nil}. If yes, the link is created by getting the
  8326. manual topic from the buffer name and prefixing it with the string
  8327. @samp{man:}. Then it must call the command @code{org-store-link-props}
  8328. and set the @code{:type} and @code{:link} properties. Optionally you
  8329. can also set the @code{:description} property to provide a default for
  8330. the link description when the link is later inserted into an Org
  8331. buffer with @kbd{C-c C-l}.
  8332. @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Hacking
  8333. @section Tables and lists in arbitrary syntax
  8334. @cindex tables, in other modes
  8335. @cindex lists, in other modes
  8336. @cindex Orgtbl mode
  8337. Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
  8338. frequent feature request has been to make it work with native tables in
  8339. specific languages, for example La@TeX{}. However, this is extremely
  8340. hard to do in a general way, would lead to a customization nightmare,
  8341. and would take away much of the simplicity of the Orgtbl mode table
  8342. editor.
  8343. This appendix describes a different approach. We keep the Orgtbl mode
  8344. table in its native format (the @i{source table}), and use a custom
  8345. function to @i{translate} the table to the correct syntax, and to
  8346. @i{install} it in the right location (the @i{target table}). This puts
  8347. the burden of writing conversion functions on the user, but it allows
  8348. for a very flexible system.
  8349. Bastien added the ability to do the same with lists. You can use Org's
  8350. facilities to edit and structure lists by turning @code{orgstruct-mode}
  8351. on, then locally exporting such lists in another format (HTML, La@TeX{}
  8352. or Texinfo.)
  8353. @menu
  8354. * Radio tables:: Sending and receiving
  8355. * A LaTeX example:: Step by step, almost a tutorial
  8356. * Translator functions:: Copy and modify
  8357. * Radio lists:: Doing the same for lists
  8358. @end menu
  8359. @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
  8360. @subsection Radio tables
  8361. @cindex radio tables
  8362. To define the location of the target table, you first need to create two
  8363. lines that are comments in the current mode, but contain magic words for
  8364. Orgtbl mode to find. Orgtbl mode will insert the translated table
  8365. between these lines, replacing whatever was there before. For example:
  8366. @example
  8367. /* BEGIN RECEIVE ORGTBL table_name */
  8368. /* END RECEIVE ORGTBL table_name */
  8369. @end example
  8370. @noindent
  8371. Just above the source table, we put a special line that tells
  8372. Orgtbl mode how to translate this table and where to install it. For
  8373. example:
  8374. @example
  8375. #+ORGTBL: SEND table_name translation_function arguments....
  8376. @end example
  8377. @noindent
  8378. @code{table_name} is the reference name for the table that is also used
  8379. in the receiver lines. @code{translation_function} is the Lisp function
  8380. that does the translation. Furthermore, the line can contain a list of
  8381. arguments (alternating key and value) at the end. The arguments will be
  8382. passed as a property list to the translation function for
  8383. interpretation. A few standard parameters are already recognized and
  8384. acted upon before the translation function is called:
  8385. @table @code
  8386. @item :skip N
  8387. Skip the first N lines of the table. Hlines do count as separate lines for
  8388. this parameter!
  8389. @item :skipcols (n1 n2 ...)
  8390. List of columns that should be skipped. If the table has a column with
  8391. calculation marks, that column is automatically discarded as well.
  8392. Please note that the translator function sees the table @emph{after} the
  8393. removal of these columns, the function never knows that there have been
  8394. additional columns.
  8395. @end table
  8396. @noindent
  8397. The one problem remaining is how to keep the source table in the buffer
  8398. without disturbing the normal workings of the file, for example during
  8399. compilation of a C file or processing of a La@TeX{} file. There are a
  8400. number of different solutions:
  8401. @itemize @bullet
  8402. @item
  8403. The table could be placed in a block comment if that is supported by the
  8404. language. For example, in C mode you could wrap the table between
  8405. @samp{/*} and @samp{*/} lines.
  8406. @item
  8407. Sometimes it is possible to put the table after some kind of @i{END}
  8408. statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
  8409. in La@TeX{}.
  8410. @item
  8411. You can just comment the table line by line whenever you want to process
  8412. the file, and uncomment it whenever you need to edit the table. This
  8413. only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
  8414. make this comment-toggling very easy, in particular if you bind it to a
  8415. key.
  8416. @end itemize
  8417. @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
  8418. @subsection A LaTeX example of radio tables
  8419. @cindex LaTeX, and Orgtbl mode
  8420. The best way to wrap the source table in La@TeX{} is to use the
  8421. @code{comment} environment provided by @file{comment.sty}. It has to be
  8422. activated by placing @code{\usepackage@{comment@}} into the document
  8423. header. Orgtbl mode can insert a radio table skeleton@footnote{By
  8424. default this works only for La@TeX{}, HTML, and Texinfo. Configure the
  8425. variable @code{orgtbl-radio-tables} to install templates for other
  8426. modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
  8427. be prompted for a table name, let's say we use @samp{salesfigures}. You
  8428. will then get the following template:
  8429. @cindex #+ORGTBL: SEND
  8430. @example
  8431. % BEGIN RECEIVE ORGTBL salesfigures
  8432. % END RECEIVE ORGTBL salesfigures
  8433. \begin@{comment@}
  8434. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  8435. | | |
  8436. \end@{comment@}
  8437. @end example
  8438. @noindent
  8439. The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
  8440. @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
  8441. into the receiver location with name @code{salesfigures}. You may now
  8442. fill in the table, feel free to use the spreadsheet features@footnote{If
  8443. the @samp{#+TBLFM} line contains an odd number of dollar characters,
  8444. this may cause problems with font-lock in LaTeX mode. As shown in the
  8445. example you can fix this by adding an extra line inside the
  8446. @code{comment} environment that is used to balance the dollar
  8447. expressions. If you are using AUCTeX with the font-latex library, a
  8448. much better solution is to add the @code{comment} environment to the
  8449. variable @code{LaTeX-verbatim-environments}.}:
  8450. @example
  8451. % BEGIN RECEIVE ORGTBL salesfigures
  8452. % END RECEIVE ORGTBL salesfigures
  8453. \begin@{comment@}
  8454. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  8455. | Month | Days | Nr sold | per day |
  8456. |-------+------+---------+---------|
  8457. | Jan | 23 | 55 | 2.4 |
  8458. | Feb | 21 | 16 | 0.8 |
  8459. | March | 22 | 278 | 12.6 |
  8460. #+TBLFM: $4=$3/$2;%.1f
  8461. % $ (optional extra dollar to keep font-lock happy, see footnote)
  8462. \end@{comment@}
  8463. @end example
  8464. @noindent
  8465. When you are done, press @kbd{C-c C-c} in the table to get the converted
  8466. table inserted between the two marker lines.
  8467. Now let's assume you want to make the table header by hand, because you
  8468. want to control how columns are aligned etc. In this case we make sure
  8469. that the table translator does skip the first 2 lines of the source
  8470. table, and tell the command to work as a @i{splice}, i.e. to not produce
  8471. header and footer commands of the target table:
  8472. @example
  8473. \begin@{tabular@}@{lrrr@}
  8474. Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
  8475. % BEGIN RECEIVE ORGTBL salesfigures
  8476. % END RECEIVE ORGTBL salesfigures
  8477. \end@{tabular@}
  8478. %
  8479. \begin@{comment@}
  8480. #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
  8481. | Month | Days | Nr sold | per day |
  8482. |-------+------+---------+---------|
  8483. | Jan | 23 | 55 | 2.4 |
  8484. | Feb | 21 | 16 | 0.8 |
  8485. | March | 22 | 278 | 12.6 |
  8486. #+TBLFM: $4=$3/$2;%.1f
  8487. \end@{comment@}
  8488. @end example
  8489. The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
  8490. Orgtbl mode. It uses a @code{tabular} environment to typeset the table
  8491. and marks horizontal lines with @code{\hline}. Furthermore, it
  8492. interprets the following parameters (see also @ref{Translator functions}):
  8493. @table @code
  8494. @item :splice nil/t
  8495. When set to t, return only table body lines, don't wrap them into a
  8496. tabular environment. Default is nil.
  8497. @item :fmt fmt
  8498. A format to be used to wrap each field, should contain @code{%s} for the
  8499. original field value. For example, to wrap each field value in dollars,
  8500. you could use @code{:fmt "$%s$"}. This may also be a property list with
  8501. column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
  8502. A function of one argument can be used in place of the strings; the
  8503. function must return a formatted string.
  8504. @item :efmt efmt
  8505. Use this format to print numbers with exponentials. The format should
  8506. have @code{%s} twice for inserting mantissa and exponent, for example
  8507. @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
  8508. may also be a property list with column numbers and formats, for example
  8509. @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
  8510. @code{efmt} has been applied to a value, @code{fmt} will also be
  8511. applied. Similar to @code{fmt}, functions of two arguments can be
  8512. supplied instead of strings.
  8513. @end table
  8514. @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
  8515. @subsection Translator functions
  8516. @cindex HTML, and Orgtbl mode
  8517. @cindex translator function
  8518. Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
  8519. (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
  8520. @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
  8521. Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
  8522. code that produces tables during HTML export.}, these all use a generic
  8523. translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
  8524. itself is a very short function that computes the column definitions for the
  8525. @code{tabular} environment, defines a few field and line separators and then
  8526. hands over to the generic translator. Here is the entire code:
  8527. @lisp
  8528. @group
  8529. (defun orgtbl-to-latex (table params)
  8530. "Convert the Orgtbl mode TABLE to LaTeX."
  8531. (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
  8532. org-table-last-alignment ""))
  8533. (params2
  8534. (list
  8535. :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
  8536. :tend "\\end@{tabular@}"
  8537. :lstart "" :lend " \\\\" :sep " & "
  8538. :efmt "%s\\,(%s)" :hline "\\hline")))
  8539. (orgtbl-to-generic table (org-combine-plists params2 params))))
  8540. @end group
  8541. @end lisp
  8542. As you can see, the properties passed into the function (variable
  8543. @var{PARAMS}) are combined with the ones newly defined in the function
  8544. (variable @var{PARAMS2}). The ones passed into the function (i.e. the
  8545. ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
  8546. would like to use the La@TeX{} translator, but wanted the line endings to
  8547. be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
  8548. overrule the default with
  8549. @example
  8550. #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
  8551. @end example
  8552. For a new language, you can either write your own converter function in
  8553. analogy with the La@TeX{} translator, or you can use the generic function
  8554. directly. For example, if you have a language where a table is started
  8555. with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
  8556. started with @samp{!BL!}, ended with @samp{!EL!} and where the field
  8557. separator is a TAB, you could call the generic translator like this (on
  8558. a single line!):
  8559. @example
  8560. #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
  8561. :lstart "!BL! " :lend " !EL!" :sep "\t"
  8562. @end example
  8563. @noindent
  8564. Please check the documentation string of the function
  8565. @code{orgtbl-to-generic} for a full list of parameters understood by
  8566. that function and remember that you can pass each of them into
  8567. @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
  8568. using the generic function.
  8569. Of course you can also write a completely new function doing complicated
  8570. things the generic translator cannot do. A translator function takes
  8571. two arguments. The first argument is the table, a list of lines, each
  8572. line either the symbol @code{hline} or a list of fields. The second
  8573. argument is the property list containing all parameters specified in the
  8574. @samp{#+ORGTBL: SEND} line. The function must return a single string
  8575. containing the formatted table. If you write a generally useful
  8576. translator, please post it on @code{emacs-orgmode@@gnu.org} so that
  8577. others can benefit from your work.
  8578. @node Radio lists, , Translator functions, Tables in arbitrary syntax
  8579. @subsection Radio lists
  8580. @cindex radio lists
  8581. @cindex org-list-insert-radio-list
  8582. Sending and receiving radio lists works exactly the same way than
  8583. sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
  8584. need to load the @code{org-export-latex.el} package to use radio lists
  8585. since the relevant code is there for now.}. As for radio tables, you
  8586. can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by
  8587. calling @code{org-list-insert-radio-list}.
  8588. Here are the differences with radio tables:
  8589. @itemize @minus
  8590. @item
  8591. Use @code{ORGLST} instead of @code{ORGTBL}.
  8592. @item
  8593. The available translation functions for radio lists don't take
  8594. parameters.
  8595. @item
  8596. `C-c C-c' will work when pressed on the first item of the list.
  8597. @end itemize
  8598. Here is a La@TeX{} example. Let's say that you have this in your
  8599. La@TeX{} file:
  8600. @example
  8601. % BEGIN RECEIVE ORGLST to-buy
  8602. % END RECEIVE ORGLST to-buy
  8603. \begin@{comment@}
  8604. #+ORGLIST: SEND to-buy orgtbl-to-latex
  8605. - a new house
  8606. - a new computer
  8607. + a new keyboard
  8608. + a new mouse
  8609. - a new life
  8610. \end@{comment@}
  8611. @end example
  8612. Pressing `C-c C-c' on @code{a new house} and will insert the converted
  8613. La@TeX{} list between the two marker lines.
  8614. @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
  8615. @section Dynamic blocks
  8616. @cindex dynamic blocks
  8617. Org documents can contain @emph{dynamic blocks}. These are
  8618. specially marked regions that are updated by some user-written function.
  8619. A good example for such a block is the clock table inserted by the
  8620. command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
  8621. Dynamic block are enclosed by a BEGIN-END structure that assigns a name
  8622. to the block and can also specify parameters for the function producing
  8623. the content of the block.
  8624. #+BEGIN:dynamic block
  8625. @example
  8626. #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
  8627. #+END:
  8628. @end example
  8629. Dynamic blocks are updated with the following commands
  8630. @table @kbd
  8631. @kindex C-c C-x C-u
  8632. @item C-c C-x C-u
  8633. Update dynamic block at point.
  8634. @kindex C-u C-c C-x C-u
  8635. @item C-u C-c C-x C-u
  8636. Update all dynamic blocks in the current file.
  8637. @end table
  8638. Updating a dynamic block means to remove all the text between BEGIN and
  8639. END, parse the BEGIN line for parameters and then call the specific
  8640. writer function for this block to insert the new content. If you want
  8641. to use the original content in the writer function, you can use the
  8642. extra parameter @code{:content}.
  8643. For a block with name @code{myblock}, the writer function is
  8644. @code{org-dblock-write:myblock} with as only parameter a property list
  8645. with the parameters given in the begin line. Here is a trivial example
  8646. of a block that keeps track of when the block update function was last
  8647. run:
  8648. @example
  8649. #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
  8650. #+END:
  8651. @end example
  8652. @noindent
  8653. The corresponding block writer function could look like this:
  8654. @lisp
  8655. (defun org-dblock-write:block-update-time (params)
  8656. (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
  8657. (insert "Last block update at: "
  8658. (format-time-string fmt (current-time)))))
  8659. @end lisp
  8660. If you want to make sure that all dynamic blocks are always up-to-date,
  8661. you could add the function @code{org-update-all-dblocks} to a hook, for
  8662. example @code{before-save-hook}. @code{org-update-all-dblocks} is
  8663. written in a way that is does nothing in buffers that are not in
  8664. @code{org-mode}.
  8665. @node Special agenda views, Using the property API, Dynamic blocks, Hacking
  8666. @section Special agenda views
  8667. @cindex agenda views, user-defined
  8668. Org provides a special hook that can be used to narrow down the
  8669. selection made by any of the agenda views. You may specify a function
  8670. that is used at each match to verify if the match should indeed be part
  8671. of the agenda view, and if not, how much should be skipped.
  8672. Let's say you want to produce a list of projects that contain a WAITING
  8673. tag anywhere in the project tree. Let's further assume that you have
  8674. marked all tree headings that define a project with the TODO keyword
  8675. PROJECT. In this case you would run a TODO search for the keyword
  8676. PROJECT, but skip the match unless there is a WAITING tag anywhere in
  8677. the subtree belonging to the project line.
  8678. To achieve this, you must write a function that searches the subtree for
  8679. the tag. If the tag is found, the function must return @code{nil} to
  8680. indicate that this match should not be skipped. If there is no such
  8681. tag, return the location of the end of the subtree, to indicate that
  8682. search should continue from there.
  8683. @lisp
  8684. (defun my-skip-unless-waiting ()
  8685. "Skip trees that are not waiting"
  8686. (let ((subtree-end (save-excursion (org-end-of-subtree t))))
  8687. (if (re-search-forward ":waiting:" subtree-end t)
  8688. nil ; tag found, do not skip
  8689. subtree-end))) ; tag not found, continue after end of subtree
  8690. @end lisp
  8691. Now you may use this function in an agenda custom command, for example
  8692. like this:
  8693. @lisp
  8694. (org-add-agenda-custom-command
  8695. '("b" todo "PROJECT"
  8696. ((org-agenda-skip-function 'my-skip-unless-waiting)
  8697. (org-agenda-overriding-header "Projects waiting for something: "))))
  8698. @end lisp
  8699. Note that this also binds @code{org-agenda-overriding-header} to get a
  8700. meaningful header in the agenda view.
  8701. A general way to create custom searches is to base them on a search for
  8702. entries with a certain level limit. If you want to study all entries with
  8703. your custom search function, simply do a search for @samp{LEVEL>0}, and then
  8704. use @code{org-agenda-skip-function} to select the entries you really want to
  8705. have.
  8706. You may also put a Lisp form into @code{org-agenda-skip-function}. In
  8707. particular, you may use the functions @code{org-agenda-skip-entry-if}
  8708. and @code{org-agenda-skip-subtree-if} in this form, for example:
  8709. @table @code
  8710. @item '(org-agenda-skip-entry-if 'scheduled)
  8711. Skip current entry if it has been scheduled.
  8712. @item '(org-agenda-skip-entry-if 'notscheduled)
  8713. Skip current entry if it has not been scheduled.
  8714. @item '(org-agenda-skip-entry-if 'deadline)
  8715. Skip current entry if it has a deadline.
  8716. @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
  8717. Skip current entry if it has a deadline, or if it is scheduled.
  8718. @item '(org-agenda-skip-entry 'regexp "regular expression")
  8719. Skip current entry if the regular expression matches in the entry.
  8720. @item '(org-agenda-skip-entry 'notregexp "regular expression")
  8721. Skip current entry unless the regular expression matches.
  8722. @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
  8723. Same as above, but check and skip the entire subtree.
  8724. @end table
  8725. Therefore we could also have written the search for WAITING projects
  8726. like this, even without defining a special function:
  8727. @lisp
  8728. (org-add-agenda-custom-command
  8729. '("b" todo "PROJECT"
  8730. ((org-agenda-skip-function '(org-agenda-skip-subtree-if
  8731. 'regexp ":waiting:"))
  8732. (org-agenda-overriding-header "Projects waiting for something: "))))
  8733. @end lisp
  8734. @node Using the property API, Using the mapping API, Special agenda views, Hacking
  8735. @section Using the property API
  8736. @cindex API, for properties
  8737. @cindex properties, API
  8738. Here is a description of the functions that can be used to work with
  8739. properties.
  8740. @defun org-entry-properties &optional pom which
  8741. Get all properties of the entry at point-or-marker POM.
  8742. This includes the TODO keyword, the tags, time strings for deadline,
  8743. scheduled, and clocking, and any additional properties defined in the
  8744. entry. The return value is an alist, keys may occur multiple times
  8745. if the property key was used several times.
  8746. POM may also be nil, in which case the current entry is used.
  8747. If WHICH is nil or `all', get all properties. If WHICH is
  8748. `special' or `standard', only get that subclass.
  8749. @end defun
  8750. @defun org-entry-get pom property &optional inherit
  8751. Get value of PROPERTY for entry at point-or-marker POM. By default,
  8752. this only looks at properties defined locally in the entry. If INHERIT
  8753. is non-nil and the entry does not have the property, then also check
  8754. higher levels of the hierarchy. If INHERIT is the symbol
  8755. @code{selective}, use inheritance if and only if the setting of
  8756. @code{org-use-property-inheritance} selects PROPERTY for inheritance.
  8757. @end defun
  8758. @defun org-entry-delete pom property
  8759. Delete the property PROPERTY from entry at point-or-marker POM.
  8760. @end defun
  8761. @defun org-entry-put pom property value
  8762. Set PROPERTY to VALUE for entry at point-or-marker POM.
  8763. @end defun
  8764. @defun org-buffer-property-keys &optional include-specials
  8765. Get all property keys in the current buffer.
  8766. @end defun
  8767. @defun org-insert-property-drawer
  8768. Insert a property drawer at point.
  8769. @end defun
  8770. @defun org-entry-put-multivalued-property pom property &rest values
  8771. Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
  8772. strings. They will be concatenated, with spaces as separators.
  8773. @end defun
  8774. @defun org-entry-get-multivalued-property pom property
  8775. Treat the value of the property PROPERTY as a whitespace-separated list of
  8776. values and return the values as a list of strings.
  8777. @end defun
  8778. @defun org-entry-add-to-multivalued-property pom property value
  8779. Treat the value of the property PROPERTY as a whitespace-separated list of
  8780. values and make sure that VALUE is in this list.
  8781. @end defun
  8782. @defun org-entry-remove-from-multivalued-property pom property value
  8783. Treat the value of the property PROPERTY as a whitespace-separated list of
  8784. values and make sure that VALUE is @emph{not} in this list.
  8785. @end defun
  8786. @defun org-entry-member-in-multivalued-property pom property value
  8787. Treat the value of the property PROPERTY as a whitespace-separated list of
  8788. values and check if VALUE is in this list.
  8789. @end defun
  8790. @node Using the mapping API, , Using the property API, Hacking
  8791. @section Using the mapping API
  8792. @cindex API, for mapping
  8793. @cindex mapping entries, API
  8794. Org has sophisticated mapping capabilities to find all entries satisfying
  8795. certain criteria. Internally, this functionality is used to produce agenda
  8796. views, but there is also an API that can be used to execute arbitrary
  8797. functions for each or selected entries. The main entry point for this API
  8798. is:
  8799. @defun org-map-entries func &optional match scope &rest skip
  8800. Call FUNC at each headline selected by MATCH in SCOPE.
  8801. FUNC is a function or a lisp form. The function will be called without
  8802. arguments, with the cursor positioned at the beginning of the headline.
  8803. The return values of all calls to the function will be collected and
  8804. returned as a list.
  8805. MATCH is a tags/property/todo match as it is used in the agenda match view.
  8806. Only headlines that are matched by this query will be considered during
  8807. the iteration. When MATCH is nil or t, all headlines will be
  8808. visited by the iteration.
  8809. SCOPE determines the scope of this command. It can be any of:
  8810. @example
  8811. nil @r{the current buffer, respecting the restriction if any}
  8812. tree @r{the subtree started with the entry at point}
  8813. file @r{the current buffer, without restriction}
  8814. file-with-archives
  8815. @r{the current buffer, and any archives associated with it}
  8816. agenda @r{all agenda files}
  8817. agenda-with-archives
  8818. @r{all agenda files with any archive files associated with them}
  8819. (file1 file2 ...)
  8820. @r{if this is a list, all files in the list will be scanned}
  8821. @end example
  8822. The remaining args are treated as settings for the skipping facilities of
  8823. the scanner. The following items can be given here:
  8824. @example
  8825. archive @r{skip trees with the archive tag}
  8826. comment @r{skip trees with the COMMENT keyword}
  8827. function or Lisp form
  8828. @r{will be used as value for @code{org-agenda-skip-function},}
  8829. @r{so whenever the the function returns t, FUNC}
  8830. @r{will not be called for that entry and search will}
  8831. @r{continue from the point where the function leaves it}
  8832. @end example
  8833. @end defun
  8834. The function given to that mapping routine can really do anything you like.
  8835. It can use the property API (@pxref{Using the property API}) to gather more
  8836. information about the entry, or in order to change metadata in the entry.
  8837. Here are a couple of functions that might be handy:
  8838. @defun org-todo &optional arg
  8839. Change the TODO state of the entry, see the docstring of the functions for
  8840. the many possible values for the argument ARG.
  8841. @end defun
  8842. @defun org-priority &optional action
  8843. Change the priority of the entry, see the docstring of this function for the
  8844. possible values for ACTION.
  8845. @end defun
  8846. @defun org-toggle-tag tag &optional onoff
  8847. Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
  8848. or @code{off} will not toggle tag, but ensure that it is either on or off.
  8849. @end defun
  8850. @defun org-promote
  8851. Promote the current entry.
  8852. @end defun
  8853. @defun org-demote
  8854. Demote the current entry.
  8855. @end defun
  8856. Here is a simple example that will turn all entries in the current file with
  8857. a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
  8858. Entries in comment trees and in archive trees will be ignored.
  8859. @lisp
  8860. (org-map-entries
  8861. '(org-todo "UPCOMING")
  8862. "+TOMORROW" 'file 'archive 'comment)
  8863. @end lisp
  8864. The following example counts the number of entries with TODO keyword
  8865. @code{WAITING}, in all agenda files.
  8866. @lisp
  8867. (length (org-map-entries t "/+WAITING" 'agenda))
  8868. @end lisp
  8869. @node History and Acknowledgments, Main Index, Hacking, Top
  8870. @appendix History and Acknowledgments
  8871. @cindex acknowledgments
  8872. @cindex history
  8873. @cindex thanks
  8874. Org was borne in 2003, out of frustration over the user interface
  8875. of the Emacs Outline mode. I was trying to organize my notes and
  8876. projects, and using Emacs seemed to be the natural way to go. However,
  8877. having to remember eleven different commands with two or three keys per
  8878. command, only to hide and show parts of the outline tree, that seemed
  8879. entirely unacceptable to me. Also, when using outlines to take notes, I
  8880. constantly want to restructure the tree, organizing it parallel to my
  8881. thoughts and plans. @emph{Visibility cycling} and @emph{structure
  8882. editing} were originally implemented in the package
  8883. @file{outline-magic.el}, but quickly moved to the more general
  8884. @file{org.el}. As this environment became comfortable for project
  8885. planning, the next step was adding @emph{TODO entries}, basic @emph{time
  8886. stamps}, and @emph{table support}. These areas highlight the two main
  8887. goals that Org still has today: To create a new, outline-based,
  8888. plain text mode with innovative and intuitive editing features, and to
  8889. incorporate project planning functionality directly into a notes file.
  8890. A special thanks goes to @i{Bastien Guerry} who has not only written a large
  8891. number of extensions to Org (most of them integrated into the core by now),
  8892. but has also helped the development and maintenance of Org so much that he
  8893. should be considered co-author of this package.
  8894. Since the first release, literally thousands of emails to me or on
  8895. @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
  8896. reports, feedback, new ideas, and sometimes patches and add-on code.
  8897. Many thanks to everyone who has helped to improve this package. I am
  8898. trying to keep here a list of the people who had significant influence
  8899. in shaping one or more aspects of Org. The list may not be
  8900. complete, if I have forgotten someone, please accept my apologies and
  8901. let me know.
  8902. @itemize @bullet
  8903. @item
  8904. @i{Russel Adams} came up with the idea for drawers.
  8905. @item
  8906. @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
  8907. @item
  8908. @i{Christophe Bataillon} created the great unicorn logo that we use on the
  8909. Org-mode website.
  8910. @item
  8911. @i{Alex Bochannek} provided a patch for rounding time stamps.
  8912. @item
  8913. @i{Charles Cave}'s suggestion sparked the implementation of templates
  8914. for Remember.
  8915. @item
  8916. @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
  8917. specified time.
  8918. @item
  8919. @i{Gregory Chernov} patched support for lisp forms into table
  8920. calculations and improved XEmacs compatibility, in particular by porting
  8921. @file{nouline.el} to XEmacs.
  8922. @item
  8923. @i{Sacha Chua} suggested to copy some linking code from Planner.
  8924. @item
  8925. @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
  8926. came up with the idea of properties, and that there should be an API for
  8927. them.
  8928. @item
  8929. @i{Kees Dullemond} used to edit projects lists directly in HTML and so
  8930. inspired some of the early development, including HTML export. He also
  8931. asked for a way to narrow wide table columns.
  8932. @item
  8933. @i{Christian Egli} converted the documentation into Texinfo format,
  8934. patched CSS formatting into the HTML exporter, and inspired the agenda.
  8935. @item
  8936. @i{David Emery} provided a patch for custom CSS support in exported
  8937. HTML agendas.
  8938. @item
  8939. @i{Nic Ferrier} contributed mailcap and XOXO support.
  8940. @item
  8941. @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
  8942. @item
  8943. @i{John Foerch} figured out how to make incremental search show context
  8944. around a match in a hidden outline tree.
  8945. @item
  8946. @i{Niels Giesen} had the idea to automatically archive DONE trees.
  8947. @item
  8948. @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
  8949. has been prolific with patches, ideas, and bug reports.
  8950. @item
  8951. @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
  8952. @item
  8953. @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
  8954. task state change logging, and the clocktable. His clear explanations have
  8955. been critical when we started to adopt the GIT version control system.
  8956. @item
  8957. @i{Manuel Hermenegildo} has contributed various ideas, small fixed and
  8958. patches.
  8959. @item
  8960. @i{Phil Jackson} wrote @file{org-irc.el}.
  8961. @item
  8962. @i{Scott Jaderholm} proposed footnotes, control over whitespace between
  8963. folded entries, and column view for properties.
  8964. @item
  8965. @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
  8966. @item
  8967. @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
  8968. provided frequent feedback and some patches.
  8969. @item
  8970. @i{Matt Lundin} has proposed last-row references for table formulas and named
  8971. invisible anchors. He has also worked a lot on the FAQ.
  8972. @item
  8973. @i{Jason F. McBrayer} suggested agenda export to CSV format.
  8974. @item
  8975. @i{Max Mikhanosha} came up with the idea of refiling.
  8976. @item
  8977. @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
  8978. basis.
  8979. @item
  8980. @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
  8981. happy.
  8982. @item
  8983. @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
  8984. and to be able to quickly restrict the agenda to a subtree.
  8985. @item
  8986. @i{Todd Neal} provided patches for links to Info files and elisp forms.
  8987. @item
  8988. @i{Tim O'Callaghan} suggested in-file links, search options for general
  8989. file links, and TAGS.
  8990. @item
  8991. @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
  8992. into Japanese.
  8993. @item
  8994. @i{Oliver Oppitz} suggested multi-state TODO items.
  8995. @item
  8996. @i{Scott Otterson} sparked the introduction of descriptive text for
  8997. links, among other things.
  8998. @item
  8999. @i{Pete Phillips} helped during the development of the TAGS feature, and
  9000. provided frequent feedback.
  9001. @item
  9002. @i{T.V. Raman} reported bugs and suggested improvements.
  9003. @item
  9004. @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
  9005. control.
  9006. @item
  9007. @i{Paul Rivier} provided the basic implementation of named footnotes.
  9008. @item
  9009. @i{Kevin Rogers} contributed code to access VM files on remote hosts.
  9010. @item
  9011. @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
  9012. webpages derived from Org using an Info-like, or a folding interface with
  9013. single key navigation.
  9014. @item
  9015. @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
  9016. conflict with @file{allout.el}.
  9017. @item
  9018. @i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with
  9019. extensive patches.
  9020. @item
  9021. @i{Philip Rooke} created the Org reference card, provided lots
  9022. of feedback, developed and applied standards to the Org documentation.
  9023. @item
  9024. @i{Christian Schlauer} proposed angular brackets around links, among
  9025. other things.
  9026. @item
  9027. @i{Eric Schulte} wrote @file{org-plot.el}.
  9028. @item
  9029. Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
  9030. @file{organizer-mode.el}.
  9031. @item
  9032. @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
  9033. examples, and remote highlighting for referenced code lines.
  9034. @item
  9035. @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
  9036. now packaged into Org's @file{contrib} directory.
  9037. @item
  9038. @i{Daniel Sinder} came up with the idea of internal archiving by locking
  9039. subtrees.
  9040. @item
  9041. @i{Dale Smith} proposed link abbreviations.
  9042. @item
  9043. @i{James TD Smith} has contributed a large number of patches for useful
  9044. tweaks and features.
  9045. @item
  9046. @i{Adam Spiers} asked for global linking commands, inspired the link
  9047. extension system, added support for mairix, and proposed the mapping API.
  9048. @item
  9049. @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
  9050. with links transformation to Org syntax.
  9051. @item
  9052. @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
  9053. chapter about publishing.
  9054. @item
  9055. @i{J@"urgen Vollmer} contributed code generating the table of contents
  9056. in HTML output.
  9057. @item
  9058. @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
  9059. keyword.
  9060. @item
  9061. @i{David Wainberg} suggested archiving, and improvements to the linking
  9062. system.
  9063. @item
  9064. @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
  9065. @file{muse.el}, which have similar goals as Org. Initially the
  9066. development of Org was fully independent because I was not aware of the
  9067. existence of these packages. But with time I have occasionally looked
  9068. at John's code and learned a lot from it. John has also contributed a
  9069. number of great ideas and patches directly to Org, including the attachment
  9070. system (@file{org-attach.el}) and integration with Apple Mail
  9071. (@file{org-mac-message.el}).
  9072. @item
  9073. @i{Carsten Wimmer} suggested some changes and helped fix a bug in
  9074. linking to Gnus.
  9075. @item
  9076. @i{Roland Winkler} requested additional key bindings to make Org
  9077. work on a tty.
  9078. @item
  9079. @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
  9080. and contributed various ideas and code snippets.
  9081. @end itemize
  9082. @node Main Index, Key Index, History and Acknowledgments, Top
  9083. @unnumbered The Main Index
  9084. @printindex cp
  9085. @node Key Index, , Main Index, Top
  9086. @unnumbered Key Index
  9087. @printindex ky
  9088. @bye
  9089. @ignore
  9090. arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
  9091. @end ignore
  9092. @c Local variables:
  9093. @c ispell-local-dictionary: "en_US-w_accents"
  9094. @c ispell-local-pdict: "./.aspell.org.pws"
  9095. @c fill-column: 77
  9096. @c End: