org 175 KB

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