org 177 KB

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