org 158 KB

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