org 164 KB

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