org.texi 335 KB

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