org 179 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239
  1. This is org, produced by makeinfo version 4.8 from org.texi.
  2. INFO-DIR-SECTION Emacs
  3. START-INFO-DIR-ENTRY
  4. * Org Mode: (org). outline-based notes management and organizer
  5. END-INFO-DIR-ENTRY
  6. This manual is for Org-mode (version 4.29).
  7. Copyright (C) 2004, 2005, 2006 Free Software Foundation
  8. Permission is granted to copy, distribute and/or modify this
  9. document under the terms of the GNU Free Documentation License,
  10. Version 1.1 or any later version published by the Free Software
  11. Foundation; with no Invariant Sections, with the Front-Cover texts
  12. being "A GNU Manual," and with the Back-Cover Texts as in (a)
  13. below. A copy of the license is included in the section entitled
  14. "GNU Free Documentation License."
  15. (a) The FSF's Back-Cover Text is: "You have freedom to copy and
  16. modify this GNU Manual, like GNU software. Copies published by
  17. the Free Software Foundation raise funds for GNU development."
  18. 
  19. File: org, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
  20. Org Mode Manual
  21. ***************
  22. This manual is for Org-mode (version 4.29).
  23. Copyright (C) 2004, 2005, 2006 Free Software Foundation
  24. Permission is granted to copy, distribute and/or modify this
  25. document under the terms of the GNU Free Documentation License,
  26. Version 1.1 or any later version published by the Free Software
  27. Foundation; with no Invariant Sections, with the Front-Cover texts
  28. being "A GNU Manual," and with the Back-Cover Texts as in (a)
  29. below. A copy of the license is included in the section entitled
  30. "GNU Free Documentation License."
  31. (a) The FSF's Back-Cover Text is: "You have freedom to copy and
  32. modify this GNU Manual, like GNU software. Copies published by
  33. the Free Software Foundation raise funds for GNU development."
  34. * Menu:
  35. * Introduction:: Getting started
  36. * Document structure:: A tree works like your brain
  37. * Tables:: Pure magic for quick formatting
  38. * Hyperlinks:: Notes in context
  39. * TODO items:: Every tree branch can be a TODO item
  40. * Timestamps:: Assign date and time to items
  41. * Tags:: Tagging headlines and matching sets of tags
  42. * Agenda views:: Collecting information into views
  43. * Exporting:: Sharing and publishing of notes
  44. * Miscellaneous:: All the rest which did not fit elsewhere
  45. * Index:: The fast road to specific information
  46. * Key Index:: Key bindings and where they are described
  47. --- The Detailed Node Listing ---
  48. Introduction
  49. * Summary:: Brief summary of what Org-mode does
  50. * Installation and activation:: How to install Org-mode
  51. * Feedback:: Bug reports, ideas, patches etc.
  52. Document Structure
  53. * Outlines:: Org-mode is based on outline-mode
  54. * Headlines:: How to typeset org-tree headlines
  55. * Visibility cycling:: Show and hide, much simplified
  56. * Motion:: Jumping to other headlines
  57. * Structure editing:: Changing sequence and level of headlines
  58. * Archiving:: Move done task trees to a different place
  59. * Sparse trees:: Matches embedded in context
  60. * Plain lists:: Editing hand-formatted lists
  61. Tables
  62. * Built-in table editor:: Simple tables
  63. * Narrow columns:: Stop wasting space in tables
  64. * Table calculations:: Compute a field from other fields
  65. * orgtbl-mode:: The table editor as minor mode
  66. * table.el:: Complex tables
  67. Calculations in tables
  68. * Formula syntax:: How to write a formula
  69. * Lisp formulas:: An alternative way to write formulas
  70. * Column formulas:: Formulas valid for all fields in a column
  71. * Advanced features:: Field names, parameters and automatic recalc
  72. * Named-field formulas:: Formulas valid in single fields
  73. * Editing/debugging formulas:: Changing a stored formula
  74. * Appetizer:: Taste the power of calc
  75. Hyperlinks
  76. * Link format:: How links in Org-mode are formatted
  77. * Internal links:: Links to other places in the current file
  78. * External links:: URL-like links to the world
  79. * Handling links:: Creating, inserting and following
  80. * Search options:: Linking to a specific location
  81. * Custom searches:: When the default search is not enough
  82. * Remember:: Org-trees store quick notes
  83. Internal links
  84. * Radio targets:: Make targets trigger links in plain text.
  85. * CamelCase links:: Activating CamelCase words as links
  86. TODO items
  87. * TODO basics:: Marking and displaying TODO entries
  88. * Progress logging:: Document your productivity
  89. * TODO extensions:: Workflow and assignments
  90. * Priorities:: Some things are more important than others
  91. Extended use of TODO keywords
  92. * Workflow states:: From TODO to DONE in steps
  93. * TODO types:: I do this, Fred the rest
  94. * Per file keywords:: Different files, different requirements
  95. Timestamps
  96. * Time stamps:: Assigning a time to a tree entry
  97. * Creating timestamps:: Commands which insert timestamps
  98. Tags
  99. * Tag inheritance:: Tags use the tree structure of the outline
  100. * Setting tags:: How to assign tags to a headline
  101. * Tag searches:: Searching for combinations of tags
  102. Agenda Views
  103. * Agenda files:: Files being searched for agenda information
  104. * Agenda dispatcher:: Keyboard access to agenda views
  105. * Weekly/Daily agenda:: The calendar page with current tasks
  106. * Global TODO list:: All unfinished action items
  107. * Matching headline tags:: Structured information with fine-tuned search
  108. * Timeline:: Time-sorted view for single file
  109. * Agenda commands:: Remote editing of org trees
  110. The weekly/daily agenda
  111. * Categories:: Not all tasks are equal
  112. * Time-of-day specifications:: How the agenda knows the time
  113. * Calendar/Diary integration:: Integrating Anniversaries and more
  114. * Sorting of agenda items:: The order of things
  115. Exporting
  116. * ASCII export:: Exporting to plain ASCII
  117. * HTML export:: Exporting to HTML
  118. * XML export:: Exporting to XML
  119. * iCalendar export:: Exporting in iCalendar format
  120. * Text interpretation:: How the exporter looks at the file
  121. Text interpretation by the exporter
  122. * Comment lines:: Some lines will not be exported
  123. * Enhancing text:: Subscripts, symbols and more
  124. * Export options:: How to influence the export settings
  125. Miscellaneous
  126. * Completion:: M-TAB knows what you need
  127. * Customization:: Adapting Org-mode to your taste
  128. * Summary of in-buffer settings:: Using special lines to set options
  129. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  130. * Clean view:: Getting rid of leading stars in the outline
  131. * TTY keys:: Using Org-mode on a tty
  132. * FAQ:: Frequently asked questions
  133. * Interaction:: Other Emacs packages
  134. * Bugs:: Things which do not work perfectly
  135. * Acknowledgments:: These people provided feedback and more
  136. 
  137. File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
  138. 1 Introduction
  139. **************
  140. * Menu:
  141. * Summary:: Brief summary of what Org-mode does
  142. * Installation and activation:: How to install Org-mode
  143. * Feedback:: Bug reports, ideas, patches etc.
  144. 
  145. File: org, Node: Summary, Next: Installation and activation, Prev: Introduction, Up: Introduction
  146. 1.1 Summary
  147. ===========
  148. Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
  149. project planning with a fast and effective plain-text system.
  150. Org-mode develops organizational tasks around NOTES files that
  151. contain information about projects as plain text. Org-mode is
  152. implemented on top of outline-mode, which makes it possible to keep the
  153. content of large files well structured. Visibility cycling and
  154. structure editing help to work with the tree. Tables are easily
  155. created with a built-in table editor. Org-mode supports ToDo items,
  156. deadlines, time stamps, and scheduling. It dynamically compiles
  157. entries into an agenda that utilizes and smoothly integrates much of
  158. the Emacs calendar and diary. Plain text URL-like links connect to
  159. websites, emails, Usenet messages, BBDB entries, and any files related
  160. to the projects. For printing and sharing of notes, an Org-mode file
  161. can be exported as a structured ASCII file, as HTML, or (todo and
  162. agenda items only) as an iCalendar file.
  163. Org-mode keeps simple things simple. When first fired up, it should
  164. feel like a simple, easy to use outliner. Complexity is not imposed,
  165. but a large amount of functionality is available when you need it.
  166. Org-mode can be used on different levels and in different ways, for
  167. example:
  168. * as an outline extension with visibility cycling and structure editing
  169. * as an ASCII system and table editor for taking structured notes
  170. * as an ASCII table editor with spreadsheet-like capabilities
  171. * as a simple hypertext system, with HTML export
  172. * as a TODO list editor
  173. * as a full agenda and planner with deadlines and work scheduling
  174. The Org-mode table editor can be integrated into any major mode by
  175. activating the minor Orgtbl-mode.
  176. There is a website for Org-mode which provides links to the newest
  177. version of Org-mode, as well as additional information, screen shots
  178. and example files. This page is located at
  179. `http://www.astro.uva.nl/~dominik/Tools/org/'.
  180. 
  181. File: org, Node: Installation and activation, Next: Feedback, Prev: Summary, Up: Introduction
  182. 1.2 Installation and Activation
  183. ===============================
  184. If Org-mode is part of the Emacs distribution or an XEmacs package, you
  185. only need to copy the following lines to your `.emacs' file. The last
  186. two lines define _global_ keys for the commands `org-store-link' and
  187. `org-agenda' - please choose suitable keys yourself.
  188. ;; The following lines are always needed. Choose your own keys.
  189. (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
  190. (define-key global-map "\C-cl" 'org-store-link)
  191. (define-key global-map "\C-ca" 'org-agenda)
  192. If you have downloaded Org-mode from the Web, you must byte-compile
  193. `org.el' and put it on your load path. In addition to the Emacs Lisp
  194. lines above, you also need to add the following lines to `.emacs':
  195. ;; These lines only if org-mode is not part of the X/Emacs distribution.
  196. (autoload 'org-mode "org" "Org mode" t)
  197. (autoload 'org-diary "org" "Diary entries from Org mode")
  198. (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
  199. (autoload 'org-store-link "org" "Store a link to the current location" t)
  200. (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
  201. (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
  202. With this setup, all files with extension `.org' will be put into
  203. Org-mode. As an alternative, make the first line of a file look like
  204. this:
  205. MY PROJECTS -*- mode: org; -*-
  206. which will select Org-mode for this buffer no matter what the file's
  207. name is. See also the variable `org-insert-mode-line-in-empty-file'.
  208. 
  209. File: org, Node: Feedback, Prev: Installation and activation, Up: Introduction
  210. 1.3 Feedback
  211. ============
  212. If you find problems with Org-mode, or if you have questions, remarks,
  213. or ideas about it, please contact the maintainer Carsten Dominik at
  214. <dominik@science.uva.nl>.
  215. For bug reports, please provide as much information as possible,
  216. including the version information of Emacs (`C-h v emacs-version
  217. <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
  218. Org-mode related setup in `.emacs'. If an error occurs, a traceback
  219. can be very useful. Often a small example file helps, along with clear
  220. information about:
  221. 1. What exactly did you do?
  222. 2. What did you expect to happen?
  223. 3. What happened instead?
  224. Thank you for helping to improve this mode.
  225. 
  226. File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
  227. 2 Document Structure
  228. ********************
  229. Org-mode is based on outline mode and provides flexible commands to
  230. edit the structure of the document.
  231. * Menu:
  232. * Outlines:: Org-mode is based on outline-mode
  233. * Headlines:: How to typeset org-tree headlines
  234. * Visibility cycling:: Show and hide, much simplified
  235. * Motion:: Jumping to other headlines
  236. * Structure editing:: Changing sequence and level of headlines
  237. * Archiving:: Move done task trees to a different place
  238. * Sparse trees:: Matches embedded in context
  239. * Plain lists:: Editing hand-formatted lists
  240. 
  241. File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
  242. 2.1 Outlines
  243. ============
  244. Org-mode is implemented on top of outline-mode. Outlines allow to
  245. organize a document in a hierarchical structure, which (at least for
  246. me) is the best representation of notes and thoughts. Overview over
  247. this structure is achieved by folding (hiding) large parts of the
  248. document to show only the general document structure and the parts
  249. currently being worked on. Org-mode greatly simplifies the use of
  250. outlines by compressing the entire show/hide functionality into a
  251. single command `org-cycle', which is bound to the <TAB> key.
  252. 
  253. File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
  254. 2.2 Headlines
  255. =============
  256. Headlines define the structure of an outline tree. The headlines in
  257. Org-mode start with one or more stars, on the left margin. For example:
  258. * Top level headline
  259. ** Second level
  260. *** 3rd level
  261. some text
  262. *** 3rd level
  263. more text
  264. * Another top level headline
  265. Some people find the many stars too noisy and would prefer an outline
  266. that has whitespace followed by a single star as headline starters.
  267. *Note Clean view:: describes a setup to realize this.
  268. 
  269. File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
  270. 2.3 Visibility cycling
  271. ======================
  272. Outlines make it possible to hide parts of the text in the buffer.
  273. Org-mode uses a single command bound to the <TAB> key to change the
  274. visibility in the buffer.
  275. `<TAB>'
  276. Rotate current subtree between the states
  277. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  278. '-----------------------------------'
  279. At the beginning of the buffer (or when called with `C-u'), this
  280. does the same as the command `S-<TAB>' below.
  281. `S-<TAB>'
  282. Rotate the entire buffer between the states
  283. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  284. '--------------------------------------'
  285. Note that inside tables, `S-<TAB>' jumps to the previous field.
  286. `C-c C-a'
  287. Show all.
  288. When Emacs first visits an Org-mode file, the global state is set to
  289. OVERVIEW, i.e. only the top level headlines are visible. This can be
  290. configured through the variable `org-startup-folded', or on a per-file
  291. basis by adding one of the following lines anywhere in the buffer:
  292. #+STARTUP: overview
  293. #+STARTUP: content
  294. #+STARTUP: showall
  295. 
  296. File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
  297. 2.4 Motion
  298. ==========
  299. The following commands jump to other headlines in the buffer.
  300. `C-c C-n'
  301. Next heading.
  302. `C-c C-p'
  303. Previous heading.
  304. `C-c C-f'
  305. Next heading same level.
  306. `C-c C-b'
  307. Previous heading same level.
  308. `C-c C-u'
  309. Backward to higher level heading.
  310. `C-c C-j'
  311. Jump to a different place without changing the current outline
  312. visibility. Shows the document structure in a temporary buffer,
  313. where you can use visibility cycling (<TAB>) to find your
  314. destination. After pressing <RET>, the cursor moves to the
  315. selected location in the original buffer, and the headings
  316. hierarchy above it is made visible.
  317. 
  318. File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
  319. 2.5 Structure editing
  320. =====================
  321. `M-<RET>'
  322. Insert new heading with same level as current. If the cursor is
  323. in a plain list item, a new item is created (*note Plain lists::).
  324. To force creation of a new headline, use a prefix arg, or first
  325. press <RET> to get to the beginning of the next line. When this
  326. command is used in the middle of a line, the line is split and the
  327. rest of the line becomes the new headline. If the command is used
  328. at the beginning of a headline, the new headline is created before
  329. the current line. It at the beginning of any other line, the
  330. content of that line is made the new heading.
  331. `M-S-<RET>'
  332. Insert new TODO entry with same level as current heading.
  333. `M-<left>'
  334. Promote current heading by one level.
  335. `M-<right>'
  336. Demote current heading by one level.
  337. `M-S-<left>'
  338. Promote the current subtree by one level.
  339. `M-S-<right>'
  340. Demote the current subtree by one level.
  341. `M-S-<up>'
  342. Move subtree up (swap with previous subtree of same level).
  343. `M-S-<down>'
  344. Move subtree down (swap with next subtree of same level).
  345. `C-c C-x C-w'
  346. `C-c C-x C-k'
  347. Kill subtree, i.e. remove it from buffer but save in kill ring.
  348. `C-c C-x M-w'
  349. Copy subtree to kill ring.
  350. `C-c C-x C-y'
  351. Yank subtree from kill ring. This does modify the level of the
  352. subtree to make sure the tree fits in nicely at the yank position.
  353. The yank level can also be specified with a prefix arg, or by
  354. yanking after a headline marker like `****'.
  355. When there is an active region (transient-mark-mode), promotion and
  356. demotion work on all headlines in the region. To select a region of
  357. headlines, it is best to place both point and mark at the beginning of a
  358. line, mark at the beginning of the first headline, and point at the line
  359. just after the last headline to change. Note that when the cursor is
  360. inside a table (*note Tables::), the Meta-Cursor keys have different
  361. functionality.
  362. 
  363. File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
  364. 2.6 Archiving
  365. =============
  366. When a project represented by a (sub)tree is finished, you may want to
  367. move the tree to an archive place, either in the same file under a
  368. special top-level heading, or even to a different file.
  369. `C-c $'
  370. Archive the subtree starting at the cursor position to the location
  371. given by `org-archive-location'.
  372. The default archive is a file in the same directory as the current
  373. file, with the name derived by appending `_archive' to the current file
  374. name. For information and examples on how to change this, see the
  375. documentation string of the variable `org-archive-location'. If you
  376. are also using the Org-mode agenda, archiving to a different file is a
  377. good way to keep archived trees from contributing agenda items.
  378. 
  379. File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
  380. 2.7 Sparse trees
  381. ================
  382. An important feature of Org-mode is the ability to construct _sparse
  383. trees_ for selected information in an outline tree. A sparse tree
  384. means that the entire document is folded as much as possible, but the
  385. selected information is made visible along with the headline structure
  386. above it(1). Just try it out and you will see immediately how it works.
  387. Org-mode contains several commands creating such trees. The most
  388. basic one is `org-occur':
  389. `C-c /'
  390. Occur. Prompts for a regexp and shows a sparse tree with all
  391. matches. If the match is in a headline, the headline is made
  392. visible. If the match is in the body of an entry, headline and
  393. body are made visible. In order to provide minimal context, also
  394. the full hierarchy of headlines above the match is shown, as well
  395. as the headline following the match. Each match is also
  396. highlighted, the highlights disappear when the buffer is changed
  397. with an editing command.
  398. For frequently used sparse trees of specific search strings, you can
  399. use the variable `org-agenda-custom-commands' to define fast keyboard
  400. access to specific sparse trees. These commands will then be
  401. accessible through the agenda dispatcher (*note Agenda dispatcher::).
  402. For example:
  403. (setq org-agenda-custom-commands
  404. '(("f" occur-tree "FIXME")))
  405. will define the key `C-c a f' as a shortcut for creating a sparse tree
  406. matching the string `FIXME'.
  407. Other commands are using sparse trees as well. For example `C-c
  408. C-v' creates a sparse TODO tree (*note TODO basics::).
  409. To print a sparse tree, you can use the Emacs command
  410. `ps-print-buffer-with-faces' which does not print invisible parts of
  411. the document (2). Or you can use the command `C-c C-x v' to export
  412. only the visible part of the document and print the resulting file.
  413. ---------- Footnotes ----------
  414. (1) See also the variables `org-show-hierarchy-above' and
  415. `org-show-following-heading'.
  416. (2) This does not work under XEmacs, because XEmacs uses selective
  417. display for outlining, not text properties.
  418. 
  419. File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
  420. 2.8 Plain lists
  421. ===============
  422. Headlines define both the structure of the Org-mode file, and also lists
  423. (for example, TODO items (*note TODO items::) should be created using
  424. headline levels). However, when taking notes, the plain text is
  425. sometimes easier to read with hand-formatted lists. Org-mode supports
  426. editing such lists, and the HTML exporter (*note Exporting::) does
  427. parse and format them.
  428. Org-mode knows ordered and unordered lists. Unordered list items
  429. start with `-', `+', or `*'(1) as bullets. Ordered list items start
  430. with `1.' or `1)'. Items belonging to the same list must have the same
  431. indentation on the first line. In particular, if an ordered list
  432. reaches number `10.', then the 2-digit numbers must be written
  433. left-aligned with the other numbers in the list. Indentation also
  434. determines the end of a list item. It ends before the next line that
  435. is indented like the bullet/number, or less. For example:
  436. ** Lord of the Rings
  437. My favorite scenes are (in this order)
  438. 1. Eowyns fight with the witch king
  439. + this was already my favorite scene in the book
  440. + I really like Miranda Otto.
  441. 2. The attack of the Rohirrim
  442. 3. Peter Jackson being shot by Legolas
  443. - on DVD only
  444. He makes a really funny face when it happens.
  445. But in the end, not individual scenes matter but the film as a whole.
  446. Org-mode supports these lists by tuning filling and wrapping commands
  447. to correctly deal with them. Furthermore, the following commands act
  448. on items when the cursor is in the first line of an item (the line with
  449. the bullet or number).
  450. `<TAB>'
  451. Items can be folded just like headline levels if you set the
  452. variable `org-cycle-include-plain-lists'. The level of an item is
  453. then given by the indentation of the bullet/number. However,
  454. items are always subordinate to real headlines, the hierarchies
  455. remain completely separated.
  456. `M-<RET>'
  457. Insert new item at current level. With prefix arg, force a new
  458. heading (*note Structure editing::). If this command is used in
  459. the middle of a line, the line is _split_ and the rest of the line
  460. becomes the new item. If this command is executed in the
  461. _whitespace before a bullet or number_, the new item is created
  462. _before_ the current item. If the command is executed in the
  463. white space before the text that is part of an item but does not
  464. contain the bullet, a bullet is added to the current line.
  465. `M-S-<up>'
  466. `M-S-<down>'
  467. Move the item including subitems up/down (swap with previous/next
  468. item of same indentation). If the list is ordered, renumbering is
  469. automatic.
  470. `M-S-<left>'
  471. `M-S-<right>'
  472. Decrease/increase the indentation of the item, including subitems.
  473. Initially, the item tree is selected based on current indentation.
  474. When these commands are executed several times in direct
  475. succession, the initially selected region is used, even if the new
  476. indentation would imply a different hierarchy. To use the new
  477. hierarchy, break the command chain with a cursor motion or so.
  478. `C-c C-c'
  479. Renumber the ordered list at the cursor.
  480. ---------- Footnotes ----------
  481. (1) When using `*' as a bullet, lines must be indented or they will
  482. be seen as top-level headlines. Also, when you are hiding leading
  483. stars to get a clean outline view, plain list items starting with a
  484. star are visually indistinguishable from true headlines. In short:
  485. even though `*' is supported, it may be better to not use it for plain
  486. list items
  487. 
  488. File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
  489. 3 Tables
  490. ********
  491. Org-mode has a very fast and intuitive table editor built-in.
  492. Spreadsheet-like calculations are supported in connection with the
  493. Emacs `calc' package.
  494. * Menu:
  495. * Built-in table editor:: Simple tables
  496. * Narrow columns:: Stop wasting space in tables
  497. * Table calculations:: Compute a field from other fields
  498. * orgtbl-mode:: The table editor as minor mode
  499. * table.el:: Complex tables
  500. 
  501. File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
  502. 3.1 The built-in table editor
  503. =============================
  504. Org-mode makes it easy to format tables in plain ASCII. Any line with
  505. `|' as the first non-white character is considered part of a table.
  506. `|' is also the column separator. A table might look like this:
  507. | Name | Phone | Age |
  508. |-------+-------+-----|
  509. | Peter | 1234 | 17 |
  510. | Anna | 4321 | 25 |
  511. A table is re-aligned automatically each time you press <TAB> or
  512. <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
  513. field (<RET> to the next row) and creates new table rows at the end of
  514. the table or before horizontal lines. The indentation of the table is
  515. set by the first line. Any line starting with `|-' is considered as a
  516. horizontal separator line and will be expanded on the next re-align to
  517. span the whole table width. So, to create the above table, you would
  518. only type
  519. |Name|Phone|Age
  520. |-
  521. and then press <TAB> to align the table and start filling in fields.
  522. When typing text into a field, Org-mode treats <DEL>, <Backspace>,
  523. and all character keys in a special way, so that inserting and deleting
  524. avoids shifting other fields. Also, when typing _immediately after the
  525. cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
  526. the field is automatically made blank. If this behavior is too
  527. unpredictable for you, configure the variables
  528. `org-enable-table-editor' and `org-table-auto-blank-field'.
  529. Creation and conversion
  530. .......................
  531. `C-c |'
  532. Convert the active region to table. If every line contains at
  533. least one TAB character, the function assumes that the material is
  534. tab separated. If not, lines are split at whitespace into fields.
  535. You can use a prefix argument to indicate the minimum number of
  536. consecutive spaces required to identify a field separator
  537. (default: just one).
  538. If there is no active region, this command creates an empty
  539. Org-mode table. However, it's easier to just start typing, like
  540. `|Name|Phone|Age <RET> |- <TAB>'.
  541. Re-aligning and field motion
  542. ............................
  543. `C-c C-c'
  544. Re-align the table without moving the cursor.
  545. `<TAB>'
  546. Re-align the table, move to the next field. Creates a new row if
  547. necessary.
  548. `S-<TAB>'
  549. Re-align, move to previous field.
  550. `<RET>'
  551. Re-align the table and move down to next row. Creates a new row if
  552. necessary. At the beginning or end of a line, <RET> still does
  553. NEWLINE, so it can be used to split a table.
  554. Column and row editing
  555. ......................
  556. `M-<left>'
  557. `M-<right>'
  558. Move the current column left/right.
  559. `M-S-<left>'
  560. Kill the current column.
  561. `M-S-<right>'
  562. Insert a new column to the left of the cursor position.
  563. `M-<up>'
  564. `M-<down>'
  565. Move the current row up/down.
  566. `M-S-<up>'
  567. Kill the current row or horizontal line.
  568. `M-S-<down>'
  569. Insert a new row above (with arg: below) the current row.
  570. `C-c -'
  571. Insert a horizontal line below current row. With prefix arg, the
  572. line is created above the current line.
  573. `C-c ^'
  574. Sort the table lines in the region. Point and mark must be in the
  575. first and last line to be included, and must be in the column that
  576. should be used for sorting. The command prompts for numerical
  577. versus alphanumerical sorting.
  578. Regions
  579. .......
  580. `C-c C-x M-w'
  581. Copy a rectangular region from a table to a special clipboard.
  582. Point and mark determine edge fields of the rectangle. The
  583. process ignores horizontal separator lines.
  584. `C-c C-x C-w'
  585. Copy a rectangular region from a table to a special clipboard, and
  586. blank all fields in the rectangle. So this is the "cut" operation.
  587. `C-c C-x C-y'
  588. Paste a rectangular region into a table. The upper right corner
  589. ends up in the current field. All involved fields will be
  590. overwritten. If the rectangle does not fit into the present table,
  591. the table is enlarged as needed. The process ignores horizontal
  592. separator lines.
  593. `C-c C-q'
  594. Wrap several fields in a column like a paragraph. If there is an
  595. active region, and both point and mark are in the same column, the
  596. text in the column is wrapped to minimum width for the given
  597. number of lines. A prefix ARG may be used to change the number of
  598. desired lines. If there is no region, the current field is split
  599. at the cursor position and the text fragment to the right of the
  600. cursor is prepended to the field one line down. If there is no
  601. region, but you specify a prefix ARG, the current field is made
  602. blank, and the content is appended to the field above.
  603. Calculations
  604. ............
  605. `C-c ='
  606. Install a new formula for the current column and replace current
  607. field with the result of the formula.
  608. `C-u C-c ='
  609. Install a new formula for the current field, which must be a named
  610. field. Evaluate the formula and replace the field content with the
  611. result.
  612. `C-c ''
  613. Edit all formulas associated with the current table in a separate
  614. buffer.
  615. `C-c *'
  616. Recalculate the current row by applying the stored formulas from
  617. left to right. When called with a `C-u' prefix, recalculate the
  618. entire table, starting with the first non-header line (i.e. below
  619. the first horizontal separator line). For details, see *Note
  620. Table calculations::.
  621. `C-#'
  622. Rotate the calculation mark in first column through the states `',
  623. `#', `*', `!', `$'. For the meaning of these marks see *Note
  624. Advanced features::. When there is an active region, change all
  625. marks in the region.
  626. `C-c ?'
  627. Which table column is the cursor in? Displays number >0 in echo
  628. area.
  629. `C-c +'
  630. Sum the numbers in the current column, or in the rectangle defined
  631. by the active region. The result is shown in the echo area and can
  632. be inserted with `C-y'.
  633. `S-<RET>'
  634. When current field is empty, copy from first non-empty field above.
  635. When not empty, copy current field down to next row and move cursor
  636. along with it. Depending on the variable
  637. `org-table-copy-increment', integer field values will be
  638. incremented during copy. This key is also used by CUA-mode (*note
  639. Interaction::).
  640. Miscellaneous
  641. .............
  642. `C-c `'
  643. Edit the current field in a separate window. This is useful for
  644. fields that are not fully visible (*note Narrow columns::). When
  645. called with a `C-u' prefix, just make the full field visible, so
  646. that it can be edited in place.
  647. `C-c <TAB>'
  648. This is an alias for `C-u C-c `' to make the current field fully
  649. visible.
  650. `M-x org-table-import'
  651. Import a file as a table. The table should be TAB- or whitespace
  652. separated. Useful, for example, to import an Excel table or data
  653. from a database, because these programs generally can write
  654. TAB-separated text files. This command works by inserting the
  655. file into the buffer and then converting the region to a table.
  656. Any prefix argument is passed on to the converter, which uses it
  657. to determine the separator.
  658. `M-x org-table-export'
  659. Export the table as a TAB-separated file. Useful for data
  660. exchange with, for example, Excel or database programs.
  661. If you don't like the automatic table editor because it gets in your
  662. way on lines which you would like to start with `|', you can turn it
  663. off with
  664. (setq org-enable-table-editor nil)
  665. The only table command which then still works is `C-c C-c' to do a
  666. manual re-align.
  667. 
  668. File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
  669. 3.2 Narrow columns
  670. ==================
  671. The width of columns is automatically determined by the table editor.
  672. Sometimes a single field or a few fields need to carry more text,
  673. leading to inconveniently wide columns. To limit(1) the width of a
  674. column, one field anywhere in the column may contain just the string
  675. `<N>' where `N' is an integer specifying the width of the column in
  676. characters. The next re-align will then set the width of this column
  677. to no more than this value.
  678. |---+------------------------------| |---+--------|
  679. | | | | | <6> |
  680. | 1 | one | | 1 | one |
  681. | 2 | two | ----\ | 2 | two |
  682. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  683. | 4 | four | | 4 | four |
  684. |---+------------------------------| |---+--------|
  685. Fields that are wider become clipped and end in the string `=>'. Note
  686. that the full text is still in the buffer, it is only invisible. To
  687. see the full text, hold the mouse over the field - a tooltip window
  688. will show the full content. To edit such a field, use the command `C-c
  689. `' (that is `C-c' followed by the backquote). This will open a new
  690. window with the full field. Edit it and finish with `C-c C-c'.
  691. When visiting a file containing a table with narrowed columns, the
  692. necessary character hiding has not yet happened, and the table needs to
  693. be aligned before it looks nice. Setting the option
  694. `org-startup-align-all-tables' will realign all tables in a file upon
  695. visiting, but also slow down startup. You can also set this option on
  696. a per-file basis with:
  697. #+STARTUP: align
  698. #+STARTUP: noalign
  699. ---------- Footnotes ----------
  700. (1) This feature does not work on XEmacs.
  701. 
  702. File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
  703. 3.3 Calculations in tables
  704. ==========================
  705. The table editor makes use of the Emacs `calc' package to implement
  706. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  707. derive fields from other fields. Org-mode has two levels of complexity
  708. for table calculations. On the basic level, tables do only horizontal
  709. computations, so a field can be computed from other fields _in the same
  710. row_, and Org-mode assumes that there is only one formula for each
  711. column. This is very efficient to work with and enough for many tasks.
  712. On the complex level, columns and individual fields can be named for
  713. easier referencing in formulas, individual named fields can have their
  714. own formula associated with them, and recalculation can be automated.
  715. * Menu:
  716. * Formula syntax:: How to write a formula
  717. * Lisp formulas:: An alternative way to write formulas
  718. * Column formulas:: Formulas valid for all fields in a column
  719. * Advanced features:: Field names, parameters and automatic recalc
  720. * Named-field formulas:: Formulas valid in single fields
  721. * Editing/debugging formulas:: Changing a stored formula
  722. * Appetizer:: Taste the power of calc
  723. 
  724. File: org, Node: Formula syntax, Next: Lisp formulas, Prev: Table calculations, Up: Table calculations
  725. 3.3.1 Formula syntax
  726. --------------------
  727. A formula can be any algebraic expression understood by the Emacs
  728. `calc' package. Note that `calc' has the slightly non-standard
  729. convention that `/' has lower precedence than `*', so that `a/b*c' is
  730. interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
  731. calc-eval: (calc)Calling Calc from Your Programs.), variable
  732. substitution takes place:
  733. $ refers to the current field
  734. $3 refers to the field in column 3 of the current row
  735. $3..$7 a vector of the fields in columns 3-7 of current row
  736. $P1..$P3 vector of column range, using column names
  737. &2 second data field above the current, in same column
  738. &5-2 vector from fifth to second field above current
  739. &III-II vector of fields between 2nd and 3rd hline above
  740. &III vector of fields between third hline above and current field
  741. $name a named field, parameter or constant
  742. The range vectors can be directly fed into the calc vector functions
  743. like `vmean' and `vsum'.
  744. `$name' is interpreted as the name of a column, parameter or
  745. constant. Constants are defined globally through the variable
  746. `org-table-formula-constants'. If you have the `constants.el' package,
  747. it will also be used to resolve constants, including natural constants
  748. like `$h' for Planck's constant, and units like `$km' for kilometers.
  749. Column names and parameters can be specified in special table lines.
  750. These are described below, see *Note Advanced features::.
  751. A formula can contain an optional mode string after a semicolon.
  752. This string consists of flags to influence calc's modes(1) during
  753. execution, e.g. `p20' to switch the internal precision to 20 digits,
  754. `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
  755. or fixed display format, respectively, and `D', `R', `F', and `S' to
  756. turn on degrees, radians, fraction and symbolic modes, respectively.
  757. In addition, you may provide a `printf' format specifier to reformat
  758. the final result. A few examples:
  759. $1+$2 Sum of first and second field
  760. $1+$2;%.2f Same, format result to two decimals
  761. exp($2)+exp($1) Math functions can be used
  762. $;%.1f Reformat current cell to 1 decimal
  763. ($3-32)*5/9 Degrees F -> C conversion
  764. $c/$1/$cm Hz -> cm conversion, using `constants.el'
  765. tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
  766. sin($1);Dp3%.1e Same, but use printf specifier for display
  767. vmean($2..$7) Compute column range mean, using vector function
  768. vsum(&III) Sum numbers from 3rd hline above, up to here
  769. taylor($3,x=7,2) taylor series of $3, at x=7, second degree
  770. ---------- Footnotes ----------
  771. (1) By default, Org-mode uses the standard calc modes (precision 12,
  772. angular units degrees, fraction and symbolic modes off). However, the
  773. display format has been changed to `(float 5)' to keep tables compact.
  774. The default settings can be configured using the variable
  775. `org-calc-default-modes'.
  776. 
  777. File: org, Node: Lisp formulas, Next: Column formulas, Prev: Formula syntax, Up: Table calculations
  778. 3.3.2 Emacs Lisp forms as formulas
  779. ----------------------------------
  780. It is also possible to write a formula in Emacs lisp, this can be useful
  781. for string manipulation and control structures. If a formula starts
  782. with a single quote followed by an opening parenthesis, then it is
  783. evaluated as a lisp form. The evaluation should return either a string
  784. or a number. Just like with `calc' formulas, you can provide a format
  785. specifier after a semicolon. A few examples:
  786. swap the first two characters of the content of column 1
  787. '(concat (substring "$1" 1 2) (substring "$1" 0 1) (substring "$1" 2))
  788. Add columns 1 and 2, equivalent to the calc's `$1+$2'
  789. '(+ $1 $2)
  790. 
  791. File: org, Node: Column formulas, Next: Advanced features, Prev: Lisp formulas, Up: Table calculations
  792. 3.3.3 Column formulas
  793. ---------------------
  794. To apply a formula to a field, type it directly into the field,
  795. preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
  796. <RET> or `C-c C-c' with the cursor still in the field, the formula will
  797. be stored as the formula for the current column, evaluated and the
  798. current field replaced with the result. If the field contains only
  799. `=', the previously stored formula for this column is used.
  800. For each column, Org-mode will remember the most recently used
  801. formula. The information is stored in a special line starting with
  802. `#+TBLFM' directly below the table. When adding/deleting/moving
  803. columns with the appropriate commands, the stored equations will be
  804. modified accordingly. When a column used in a calculation is removed,
  805. references to this column become invalid and will cause an error upon
  806. applying the equation.
  807. Instead of typing an equation into the field, you may also use the
  808. command `C-c ='. It prompts for a formula (with default taken from the
  809. `#+TBLFM:' line) and applies it to the current field. A numerical
  810. prefix (e.g. `C-5 C-c =') will apply it to that many subsequent fields
  811. in the current column.
  812. To recompute all the fields in a line, use the command `C-c *'. It
  813. re-applies all stored equations to the current row, from left to right.
  814. With a `C-u' prefix, this will be done to every line in the table, so
  815. use this command it you want to make sure the entire table is
  816. up-to-date. `C-u C-c C-c' is another way to update the entire table.
  817. Global updating does not touch the line(s) above the first horizontal
  818. separator line, assuming that this is the table header.
  819. 
  820. File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
  821. 3.3.4 Advanced features
  822. -----------------------
  823. If you want the recalculation of fields to happen automatically, or if
  824. you want to be able to assign a formula to an individual field (instead
  825. of an entire column) you need to reserve the first column of the table
  826. for special marking characters. Here is an example of a table that
  827. collects exam results of students and makes use of these features:
  828. |---+---------+--------+--------+--------+-------+------|
  829. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  830. |---+---------+--------+--------+--------+-------+------|
  831. | ! | | P1 | P2 | P3 | Tot | |
  832. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  833. | ^ | | m1 | m2 | m3 | mt | |
  834. |---+---------+--------+--------+--------+-------+------|
  835. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  836. | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
  837. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  838. |---+---------+--------+--------+--------+-------+------|
  839. | | Average | | | | 29.7 | |
  840. | ^ | | | | | at | |
  841. | $ | max=50 | | | | | |
  842. |---+---------+--------+--------+--------+-------+------|
  843. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
  844. Important: Please note that for these special tables, recalculating the
  845. table with `C-u C-c *' will only affect rows which are marked `#' or
  846. `*', and named fields. The column formulas are not applied in rows
  847. with empty first field.
  848. The marking characters have the following meaning:
  849. `!'
  850. The fields in this line define names for the columns, so that you
  851. may refer to a column as `$Tot' instead of `$6'.
  852. `^'
  853. This row defines names for the fields _above_ the row. With such
  854. a definition, any formula in the table may use `$m1' to refer to
  855. the value `10'. Also, named fields can have their own formula
  856. associated with them.
  857. `_'
  858. Similar to `^', but defines names for the fields in the row
  859. _below_.
  860. `$'
  861. Fields in this row can define _parameters_ for formulas. For
  862. example, if a field in a `$' row contains `max=50', then formulas
  863. in this table can refer to the value 50 using `$max'. Parameters
  864. work exactly like constants, only that they can be defined on a
  865. per-table basis. Changing a parameter and then recalculating the
  866. table can be useful.
  867. `#'
  868. Fields in this row are automatically recalculated when pressing
  869. <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
  870. selected for a global recalculation with `C-u C-c *'. Unmarked
  871. lines will be left alone by this command.
  872. `*'
  873. Selects this line for global recalculation with `C-u C-c *', but
  874. not for automatic recalculation. Use this when automatic
  875. recalculation slows down editing too much.
  876. `'
  877. Unmarked lines are exempt from recalculation with `C-u C-c *'.
  878. All lines that should be recalculated should be marked with `#' or
  879. `*'.
  880. 
  881. File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
  882. 3.3.5 Named-field formulas
  883. --------------------------
  884. A named field can have its own formula associated with it. In the
  885. example above, this is used for the `at' field that contains the
  886. average result of the students. To enter a formula for a named field,
  887. just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
  888. This equation will be stored below the table like `$name=...'. Any
  889. recalculation in the table (even if only requested for the current
  890. line) will also update all named field formulas.
  891. 
  892. File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
  893. 3.3.6 Editing and debugging formulas
  894. ------------------------------------
  895. To edit a column or field formula, use the commands `C-c =' and `C-u
  896. C-c =', respectively. The currently active expression is then
  897. presented as default in the minibuffer, where it may be edited.
  898. Note that making a table field blank does not remove the formula
  899. associated with the field - during the next recalculation the field
  900. will be filled again. To remove a formula from a field, you have to
  901. give an empty reply when prompted for the formula, or to edit the
  902. `#+TBLFM' line.
  903. You may edit the `#+TBLFM' directly and re-apply the changed
  904. equations with `C-c C-c' in that line, or with the normal recalculation
  905. commands in the table.
  906. In particular for large tables with many formulas, it is convenient
  907. to use the command `C-c '' to edit the formulas of the current table in
  908. a separate buffer. That buffer will show the formulas one per line,
  909. and you are free to edit, add and remove formulas. Press `C-c ?' on a
  910. `$...' expression to get information about its interpretation.
  911. Exiting the buffer with `C-c C-c' only stores the modified formulas
  912. below the table. Exiting with `C-u C-c C-c' also applies them to the
  913. entire table. `C-c C-q' exits without installing the changes.
  914. When the evaluation of a formula leads to an error, the field content
  915. becomes the string `#ERROR'. If you would like see what is going on
  916. during variable substitution and calculation in order to find a bug,
  917. turn on formula debugging in the menu and repeat the calculation, for
  918. example by pressing `C-c = <RET>' in a field. Detailed information
  919. will be displayed.
  920. 
  921. File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
  922. 3.3.7 Appetizer
  923. ---------------
  924. Finally, just to wet your appetite on what can be done with the
  925. fantastic `calc' package, here is a table that computes the Taylor
  926. series for a couple of functions (homework: try that with Excel :-)
  927. |---+-------------+---+-----+--------------------------------------|
  928. | | Func | n | x | Result |
  929. |---+-------------+---+-----+--------------------------------------|
  930. | # | exp(x) | 1 | x | 1 + x |
  931. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  932. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  933. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  934. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  935. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  936. |---+-------------+---+-----+--------------------------------------|
  937. #+TBLFM: $5=taylor($2,$4,$3);n3
  938. 
  939. File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
  940. 3.4 The Orgtbl minor mode
  941. =========================
  942. If you like the intuitive way the Org-mode table editor works, you
  943. might want to use it also in other modes like text-mode or mail-mode.
  944. The minor mode Orgtbl-mode makes this possible. You can always toggle
  945. the mode with `M-x orgtbl-mode'. To turn it on by default, for example
  946. in mail mode, use
  947. (add-hook 'mail-mode-hook 'turn-on-orgtbl)
  948. 
  949. File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
  950. 3.5 The `table.el' package
  951. ==========================
  952. Complex ASCII tables with automatic line wrapping, column- and
  953. row-spanning, and alignment can be created using the Emacs table
  954. package by Takaaki Ota (`http://sourceforge.net/projects/table', and
  955. also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
  956. table, Org-mode will call `table-recognize-table' and move the cursor
  957. into the table. Inside a table, the keymap of Org-mode is inactive.
  958. In order to execute Org-mode-related commands, leave the table.
  959. `C-c C-c'
  960. Recognize `table.el' table. Works when the cursor is in a
  961. table.el table.
  962. `C-c ~'
  963. Insert a table.el table. If there is already a table at point,
  964. this command converts it between the table.el format and the
  965. Org-mode format. See the documentation string of the command
  966. `org-convert-table' for the restrictions under which this is
  967. possible.
  968. 
  969. File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
  970. 4 Hyperlinks
  971. ************
  972. Just like HMTL, Org-mode provides links inside a file, and external
  973. links to other files, Usenet articles, emails and much more.
  974. * Menu:
  975. * Link format:: How links in Org-mode are formatted
  976. * Internal links:: Links to other places in the current file
  977. * External links:: URL-like links to the world
  978. * Handling links:: Creating, inserting and following
  979. * Search options:: Linking to a specific location
  980. * Custom searches:: When the default search is not enough
  981. * Remember:: Org-trees store quick notes
  982. 
  983. File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
  984. 4.1 Link format
  985. ===============
  986. Org-mode will recognize plain URL-like links and activate them as
  987. clickable links. However, the general link format looks like this:
  988. [[link][description]] or alternatively [[link]]
  989. Once a link in the buffer is complete (all brackets present),
  990. Org-mode will change the display so that `description' is displayed
  991. instead of `[[link][description]]' and `link' is displayed instead of
  992. `[[link]]'. Links will be highlighted in the face `org-link', which by
  993. default is an underlined face. You can directly edit the visible part
  994. of a link. Note that this can be either the `link' part (if there is
  995. not description) or the `description' part. To edit also the invisible
  996. `link' part, use `C-c C-l' with the cursor on the link.
  997. If you place the cursor at the beginning or just behind the end of
  998. the displayed text and press <BACKSPACE>, you will remove the
  999. (invisible) bracket at that location. This makes the link incomplete
  1000. and the internals are again displayed as plain text. Inserting the
  1001. missing bracket does hide the link internals again. To show the
  1002. internal structure of all links, use the menu entry
  1003. `Org->Hyperlinks->Literal links'.
  1004. 
  1005. File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
  1006. 4.2 Internal links
  1007. ==================
  1008. If the link does not look like a URL, it is considered to be internal in
  1009. the current file. Links such as `[[My Target]]' or `[[My Target][Find
  1010. my target]]' lead to a text search in the current file. The link can
  1011. be followed with `C-c C-o' when the cursor is on the link, or with a
  1012. mouse click (*note Handling links::). The preferred match for such a
  1013. link is a dedicated target: The same string in double angular brackets.
  1014. Targets may be located anywhere, often it is convenient to put them
  1015. into a comment line, for example
  1016. # <<My Target>>
  1017. In HTML export (*note HTML export::), such targets will become named
  1018. anchors for direct access through `http' links.
  1019. If no dedicated target exists, Org-mode will search for the words in
  1020. the link. In the above example the search would be for `my target'.
  1021. Links starting with a star like `*My Target' restrict the search to
  1022. headlines. When searching, Org-mode will first try an exact match, but
  1023. then move on to more and more lenient searches. For example, the link
  1024. `[[*My Targets]]' will find any of the following:
  1025. ** My targets
  1026. ** TODO my targets are bright
  1027. ** my 20 targets are
  1028. To insert a link targeting a headline, in-buffer completion can be
  1029. used. Just type a star followed by a few optional letters into the
  1030. buffer and press `M-<TAB>'. All headlines in the current buffer will be
  1031. offered as completions. *Note Handling links::, for more commands
  1032. creating links.
  1033. Following a link pushes a mark onto Org-mode's own mark ring. You
  1034. can return to the previous position with `C-c &'. Using this command
  1035. several times in direct succession goes back to positions recorded
  1036. earlier.
  1037. * Menu:
  1038. * Radio targets:: Make targets trigger links in plain text.
  1039. * CamelCase links:: Activating CamelCase words as links
  1040. 
  1041. File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
  1042. 4.2.1 Radio targets
  1043. -------------------
  1044. You can configure Org-mode to link any occurrences of certain target
  1045. names in normal text. So without explicitly creating a link, the text
  1046. connects to the target radioing its position. Radio targets are
  1047. enclosed by triple angular brackets. For example, a target `<<<My
  1048. Target>>>' causes each occurrence of `my target' in normal text to
  1049. become activated as a link. The Org-mode file is scanned automatically
  1050. for radio targets only when the file is first loaded into Emacs. To
  1051. update the target list during editing, press `C-c C-c' with the cursor
  1052. on or at a target.
  1053. 
  1054. File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
  1055. 4.2.2 CamelCase words as links
  1056. ------------------------------
  1057. Org-mode also supports CamelCase words as links. This feature is not
  1058. turned on by default because of the inconsistencies this system suffers
  1059. from. To activate CamelCase words as links, you need to customize the
  1060. option `org-activate-links'. A CamelCase word then leads to a text
  1061. search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
  1062. 
  1063. File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
  1064. 4.3 External links
  1065. ==================
  1066. Org-mode supports links to files, websites, Usenet and email messages;
  1067. and BBDB database entries. External links are URL-like locators. The
  1068. following list shows examples for each link type.
  1069. http://www.astro.uva.nl/~dominik on the web
  1070. file:/home/dominik/images/jupiter.jpg file, absolute path
  1071. file:papers/last.pdf file, relative path
  1072. news:comp.emacs Usenet link
  1073. mailto:adent@galaxy.net Mail link
  1074. vm:folder VM folder link
  1075. vm:folder#id VM message link
  1076. vm://myself@some.where.org/folder#id VM on remote machine
  1077. wl:folder WANDERLUST folder link
  1078. wl:folder#id WANDERLUST message link
  1079. mhe:folder MH-E folder link
  1080. mhe:folder#id MH-E message link
  1081. rmail:folder RMAIL folder link
  1082. rmail:folder#id RMAIL message link
  1083. gnus:group GNUS group link
  1084. gnus:group#id GNUS article link
  1085. bbdb:Richard Stallman BBDB link
  1086. shell:ls *.org A shell command
  1087. A link should be enclosed in double brackets and may contain a
  1088. descriptive text to be displayed instead of the url (*note Link
  1089. format::), for example:
  1090. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  1091. Org-mode also finds external links in the normal text and activates
  1092. them as links. If spaces must be part of the link (for example in
  1093. `bbdb:Richard Stallman') or to remove ambiguities about the end of the
  1094. link, enclose them in angular brackets.
  1095. 
  1096. File: org, Node: Handling links, Next: Search options, Prev: External links, Up: Hyperlinks
  1097. 4.4 Handling links
  1098. ==================
  1099. Org-mode provides methods to create a link in the correct syntax, to
  1100. insert it into an org-mode file, and to follow the link.
  1101. `C-c l'
  1102. Store a link to the current location. This is a _global_ command
  1103. which can be used in any buffer to create a link. The link will be
  1104. stored for later insertion into an Org-mode buffer (see below).
  1105. For Org-mode files, if there is a `<<target>>' at the cursor, the
  1106. link points to the target. Otherwise it points to the current
  1107. headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
  1108. the link will indicate to the current article/entry. For W3 and
  1109. W3M buffers, the link goes to the current URL. For any other
  1110. files, the link will point to the file, with a search string
  1111. (*note Search options::) pointing to the contents of the current
  1112. line. If there is an active region, the selected words will form
  1113. the basis of the search string. If the automatically created link
  1114. is not working correctly or accurately enough, you can write
  1115. custom functions to select the search string and to do the search
  1116. for particular file types - see *Note Custom searches::. The key
  1117. binding `C-c l' is only a suggestion - see *Note Installation and
  1118. activation::.
  1119. `C-c C-l'
  1120. Insert a link. This prompts for a link to be inserted into the
  1121. buffer. You can just type a link, using text for an internal
  1122. link, or one of the link type prefixes mentioned in the examples
  1123. above. Through completion, all links stored during the current
  1124. session can be accessed. The link will be inserted into the
  1125. buffer, along with a descriptive text. Note that you don't have
  1126. to use this command to insert a link. Links in Org-mode are plain
  1127. text, and you can type or paste them straight into the buffer. By
  1128. using this command, the links are automatically enclosed in double
  1129. brackets, and you will be asked for the optional descriptive text.
  1130. `C-u C-c C-l'
  1131. When `C-c C-l' is called with a `C-u' prefix argument, a link to a
  1132. file will be inserted and you may use file name completion to
  1133. select the name of the file. The path to the file is inserted
  1134. relative to the directory of the current org file, if the linked
  1135. file is in the current directory or in a subdirectory of it, or if
  1136. the path is written relative to the current directory using `../'.
  1137. Otherwise an absolute path is used, if possible with `~/' for
  1138. your home directory. You can force an absolute path with two
  1139. `C-u' prefixes.
  1140. `C-c C-l with cursor on existing link'
  1141. When the cursor is on an existing link, `C-c C-l' allows to edit
  1142. the link and description parts of the link.
  1143. `C-c C-o'
  1144. Open link at point. This will launch a web browser for URLs (using
  1145. `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
  1146. the corresponding links, and execute the command in a shell link.
  1147. When the cursor is on an internal link, this commands runs the
  1148. corresponding search. When the cursor is on a TAGS list in a
  1149. headline, it creates the corresponding TAGS view. If the cursor
  1150. is on a time stamp, it compiles the agenda for that date.
  1151. Furthermore, it will visit text files in `file:' links with Emacs
  1152. and select a suitable application for non-text files.
  1153. Classification of files is based on file extension only. See
  1154. option `org-file-apps'. If you want to override the default
  1155. application and visit the file with Emacs, use a `C-u' prefix.
  1156. `mouse-2'
  1157. `mouse-1'
  1158. On links, `mouse-2' will open the link just like `C-c C-o' would.
  1159. Under Emacs 22, also `mouse-1' will follow a link.
  1160. `mouse-3'
  1161. Like `mouse-2', but force file links to be opened with Emacs.
  1162. `C-c %'
  1163. Push the current position onto the mark ring, to be able to return
  1164. easily. Commands following an internal link do this automatically.
  1165. `C-c &'
  1166. Jump back to a recorded position. A position is recorded by the
  1167. commands following internal links, and by `C-c %'. Using this
  1168. command several times in direct succession moves through a ring of
  1169. previously recorded positions.
  1170. 
  1171. File: org, Node: Search options, Next: Custom searches, Prev: Handling links, Up: Hyperlinks
  1172. 4.5 Search options in file links
  1173. ================================
  1174. File links can contain additional information to make Emacs jump to a
  1175. particular location in the file when following a link. This can be a
  1176. line number or a search option after a double(1) colon. For example,
  1177. when the command `C-c l' creates a link (*note Handling links::) to a
  1178. file, it encodes the words in the current line as a search string that
  1179. can be used to find this line back later when following the link with
  1180. `C-c C-o'.
  1181. Here is the syntax of the different ways to attach a search to a file
  1182. link, together with an explanation:
  1183. [[file:~/code/main.c::255]]
  1184. [[file:~/xx.org::My Target]]
  1185. [[file:~/xx.org::*My Target]]
  1186. [[file:~/xx.org::/regexp/]]
  1187. `255'
  1188. Jump to line 255.
  1189. `My Target'
  1190. Search for a link target `<<My Target>>', or do a text search for
  1191. `my target', similar to the search in internal links, see *Note
  1192. Internal links::. In HTML export (*note HTML export::), such a
  1193. file link will become an html reference to the corresponding named
  1194. anchor in the linked file.
  1195. `*My Target'
  1196. In an Org-mode file, restrict search to headlines.
  1197. `/regexp/'
  1198. Do a regular expression search for `regexp'. This uses the Emacs
  1199. command `occur' to list all matches in a separate window. If the
  1200. target file is in Org-mode, `org-occur' is used to create a sparse
  1201. tree with the matches.
  1202. As a degenerate case, a file link with an empty file name can be used
  1203. to search the current file. For example, `<file:::find me>' does a
  1204. search for `find me' in the current file, just like `[[find me]]' would.
  1205. ---------- Footnotes ----------
  1206. (1) For backward compatibility, line numbers can also follow a
  1207. single colon.
  1208. 
  1209. File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
  1210. 4.6 Custom Searches
  1211. ===================
  1212. The default mechanism for creating search strings and for doing the
  1213. actual search related to a file link may not work correctly in all
  1214. cases. For example, BibTeX database files have many entries like
  1215. `year="1993"' which would not result in good search strings, because
  1216. the only unique identification for a BibTeX entry is the citation key.
  1217. If you come across such a problem, you can write custom functions to
  1218. set the right search string for a particular file type, and to do the
  1219. search for the string in the file. Using `add-hook', these functions
  1220. need to be added to the hook variables
  1221. `org-create-file-search-functions' and
  1222. `org-execute-file-search-functions'. See the docstring for these
  1223. variables for more information. Org-mode actually uses this mechanism
  1224. for BibTeX database files, and you can use the corresponding code as an
  1225. implementation example. Search for `BibTeX links' in the source file.
  1226. 
  1227. File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
  1228. 4.7 Remember
  1229. ============
  1230. Another way to create org entries with links to other files is through
  1231. the _Remember_ package by John Wiegley. _Remember_ lets you store
  1232. quick notes with little interruption of your work flow. See
  1233. `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
  1234. information. The notes produced by _Remember_ can be stored in
  1235. different ways, and Org-mode files are a good target. Org-mode allows
  1236. to file away notes either to a default file, or directly to the correct
  1237. location in your Org-mode outline tree. The following customization(1)
  1238. will tell _Remember_ to use org files as target, and to create
  1239. annotations compatible with Org-mode links.
  1240. (setq org-directory "~/path/to/my/orgfiles/")
  1241. (setq org-default-notes-file "~/.notes")
  1242. (autoload 'org-remember-annotation "org")
  1243. (autoload 'org-remember-apply-template "org")
  1244. (autoload 'org-remember-handler "org")
  1245. (setq remember-annotation-functions '(org-remember-annotation))
  1246. (setq remember-handler-functions '(org-remember-handler))
  1247. (add-hook 'remember-mode-hook 'org-remember-apply-template)
  1248. In combination with Org-mode, you can use templates to generate
  1249. different types of remember notes. For example, if you would like to
  1250. use one template to create general TODO entries, and another one for
  1251. journal entries, you could use:
  1252. (setq org-remember-templates
  1253. '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
  1254. (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
  1255. In these entries, the character specifies how to select the template,
  1256. the first string specifies the template, and the (optional) second
  1257. string specifies a default file (overruling `org-default-notes-file')
  1258. as a target for this note.
  1259. When you call `M-x remember' to remember something, org will prompt
  1260. for a key to select the template and then prepare the buffer like
  1261. * TODO
  1262. <file:link to where you called remember>
  1263. or
  1264. * [2006-03-21 Tue 15:37]
  1265. <file:link to where you called remember>
  1266. See the variable `org-remember-templates' for more details.
  1267. When you are finished composing a note with remember, you have to
  1268. press `C-c C-c' to file the note away. The handler first prompts for a
  1269. target file - if you press <RET>, the value of `org-default-notes-file'
  1270. is used. Then the command offers the headings tree of the selected
  1271. file. You can either immediately press <RET> to get the note appended
  1272. to the file. Or you can use vertical cursor motion (<up> and <down>)
  1273. and visibility cycling (<TAB>) to find a better place. Pressing <RET>
  1274. or <left> or <right> leads to the following result.
  1275. Cursor Key Note gets inserted
  1276. position
  1277. buffer-start <RET> as level 2 heading at end of file
  1278. on headline <RET> as sublevel of the heading at cursor
  1279. <left> as same level, before current heading
  1280. <right> as same level, after current heading
  1281. not on <RET> at cursor position, level taken from context.
  1282. headline Or use prefix arg to specify level
  1283. manually.
  1284. So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
  1285. append it to the default file. Even shorter would be `C-u C-c C-c',
  1286. which does the same without even showing the tree. But with little
  1287. extra effort, you can push it directly to the correct location.
  1288. Before inserting the text into a tree, the function ensures that the
  1289. text has a headline, i.e. a first line that starts with a `*'. If not,
  1290. a headline is constructed from the current date and some additional
  1291. data. If the variable `org-adapt-indentation' is non-nil, the entire
  1292. text is also indented so that it starts in the same column as the
  1293. headline (after the asterisks).
  1294. ---------- Footnotes ----------
  1295. (1) The three autoload forms are only necessary if `org.el' is not
  1296. part of the Emacs distribution or an XEmacs package.
  1297. 
  1298. File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
  1299. 5 TODO items
  1300. ************
  1301. Org-mode does not maintain TODO lists as a separate document. TODO
  1302. items are an integral part of the notes file, because TODO items
  1303. usually come up while taking notes! With Org-mode, you simply mark any
  1304. entry in a tree as being a TODO item. In this way, the information is
  1305. not duplicated, and the entire context from which the item emerged is
  1306. always present when you check.
  1307. Of course, this technique causes TODO items to be scattered
  1308. throughout your file. Org-mode provides methods to give you an
  1309. overview over all things you have to do.
  1310. * Menu:
  1311. * TODO basics:: Marking and displaying TODO entries
  1312. * Progress logging:: Document your productivity
  1313. * TODO extensions:: Workflow and assignments
  1314. * Priorities:: Some things are more important than others
  1315. 
  1316. File: org, Node: TODO basics, Next: Progress logging, Prev: TODO items, Up: TODO items
  1317. 5.1 Basic TODO functionality
  1318. ============================
  1319. Any headline can become a TODO item by starting it with the word TODO,
  1320. for example:
  1321. *** TODO Write letter to Sam Fortune
  1322. The most important commands to work with TODO entries are:
  1323. `C-c C-t'
  1324. Rotate the TODO state of the current item between
  1325. ,-> (unmarked) -> TODO -> DONE --.
  1326. '--------------------------------'
  1327. The same rotation can also be done "remotely" from the timeline and
  1328. agenda buffers with the `t' command key (*note Agenda commands::).
  1329. `C-c C-v'
  1330. View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
  1331. the entire buffer, but shows all TODO items and the headings
  1332. hierarchy above them. With prefix arg, show also the DONE
  1333. entries. With numerical prefix N, show the tree for the Nth
  1334. keyword in the variable `org-todo-keywords'.
  1335. `C-c a t'
  1336. Show the global TODO list. This collects the TODO items from all
  1337. agenda files (*note Agenda views::) into a single buffer. The
  1338. buffer is in `agenda-mode', so there are commands to examine and
  1339. manipulate the TODO entries directly from that buffer (*note
  1340. Agenda commands::). *Note Global TODO list::, for more
  1341. information.
  1342. 
  1343. File: org, Node: Progress logging, Next: TODO extensions, Prev: TODO basics, Up: TODO items
  1344. 5.2 Progress Logging
  1345. ====================
  1346. If you want to keep track of _when_ a certain TODO item was finished,
  1347. turn on logging with
  1348. (setq org-log-done t)
  1349. Then each time you turn a TODO entry into DONE using either `C-c C-t'
  1350. in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
  1351. [timestamp]' will be inserted just after the headline. If you turn the
  1352. entry back into a TODO item again through further state cycling, that
  1353. line will be removed again. In the timeline (*note Timeline::) and in
  1354. the agenda (*note Weekly/Daily agenda::), you can then use the `L' key
  1355. to display the TODO items closed on each day, giving you an overview of
  1356. what has been done on a day.
  1357. 
  1358. File: org, Node: TODO extensions, Next: Priorities, Prev: Progress logging, Up: TODO items
  1359. 5.3 Extended use of TODO keywords
  1360. =================================
  1361. The default implementation of TODO entries is just two states: TODO and
  1362. DONE. You can, however, use the TODO feature for more complicated
  1363. things by configuring the variables `org-todo-keywords' and
  1364. `org-todo-interpretation'. Using special setup, you can even use TODO
  1365. keywords in different ways in different org files.
  1366. Note that tags are another way to classify headlines in general and
  1367. TODO items in particular (*note Tags::).
  1368. * Menu:
  1369. * Workflow states:: From TODO to DONE in steps
  1370. * TODO types:: I do this, Fred the rest
  1371. * Per file keywords:: Different files, different requirements
  1372. 
  1373. File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
  1374. 5.3.1 TODO keywords as workflow states
  1375. --------------------------------------
  1376. You can use TODO keywords to indicate different states in the process
  1377. of working on an item, for example:
  1378. (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
  1379. org-todo-interpretation 'sequence)
  1380. Changing these variables becomes only effective in a new Emacs
  1381. session. With this setup, the command `C-c C-t' will cycle an entry
  1382. from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
  1383. also use a prefix argument to quickly select a specific state. For
  1384. example `C-3 C-c C-t' will change the state immediately to VERIFY. If
  1385. you define many keywords, you can use in-buffer completion (see *Note
  1386. Completion::) to insert these words into the buffer.
  1387. 
  1388. File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
  1389. 5.3.2 TODO keywords as types
  1390. ----------------------------
  1391. The second possibility is to use TODO keywords to indicate different
  1392. types of action items. For example, you might want to indicate that
  1393. items are for "work" or "home". If you are into David Allen's _Getting
  1394. Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
  1395. `MAYBE'. Or, when you work with several people on a single project,
  1396. you might want to assign action items directly to persons, by using
  1397. their names as TODO keywords. This would be set up like this:
  1398. (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
  1399. org-todo-interpretation 'type)
  1400. In this case, different keywords do not indicate a sequence, but
  1401. rather different types. So it is normally not useful to change from
  1402. one type to another. Therefore, in this case the behavior of the
  1403. command `C-c C-t' is changed slightly(1). When used several times in
  1404. succession, it will still cycle through all names. But when you return
  1405. to the item after some time and execute `C-c C-t' again, it will switch
  1406. from each name directly to DONE. Use prefix arguments or completion to
  1407. quickly select a specific name. You can also review the items of a
  1408. specific TODO type in a sparse tree by using a numeric prefix to `C-c
  1409. C-v'. For example, to see all things Lucy has to do, you would use
  1410. `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
  1411. single buffer, you would use the prefix arg as well when creating the
  1412. global todo list: `C-3 C-c t'.
  1413. ---------- Footnotes ----------
  1414. (1) This is also true for the `t' command in the timeline and agenda
  1415. buffers.
  1416. 
  1417. File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
  1418. 5.3.3 Setting up TODO keywords for individual files
  1419. ---------------------------------------------------
  1420. It can be very useful to use different aspects of the TODO mechanism in
  1421. different files, which is not possible with the global settings
  1422. described above. For file-local settings, you need to add special
  1423. lines to the file which set the keywords and interpretation for that
  1424. file only. For example, to set one of the two examples discussed
  1425. above, you need one of the following lines, starting in column zero
  1426. anywhere in the file:
  1427. #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
  1428. #+TYP_TODO: Fred Sara Lucy Mike DONE
  1429. To make sure you are using the correct keyword, type `#+' into the
  1430. buffer and then use `M-<TAB>' completion.
  1431. Remember that the last keyword must always mean that the item is DONE
  1432. (you may use a different word, though). Also note that in each file,
  1433. only one of the two aspects of TODO keywords can be used. After
  1434. changing one of these lines, use `C-c C-c' with the cursor still in the
  1435. line to make the changes known to Org-mode(1).
  1436. If you want to use very many keywords, for example when working with
  1437. a large group of people, you may split the names over several lines:
  1438. #+TYP_TODO: Fred Sara Lucy Mike
  1439. #+TYP_TODO: Luis George Jules Jessica
  1440. #+TYP_TODO: Kim Arnold Peter
  1441. #+TYP_TODO: DONE
  1442. ---------- Footnotes ----------
  1443. (1) Org-mode parses these lines only when Org-mode is activated
  1444. after visiting a file. `C-c C-c' with the cursor in a line starting
  1445. with `#+' is simply restarting Org-mode, making sure that these changes
  1446. will be respected.
  1447. 
  1448. File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
  1449. 5.4 Priorities
  1450. ==============
  1451. If you use Org-mode extensively to organize your work, you may end up
  1452. with a number of TODO entries so large that you'd like to prioritize
  1453. them. This can be done by placing a _priority cookie_ into the
  1454. headline, like this
  1455. *** TODO [#A] Write letter to Sam Fortune
  1456. With its standard setup, Org-mode supports priorities `A', `B', and
  1457. `C'. `A' is the highest priority. An entry without a cookie is
  1458. treated as priority `B'. Priorities make a difference only in the
  1459. agenda (*note Weekly/Daily agenda::).
  1460. `C-c ,'
  1461. Set the priority of the current item. The command prompts for a
  1462. priority character `A', `B' or `C'. When you press <SPC> instead,
  1463. the priority cookie is removed from the headline. The priorities
  1464. can also be changed "remotely" from the timeline and agenda buffer
  1465. with the `,' command (*note Agenda commands::).
  1466. `S-<up>'
  1467. `S-<down>'
  1468. Increase/decrease priority of current item. Note that these keys
  1469. are also used to modify time stamps (*note Creating timestamps::).
  1470. Furthermore, these keys are also used by CUA-mode (*note
  1471. Interaction::).
  1472. 
  1473. File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
  1474. 6 Timestamps
  1475. ************
  1476. Items can be labeled with timestamps to make them useful for project
  1477. planning.
  1478. * Menu:
  1479. * Time stamps:: Assigning a time to a tree entry
  1480. * Creating timestamps:: Commands which insert timestamps
  1481. 
  1482. File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
  1483. 6.1 Time stamps, deadlines and scheduling
  1484. =========================================
  1485. A time stamp is a specification of a date (possibly with time) in a
  1486. special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
  1487. A time stamp can appear anywhere in the headline or body of an org-tree
  1488. entry. Its presence allows entries to be shown on specific dates in
  1489. the agenda (*note Weekly/Daily agenda::). We distinguish:
  1490. TIMESTAMP
  1491. A simple time stamp just assigns a date/time to an item. This is
  1492. just like writing down an appointment in a paper agenda, or like
  1493. writing down an event in a diary, when you want to take not of
  1494. when something happened. In the timeline and agenda displays, the
  1495. headline of an entry associated with a plain time stamp will be
  1496. shown exactly on that date.
  1497. TIMERANGE
  1498. Two time stamps connected by `--' denote a time range. The
  1499. headline will be shown on the first and last day of the range, and
  1500. on any dates that are displayed and fall in the range. Here is an
  1501. example:
  1502. ** Meeting in Amsterdam
  1503. <2004-08-23 Mon>--<2004-08-26 Thu>
  1504. SCHEDULED
  1505. If a time stamp is preceded by the word `SCHEDULED:', it means you
  1506. are planning to start working on that task on the given date. So
  1507. this is not about recording an event, but about planning your
  1508. work. The headline will be listed under the given date. In
  1509. addition, a reminder that the scheduled date has passed will be
  1510. present in the compilation for _today_, until the entry is marked
  1511. DONE. I.e., the task will automatically be forwarded until
  1512. completed.
  1513. *** TODO Call Trillian for a date on New Years Eve.
  1514. SCHEDULED: <2004-12-25 Sat>
  1515. DEADLINE
  1516. If a time stamp is preceded by the word `DEADLINE:', the task
  1517. (most likely a TODO item) is supposed to be finished on that date,
  1518. and it will be listed then. In addition, the compilation for
  1519. _today_ will carry a warning about the approaching or missed
  1520. deadline, starting `org-deadline-warning-days' before the due
  1521. date, and continuing until the entry is marked DONE. An example:
  1522. *** TODO write article about the Earth for the Guide
  1523. The editor in charge is <bbdb:Ford Prefect>
  1524. DEADLINE: <2004-02-29 Sun>
  1525. 
  1526. File: org, Node: Creating timestamps, Prev: Time stamps, Up: Timestamps
  1527. 6.2 Creating timestamps
  1528. =======================
  1529. For Org-mode to recognize time stamps, they need to be in the specific
  1530. format. All commands listed below produce time stamps in the correct
  1531. format.
  1532. `C-c .'
  1533. Prompt for a date and insert a corresponding time stamp. When the
  1534. cursor is at a previously used time stamp, it is updated to NOW.
  1535. When this command is used twice in succession, a time range is
  1536. inserted.
  1537. `C-u C-c .'
  1538. Like `C-c .', but use the alternative format which contains date
  1539. and time. The default time can be rounded to multiples of 5
  1540. minutes, see the option `org-time-stamp-rounding-minutes'.
  1541. `C-c !'
  1542. Like `C-c .', but insert an inactive time stamp not triggering the
  1543. agenda.
  1544. `C-c <'
  1545. Insert a time stamp corresponding to the cursor date in the
  1546. Calendar.
  1547. `C-c >'
  1548. Access the Emacs calendar for the current date. If there is a
  1549. timestamp in the current line, goto the corresponding date instead.
  1550. `C-c C-o'
  1551. Access the agenda for the date given by the time stamp at point
  1552. (*note Weekly/Daily agenda::).
  1553. `C-c C-d'
  1554. Insert `DEADLINE' keyword along with a stamp.
  1555. `C-c C-w'
  1556. Create a sparse tree with all deadlines that are either past-due,
  1557. or which will become due within `org-deadline-warning-days'. With
  1558. `C-u' prefix, show all deadlines in the file. With a numeric
  1559. prefix, check that many days. For example, `C-1 C-c C-w' shows
  1560. all deadlines due tomorrow.
  1561. `C-c C-s'
  1562. Insert `SCHEDULED' keyword along with a stamp.
  1563. `S-<left>'
  1564. `S-<right>'
  1565. Change date at cursor by one day. These key bindings conflict with
  1566. CUA-mode (*note Interaction::).
  1567. `S-<up>'
  1568. `S-<down>'
  1569. Change the item under the cursor in a timestamp. The cursor can
  1570. be on a year, month, day, hour or minute. Note that if the cursor
  1571. is not at a time stamp, these same keys modify the priority of an
  1572. item. (*note Priorities::). The key bindings also conflict with
  1573. CUA-mode (*note Interaction::).
  1574. `C-c C-y'
  1575. Evaluate a time range by computing the difference between start and
  1576. end. With prefix arg, insert result after the time range (in a
  1577. table: into the following column).
  1578. When Org-mode prompts for a date/time, the function reading your
  1579. input will replace anything you choose not to specify with the current
  1580. date and time. For details, see the documentation string of
  1581. `org-read-date'. Also, a calender will pop up to allow selecting a
  1582. date. The calendar can be fully controlled from the minibuffer, and a
  1583. date can be selected with the following commands:
  1584. `<'
  1585. Scroll calendar backwards by one month.
  1586. `>'
  1587. Scroll calendar forwards by one month.
  1588. `mouse-1'
  1589. Select date by clicking on it.
  1590. `S-<right>'
  1591. One day forward.
  1592. `S-<left>'
  1593. One day back.
  1594. `S-<down>'
  1595. One week forward.
  1596. `S-<up>'
  1597. One week back.
  1598. `M-S-<right>'
  1599. One month forward.
  1600. `M-S-<left>'
  1601. One month back.
  1602. `<RET>'
  1603. Choose date in calendar (only if nothing typed into minibuffer).
  1604. 
  1605. File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
  1606. 7 Tags
  1607. ******
  1608. If you wish to implement a system to cross-correlate information, an
  1609. excellent way is to assign tags to headline. Org-mode has extensive
  1610. support for using tags.
  1611. Every headline can contain a list of tags, at the end of the
  1612. headline. Tags are normal words containing letters, numbers, `_', and
  1613. `@'. Tags must be preceded and followed by a single colon; like
  1614. `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
  1615. * Menu:
  1616. * Tag inheritance:: Tags use the tree structure of the outline
  1617. * Setting tags:: How to assign tags to a headline
  1618. * Tag searches:: Searching for combinations of tags
  1619. 
  1620. File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
  1621. 7.1 Tag inheritance
  1622. ===================
  1623. Tags make use of the hierarchical structure of outline trees. If a
  1624. heading has a certain tag, all subheadings will inherit the tag as
  1625. well. For example, in the list
  1626. * Meeting with the French group :WORK:
  1627. ** Summary by Frank :BOSS:NOTES:
  1628. *** TODO Prepare slides for him :ACTION:
  1629. the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
  1630. `:ACTION:'. When executing tag searches and Org-mode finds that a
  1631. certain headline matches the search criterion, it will not check any
  1632. sublevel headline, assuming that these likely also match, and that the
  1633. list of matches can become very long. However, this may not be what
  1634. you want, and you can influence inheritance and searching using the
  1635. variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
  1636. 
  1637. File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
  1638. 7.2 Setting tags
  1639. ================
  1640. As Org-mode deals with plain text files, tags can simply be typed into
  1641. the buffer. After a colon, `M-<TAB>' offers completion on all tags
  1642. being used in the current buffer. There is also a special command for
  1643. inserting tags:
  1644. `C-c C-c'
  1645. Enter new tags for the current headline. The minibuffer will
  1646. prompt for a list of tags and offer completion with respect to all
  1647. other tags used in the current buffer. Several tags, separated by
  1648. colons, may be specified at the prompt. After pressing <RET>, the
  1649. tags will be inserted and aligned to `org-tags-column'. When
  1650. called with a `C-u' prefix, all tags in the current buffer will be
  1651. aligned to that column, just to make things look nice. TAGS are
  1652. automatically realigned after promotion, demotion, and TODO state
  1653. changes (*note TODO basics::).
  1654. 
  1655. File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
  1656. 7.3 Tag searches
  1657. ================
  1658. Once a tags system has been set up, it can be used to collect related
  1659. information into special lists.
  1660. `C-c \'
  1661. Create a sparse tree with all headlines matching a tags search.
  1662. `C-c a m'
  1663. Create a global list of tag matches from all agenda files. *Note
  1664. Matching headline tags::.
  1665. `C-c a M'
  1666. Create a global list of tag matches from all agenda files, but
  1667. check only TODO items and force checking subitems (see variable
  1668. `org-tags-match-list-sublevels').
  1669. A tags search string can use Boolean operators `&' for AND and `|'
  1670. for OR. `&' binds more strongly than `|'. Parenthesis are currently
  1671. not implemented. A tag may also be preceded by `-', to select against
  1672. it, and `+' is syntactic sugar for positive selection. The AND
  1673. operator `&' is optional when `+' or `-' is present. For example,
  1674. `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
  1675. discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
  1676. selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
  1677. `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
  1678. `NIGHT'.
  1679. 
  1680. File: org, Node: Agenda views, Next: Exporting, Prev: Tags, Up: Top
  1681. 8 Agenda Views
  1682. **************
  1683. Due to the way Org-mode works, TODO items, time-stamped items, and
  1684. tagged headlines can be scattered throughout a file or even a number of
  1685. files. To get an overview over open action items, or over events that
  1686. are important for a particular date, this information must be collected,
  1687. sorted and displayed in an organized way.
  1688. Org-mode can select items based on various criteria, and display them
  1689. in a separate buffer. Three different views are provided:
  1690. * an _agenda_ that is like a calendar and shows information for
  1691. specific dates
  1692. * a _TODO list_ that covers all unfinished action items, and
  1693. * a _tags view_ that shows information based on the tags associated
  1694. with headlines in the outline tree.
  1695. The extracted information is displayed in a special _agenda buffer_.
  1696. This buffer is read-only, but provides commands to visit the
  1697. corresponding locations in the original Org-mode files, and even to
  1698. edit these files remotely.
  1699. * Menu:
  1700. * Agenda files:: Files being searched for agenda information
  1701. * Agenda dispatcher:: Keyboard access to agenda views
  1702. * Weekly/Daily agenda:: The calendar page with current tasks
  1703. * Global TODO list:: All unfinished action items
  1704. * Matching headline tags:: Structured information with fine-tuned search
  1705. * Timeline:: Time-sorted view for single file
  1706. * Agenda commands:: Remote editing of org trees
  1707. 
  1708. File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
  1709. 8.1 Agenda files
  1710. ================
  1711. The information to be shown is collected from all _agenda files_, the
  1712. files listed in the variable `org-agenda-files'(1). Thus even if you
  1713. only work with a single Org-mode file, this file should be put into
  1714. that list(2). You can customize `org-agenda-files', but the easiest
  1715. way to maintain it is through the following commands
  1716. `C-c ['
  1717. Add current file to the list of agenda files. The file is added to
  1718. the front of the list. If it was already in the list, it is moved
  1719. to the front. With prefix arg, file is added/moved to the end.
  1720. `C-c ]'
  1721. Remove current file from the list of agenda files.
  1722. `C-,'
  1723. Cycle through agenda file list, visiting one file after the other.
  1724. The Org menu contains the current list of files and can be used to
  1725. visit any of them.
  1726. ---------- Footnotes ----------
  1727. (1) If the value of that variable is not a list, but a single file
  1728. name, then the list of agenda files will be maintained in that external
  1729. file.
  1730. (2) When using the dispatcher pressing `1' before selecting a
  1731. command will actually limit the command to the current file, and ignore
  1732. `org-agenda-files' until the next dispatcher command.
  1733. 
  1734. File: org, Node: Agenda dispatcher, Next: Weekly/Daily agenda, Prev: Agenda files, Up: Agenda views
  1735. 8.2 The agenda dispatcher
  1736. =========================
  1737. The views are created through a dispatcher that should be bound to a
  1738. global key, for example `C-c a' (*note Installation and activation::).
  1739. In the following we will assume that `C-c a' is indeed how the
  1740. dispatcher is accessed and list keyboard access to commands
  1741. accordingly. After pressing `C-c a', an additional letter is required
  1742. to execute a command. The dispatcher offers the following default
  1743. commands:
  1744. `a'
  1745. Create the calendar-like agenda (*note Weekly/Daily agenda::).
  1746. `t / T'
  1747. Create a list of all TODO items (*note Global TODO list::).
  1748. `m / M'
  1749. Create a list of headlines matching a TAGS expression (*note
  1750. Matching headline tags::).
  1751. You can also define custom commands that will be accessible through
  1752. the dispatcher, just like the default commands. Custom commands are
  1753. global searches for tags and specific TODO keywords, or a variety of
  1754. sparse tree creating commands (*note Sparse trees::). As sparse trees
  1755. are only defined for a single org-mode file, these latter commands act
  1756. on the current buffer instead of the list of agenda files.
  1757. Custom commands are configured in the variable
  1758. `org-agenda-custom-commands'. You can customize this variable, for
  1759. example by pressing `C-c a C'. You can also directly set it with Emacs
  1760. Lisp in `.emacs'. For example:
  1761. (setq org-agenda-custom-commands
  1762. '(("w" todo "WAITING")
  1763. ("u" tags "+BOSS-URGENT")
  1764. ("U" tags-tree "+BOSS-URGENT")
  1765. ("f" occur-tree "\\<FIXME\\>")))
  1766. will define `C-c a w' as a global search for TODO entries with
  1767. `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
  1768. headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
  1769. search but only in the current buffer and display the result as a
  1770. sparse tree, and `C-c a f' to create a sparse tree with all entries
  1771. containing the word `FIXME'. For more information, look at the
  1772. documentation string of the variable `org-agenda-custom-commands'.
  1773. 
  1774. File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda views
  1775. 8.3 The weekly/daily agenda
  1776. ===========================
  1777. The purpose of the weekly/daily _agenda_ is to act like a page of a
  1778. paper agenda, showing all the tasks for the current week or day.
  1779. `C-c a a'
  1780. Compile an agenda for the current week from a list of org files.
  1781. The agenda shows the entries for each day. With a `C-u' prefix (or
  1782. when the variable `org-agenda-include-all-todo' is `t'), all
  1783. unfinished TODO items (including those without a date) are also
  1784. listed at the beginning of the buffer, before the first date.
  1785. Remote editing from the agenda buffer means, for example, that you
  1786. can change the dates of deadlines and appointments from the agenda
  1787. buffer. The commands available in the Agenda buffer are listed in
  1788. *Note Agenda commands::.
  1789. * Menu:
  1790. * Categories:: Not all tasks are equal
  1791. * Time-of-day specifications:: How the agenda knows the time
  1792. * Calendar/Diary integration:: Integrating Anniversaries and more
  1793. * Sorting of agenda items:: The order of things
  1794. 
  1795. File: org, Node: Categories, Next: Time-of-day specifications, Prev: Weekly/Daily agenda, Up: Weekly/Daily agenda
  1796. 8.3.1 Categories
  1797. ----------------
  1798. In the agenda buffer, each entry is preceded by a _category_, which is
  1799. derived from the file name. The category can also be set with a
  1800. special line anywhere in the buffer, looking like this:
  1801. #+CATEGORY: Thesis
  1802. If there are several such lines in a file, each specifies the
  1803. category for the text below it (but the first category also applies to
  1804. any text before the first CATEGORY line). The display in the agenda
  1805. buffer looks best if the category is not longer than 10 characters.
  1806. 
  1807. File: org, Node: Time-of-day specifications, Next: Calendar/Diary integration, Prev: Categories, Up: Weekly/Daily agenda
  1808. 8.3.2 Time-of-Day Specifications
  1809. --------------------------------
  1810. Org-mode checks each agenda item for a time-of-day specification. The
  1811. time can be part of the time stamp that triggered inclusion into the
  1812. agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
  1813. specified with two time stamps, like
  1814. `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
  1815. In the headline of the entry itself, a time(range) may also appear as
  1816. plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
  1817. Emacs diary (*note Calendar/Diary integration::), time specifications
  1818. in diary entries are recognized as well.
  1819. For agenda display, Org-mode extracts the time and displays it in a
  1820. standard 24 hour format as part of the prefix. The example times in
  1821. the previous paragraphs would end up in the agenda like this:
  1822. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  1823. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  1824. 19:00...... The Vogon reads his poem
  1825. 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
  1826. If the agenda is in single-day mode, or for the display of today, the
  1827. timed entries are embedded in a time grid, like
  1828. 8:00...... ------------------
  1829. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  1830. 10:00...... ------------------
  1831. 12:00...... ------------------
  1832. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  1833. 14:00...... ------------------
  1834. 16:00...... ------------------
  1835. 18:00...... ------------------
  1836. 19:00...... The Vogon reads his poem
  1837. 20:00...... ------------------
  1838. 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
  1839. The time grid can be turned on and off with the variable
  1840. `org-agenda-use-time-grid', and can be configured with
  1841. `org-agenda-time-grid'.
  1842. 
  1843. File: org, Node: Calendar/Diary integration, Next: Sorting of agenda items, Prev: Time-of-day specifications, Up: Weekly/Daily agenda
  1844. 8.3.3 Calendar/Diary integration
  1845. --------------------------------
  1846. Emacs contains the calendar and diary by Edward M. Reingold. The
  1847. calendar displays a three-month calendar with holidays from different
  1848. countries and cultures. The diary allows you to keep track of
  1849. anniversaries, lunar phases, sunrise/set, recurrent appointments
  1850. (weekly, monthly) and more. In this way, it is quite complementary to
  1851. Org-mode. It can be very useful to combine output from Org-mode with
  1852. the diary.
  1853. In order to include entries from the Emacs diary into Org-mode's
  1854. agenda, you only need to customize the variable
  1855. (setq org-agenda-include-diary t)
  1856. After that, everything will happen automatically. All diary entries
  1857. including holidays, anniversaries etc will be included in the agenda
  1858. buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
  1859. the agenda buffer to jump to the diary file in order to edit existing
  1860. diary entries. The `i' command to insert new entries for the current
  1861. date works in the agenda buffer, as well as the commands `S', `M', and
  1862. `C' to display Sunrise/Sunset times, show lunar phases and to convert
  1863. to other calendars, respectively. `c' can be used to switch back and
  1864. forth between calendar and agenda.
  1865. 
  1866. File: org, Node: Sorting of agenda items, Prev: Calendar/Diary integration, Up: Weekly/Daily agenda
  1867. 8.3.4 Sorting of agenda items
  1868. -----------------------------
  1869. The entries for each day are sorted. The default order is to first
  1870. collect all items containing an explicit time-of-day specification.
  1871. These entries will be shown at the beginning of the list, as a
  1872. _schedule_ for the day. After that, items remain grouped in
  1873. categories, in the sequence given by `org-agenda-files'. Within each
  1874. category, items are sorted by priority (*note Priorities::).
  1875. The priority is a numerical quantity composed of the base priority
  1876. (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
  1877. increments for overdue scheduled or deadline items.
  1878. Sorting can be customized using the variable
  1879. `org-agenda-sorting-strategy'.
  1880. 
  1881. File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Agenda views
  1882. 8.4 The global TODO list
  1883. ========================
  1884. The global TODO list contains all unfinished TODO items, formatted and
  1885. collected into a single place.
  1886. `C-c a t'
  1887. Show the global TODO list. This collects the TODO items from all
  1888. agenda files (*note Agenda views::) into a single buffer. The
  1889. buffer is in `agenda-mode', so there are commands to examine and
  1890. manipulate the TODO entries directly from that buffer (*note
  1891. Agenda commands::). *Note Global TODO list::, for more
  1892. information.
  1893. `C-c a T'
  1894. Like the above, but allows selection of a specific TODO keyword.
  1895. You can also do this by specifying a prefix argument to `C-c a t'.
  1896. With a `C-u' prefix you are prompted for a keyword. With a
  1897. numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
  1898. `r' key in the agenda buffer regenerates it, and you can give a
  1899. prefix argument to this command to change the selected TODO
  1900. keyword, for example `3 r'. If you often need a search for a
  1901. specific keyword, define a custom command for it (*note Agenda
  1902. dispatcher::).
  1903. Remote editing of TODO items means that you can change the state of a
  1904. TODO entry with a single key press. The commands available in the TODO
  1905. list are described in *Note Agenda commands::.
  1906. 
  1907. File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda views
  1908. 8.5 Matching headline tags
  1909. ==========================
  1910. If headlines in the agenda files are marked with _tags_ (*note Tags::),
  1911. you can select headlines based on the tags that apply to them and
  1912. collect them into an agenda buffer.
  1913. `C-c a m'
  1914. Produce a list of all headlines that match a given set of tags.
  1915. The command prompts for a selection criterion, which is a boolean
  1916. logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
  1917. `WORK|HOME' (*note Tags::). If you often need a specific search,
  1918. define a custom command for it (*note Agenda dispatcher::).
  1919. `C-c a M'
  1920. Like `C-c a m', but only select headlines that are also TODO items
  1921. and force checking subitems (see variable
  1922. `org-tags-match-list-sublevels'.
  1923. The commands available in the tags list are described in *Note
  1924. Agenda commands::.
  1925. 
  1926. File: org, Node: Timeline, Next: Agenda commands, Prev: Matching headline tags, Up: Agenda views
  1927. 8.6 Timeline for a single file
  1928. ==============================
  1929. The timeline is not really an agenda view, because it only summarizes
  1930. items from a single Org-mode file. But it also uses the agenda buffer
  1931. and provides similar commands, so we discuss it here. The timeline
  1932. shows all time-stamped items in a single Org-mode file (or the selected
  1933. part of it), in a _time-sorted view_. The main purpose of this command
  1934. is to give an overview over events in a project.
  1935. `C-c C-r'
  1936. Show a time-sorted view of the org file, with all time-stamped
  1937. items. When called with a `C-u' prefix, all unfinished TODO
  1938. entries (scheduled or not) are also listed under the current date.
  1939. The commands available in the timeline buffer are listed in *Note
  1940. Agenda commands::.
  1941. 
  1942. File: org, Node: Agenda commands, Prev: Timeline, Up: Agenda views
  1943. 8.7 Commands in the agenda buffer
  1944. =================================
  1945. Entries in the agenda buffer are linked back to the org file or diary
  1946. file where they originate. You are not allowed to edit the agenda
  1947. buffer itself, but commands are provided to show and jump to the
  1948. original entry location, and to edit the org-files "remotely" from the
  1949. agenda buffer. In this way, all information is stored only once,
  1950. removing the risk that your agenda and note files may diverge.
  1951. Some commands can be executed with mouse clicks on agenda lines. For
  1952. the other commands, the cursor needs to be in the desired line.
  1953. Motion
  1954. ......
  1955. `n'
  1956. Next line (same as <up>).
  1957. `p'
  1958. Previous line (same as <down>).
  1959. View/GoTo org file
  1960. ..................
  1961. `mouse-3'
  1962. `<SPC>'
  1963. Display the original location of the item in another window.
  1964. `L'
  1965. Display original location and recenter that window.
  1966. `mouse-2'
  1967. `mouse-1'
  1968. `<TAB>'
  1969. Go to the original location of the item in another window. Under
  1970. Emacs 22, `mouse-1' will also works for this.
  1971. `<RET>'
  1972. Go to the original location of the item and delete other windows.
  1973. `f'
  1974. Toggle Follow mode. In Follow mode, as you move the cursor through
  1975. the agenda buffer, the other window always shows the corresponding
  1976. location in the org file. The initial setting for this mode in new
  1977. agenda buffers can be set with the variable
  1978. `org-agenda-start-with-follow-mode'.
  1979. `l'
  1980. Toggle Logbook mode. In Logbook mode, entries that where marked
  1981. DONE while logging was on (variable `org-log-done') are shown in
  1982. the agenda.
  1983. Change display
  1984. ..............
  1985. `o'
  1986. Delete other windows.
  1987. `w'
  1988. Switch to weekly view (7 days displayed together).
  1989. `d'
  1990. Switch to daily view (just one day displayed).
  1991. `D'
  1992. Toggle the inclusion of diary entries. See *Note Calendar/Diary
  1993. integration::.
  1994. `g'
  1995. Toggle the time grid on and off. See also the variables
  1996. `org-agenda-use-time-grid' and `org-agenda-time-grid'.
  1997. `r'
  1998. Recreate the agenda buffer, for example to reflect the changes
  1999. after modification of the time stamps of items with S-<left> and
  2000. S-<right>. When the buffer is the global todo list, a prefix
  2001. argument is interpreted to create a selective list for a specific
  2002. TODO keyword.
  2003. `<right>'
  2004. Display the following `org-agenda-ndays' days. For example, if
  2005. the display covers a week, switch to the following week. With
  2006. prefix arg, go forward that many times `org-agenda-ndays' days.
  2007. `<left>'
  2008. Display the previous dates.
  2009. `.'
  2010. Goto today.
  2011. Remote editing
  2012. ..............
  2013. `0-9'
  2014. Digit argument.
  2015. `t'
  2016. Change the TODO state of the item, both in the agenda and in the
  2017. original org file.
  2018. `T'
  2019. Show all tags associated with the current item. Because of
  2020. inheritance, this may be more than the tags listed in the line
  2021. itself.
  2022. `:'
  2023. Set tags for the current headline.
  2024. `,'
  2025. Set the priority for the current item. Org-mode prompts for the
  2026. priority character. If you reply with <SPC>, the priority cookie
  2027. is removed from the entry.
  2028. `p'
  2029. Display weighted priority of current item.
  2030. `+'
  2031. `S-<up>'
  2032. Increase the priority of the current item. The priority is
  2033. changed in the original buffer, but the agenda is not resorted.
  2034. Use the `r' key for this.
  2035. `-'
  2036. `S-<down>'
  2037. Decrease the priority of the current item.
  2038. `C-c C-s'
  2039. Schedule this item
  2040. `C-c C-d'
  2041. Set a deadline for this item.
  2042. `S-<right>'
  2043. Change the time stamp associated with the current line by one day
  2044. into the future. With prefix argument, change it by that many
  2045. days. For example, `3 6 5 S-<right>' will change it by a year.
  2046. The stamp is changed in the original org file, but the change is
  2047. not directly reflected in the agenda buffer. Use the `r' key to
  2048. update the buffer.
  2049. `S-<left>'
  2050. Change the time stamp associated with the current line by one day
  2051. into the past.
  2052. `>'
  2053. Change the time stamp associated with the current line to today.
  2054. The key `>' has been chosen, because it is the same as `S-.' on my
  2055. keyboard.
  2056. `i'
  2057. Insert a new entry into the diary. Prompts for the type of entry
  2058. (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
  2059. new entry in the diary, just like `i d' etc. would do in the
  2060. calendar. The date is taken from the cursor position.
  2061. Calendar commands
  2062. .................
  2063. `c'
  2064. Open the Emacs calendar and move to the date at the agenda cursor.
  2065. `c'
  2066. When in the calendar, compute and show the Org-mode agenda for the
  2067. date at the cursor.
  2068. `M'
  2069. Show the phases of the moon for the three months around current
  2070. date.
  2071. `S'
  2072. Show sunrise and sunset times. The geographical location must be
  2073. set with calendar variables, see documentation of the Emacs
  2074. calendar.
  2075. `C'
  2076. Convert the date at cursor into many other cultural and historic
  2077. calendars.
  2078. `H'
  2079. Show holidays for three month around the cursor date.
  2080. `C-c C-x C-c'
  2081. Export a single iCalendar file containing entries from all agenda
  2082. files.
  2083. Quit and Exit
  2084. .............
  2085. `q'
  2086. Quit agenda, remove the agenda buffer.
  2087. `x'
  2088. Exit agenda, remove the agenda buffer and all buffers loaded by
  2089. Emacs for the compilation of the agenda. Buffers created by the
  2090. user to visit org files will not be removed.
  2091. 
  2092. File: org, Node: Exporting, Next: Miscellaneous, Prev: Agenda views, Up: Top
  2093. 9 Exporting
  2094. ***********
  2095. Org-mode documents can be exported into a variety of other formats. For
  2096. printing and sharing of notes, ASCII export produces a readable and
  2097. simple version of an Org-mode file. HTML export allows to publish a
  2098. notes file on the web, while the XML format provides a solid base for
  2099. exchange with a broad range of other applications. To incorporate
  2100. entries with associated times like deadlines or appointments into a
  2101. desktop calendar program like iCal, Org-mode can also produce extracts
  2102. in the iCalendar format. Currently Org-mode only supports export, not
  2103. import of these different formats.
  2104. When exporting, Org-mode uses special conventions to enrich the
  2105. output produced. *Note Text interpretation::, for more details.
  2106. * Menu:
  2107. * ASCII export:: Exporting to plain ASCII
  2108. * HTML export:: Exporting to HTML
  2109. * XML export:: Exporting to XML
  2110. * iCalendar export:: Exporting in iCalendar format
  2111. * Text interpretation:: How the exporter looks at the file
  2112. 
  2113. File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
  2114. 9.1 ASCII export
  2115. ================
  2116. ASCII export produces an simple and very readable version of an Org-mode
  2117. file.
  2118. `C-c C-x a'
  2119. Export as ASCII file. If there is an active region, only the
  2120. region will be exported. For an org file `myfile.org', the ASCII
  2121. file will be `myfile.txt'. The file will be overwritten without
  2122. warning.
  2123. `C-c C-x v a'
  2124. Export only the visible part of the document.
  2125. In the exported version, the first 3 outline levels will become
  2126. headlines, defining a general document structure. Additional levels
  2127. will be exported as itemized lists. If you want that transition to
  2128. occur at a different level, specify it with a prefix argument. For
  2129. example,
  2130. C-1 C-c C-x a org-export-as-ascii
  2131. creates only top level headlines and does the rest as items.
  2132. 
  2133. File: org, Node: HTML export, Next: XML export, Prev: ASCII export, Up: Exporting
  2134. 9.2 HTML export
  2135. ===============
  2136. Org-mode contains an HTML exporter with extensive HTML formatting, in
  2137. ways similar to John Grubers _markdown_ language, but with additional
  2138. support for tables.
  2139. `C-c C-x h'
  2140. Export as HTML file `myfile.html'.
  2141. `C-c C-x b'
  2142. Export as HTML file and open it with a browser.
  2143. `C-c C-x v h'
  2144. `C-c C-x v b'
  2145. Export only the visible part of the document.
  2146. In the exported version, the first 3 outline levels will become
  2147. headlines, defining a general document structure. Additional levels
  2148. will be exported as itemized lists. If you want that transition to
  2149. occur at a different level, specify it with a prefix argument. For
  2150. example,
  2151. C-2 C-c C-x b
  2152. creates two levels of headings and does the rest as items.
  2153. If you want to include HTML tags which should be interpreted as such,
  2154. mark them with a `@' like in `@<b>bold text@</b>'. Plain `<' and `>'
  2155. are always transformed to `&lt;' and `&gt;' in HTML export.
  2156. You can also give style information for the exported file. The
  2157. default specification can be configured through the option
  2158. `org-export-html-style'. If you want to use a file-local style, you
  2159. may use file variables, best wrapped into a COMMENT section at the end
  2160. of the outline tree. For example:
  2161. * COMMENT HTML style specifications
  2162. # Local Variables:
  2163. # org-export-html-style: " <style type=\"text/css\">
  2164. p {font-weight: normal; color: gray; }
  2165. h1 {color: black; }
  2166. </style>"
  2167. # End: ***
  2168. Remember to execute `M-x normal-mode' after changing this to make
  2169. the new style visible to Emacs. This command restarts org-mode for the
  2170. current buffer and forces Emacs to re-evaluate the local variables
  2171. section in the buffer.
  2172. 
  2173. File: org, Node: XML export, Next: iCalendar export, Prev: HTML export, Up: Exporting
  2174. 9.3 XML export
  2175. ==============
  2176. Org-mode contains an XML exporter that produces XOXO-style XML.
  2177. Currently, this exporter only handles the general outline structure and
  2178. does not interpret any additional Org-mode features.
  2179. `C-c C-x C-x'
  2180. Export as XML file `myfile.xml'.
  2181. `C-c C-x v x'
  2182. Export only the visible part of the document.
  2183. 
  2184. File: org, Node: iCalendar export, Next: Text interpretation, Prev: XML export, Up: Exporting
  2185. 9.4 iCalendar export
  2186. ====================
  2187. Some people like to use Org-mode for keeping track of projects, but
  2188. still prefer a standard calendar application for anniversaries and
  2189. appointments. In this case it can be useful to have deadlines and
  2190. other time-stamped items in Org-mode files show up in the calendar
  2191. application. Org-mode can export calendar information in the standard
  2192. iCalendar format.
  2193. `C-c C-x i'
  2194. Create iCalendar entries for the current file and store them in
  2195. the same directory, using a file extension `.ics'.
  2196. `C-c C-x C-i'
  2197. Like `C-c C-x i', but do this for all files in `org-agenda-files'.
  2198. For each of these files, a separate iCalendar file will be
  2199. written.
  2200. `C-c C-x c'
  2201. Create a single large iCalendar file from all files in
  2202. `org-agenda-files' and write it to the file given by
  2203. `org-combined-agenda-icalendar-file'.
  2204. How this calendar is best read and updated, depends on the
  2205. application you are using. For example, when using iCal under Apple
  2206. MacOS X, you could create a new calendar `OrgMode' (the default name
  2207. for the calendar created by `C-c C-x c', see the variables
  2208. `org-icalendar-combined-name' and
  2209. `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
  2210. the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
  2211. use AppleScript to make iCal re-read the calendar files each time a new
  2212. version of `OrgMode.ics' is produced. Here is the setup needed for
  2213. this:
  2214. (setq org-combined-agenda-icalendar-file
  2215. "~/Library/Calendars/OrgMode.ics")
  2216. (add-hook 'org-after-save-iCalendar-file-hook
  2217. (lambda ()
  2218. (shell-command
  2219. "osascript -e 'tell application \"iCal\" to reload calendars'")))
  2220. 
  2221. File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
  2222. 9.5 Text interpretation by the exporter
  2223. =======================================
  2224. The exporter backends interpret additional structure in the Org-mode
  2225. file in order to produce better output.
  2226. * Menu:
  2227. * Comment lines:: Some lines will not be exported
  2228. * Enhancing text:: Subscripts, symbols and more
  2229. * Export options:: How to influence the export settings
  2230. 
  2231. File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
  2232. 9.5.1 Comment lines
  2233. -------------------
  2234. Lines starting with `#' in column zero are treated as comments and will
  2235. never be exported. Also entire subtrees starting with the word
  2236. `COMMENT' will never be exported. Finally, any text before the first
  2237. headline will not be exported either.
  2238. `C-c ;'
  2239. Toggle the COMMENT keyword at the beginning of an entry.
  2240. 
  2241. File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
  2242. 9.5.2 Enhancing text for export
  2243. -------------------------------
  2244. Some of the export backends of Org-mode allow for sophisticated text
  2245. formatting, this is true in particular for the HTML backend. Org-mode
  2246. has a number of typing conventions that allow to produce a richly
  2247. formatted output.
  2248. * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
  2249. enumerator will be recognized and transformed if the backend
  2250. supports lists. See *Note Plain lists::.
  2251. * You can make words *bold*, /italic/, and _underlined_
  2252. * Simple TeX-like math constructs are interpreted:
  2253. - `10^22' and `J_n' are super- and subscripts. You can quote
  2254. `^' and `_' with a backslash: `\_' and `\^'
  2255. - `\alpha' indicates a Greek letter, `\to' an arrow. You can
  2256. use completion for these macros, just type `\' and maybe a few
  2257. letters, and press `M-<TAB>' to see possible completions.
  2258. * Tables are transformed into native tables under the exporter, if
  2259. the export backend supports this. Data fields before the first
  2260. horizontal separator line will be formatted as table header fields.
  2261. * If a headline starts with the word `QUOTE', the text below the
  2262. headline will be typeset as fixed-width, to allow quoting of
  2263. computer codes etc. Lines starting with `:' are also typeset in
  2264. fixed-width font.
  2265. `C-c :'
  2266. Toggle fixed-width for entry (QUOTE) or region, see below.
  2267. If these conversions conflict with your habits of typing ASCII text,
  2268. they can all be turned off with corresponding variables (see the
  2269. customization group `org-export-general', and the following section
  2270. which explains how to set export options with special lines in a buffer.
  2271. 
  2272. File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
  2273. 9.5.3 Export options
  2274. --------------------
  2275. The exporter recognizes special lines in the buffer which provide
  2276. additional information. These lines may be put anywhere in the file.
  2277. The whole set of lines can be inserted into the buffer with `C-c C-x
  2278. t'. For individual lines, a good way to make sure the keyword is
  2279. correct is to type `#+' and then use `M-<TAB>' completion (*note
  2280. Completion::).
  2281. `C-c C-x t'
  2282. Insert template with export options, see example below.
  2283. #+TITLE: the title to be shown (default is the buffer name)
  2284. #+AUTHOR: the author (default taken from `user-full-name')
  2285. #+EMAIL: his/her email address (default from `user-mail-address')
  2286. #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
  2287. #+TEXT: Some descriptive text to be inserted at the beginning.
  2288. #+TEXT: Several lines may be given.
  2289. #+OPTIONS: H:2 num:t toc:t \n:nil t ::t |:t ^:t *:nil TeX:t
  2290. The OPTIONS line is a compact form to specify export settings. Here
  2291. you can:
  2292. H: set the number of headline levels for export
  2293. num: turn on/off section-numbers
  2294. toc: turn on/off table of contents
  2295. \n: turn on/off linebreak-preservation
  2296. @: turn on/off quoted html tags
  2297. :: turn on/off fixed-width sections
  2298. |: turn on/off tables
  2299. ^: turn on/off TeX-like syntax for sub- and superscripts.
  2300. *: turn on/off emphasized text (bold, italic, underlined)
  2301. TeX: turn on/off TeX macros
  2302. 
  2303. File: org, Node: Miscellaneous, Next: Index, Prev: Exporting, Up: Top
  2304. 10 Miscellaneous
  2305. ****************
  2306. * Menu:
  2307. * Completion:: M-TAB knows what you need
  2308. * Customization:: Adapting Org-mode to your taste
  2309. * Summary of in-buffer settings:: Using special lines to set options
  2310. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  2311. * Clean view:: Getting rid of leading stars in the outline
  2312. * TTY keys:: Using Org-mode on a tty
  2313. * FAQ:: Frequently asked questions
  2314. * Interaction:: Other Emacs packages
  2315. * Bugs:: Things which do not work perfectly
  2316. * Acknowledgments:: These people provided feedback and more
  2317. 
  2318. File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
  2319. 10.1 Completion
  2320. ===============
  2321. Org-mode supports in-buffer completion. This type of completion does
  2322. not make use of the minibuffer. You simply type a few letters into the
  2323. buffer and use the key to complete text right there.
  2324. `M-<TAB>'
  2325. Complete word at point
  2326. * At the beginning of a headline, complete TODO keywords.
  2327. * After `\', complete TeX symbols supported by the exporter.
  2328. * After `*', complete CamelCase versions of all headlines in the
  2329. buffer.
  2330. * After `:', complete tags used elsewhere in the buffer.
  2331. * After `#+', complete the special keywords like `TYP_TODO' or
  2332. `OPTIONS' which set file-specific options for Org-mode. When
  2333. the option keyword is already complete, pressing `M-<TAB>'
  2334. again will insert example settings for this keyword.
  2335. * Elsewhere, complete dictionary words using ispell.
  2336. 
  2337. File: org, Node: Customization, Next: Summary of in-buffer settings, Prev: Completion, Up: Miscellaneous
  2338. 10.2 Customization
  2339. ==================
  2340. There are more than 100 variables that can be used to customize
  2341. Org-mode. For the sake of compactness of the manual, we are not
  2342. describing the variables here. A structured overview of customization
  2343. variables is available with `M-x org-customize'. Or select `Browse Org
  2344. Group' from the `Org->Customization' menu. Many settings can also be
  2345. activated on a per-file basis, by putting special lines into the buffer
  2346. (*note Summary of in-buffer settings::).
  2347. 
  2348. File: org, Node: Summary of in-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
  2349. 10.3 Summary of in-buffer settings
  2350. ==================================
  2351. Org-mode uses special lines in the buffer to define settings on a
  2352. per-file basis. These lines start with a `#+' followed by a keyword, a
  2353. colon, and then individual words defining a setting. Several settings
  2354. words con be in the same line, but you can also have multiple lines for
  2355. the keyword. While these settings are described throughout the manual,
  2356. here is a summary. After changing any of those lines in the buffer,
  2357. press `C-c C-c' with the cursor still in the line to activate the
  2358. changes immediately. Otherwise they become effective only when the
  2359. file is visited again in a new Emacs session.
  2360. `#+STARTUP:'
  2361. This line sets options to be used at startup of org-mode, when an
  2362. Org-mode file is being visited. The first set of options deals
  2363. with the initial visibility of the outline tree. The
  2364. corresponding variable for global default settings is
  2365. `org-startup-folded', with a default value `t', which means
  2366. `overview'.
  2367. overview top-level headlines only
  2368. content all headlines
  2369. showall no folding at all, show everything
  2370. Then there are options for aligning tables upon visiting a file.
  2371. This is useful in files containing narrowed table columns. The
  2372. corresponding variable is `org-startup-align-all-tables', with a
  2373. default value `nil'.
  2374. align align all tables
  2375. noalign don't align tables on startup
  2376. Here are the options for hiding leading stars in outline headings.
  2377. The corresponding variables are `org-hide-leading-stars' and
  2378. `org-odd-levels-only', both with a default setting `nil' (meaning
  2379. `showstars' and `oddeven').
  2380. hidestars make all but one of the stars starting a headline invisible.
  2381. showstars show all stars starting a headline
  2382. odd allow only odd outline levels (1,3,...)
  2383. oddeven allow all outline levels
  2384. `#+SEQ_TODO: #+TYP_TODO:'
  2385. These lines that the TODO keywords and their interpretation in the
  2386. current file. The corresponding variables are `org-todo-keywords'
  2387. and `org-todo-interpretation'.
  2388. `#+CATEGORY:'
  2389. This line sets the category for the agenda file. The category
  2390. applies for all subsequent lines until the next `#+CATEGORY' line,
  2391. or the end of the file.
  2392. `#+TBLFM:'
  2393. This line contains the formulas for the table directly above the
  2394. line.
  2395. `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
  2396. These lines provide setting for exporting files. For more details
  2397. see *Note Export options::.
  2398. 
  2399. File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: Summary of in-buffer settings, Up: Miscellaneous
  2400. 10.4 The very busy C-c C-c key
  2401. ==============================
  2402. The key `C-c C-c' has many purposes in org-mode, which are all
  2403. mentioned scattered throughout this manual. One specific function of
  2404. this key is to add _tags_ to a headline (*note Tags::). In many other
  2405. circumstances it means something like _Hey Org-mode, look here and
  2406. update according to what you see here_. Here is a summary what this
  2407. means in different contexts.
  2408. - If the cursor is in one of the special #+KEYWORD lines, this
  2409. triggers scanning the buffer for these lines and updating the
  2410. information.
  2411. - If the cursor is inside a table, realign the table. This command
  2412. works even if the automatic table editor has been turned off.
  2413. - If the cursor is on a #+TBLFM line, re-apply the formulas to the
  2414. entire table.
  2415. - If the cursor is inside a table created by the `table.el' package,
  2416. activate that table.
  2417. - If the current buffer is a remember buffer, close note and file it.
  2418. with a prefix argument, file it without further interaction to the
  2419. default location.
  2420. - If the cursor is on a <<<target>>>, update radio targets and
  2421. corresponding links in this buffer.
  2422. - If the cursor is on a numbered item in a plain list, renumber the
  2423. ordered list.
  2424. 
  2425. File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
  2426. 10.5 A cleaner outline view
  2427. ===========================
  2428. Some people find it noisy and distracting that the Org-mode headlines
  2429. are starting with a potentially large number of stars. For example the
  2430. tree from *Note Headlines:::
  2431. * Top level headline
  2432. ** Second level
  2433. *** 3rd level
  2434. some text
  2435. *** 3rd level
  2436. more text
  2437. * Another top level headline
  2438. Unfortunately this is deeply ingrained into the code of Org-mode and
  2439. cannot be easily changed. You can, however, modify the display in such
  2440. a way that all leading stars become invisible and the outline more easy
  2441. to read. To do this, customize the variable `org-hide-leading-stars'
  2442. like this:
  2443. (setq org-hide-leading-stars t)
  2444. or change this on a per-file basis with one of the lines (anywhere in
  2445. the buffer)
  2446. #+STARTUP: showstars
  2447. #+STARTUP: hidestars
  2448. Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
  2449. modifications.
  2450. With stars hidden, the tree becomes:
  2451. * Top level headline
  2452. * Second level
  2453. * 3rd level
  2454. some text
  2455. * 3rd level
  2456. more text
  2457. * Another top level headline
  2458. Note that the leading stars are not truly replaced by whitespace, they
  2459. are only fontified with the face `org-hide' that uses the background
  2460. color as font color. If are are not using either white or black
  2461. background, you may have to customize this face to get the wanted
  2462. effect. Another possibility is to set this font such that the extra
  2463. stars are almost invisible, for example using the color `grey90' on a
  2464. white background.
  2465. Things become cleaner still if you skip all the even levels and use
  2466. only odd levels 1, 3, 5..., effectively adding two stars to go from one
  2467. outline level to the next:
  2468. * Top level headline
  2469. * Second level
  2470. * 3rd level
  2471. some text
  2472. * 3rd level
  2473. more text
  2474. * Another top level headline
  2475. In order to make the structure editing and export commands handle this
  2476. convention correctly, use
  2477. (setq org-odd-levels-only t)
  2478. or set this on a per-file basis with one of the following lines (don't
  2479. forget to press `C-c C-c' with the cursor in the startup line to
  2480. activate changes immediately).
  2481. #+STARTUP: odd
  2482. #+STARTUP: oddeven
  2483. You can convert an Org-mode file from single-star-per-level to the
  2484. double-star-per-level convention with `M-x org-convert-to-odd-levels
  2485. RET' in that file. The reverse operation is `M-x
  2486. org-convert-to-oddeven-levels'.
  2487. 
  2488. File: org, Node: TTY keys, Next: FAQ, Prev: Clean view, Up: Miscellaneous
  2489. 10.6 Using org-mode on a tty
  2490. ============================
  2491. Org-mode uses a number of keys that are not accessible on a tty. This
  2492. applies to most special keys like cursor keys, <TAB> and <RET>, when
  2493. these are combined with modifier keys like <Meta> and/or <Shift>.
  2494. Org-mode uses these bindings because it needs to provide keys for a
  2495. large number of commands, and because these keys appeared particularly
  2496. easy to remember. In order to still be able to access the core
  2497. functionality of Org-mode on a tty, alternative bindings are provided.
  2498. Here is a complete list of these bindings, which are obviously more
  2499. cumbersome to use. Note that sometimes a work-around can be better.
  2500. For example changing a time stamp is really only fun with `S-<cursor>'
  2501. keys. On a tty you would rather use `C-c .' to re-insert the
  2502. timestamp.
  2503. Default Alternative 1 Alternative 2
  2504. `S-<TAB>' `C-u <TAB>'
  2505. `M-<left>' `C-c C-x l' `<Esc> <left>'
  2506. `M-S-<left>'`C-c C-x L'
  2507. `M-<right>' `C-c C-x r' `<Esc>
  2508. <right>'
  2509. `M-S-<right>'`C-c C-x R'
  2510. `M-<up>' `C-c C-x u' `<Esc> <up>'
  2511. `M-S-<up>' `C-c C-x U'
  2512. `M-<down>' `C-c C-x d' `<Esc> <down>'
  2513. `M-S-<down>'`C-c C-x D'
  2514. `S-<RET>' `C-c C-x c'
  2515. `M-<RET>' `C-c C-x m' `<Esc> <RET>'
  2516. `M-S-<RET>' `C-c C-x M'
  2517. `S-<left>' `C-c C-x
  2518. <left>'
  2519. `S-<right>' `C-c C-x
  2520. <right>'
  2521. `S-<up>' `C-c C-x
  2522. <up>'
  2523. `S-<down>' `C-c C-x
  2524. <down>'
  2525. 
  2526. File: org, Node: FAQ, Next: Interaction, Prev: TTY keys, Up: Miscellaneous
  2527. 10.7 Frequently asked questions
  2528. ===============================
  2529. 1. When I try to use Org-mode, I always get `(wrong-type-argument
  2530. keymapp nil)'.
  2531. This is a conflict with an outdated version of the `allout.el'
  2532. package which pretends to be also the standard outline-mode but is
  2533. not. This happens with older versions of `allout.el', for example
  2534. the one distributed with Emacs 21. Upgrade to Emacs 22 and this
  2535. problem will disappear. If for some reason you cannot do this,
  2536. make sure that org.el is loaded _before_ `allout.el', for example
  2537. by putting `(require 'org)' early enough into your `.emacs' file.
  2538. 2. Org-mode seems to be a useful default mode for the various
  2539. `README' files I have scattered through my directories. How do I
  2540. turn it on for all `README' files?
  2541. (add-to-list 'auto-mode-alist '("README$" . org-mode))
  2542. 3. Some of my links stopped working after I upgraded to a version
  2543. 4.20 or later. Why is this, and how can I fix it?
  2544. These must be links in plain text, containing white space, such as
  2545. `bbdb:Richard Stallman'. You need to protect these links by
  2546. putting double brackets around them, like `[[bbdb:Richard
  2547. Stallman]]'.
  2548. 4. I see that Org-mode now creates links using the double bracket
  2549. convention that hides the link part and the brackets, only showing
  2550. the description part. How can I convert my old links to this new
  2551. format?
  2552. Execute once in each Org-mode file: `M-x org-upgrade-old-links'.
  2553. This replaces angular brackets with the new link format.
  2554. 5. I don't care if you find the new bracket links great, I am
  2555. attached to the old style using angular brackets and no hiding of
  2556. the link text. Please give them back to me, don't tell me it is
  2557. not possible!
  2558. Would I let you down like that? If you must, you can do this
  2559. (setq org-link-style 'plain
  2560. org-link-format "<%s>")
  2561. 6. When I am executing shell links I always get a confirmation prompt
  2562. and need to type `yes <RET>', thats 4 key presses! Can I get rid
  2563. of this?
  2564. The confirmation is there to protect you from unwantingly execute
  2565. potentially dangerous commands. For example, imagine a link
  2566. `[[shell:rm -rf ~/*][Google Search]]'. In an Org-mode buffer, this
  2567. command would look like `Google Search', but really it would remove
  2568. your home directory. If you wish, you can make it easier to
  2569. respond to the query by setting `org-confirm-shell-links' to
  2570. `y-or-n-p'. Then a single `y' keypress will be enough to confirm
  2571. shell links. It is also possible to turn off this check entirely,
  2572. but I do not recommend to do this. Be warned.
  2573. 7. All these stars are driving me mad, I just find the Emacs outlines
  2574. unreadable. Can't you just put white space and a single star as a
  2575. starter for headlines?
  2576. See *Note Clean view::.
  2577. 8. I would like to have two windows on the same Org-mode file, but
  2578. with different outline visibility. Is that possible?
  2579. In GNU Emacs, you may use _indirect buffers_ which do exactly this.
  2580. See the documentation on the command `make-indirect-buffer'. In
  2581. XEmacs, this is currently not possible because of the different
  2582. outline implementation.
  2583. 9. When I export my TODO list, every TODO item becomes a separate
  2584. section. How do I enforce these items to be exported as an
  2585. itemized list?
  2586. If you plan to use ASCII or HTML export, make sure things you want
  2587. to be exported as item lists are level 4 at least, even if that
  2588. does mean there is a level jump. For example:
  2589. * Todays top priorities
  2590. **** TODO write a letter to xyz
  2591. **** TODO Finish the paper
  2592. **** Pick up kids at the school
  2593. Alternatively, if you need a specific value for the heading/item
  2594. transition in a particular file, use the `+OPTIONS' line to
  2595. configure the `H' switch.
  2596. +OPTIONS: H:2; ...
  2597. 10. I would like to export only a subtree of my file to HTML. How?
  2598. If you want to export a subtree, mark the subtree as region and
  2599. then export. Marking can be done with `C-c @ C-x C-x', for
  2600. example.
  2601. 11. Org-mode takes over the S-cursor keys. I also want to use
  2602. CUA-mode, is there a way to fix this conflict?
  2603. Yes, see *Note Interaction::.
  2604. 12. One of my table columns has started to fill up with `#ERROR'.
  2605. What is going on?
  2606. Org-mode tried to compute the column from other fields using a
  2607. formula stored in the `#+TBLFM:' line just below the table, and
  2608. the evaluation of the formula fails. Fix the fields used in the
  2609. formula, or fix the formula, or remove it!
  2610. 13. When I am in the last column of a table and just above a
  2611. horizontal line in the table, pressing TAB creates a new table line
  2612. before the horizontal line. How can I quickly move to the line
  2613. below the horizontal line instead?
  2614. Press <down> (to get on the separator line) and then <TAB>. Or
  2615. configure the variable `org-table-tab-jumps-over-hlines'.
  2616. 14. How can I change the indentation of an entire table without fixing
  2617. every line by hand?
  2618. The indentation of a table is set by the first line. So just fix
  2619. the indentation of the first line and realign with <TAB>.
  2620. 15. Is it possible to include entries from org-mode files into my
  2621. emacs diary?
  2622. Since the org-mode agenda is much more powerful and can contain the
  2623. diary (*note Calendar/Diary integration::), you should think twice
  2624. before deciding to do this. Integrating Org-mode information into
  2625. the diary is, however, possible. The following steps are
  2626. necessary: Autoload the function `org-diary' as shown above under
  2627. *Note Installation and activation::. You also need to use _fancy
  2628. diary display_ by setting in `.emacs':
  2629. (add-hook 'diary-display-hook 'fancy-diary-display)
  2630. Then include the following line into your `~/diary' file, in order
  2631. to get the entries from all files listed in the variable
  2632. `org-agenda-files':
  2633. &%%(org-diary)
  2634. You may also select specific files with
  2635. &%%(org-diary) ~/path/to/some/org-file.org
  2636. &%%(org-diary) ~/path/to/another/org-file.org
  2637. If you now launch the calendar and press `d' to display a diary,
  2638. the headlines of entries containing a timestamp, date range,
  2639. schedule, or deadline referring to the selected date will be
  2640. listed. Just like in Org-mode's agenda view, the diary for
  2641. _today_ contains additional entries for overdue deadlines and
  2642. scheduled items. See also the documentation of the `org-diary'
  2643. function. Under XEmacs, it is not possible to jump back from the
  2644. diary to the org, this works only in the agenda buffer.
  2645. 
  2646. File: org, Node: Interaction, Next: Bugs, Prev: FAQ, Up: Miscellaneous
  2647. 10.8 Interaction with other packages
  2648. ====================================
  2649. Org-mode can cooperate with the following packages:
  2650. `org-mouse.el' by Piotr Zielinski
  2651. This package implements extended mouse functionality for Org-mode.
  2652. It allows you to cycle visibility and to edit the document
  2653. structure with the mouse. Best of all, it provides a
  2654. context-sensitive menu on <mouse-3> that changes depending on the
  2655. context of a mouse-click. Use a search engine to find this
  2656. package on the web.
  2657. `table.el' by Takaaki Ota
  2658. Org mode cooperates with table.el, see *Note table.el::.
  2659. `table.el' is part of Emacs 22.
  2660. `calc.el' by Dave Gillespie
  2661. Org-mode uses the calc package for implementing spreadsheet
  2662. functionality in its tables (*note Table calculations::).
  2663. Org-modes checks for the availability of calc by looking for the
  2664. function `calc-eval' which should be autoloaded in your setup if
  2665. calc has been installed properly. As of Emacs 22, calc is part of
  2666. the Emacs distribution. Another possibility for interaction
  2667. between the two packages is using calc for embedded calculations.
  2668. *Note Embedded Mode: (calc)Embedded Mode.
  2669. `constants.el' by Carsten Dominik
  2670. In a table formula (*note Table calculations::), it is possible to
  2671. use names for natural constants or units. Instead of defining
  2672. your own constants in the variable `org-table-formula-constants',
  2673. install the `constants' package which defines a large number of
  2674. constants and units, and lets you use unit prefixes like `M' for
  2675. `Mega' etc. You will need version 2.0 of this package, available
  2676. at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
  2677. the function `constants-get', which has to be autoloaded in your
  2678. setup. See the installation instructions in the file
  2679. `constants.el'.
  2680. `CUA.el' by Kim. F. Storm
  2681. Keybindings in Org-mode conflict with the `S-<cursor>' keys used
  2682. by CUA-mode (as well as pc-select-mode and s-region-mode) to
  2683. select and extend the region. If you want to use one of these
  2684. packages along with Org-mode, configure the variable
  2685. `org-CUA-compatible'. When set, Org-mode will move the following
  2686. keybindings in org-mode files, and in the agenda buffer (but not
  2687. during date selection).
  2688. S-UP -> M-p S-DOWN -> M-n
  2689. S-LEFT -> M-- S-RIGHT -> M-+
  2690. S-RET -> C-S-RET
  2691. Yes, these are unfortunately more difficult to remember. If you
  2692. want to have other replacement keys, look at the variable
  2693. `org-disputed-keys'.
  2694. `windmove.el' by Hovav Shacham
  2695. Also this package uses the `S-<cursor>' keys, so everything written
  2696. in the paragraph above about CUA mode also applies here.
  2697. `remember.el' by John Wiegley
  2698. Org mode cooperates with remember, see *Note Remember::.
  2699. `Remember.el' is not part of Emacs, find it on the web.
  2700. 
  2701. File: org, Node: Bugs, Next: Acknowledgments, Prev: Interaction, Up: Miscellaneous
  2702. 10.9 Bugs
  2703. =========
  2704. Here is a list of things that should work differently, but which I have
  2705. found too hard to fix.
  2706. * If a table field starts with a link, and if the corresponding table
  2707. column is narrowed (*note Narrow columns::) to a width too small to
  2708. display the link, the field would look entirely empty even though
  2709. it is not. To prevent this, Org-mode throws an error. The
  2710. work-around is to make the column wide enough to fit the link, or
  2711. to add some text (at least 2 characters) before the link in the
  2712. same field.
  2713. * Narrowing table columns does not work on XEmacs, because the
  2714. `format' function does not transport text properties.
  2715. * Text in an entry protected with the `QUOTE' keyword should not
  2716. autowrap.
  2717. * When the application called by `C-c C-o' to open a file link fails
  2718. (for example because the application does not exits or refuses to
  2719. open the file), it does so silently. No error message is
  2720. displayed.
  2721. * Plain list items should be able to hold a TODO item.
  2722. Unfortunately this has so many technical problems that I will only
  2723. consider this change for the next major release (5.0).
  2724. * The remote-editing commands in the agenda buffer cannot be undone
  2725. with `undo' called from within the agenda buffer. But you can go
  2726. to the corresponding buffer (using <TAB> or <RET> and execute
  2727. `undo' there.
  2728. * Recalculating a table line applies the formulas from left to right.
  2729. If a formula uses _calculated_ fields further down the row,
  2730. multiple recalculation may be needed to get all fields consistent.
  2731. * You can only make a single word boldface or italic. To emphasize
  2732. several words in a row, each must have the emphasize markers, like
  2733. in `*three* *bold* *words*'.
  2734. * The exporters work well, but could be made more efficient.
  2735. 
  2736. File: org, Node: Acknowledgments, Prev: Bugs, Up: Miscellaneous
  2737. 10.10 Acknowledgments
  2738. =====================
  2739. Org-mode was written by Carsten Dominik, who still maintains it at the
  2740. Org-mode homepage `http://www.astro.uva.nl/~dominik/Tools/org/'. The
  2741. following people (in alphabetic order) have helped the development
  2742. along with ideas, suggestions and patches. Many thanks to all of you,
  2743. Org-mode would not be what it is without your input.
  2744. * Thomas Baumann contributed the code for links to the MH-E email
  2745. system.
  2746. * Alex Bochannek provided a patch for rounding time stamps.
  2747. * Charles Caves' suggestion sparked the implementation of templates
  2748. for Remember.
  2749. * Pavel Chalmoviansky influenced the agenda treatment of items with
  2750. specified time.
  2751. * Gregory Chenov patched support for lisp forms into table
  2752. calculations and improved XEmacs compatibility.
  2753. * Sacha Chua suggested to copy some linking code from Planner.
  2754. * Kees Dullemond inspired the use of narrowed tabled columns.
  2755. * Christian Egli converted the documentation into TeXInfo format,
  2756. patched CSS formatting into the HTML exporter, and inspired the
  2757. agenda.
  2758. * Nic Ferrier contributed mailcap and XOXO support.
  2759. * Kai Grossjohann pointed out key-binding conflicts caused by
  2760. Org-mode.
  2761. * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
  2762. happy.
  2763. * Tim O'Callaghan suggested in-file links, search options for
  2764. general file links, and TAGS.
  2765. * Oliver Oppitz suggested multi-state TODO items.
  2766. * Scott Otterson sparked the introduction of descriptive text for
  2767. links, among other things.
  2768. * Pete Phillips helped the development of the TAGS feature.
  2769. * T.V. Raman reported bugs and suggested improvements.
  2770. * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
  2771. control.
  2772. * Kevin Rogers contributed code to access VM files on remote hosts.
  2773. * Frank Ruell solved the mystery of the `keymapp nil' bug, a conflict
  2774. with `allout.el'.
  2775. * Philip Rooke created the Org-mode reference card and provided lots
  2776. of feedback.
  2777. * Christian Schlauer proposed angular brackets around links, among
  2778. other things.
  2779. * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
  2780. `organizer-mode.el'.
  2781. * David O'Toole wrote `org-publish.el' and came up with lots is ideas
  2782. for small changes.
  2783. * Ju"rgen Vollmer contributed code generating the table of contents
  2784. in HTML output.
  2785. * Chris Wallace provided a patch implementing the `QUOTE' keyword.
  2786. * David Wainberg suggested archiving, and improvements to the linking
  2787. system.
  2788. * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
  2789. development of Org-mode was fully independent, and both systems are
  2790. really different beasts in their basic ideas and implementation
  2791. details. However, I have later looked at John's code and learned
  2792. from his implementation of (i) links where the link itself is
  2793. hidden and only a description is shown, and (ii) popping up a
  2794. calendar to select a date.
  2795. * Carsten Wimmer suggested some changes and helped fix a bug in
  2796. linking to GNUS.
  2797. * Roland Winkler requested additional keybindings to make Org-mode
  2798. work on a tty.
  2799. * Piotr Zielinski wrote `org-mouse.el' and showed how to follow links
  2800. with mouse-1.
  2801. 
  2802. File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
  2803. 11 Index
  2804. ********
  2805. �[index�]
  2806. * Menu:
  2807. * acknowledgments: Acknowledgments. (line 6)
  2808. * active region <1>: HTML export. (line 10)
  2809. * active region <2>: ASCII export. (line 9)
  2810. * active region <3>: Built-in table editor.
  2811. (line 165)
  2812. * active region: Structure editing. (line 51)
  2813. * agenda: Weekly/Daily agenda. (line 6)
  2814. * agenda commands, custom: Agenda dispatcher. (line 6)
  2815. * agenda dispatcher: Agenda dispatcher. (line 6)
  2816. * agenda files, removing buffers: Agenda commands. (line 195)
  2817. * agenda views: Agenda views. (line 6)
  2818. * agenda, for single file: Timeline. (line 6)
  2819. * allout.el, conflict with: FAQ. (line 6)
  2820. * angular brackets, around links: External links. (line 35)
  2821. * applescript, for calendar update: iCalendar export. (line 38)
  2822. * archive locations: Archiving. (line 13)
  2823. * archiving: Archiving. (line 6)
  2824. * ASCII export: ASCII export. (line 6)
  2825. * author: Feedback. (line 6)
  2826. * autoload: Installation and activation.
  2827. (line 6)
  2828. * BBDB links: External links. (line 6)
  2829. * bold text: Enhancing text. (line 15)
  2830. * bug reports: Feedback. (line 6)
  2831. * bugs: Bugs. (line 6)
  2832. * calc package: Table calculations. (line 6)
  2833. * calc.el: Interaction. (line 18)
  2834. * calculations, in tables <1>: Table calculations. (line 6)
  2835. * calculations, in tables: Built-in table editor.
  2836. (line 135)
  2837. * calendar integration: Calendar/Diary integration.
  2838. (line 6)
  2839. * calendar, for selecting date: Creating timestamps. (line 68)
  2840. * CamelCase link completion: Completion. (line 6)
  2841. * CamelCase links: Internal links. (line 6)
  2842. * CamelCase links, completion of: CamelCase links. (line 6)
  2843. * category: Categories. (line 6)
  2844. * children, subtree visibility state: Visibility cycling. (line 10)
  2845. * clean outline view: Clean view. (line 6)
  2846. * column formula: Column formulas. (line 6)
  2847. * commands, in agenda buffer: Agenda commands. (line 6)
  2848. * comment lines: Comment lines. (line 6)
  2849. * completion, of CamelCase links <1>: Completion. (line 6)
  2850. * completion, of CamelCase links: CamelCase links. (line 6)
  2851. * completion, of dictionary words: Completion. (line 6)
  2852. * completion, of file names: Handling links. (line 40)
  2853. * completion, of links: Handling links. (line 28)
  2854. * completion, of option keywords <1>: Completion. (line 6)
  2855. * completion, of option keywords: Export options. (line 6)
  2856. * Completion, of option keywords: Per file keywords. (line 17)
  2857. * completion, of tags <1>: Completion. (line 6)
  2858. * completion, of tags: Setting tags. (line 12)
  2859. * completion, of TeX symbols <1>: Completion. (line 6)
  2860. * completion, of TeX symbols: Enhancing text. (line 19)
  2861. * completion, of TODO keywords <1>: Completion. (line 6)
  2862. * completion, of TODO keywords: Workflow states. (line 12)
  2863. * constants, in calculations: Formula syntax. (line 26)
  2864. * constants.el: Interaction. (line 28)
  2865. * contents, global visibility state: Visibility cycling. (line 19)
  2866. * copying, of subtrees: Structure editing. (line 6)
  2867. * creating timestamps: Creating timestamps. (line 6)
  2868. * CUA.el: Interaction. (line 40)
  2869. * custom agenda commands: Agenda dispatcher. (line 6)
  2870. * custom search strings: Custom searches. (line 6)
  2871. * customization: Customization. (line 6)
  2872. * cutting, of subtrees: Structure editing. (line 6)
  2873. * cycling, of TODO states: TODO basics. (line 13)
  2874. * cycling, visibility: Visibility cycling. (line 6)
  2875. * dangerous commands: FAQ. (line 48)
  2876. * date stamps: Time stamps. (line 6)
  2877. * date, reading in minibuffer: Creating timestamps. (line 68)
  2878. * DEADLINE keyword: Time stamps. (line 43)
  2879. * deadlines: Time stamps. (line 6)
  2880. * demotion, of subtrees: Structure editing. (line 6)
  2881. * diary entries, creating from agenda: Agenda commands. (line 153)
  2882. * diary integration: Calendar/Diary integration.
  2883. (line 6)
  2884. * dictionary word completion: Completion. (line 6)
  2885. * dispatching agenda commands: Agenda dispatcher. (line 6)
  2886. * document structure: Document structure. (line 6)
  2887. * DONE, final TODO keyword: Per file keywords. (line 20)
  2888. * editing tables: Tables. (line 6)
  2889. * editing, of table formulas: Editing/debugging formulas.
  2890. (line 6)
  2891. * emphasized text: Export options. (line 25)
  2892. * enhancing text: Enhancing text. (line 6)
  2893. * evaluate time range: Creating timestamps. (line 63)
  2894. * exporting: Exporting. (line 6)
  2895. * exporting a subtree: FAQ. (line 89)
  2896. * exporting, not: Comment lines. (line 6)
  2897. * extended TODO keywords: TODO extensions. (line 6)
  2898. * external links: External links. (line 6)
  2899. * FAQ: FAQ. (line 6)
  2900. * feedback: Feedback. (line 6)
  2901. * file links: External links. (line 6)
  2902. * file links, searching: Search options. (line 6)
  2903. * file name completion: Handling links. (line 40)
  2904. * files, adding to agenda list: Agenda files. (line 12)
  2905. * filing subtrees: Archiving. (line 6)
  2906. * fixed width: Enhancing text. (line 30)
  2907. * fixed-width sections: Export options. (line 25)
  2908. * folded, subtree visibility state: Visibility cycling. (line 10)
  2909. * folding, sparse trees: Sparse trees. (line 6)
  2910. * following links: Handling links. (line 55)
  2911. * format specifier: Formula syntax. (line 34)
  2912. * format, of links: Link format. (line 6)
  2913. * formula editing: Editing/debugging formulas.
  2914. (line 6)
  2915. * formula syntax: Formula syntax. (line 6)
  2916. * formula, for named table field: Named-field formulas.
  2917. (line 6)
  2918. * formula, for table column: Column formulas. (line 6)
  2919. * formula, in tables: Built-in table editor.
  2920. (line 135)
  2921. * global keybindings: Installation and activation.
  2922. (line 6)
  2923. * global TODO list: Global TODO list. (line 6)
  2924. * global visibility states: Visibility cycling. (line 19)
  2925. * GNUS links: External links. (line 6)
  2926. * hand-formatted lists: Enhancing text. (line 11)
  2927. * headline levels: Export options. (line 25)
  2928. * headline levels, for exporting <1>: HTML export. (line 21)
  2929. * headline levels, for exporting: ASCII export. (line 18)
  2930. * headline navigation: Motion. (line 6)
  2931. * headline tagging: Tags. (line 6)
  2932. * headline, promotion and demotion: Structure editing. (line 6)
  2933. * headlines: Headlines. (line 6)
  2934. * hide text: Visibility cycling. (line 6)
  2935. * hiding leading stars: Clean view. (line 6)
  2936. * HTML export: HTML export. (line 6)
  2937. * hyperlinks: Hyperlinks. (line 6)
  2938. * iCalendar export: iCalendar export. (line 6)
  2939. * in-buffer settings: Summary of in-buffer settings.
  2940. (line 6)
  2941. * indentation, of tables: FAQ. (line 113)
  2942. * indirect buffers: FAQ. (line 65)
  2943. * inheritance, of tags: Tag inheritance. (line 6)
  2944. * inserting links: Handling links. (line 28)
  2945. * installation: Installation and activation.
  2946. (line 6)
  2947. * internal links: Internal links. (line 6)
  2948. * introduction: Introduction. (line 6)
  2949. * italic text: Enhancing text. (line 15)
  2950. * jumping, to headlines: Motion. (line 6)
  2951. * keybindings, global: Installation and activation.
  2952. (line 6)
  2953. * keymapp nil error: FAQ. (line 6)
  2954. * keyword options: Per file keywords. (line 6)
  2955. * linebreak preservation: Export options. (line 25)
  2956. * link completion: Handling links. (line 28)
  2957. * link format: Link format. (line 6)
  2958. * links, external: External links. (line 6)
  2959. * links, internal: Internal links. (line 6)
  2960. * links, returning to: Handling links. (line 81)
  2961. * Lisp forms, as table fomulas: Lisp formulas. (line 6)
  2962. * lists, hand-formatted: Enhancing text. (line 11)
  2963. * lists, ordered: Plain lists. (line 6)
  2964. * lists, plain: Plain lists. (line 6)
  2965. * logging, of progress: Progress logging. (line 6)
  2966. * maintainer: Feedback. (line 6)
  2967. * make-indirect-buffer: FAQ. (line 65)
  2968. * mark ring: Handling links. (line 77)
  2969. * marking characters, tables: Advanced features. (line 34)
  2970. * matching, of tags: Matching headline tags.
  2971. (line 6)
  2972. * matching, tags: Tags. (line 6)
  2973. * MH-E links: External links. (line 6)
  2974. * minor mode for tables: orgtbl-mode. (line 6)
  2975. * mode, for calc: Formula syntax. (line 34)
  2976. * motion, between headlines: Motion. (line 6)
  2977. * name, of column or field: Formula syntax. (line 26)
  2978. * named field formula: Named-field formulas.
  2979. (line 6)
  2980. * names as TODO keywords: TODO types. (line 6)
  2981. * narrow columns in tables: Narrow columns. (line 6)
  2982. * occur, command: Sparse trees. (line 6)
  2983. * option keyword completion: Completion. (line 6)
  2984. * options, for customization: Customization. (line 6)
  2985. * options, for export: Export options. (line 6)
  2986. * ordered lists: Plain lists. (line 6)
  2987. * org-agenda, command: Weekly/Daily agenda. (line 9)
  2988. * org-mode, turning on: Installation and activation.
  2989. (line 28)
  2990. * org-mouse.el: Interaction. (line 8)
  2991. * orgtbl-mode: orgtbl-mode. (line 6)
  2992. * outline tree: Headlines. (line 6)
  2993. * outline-mode: Outlines. (line 6)
  2994. * outlines: Outlines. (line 6)
  2995. * overview, global visibility state: Visibility cycling. (line 19)
  2996. * packages, interaction with other: Interaction. (line 6)
  2997. * pasting, of subtrees: Structure editing. (line 6)
  2998. * per file keywords: Per file keywords. (line 6)
  2999. * plain lists: Plain lists. (line 6)
  3000. * plain text external links: External links. (line 35)
  3001. * printing sparse trees: Sparse trees. (line 39)
  3002. * priorities: Priorities. (line 6)
  3003. * priorities, of agenda items: Sorting of agenda items.
  3004. (line 6)
  3005. * progress logging: Progress logging. (line 6)
  3006. * promotion, of subtrees: Structure editing. (line 6)
  3007. * quoted html tags: Export options. (line 25)
  3008. * ranges, time: Time stamps. (line 6)
  3009. * recomputing table fields: Column formulas. (line 27)
  3010. * region, active <1>: HTML export. (line 10)
  3011. * region, active <2>: ASCII export. (line 9)
  3012. * region, active <3>: Built-in table editor.
  3013. (line 165)
  3014. * region, active: Structure editing. (line 51)
  3015. * remember.el <1>: Interaction. (line 64)
  3016. * remember.el: Remember. (line 6)
  3017. * richer text: Enhancing text. (line 6)
  3018. * RMAIL links: External links. (line 6)
  3019. * SCHEDULED keyword: Time stamps. (line 30)
  3020. * scheduling: Time stamps. (line 6)
  3021. * search option in file links: Search options. (line 6)
  3022. * section-numbers: Export options. (line 25)
  3023. * setting tags: Setting tags. (line 6)
  3024. * SHELL links: External links. (line 6)
  3025. * shell links, confirmation: FAQ. (line 48)
  3026. * show all, command: Visibility cycling. (line 27)
  3027. * show all, global visibility state: Visibility cycling. (line 19)
  3028. * show hidden text: Visibility cycling. (line 6)
  3029. * single file summary: Timeline. (line 6)
  3030. * sorting, of agenda items: Sorting of agenda items.
  3031. (line 6)
  3032. * sparse tree, for deadlines: Creating timestamps. (line 38)
  3033. * sparse tree, for TODO: TODO basics. (line 20)
  3034. * sparse tree, tag based: Tags. (line 6)
  3035. * sparse trees: Sparse trees. (line 6)
  3036. * special keywords: Summary of in-buffer settings.
  3037. (line 6)
  3038. * spreadsheet capabilities: Table calculations. (line 6)
  3039. * storing links: Handling links. (line 9)
  3040. * structure editing: Structure editing. (line 6)
  3041. * structure of document: Document structure. (line 6)
  3042. * subtree visibility states: Visibility cycling. (line 10)
  3043. * subtree, cut and paste: Structure editing. (line 6)
  3044. * subtree, subtree visibility state: Visibility cycling. (line 10)
  3045. * subtrees, cut and paste: Structure editing. (line 6)
  3046. * summary: Summary. (line 6)
  3047. * syntax, of formulas: Formula syntax. (line 6)
  3048. * table editor, builtin: Built-in table editor.
  3049. (line 6)
  3050. * table editor, table.el: table.el. (line 6)
  3051. * table of contents: Export options. (line 25)
  3052. * table.el <1>: Interaction. (line 14)
  3053. * table.el: table.el. (line 6)
  3054. * tables <1>: Export options. (line 25)
  3055. * tables: Tables. (line 6)
  3056. * tables, export: Enhancing text. (line 26)
  3057. * tag completion: Completion. (line 6)
  3058. * tag searches: Tag searches. (line 6)
  3059. * tags: Tags. (line 6)
  3060. * tags view: Matching headline tags.
  3061. (line 6)
  3062. * templates, for remember: Remember. (line 26)
  3063. * TeX interpretation: Enhancing text. (line 17)
  3064. * TeX macros: Export options. (line 25)
  3065. * TeX symbol completion: Completion. (line 6)
  3066. * TeX-like syntax for sub- and superscripts: Export options. (line 25)
  3067. * thanks: Acknowledgments. (line 6)
  3068. * time stamps: Time stamps. (line 6)
  3069. * time, reading in minibuffer: Creating timestamps. (line 68)
  3070. * time-sorted view: Timeline. (line 6)
  3071. * timeline, single file: Timeline. (line 6)
  3072. * timerange: Time stamps. (line 21)
  3073. * timestamp: Time stamps. (line 12)
  3074. * timestamps, creating: Creating timestamps. (line 6)
  3075. * TODO items: TODO items. (line 6)
  3076. * TODO keywords completion: Completion. (line 6)
  3077. * TODO list, global: Global TODO list. (line 6)
  3078. * TODO types: TODO types. (line 6)
  3079. * TODO workflow: Workflow states. (line 6)
  3080. * transient-mark-mode <1>: HTML export. (line 10)
  3081. * transient-mark-mode <2>: ASCII export. (line 9)
  3082. * transient-mark-mode <3>: Built-in table editor.
  3083. (line 165)
  3084. * transient-mark-mode: Structure editing. (line 51)
  3085. * trees, sparse: Sparse trees. (line 6)
  3086. * trees, visibility: Visibility cycling. (line 6)
  3087. * tty keybindings: TTY keys. (line 6)
  3088. * types as TODO keywords: TODO types. (line 6)
  3089. * underlined text: Enhancing text. (line 15)
  3090. * URL links: External links. (line 6)
  3091. * USENET links: External links. (line 6)
  3092. * variables, for customization: Customization. (line 6)
  3093. * vectors, in table calculations: Formula syntax. (line 23)
  3094. * visibility cycling: Visibility cycling. (line 6)
  3095. * visible text, printing: Sparse trees. (line 39)
  3096. * VM links: External links. (line 6)
  3097. * WANDERLUST links: External links. (line 6)
  3098. * windmove.el: Interaction. (line 60)
  3099. * workflow states as TODO keywords: Workflow states. (line 6)
  3100. * XML export: XML export. (line 6)
  3101. 
  3102. File: org, Node: Key Index, Prev: Index, Up: Top
  3103. 12 Key Index
  3104. ************
  3105. �[index�]
  3106. * Menu:
  3107. * +: Agenda commands. (line 120)
  3108. * ,: Agenda commands. (line 112)
  3109. * -: Agenda commands. (line 126)
  3110. * .: Agenda commands. (line 91)
  3111. * :: Agenda commands. (line 109)
  3112. * <: Creating timestamps. (line 75)
  3113. * <left>: Agenda commands. (line 88)
  3114. * <RET> <1>: Agenda commands. (line 41)
  3115. * <RET> <2>: Creating timestamps. (line 100)
  3116. * <RET>: Built-in table editor.
  3117. (line 64)
  3118. * <right>: Agenda commands. (line 83)
  3119. * <SPC>: Agenda commands. (line 28)
  3120. * <TAB> <1>: Agenda commands. (line 35)
  3121. * <TAB> <2>: Built-in table editor.
  3122. (line 57)
  3123. * <TAB> <3>: Plain lists. (line 38)
  3124. * <TAB>: Visibility cycling. (line 10)
  3125. * > <1>: Agenda commands. (line 148)
  3126. * >: Creating timestamps. (line 76)
  3127. * C: Agenda commands. (line 178)
  3128. * c: Agenda commands. (line 162)
  3129. * C-#: Built-in table editor.
  3130. (line 155)
  3131. * C-,: Agenda files. (line 18)
  3132. * C-c !: Creating timestamps. (line 21)
  3133. * C-c $: Archiving. (line 9)
  3134. * C-c %: Handling links. (line 77)
  3135. * C-c &: Handling links. (line 81)
  3136. * C-c ' <1>: Editing/debugging formulas.
  3137. (line 20)
  3138. * C-c ': Built-in table editor.
  3139. (line 144)
  3140. * C-c *: Built-in table editor.
  3141. (line 148)
  3142. * C-c +: Built-in table editor.
  3143. (line 165)
  3144. * C-c ,: Priorities. (line 18)
  3145. * C-c -: Built-in table editor.
  3146. (line 92)
  3147. * C-c .: Creating timestamps. (line 10)
  3148. * C-c /: Sparse trees. (line 15)
  3149. * C-c :: Enhancing text. (line 34)
  3150. * C-c ;: Comment lines. (line 11)
  3151. * C-c <: Creating timestamps. (line 25)
  3152. * C-c <TAB>: Built-in table editor.
  3153. (line 187)
  3154. * C-c =: Built-in table editor.
  3155. (line 135)
  3156. * C-c >: Creating timestamps. (line 29)
  3157. * C-c ? <1>: Editing/debugging formulas.
  3158. (line 20)
  3159. * C-c ?: Built-in table editor.
  3160. (line 161)
  3161. * C-c [: Agenda files. (line 12)
  3162. * C-c \: Tag searches. (line 9)
  3163. * C-c ]: Agenda files. (line 15)
  3164. * C-c ^: Built-in table editor.
  3165. (line 96)
  3166. * C-c `: Built-in table editor.
  3167. (line 181)
  3168. * C-c a a: Weekly/Daily agenda. (line 9)
  3169. * C-c a C: Agenda dispatcher. (line 30)
  3170. * C-c a M: Matching headline tags.
  3171. (line 15)
  3172. * C-c a m: Matching headline tags.
  3173. (line 10)
  3174. * C-c a M: Tag searches. (line 14)
  3175. * C-c a m: Tag searches. (line 10)
  3176. * C-c a T: Global TODO list. (line 15)
  3177. * C-c a t <1>: Global TODO list. (line 9)
  3178. * C-c a t: TODO basics. (line 27)
  3179. * C-c C-a: Visibility cycling. (line 27)
  3180. * C-c C-b: Motion. (line 15)
  3181. * C-c C-c <1>: The very busy C-c C-c key.
  3182. (line 6)
  3183. * C-c C-c <2>: Setting tags. (line 11)
  3184. * C-c C-c <3>: table.el. (line 6)
  3185. * C-c C-c <4>: Editing/debugging formulas.
  3186. (line 16)
  3187. * C-c C-c <5>: Built-in table editor.
  3188. (line 54)
  3189. * C-c C-c: Plain lists. (line 68)
  3190. * C-c C-d <1>: Agenda commands. (line 133)
  3191. * C-c C-d: Creating timestamps. (line 37)
  3192. * C-c C-f: Motion. (line 12)
  3193. * C-c C-j: Motion. (line 21)
  3194. * C-c C-l: Handling links. (line 28)
  3195. * C-c C-n: Motion. (line 8)
  3196. * C-c C-o <1>: Creating timestamps. (line 33)
  3197. * C-c C-o: Handling links. (line 55)
  3198. * C-c C-p: Motion. (line 9)
  3199. * C-c C-q <1>: Editing/debugging formulas.
  3200. (line 20)
  3201. * C-c C-q: Built-in table editor.
  3202. (line 119)
  3203. * C-c C-r: Timeline. (line 13)
  3204. * C-c C-s <1>: Agenda commands. (line 130)
  3205. * C-c C-s: Creating timestamps. (line 47)
  3206. * C-c C-t: TODO basics. (line 13)
  3207. * C-c C-u: Motion. (line 18)
  3208. * C-c C-v: TODO basics. (line 20)
  3209. * C-c C-w: Creating timestamps. (line 38)
  3210. * C-c C-x a: ASCII export. (line 9)
  3211. * C-c C-x b: HTML export. (line 11)
  3212. * C-c C-x c: iCalendar export. (line 20)
  3213. * C-c C-x C-c: Agenda commands. (line 185)
  3214. * C-c C-x C-i: iCalendar export. (line 15)
  3215. * C-c C-x C-k: Structure editing. (line 36)
  3216. * C-c C-x C-w <1>: Built-in table editor.
  3217. (line 108)
  3218. * C-c C-x C-w: Structure editing. (line 36)
  3219. * C-c C-x C-x: XML export. (line 10)
  3220. * C-c C-x C-y <1>: Built-in table editor.
  3221. (line 112)
  3222. * C-c C-x C-y: Structure editing. (line 43)
  3223. * C-c C-x h: HTML export. (line 10)
  3224. * C-c C-x i: iCalendar export. (line 13)
  3225. * C-c C-x M-w <1>: Built-in table editor.
  3226. (line 105)
  3227. * C-c C-x M-w: Structure editing. (line 40)
  3228. * C-c C-x t: Export options. (line 13)
  3229. * C-c C-x v <1>: XML export. (line 11)
  3230. * C-c C-x v: Sparse trees. (line 39)
  3231. * C-c C-x v a: ASCII export. (line 13)
  3232. * C-c C-x v b: HTML export. (line 14)
  3233. * C-c C-x v h: HTML export. (line 14)
  3234. * C-c C-y: Creating timestamps. (line 63)
  3235. * C-c l: Handling links. (line 9)
  3236. * C-c |: Built-in table editor.
  3237. (line 40)
  3238. * C-c ~: table.el. (line 18)
  3239. * C-u C-c .: Creating timestamps. (line 16)
  3240. * C-u C-c =: Built-in table editor.
  3241. (line 139)
  3242. * C-u C-c C-l: Handling links. (line 40)
  3243. * D: Agenda commands. (line 68)
  3244. * d: Agenda commands. (line 65)
  3245. * f: Agenda commands. (line 44)
  3246. * g: Agenda commands. (line 72)
  3247. * H: Agenda commands. (line 182)
  3248. * i: Agenda commands. (line 153)
  3249. * l: Agenda commands. (line 51)
  3250. * L: Agenda commands. (line 32)
  3251. * M: Agenda commands. (line 169)
  3252. * M-<down>: Built-in table editor.
  3253. (line 82)
  3254. * M-<left> <1>: Built-in table editor.
  3255. (line 72)
  3256. * M-<left>: Structure editing. (line 18)
  3257. * M-<RET> <1>: Plain lists. (line 43)
  3258. * M-<RET>: Structure editing. (line 6)
  3259. * M-<right> <1>: Built-in table editor.
  3260. (line 72)
  3261. * M-<right>: Structure editing. (line 21)
  3262. * M-<TAB> <1>: Completion. (line 10)
  3263. * M-<TAB> <2>: Setting tags. (line 6)
  3264. * M-<TAB>: Per file keywords. (line 17)
  3265. * M-<up>: Built-in table editor.
  3266. (line 82)
  3267. * M-S-<down> <1>: Built-in table editor.
  3268. (line 89)
  3269. * M-S-<down> <2>: Plain lists. (line 53)
  3270. * M-S-<down>: Structure editing. (line 33)
  3271. * M-S-<left> <1>: Creating timestamps. (line 97)
  3272. * M-S-<left> <2>: Built-in table editor.
  3273. (line 76)
  3274. * M-S-<left> <3>: Plain lists. (line 59)
  3275. * M-S-<left>: Structure editing. (line 24)
  3276. * M-S-<RET>: Structure editing. (line 15)
  3277. * M-S-<right> <1>: Creating timestamps. (line 94)
  3278. * M-S-<right> <2>: Built-in table editor.
  3279. (line 79)
  3280. * M-S-<right> <3>: Plain lists. (line 59)
  3281. * M-S-<right>: Structure editing. (line 27)
  3282. * M-S-<up> <1>: Built-in table editor.
  3283. (line 86)
  3284. * M-S-<up> <2>: Plain lists. (line 53)
  3285. * M-S-<up>: Structure editing. (line 30)
  3286. * mouse-1 <1>: Agenda commands. (line 35)
  3287. * mouse-1 <2>: Creating timestamps. (line 79)
  3288. * mouse-1: Handling links. (line 69)
  3289. * mouse-2 <1>: Agenda commands. (line 35)
  3290. * mouse-2: Handling links. (line 69)
  3291. * mouse-3 <1>: Agenda commands. (line 28)
  3292. * mouse-3: Handling links. (line 74)
  3293. * n: Agenda commands. (line 19)
  3294. * o: Agenda commands. (line 59)
  3295. * P: Agenda commands. (line 117)
  3296. * p: Agenda commands. (line 20)
  3297. * q: Agenda commands. (line 192)
  3298. * r <1>: Agenda commands. (line 76)
  3299. * r: Global TODO list. (line 21)
  3300. * S: Agenda commands. (line 173)
  3301. * S-<down> <1>: Agenda commands. (line 126)
  3302. * S-<down> <2>: Creating timestamps. (line 55)
  3303. * S-<down>: Priorities. (line 25)
  3304. * S-<left> <1>: Agenda commands. (line 144)
  3305. * S-<left>: Creating timestamps. (line 50)
  3306. * S-<RET>: Built-in table editor.
  3307. (line 170)
  3308. * S-<right> <1>: Agenda commands. (line 136)
  3309. * S-<right>: Creating timestamps. (line 50)
  3310. * S-<TAB> <1>: Built-in table editor.
  3311. (line 61)
  3312. * S-<TAB>: Visibility cycling. (line 19)
  3313. * S-<up> <1>: Agenda commands. (line 120)
  3314. * S-<up> <2>: Creating timestamps. (line 55)
  3315. * S-<up>: Priorities. (line 25)
  3316. * T: Agenda commands. (line 104)
  3317. * t: Agenda commands. (line 100)
  3318. * w: Agenda commands. (line 62)
  3319. * x: Agenda commands. (line 195)
  3320. 
  3321. Tag Table:
  3322. Node: Top959
  3323. Node: Introduction7583
  3324. Node: Summary7897
  3325. Node: Installation and activation10005
  3326. Node: Feedback11674
  3327. Node: Document structure12460
  3328. Node: Outlines13226
  3329. Node: Headlines13886
  3330. Node: Visibility cycling14509
  3331. Node: Motion15705
  3332. Node: Structure editing16489
  3333. Node: Archiving18598
  3334. Node: Sparse trees19458
  3335. Ref: Sparse trees-Footnote-121443
  3336. Ref: Sparse trees-Footnote-221535
  3337. Node: Plain lists21650
  3338. Ref: Plain lists-Footnote-124944
  3339. Node: Tables25301
  3340. Node: Built-in table editor25849
  3341. Node: Narrow columns33462
  3342. Ref: Narrow columns-Footnote-135401
  3343. Node: Table calculations35447
  3344. Node: Formula syntax36767
  3345. Ref: Formula syntax-Footnote-139672
  3346. Node: Lisp formulas39971
  3347. Node: Column formulas40762
  3348. Node: Advanced features42523
  3349. Node: Named-field formulas45778
  3350. Node: Editing/debugging formulas46418
  3351. Node: Appetizer48176
  3352. Node: orgtbl-mode49278
  3353. Node: table.el49769
  3354. Node: Hyperlinks50746
  3355. Node: Link format51450
  3356. Node: Internal links52747
  3357. Node: Radio targets54697
  3358. Node: CamelCase links55412
  3359. Node: External links55910
  3360. Node: Handling links57835
  3361. Node: Search options62167
  3362. Ref: Search options-Footnote-163943
  3363. Node: Custom searches64024
  3364. Node: Remember65072
  3365. Ref: Remember-Footnote-168939
  3366. Node: TODO items69063
  3367. Node: TODO basics69986
  3368. Node: Progress logging71327
  3369. Node: TODO extensions72113
  3370. Node: Workflow states72913
  3371. Node: TODO types73781
  3372. Ref: TODO types-Footnote-175439
  3373. Node: Per file keywords75521
  3374. Ref: Per file keywords-Footnote-176974
  3375. Node: Priorities77202
  3376. Node: Timestamps78411
  3377. Node: Time stamps78732
  3378. Node: Creating timestamps81160
  3379. Node: Tags84289
  3380. Node: Tag inheritance85024
  3381. Node: Setting tags85961
  3382. Node: Tag searches86923
  3383. Node: Agenda views88132
  3384. Node: Agenda files89671
  3385. Ref: Agenda files-Footnote-190631
  3386. Ref: Agenda files-Footnote-290780
  3387. Node: Agenda dispatcher90972
  3388. Node: Weekly/Daily agenda93102
  3389. Node: Categories94237
  3390. Node: Time-of-day specifications94885
  3391. Node: Calendar/Diary integration96861
  3392. Node: Sorting of agenda items98238
  3393. Node: Global TODO list99070
  3394. Node: Matching headline tags100485
  3395. Node: Timeline101428
  3396. Node: Agenda commands102301
  3397. Node: Exporting107771
  3398. Node: ASCII export108901
  3399. Node: HTML export109791
  3400. Node: XML export111622
  3401. Node: iCalendar export112057
  3402. Node: Text interpretation113879
  3403. Node: Comment lines114356
  3404. Node: Enhancing text114825
  3405. Node: Export options116656
  3406. Node: Miscellaneous118258
  3407. Node: Completion119016
  3408. Node: Customization120012
  3409. Node: Summary of in-buffer settings120619
  3410. Node: The very busy C-c C-c key123380
  3411. Node: Clean view124785
  3412. Node: TTY keys127362
  3413. Node: FAQ128963
  3414. Node: Interaction135865
  3415. Node: Bugs138899
  3416. Node: Acknowledgments140853
  3417. Node: Index144222
  3418. Node: Key Index165665
  3419. 
  3420. End Tag Table