org.texi 643 KB
 Carsten Dominik committed Jul 19, 2010 1   Glenn Morris committed Sep 06, 2007 2 3 \input texinfo @c %**start of header  4 @setfilename ../../info/org  Carsten Dominik committed Apr 27, 2008 5 @settitle The Org Manual  Glenn Morris committed Sep 06, 2007 6   Bastien Guerry committed Aug 15, 2011 7 8 @set VERSION 7.7 @set DATE July 2011  Carsten Dominik committed Jul 19, 2010 9 10 11 12 13  @c Use proper quote and backtick for code sections in PDF output @c Cf. Texinfo manual 14.2 @set txicodequoteundirected @set txicodequotebacktick  Glenn Morris committed Sep 06, 2007 14 15  @c Version and Contact Info  Carsten Dominik committed Jan 18, 2008 16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}  Glenn Morris committed Sep 06, 2007 17 18 @set AUTHOR Carsten Dominik @set MAINTAINER Carsten Dominik  Carsten Dominik committed Jan 18, 2008 19 20 @set MAINTAINEREMAIL @email{carsten at orgmode dot org} @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}  Glenn Morris committed Sep 06, 2007 21 22 23 @c %**end of header @finalout  Carsten Dominik committed Dec 11, 2010 24 25 26 27 28 29 30 31 32 33 34 35 36  @c ----------------------------------------------------------------------------- @c Macro definitions for commands and keys @c ======================================= @c The behavior of the key/command macros will depend on the flag cmdnames @c When set, commands names are shown. When clear, they are not shown. @set cmdnames @c Below we define the following macros for Org key tables:  Bastien Guerry committed Aug 15, 2011 37 @c orgkey{key} A key item  Carsten Dominik committed Dec 11, 2010 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 @c orgcmd{key,cmd} Key with command name @c xorgcmd{key,cmmand} Key with command name as @itemx @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or" @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but @c different functions, so format as @itemx @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short" @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands @c a key but no command @c Inserts: @item key @macro orgkey{key} @kindex \key\ @item @kbd{\key\} @end macro @macro xorgkey{key} @kindex \key\ @itemx @kbd{\key\} @end macro @c one key with a command @c Inserts: @item KEY COMMAND  Carsten Dominik committed Nov 11, 2010 63 @macro orgcmd{key,command}  Carsten Dominik committed Dec 11, 2010 64 @ifset cmdnames  Carsten Dominik committed Nov 11, 2010 65 66 @kindex \key\ @findex \command\  Carsten Dominik committed Dec 11, 2010 67 @iftex  Carsten Dominik committed Nov 11, 2010 68 69 70 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\} @end iftex @ifnottex  Carsten Dominik committed Dec 11, 2010 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) @end ifnottex @end ifset @ifclear cmdnames @kindex \key\ @item @kbd{\key\} @end ifclear @end macro @c One key with one command, formatted using @itemx @c Inserts: @itemx KEY COMMAND @macro xorgcmd{key,command} @ifset cmdnames @kindex \key\ @findex \command\ @iftex @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\} @end iftex @ifnottex @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) @end ifnottex @end ifset @ifclear cmdnames  Carsten Dominik committed Nov 11, 2010 94 @kindex \key\  Carsten Dominik committed Dec 11, 2010 95 96 97 98 99 100 101 102 @itemx @kbd{\key\} @end ifclear @end macro @c one key with a command, bit do not index the key @c Inserts: @item KEY COMMAND @macro orgcmdnki{key,command} @ifset cmdnames  Carsten Dominik committed Nov 11, 2010 103 @findex \command\  Carsten Dominik committed Dec 11, 2010 104 105 106 107 @iftex @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\} @end iftex @ifnottex  Carsten Dominik committed Nov 11, 2010 108 109 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) @end ifnottex  Carsten Dominik committed Dec 11, 2010 110 111 112 113 @end ifset @ifclear cmdnames @item @kbd{\key\} @end ifclear  Carsten Dominik committed Nov 11, 2010 114 115 @end macro  Carsten Dominik committed Dec 11, 2010 116 117 118 119 @c one key with a command, and special text to replace key in item @c Inserts: @item TEXT COMMAND @macro orgcmdtkc{text,key,command} @ifset cmdnames  Carsten Dominik committed Nov 11, 2010 120 @kindex \key\  Carsten Dominik committed Dec 11, 2010 121 122 123 124 125 126 127 128 129 130 131 132 @findex \command\ @iftex @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\} @end iftex @ifnottex @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) @end ifnottex @end ifset @ifclear cmdnames @kindex \key\ @item @kbd{\text\} @end ifclear  Carsten Dominik committed Nov 11, 2010 133 134 @end macro  Carsten Dominik committed Dec 11, 2010 135 136 137 138 139 140 141 @c two keys with one command @c Inserts: @item KEY1 or KEY2 COMMAND @macro orgcmdkkc{key1,key2,command} @ifset cmdnames @kindex \key1\ @kindex \key2\ @findex \command\  Carsten Dominik committed Aug 06, 2009 142 @iftex  Carsten Dominik committed Dec 11, 2010 143 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}  Carsten Dominik committed Aug 06, 2009 144 @end iftex  Carsten Dominik committed Dec 11, 2010 145 146 147 148 149 150 151 152 153 @ifnottex @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) @end ifnottex @end ifset @ifclear cmdnames @kindex \key1\ @kindex \key2\ @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @end ifclear  Carsten Dominik committed Aug 06, 2009 154 @end macro  Carsten Dominik committed Dec 11, 2010 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179  @c Two keys with one command name, but different functions, so format as @c @itemx @c Inserts: @item KEY1 @c @itemx KEY2 COMMAND @macro orgcmdkxkc{key1,key2,command} @ifset cmdnames @kindex \key1\ @kindex \key2\ @findex \command\ @iftex @item @kbd{\key1\} @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} @end iftex @ifnottex @item @kbd{\key1\} @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) @end ifnottex @end ifset @ifclear cmdnames @kindex \key1\ @kindex \key2\ @item @kbd{\key1\} @itemx @kbd{\key2\} @end ifclear  Carsten Dominik committed Aug 06, 2009 180 @end macro  Carsten Dominik committed Dec 11, 2010 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200  @c Same as previous, but use "or short" @c Inserts: @item KEY1 or short KEY2 COMMAND @macro orgcmdkskc{key1,key2,command} @ifset cmdnames @kindex \key1\ @kindex \key2\ @findex \command\ @iftex @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} @end iftex @ifnottex @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) @end ifnottex @end ifset @ifclear cmdnames @kindex \key1\ @kindex \key2\ @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @end ifclear  Carsten Dominik committed Aug 06, 2009 201 @end macro  Carsten Dominik committed Dec 11, 2010 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221  @c Same as previous, but use @itemx @c Inserts: @itemx KEY1 or short KEY2 COMMAND @macro xorgcmdkskc{key1,key2,command} @ifset cmdnames @kindex \key1\ @kindex \key2\ @findex \command\ @iftex @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} @end iftex @ifnottex @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) @end ifnottex @end ifset @ifclear cmdnames @kindex \key1\ @kindex \key2\ @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @end ifclear  Carsten Dominik committed Aug 06, 2009 222 @end macro  Glenn Morris committed Sep 06, 2007 223   Carsten Dominik committed Dec 11, 2010 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 @c two keys with two commands @c Inserts: @item KEY1 COMMAND1 @c @itemx KEY2 COMMAND2 @macro orgcmdkkcc{key1,key2,command1,command2} @ifset cmdnames @kindex \key1\ @kindex \key2\ @findex \command1\ @findex \command2\ @iftex @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\} @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\} @end iftex @ifnottex @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\}) @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\}) @end ifnottex @end ifset @ifclear cmdnames @kindex \key1\ @kindex \key2\ @item @kbd{\key1\} @itemx @kbd{\key2\} @end ifclear @end macro @c ----------------------------------------------------------------------------- @iftex @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed} @end iftex  Glenn Morris committed Sep 06, 2007 255 256 257 258 259 260 261 262 263 264 265 @c Subheadings inside a table. @macro tsubheading{text} @ifinfo @subsubheading \text\ @end ifinfo @ifnotinfo @item @b{\text\} @end ifnotinfo @end macro @copying  Carsten Dominik committed Aug 06, 2009 266 This manual is for Org version @value{VERSION}.  Glenn Morris committed Sep 06, 2007 267   Bastien Guerry committed Aug 15, 2011 268 269 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.  Glenn Morris committed Sep 06, 2007 270 271 272  @quotation Permission is granted to copy, distribute and/or modify this document  Carsten Dominik committed Nov 24, 2008 273 under the terms of the GNU Free Documentation License, Version 1.3 or  Glenn Morris committed Sep 06, 2007 274 275 any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being A GNU Manual,''  Glenn Morris committed Aug 10, 2008 276 277 and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled GNU Free Documentation License.''  Glenn Morris committed Sep 06, 2007 278   Glenn Morris committed Jun 13, 2008 279 280 281 (a) The FSF's Back-Cover Text is: You have the freedom to copy and modify this GNU manual. Buying copies from the FSF supports it in developing GNU and promoting software freedom.''  Glenn Morris committed Jun 15, 2008 282 283 284 285 286  This document is part of a collection distributed under the GNU Free Documentation License. If you want to distribute this document separately from the collection, you can do so by adding a copy of the license to the document, as described in section 6 of the license.  Glenn Morris committed Sep 06, 2007 287 288 289 @end quotation @end copying  Bastien Guerry committed Aug 15, 2011 290 @dircategory Emacs  Karl Berry committed Feb 16, 2009 291 @direntry  Carsten Dominik committed Jul 19, 2010 292 * Org Mode: (org). Outline-based notes management and organizer  Karl Berry committed Feb 16, 2009 293 294 @end direntry  Glenn Morris committed Sep 06, 2007 295 @titlepage  Carsten Dominik committed Apr 27, 2008 296 @title The Org Manual  Glenn Morris committed Sep 06, 2007 297 298 299  @subtitle Release @value{VERSION} @author by Carsten Dominik  Carsten Dominik committed Jul 19, 2010 300 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, and Thomas Dye  Glenn Morris committed Sep 06, 2007 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318  @c The following two commands start the copyright page. @page @vskip 0pt plus 1filll @insertcopying @end titlepage @c Output the table of contents at the beginning. @contents @ifnottex @node Top, Introduction, (dir), (dir) @top Org Mode Manual @insertcopying @end ifnottex @menu  Glenn Morris committed Sep 08, 2010 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 * Introduction:: Getting started * Document Structure:: A tree works like your brain * Tables:: Pure magic for quick formatting * Hyperlinks:: Notes in context * TODO Items:: Every tree branch can be a TODO item * Tags:: Tagging headlines and matching sets of tags * Properties and Columns:: Storing information about an entry * Dates and Times:: Making items useful for planning * Capture - Refile - Archive:: The ins and outs for projects * Agenda Views:: Collecting information into views * Markup:: Prepare text for rich export * Exporting:: Sharing and publishing of notes * Publishing:: Create a web site of linked Org files * Working With Source Code:: Export, evaluate, and tangle code blocks * Miscellaneous:: All the rest which did not fit elsewhere * Hacking:: How to hack your way around * MobileOrg:: Viewing and capture on a mobile device * History and Acknowledgments:: How Org came into being * Main Index:: An index of Org's concepts and features * Key Index:: Key bindings and where they are described  Carsten Dominik committed Nov 11, 2010 339 * Command and Function Index:: Command names and some internal functions  Glenn Morris committed Sep 08, 2010 340 * Variable Index:: Variables mentioned in the manual  Glenn Morris committed Sep 06, 2007 341 342 343 344 345 346  @detailmenu --- The Detailed Node Listing --- Introduction  Glenn Morris committed Sep 08, 2010 347 348 349 350 351 * Summary:: Brief summary of what Org does * Installation:: How to install a downloaded version of Org * Activation:: How to activate Org for certain buffers * Feedback:: Bug reports, ideas, patches etc. * Conventions:: Type-setting conventions in the manual  Carsten Dominik committed Jul 19, 2010 352 353 354  Document structure  Glenn Morris committed Sep 08, 2010 355 356 357 358 359 360 361 362 363 364 365 * Outlines:: Org is based on Outline mode * Headlines:: How to typeset Org tree headlines * Visibility cycling:: Show and hide, much simplified * Motion:: Jumping to other headlines * Structure editing:: Changing sequence and level of headlines * Sparse trees:: Matches embedded in context * Plain lists:: Additional structure within an entry * Drawers:: Tucking stuff away * Blocks:: Folding blocks * Footnotes:: How footnotes are defined in Org's syntax * Orgstruct mode:: Structure editing outside Org  Glenn Morris committed Sep 06, 2007 366 367 368  Tables  Glenn Morris committed Sep 08, 2010 369 370 371 372 373 374 * Built-in table editor:: Simple tables * Column width and alignment:: Overrule the automatic settings * Column groups:: Grouping to trigger vertical lines * Orgtbl mode:: The table editor as minor mode * The spreadsheet:: The table editor has spreadsheet capabilities * Org-Plot:: Plotting from org tables  Glenn Morris committed Sep 06, 2007 375 376 377  The spreadsheet  Glenn Morris committed Sep 08, 2010 378 379 380 * References:: How to refer to another field or range * Formula syntax for Calc:: Using Calc to compute stuff * Formula syntax for Lisp:: Writing formulas in Emacs Lisp  Bastien Guerry committed Aug 15, 2011 381 382 * Durations and time values:: How to compute durations and time values * Field and range formulas:: Formula for specific (ranges of) fields  Glenn Morris committed Sep 08, 2010 383 * Column formulas:: Formulas valid for an entire column  Glenn Morris committed Sep 06, 2007 384 * Editing and debugging formulas:: Fixing formulas  Glenn Morris committed Sep 08, 2010 385 386 * Updating the table:: Recomputing all dependent fields * Advanced features:: Field names, parameters and automatic recalc  Glenn Morris committed Sep 06, 2007 387 388 389  Hyperlinks  Glenn Morris committed Sep 08, 2010 390 391 392 393 394 395 396 397 * Link format:: How links in Org are formatted * Internal links:: Links to other places in the current file * External links:: URL-like links to the world * Handling links:: Creating, inserting and following * Using links outside Org:: Linking from my C source code? * Link abbreviations:: Shortcuts for writing complex links * Search options:: Linking to a specific location * Custom searches:: When the default search is not enough  Glenn Morris committed Sep 06, 2007 398 399 400  Internal links  Glenn Morris committed Sep 08, 2010 401 * Radio targets:: Make targets trigger links in plain text  Glenn Morris committed Sep 06, 2007 402   Carsten Dominik committed Jul 19, 2010 403 TODO items  Glenn Morris committed Sep 06, 2007 404   Glenn Morris committed Sep 08, 2010 405 406 407 408 409 410 * TODO basics:: Marking and displaying TODO entries * TODO extensions:: Workflow and assignments * Progress logging:: Dates and notes for progress * Priorities:: Some things are more important than others * Breaking down tasks:: Splitting a task into manageable pieces * Checkboxes:: Tick-off lists  Glenn Morris committed Sep 06, 2007 411 412 413  Extended use of TODO keywords  Glenn Morris committed Sep 08, 2010 414 415 416 417 418 419 420 * Workflow states:: From TODO to DONE in steps * TODO types:: I do this, Fred does the rest * Multiple sets in one file:: Mixing it all, and still finding your way * Fast access to TODO states:: Single letter selection of a state * Per-file keywords:: Different files, different requirements * Faces for TODO keywords:: Highlighting states * TODO dependencies:: When one task needs to wait for others  Carsten Dominik committed Jan 18, 2008 421   Carsten Dominik committed Apr 27, 2008 422 Progress logging  Carsten Dominik committed Jan 18, 2008 423   Glenn Morris committed Sep 08, 2010 424 425 426 * Closing items:: When was this entry marked DONE? * Tracking TODO state changes:: When did the status change? * Tracking your habits:: How consistent have you been?  Glenn Morris committed Sep 06, 2007 427 428 429  Tags  Glenn Morris committed Sep 08, 2010 430 431 432 * Tag inheritance:: Tags use the tree structure of the outline * Setting tags:: How to assign tags to a headline * Tag searches:: Searching for combinations of tags  Glenn Morris committed Sep 06, 2007 433   Carsten Dominik committed Jul 19, 2010 434 Properties and columns  Glenn Morris committed Sep 06, 2007 435   Glenn Morris committed Sep 08, 2010 436 437 438 439 440 441 * Property syntax:: How properties are spelled out * Special properties:: Access to other Org-mode features * Property searches:: Matching property values * Property inheritance:: Passing values down the tree * Column view:: Tabular viewing and editing * Property API:: Properties for Lisp programmers  Glenn Morris committed Sep 06, 2007 442   Carsten Dominik committed Apr 27, 2008 443 Column view  Glenn Morris committed Sep 06, 2007 444   Glenn Morris committed Sep 08, 2010 445 446 447 * Defining columns:: The COLUMNS format property * Using column view:: How to create and use column view * Capturing column view:: A dynamic block for column view  Glenn Morris committed Sep 06, 2007 448   Carsten Dominik committed Apr 27, 2008 449 Defining columns  Glenn Morris committed Sep 06, 2007 450   Glenn Morris committed Sep 08, 2010 451 452 * Scope of column definitions:: Where defined, where valid? * Column attributes:: Appearance and content of a column  Glenn Morris committed Sep 06, 2007 453   Carsten Dominik committed Jul 19, 2010 454 Dates and times  Glenn Morris committed Sep 06, 2007 455   Glenn Morris committed Sep 08, 2010 456 457 458 459 460 461 * Timestamps:: Assigning a time to a tree entry * Creating timestamps:: Commands which insert timestamps * Deadlines and scheduling:: Planning your work * Clocking work time:: Tracking how long you spend on a task * Effort estimates:: Planning work effort in advance * Relative timer:: Notes with a running timer  Carsten Dominik committed Nov 11, 2010 462 * Countdown timer:: Starting a countdown timer for a task  Glenn Morris committed Sep 06, 2007 463 464 465  Creating timestamps  Glenn Morris committed Sep 08, 2010 466 467 * The date/time prompt:: How Org-mode helps you entering date and time * Custom time format:: Making dates look different  Glenn Morris committed Sep 06, 2007 468   Carsten Dominik committed Apr 27, 2008 469 Deadlines and scheduling  Glenn Morris committed Sep 06, 2007 470   Glenn Morris committed Sep 08, 2010 471 472 * Inserting deadline/schedule:: Planning items * Repeated tasks:: Items that show up again and again  Glenn Morris committed Sep 06, 2007 473   Carsten Dominik committed Dec 11, 2010 474 475 476 477 478 479 Clocking work time * Clocking commands:: Starting and stopping a clock * The clock table:: Detailed reports * Resolving idle time:: Resolving time when you've been idle  Carsten Dominik committed Nov 13, 2009 480 Capture - Refile - Archive  Carsten Dominik committed Oct 12, 2008 481   Glenn Morris committed Sep 08, 2010 482 483 484 * Capture:: Capturing new stuff * Attachments:: Add files to tasks * RSS Feeds:: Getting input from RSS feeds  Bastien Guerry committed Aug 15, 2011 485 * Protocols:: External (e.g.@: Browser) access to Emacs and Org  Glenn Morris committed Sep 08, 2010 486 487 * Refiling notes:: Moving a tree from one place to another * Archiving:: What to do with finished projects  Carsten Dominik committed Jul 19, 2010 488 489 490  Capture  Glenn Morris committed Sep 08, 2010 491 492 493 * Setting up capture:: Where notes will be stored * Using capture:: Commands to invoke and terminate capture * Capture templates:: Define the outline of different note types  Carsten Dominik committed Oct 12, 2008 494   Carsten Dominik committed Jul 19, 2010 495 Capture templates  Glenn Morris committed Sep 06, 2007 496   Glenn Morris committed Sep 08, 2010 497 498 * Template elements:: What is needed for a complete template entry * Template expansion:: Filling in information about time and context  Carsten Dominik committed Nov 13, 2009 499 500 501  Archiving  Glenn Morris committed Sep 08, 2010 502 503 * Moving subtrees:: Moving a tree to an archive file * Internal archiving:: Switch off a tree but keep it in the file  Glenn Morris committed Sep 06, 2007 504   Carsten Dominik committed Jul 19, 2010 505 Agenda views  Glenn Morris committed Sep 06, 2007 506   Glenn Morris committed Sep 08, 2010 507 508 509 510 511 512 513 514 * Agenda files:: Files being searched for agenda information * Agenda dispatcher:: Keyboard access to agenda views * Built-in agenda views:: What is available out of the box? * Presentation and sorting:: How agenda items are prepared for display * Agenda commands:: Remote editing of Org trees * Custom agenda views:: Defining special searches and views * Exporting Agenda Views:: Writing a view to a file * Agenda column view:: Using column view for collected entries  Glenn Morris committed Sep 06, 2007 515 516 517  The built-in agenda views  Glenn Morris committed Sep 08, 2010 518 519 * Weekly/daily agenda:: The calendar page with current tasks * Global TODO list:: All unfinished action items  Glenn Morris committed Sep 06, 2007 520 * Matching tags and properties:: Structured information with fine-tuned search  Glenn Morris committed Sep 08, 2010 521 522 523 * Timeline:: Time-sorted view for single file * Search view:: Find entries by searching for text * Stuck projects:: Find projects you need to review  Glenn Morris committed Sep 06, 2007 524 525 526  Presentation and sorting  Glenn Morris committed Sep 08, 2010 527 528 529 * Categories:: Not all tasks are equal * Time-of-day specifications:: How the agenda knows the time * Sorting of agenda items:: The order of things  Glenn Morris committed Sep 06, 2007 530 531 532  Custom agenda views  Glenn Morris committed Sep 08, 2010 533 534 535 * Storing searches:: Type once, use often * Block agenda:: All the stuff you need in a single buffer * Setting Options:: Changing the rules  Glenn Morris committed Sep 06, 2007 536   Carsten Dominik committed Nov 13, 2009 537 538 Markup for rich export  Glenn Morris committed Sep 08, 2010 539 540 541 542 543 544 545 * Structural markup elements:: The basic structure as seen by the exporter * Images and tables:: Tables and Images will be included * Literal examples:: Source code examples with special formatting * Include files:: Include additional files into a document * Index entries:: Making an index * Macro replacement:: Use macros to create complex output * Embedded LaTeX:: LaTeX can be freely used inside Org documents  Carsten Dominik committed Nov 13, 2009 546 547 548  Structural markup elements  Glenn Morris committed Sep 08, 2010 549 550 551 552 553 554 555 556 557 558 * Document title:: Where the title is taken from * Headings and sections:: The document structure as seen by the exporter * Table of contents:: The if and where of the table of contents * Initial text:: Text before the first heading? * Lists:: Lists * Paragraphs:: Paragraphs * Footnote markup:: Footnotes * Emphasis and monospace:: Bold, italic, etc. * Horizontal rules:: Make a line * Comment lines:: What will *not* be exported  Carsten Dominik committed Nov 13, 2009 559   Carsten Dominik committed Dec 11, 2010 560 Embedded @LaTeX{}  Glenn Morris committed Sep 06, 2007 561   Glenn Morris committed Sep 08, 2010 562 563 564 565 566 * Special symbols:: Greek letters and other symbols * Subscripts and superscripts:: Simple syntax for raising/lowering text * LaTeX fragments:: Complex formulas made easy * Previewing LaTeX fragments:: What will this snippet look like? * CDLaTeX mode:: Speed up entering of formulas  Glenn Morris committed Sep 06, 2007 567 568 569  Exporting  Glenn Morris committed Sep 08, 2010 570 571 572 573 574 * Selective export:: Using tags to select and exclude trees * Export options:: Per-file export settings * The export dispatcher:: How to access exporter commands * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding * HTML export:: Exporting to HTML  Carsten Dominik committed Dec 11, 2010 575 * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF  Glenn Morris committed Sep 08, 2010 576 * DocBook export:: Exporting to DocBook  Bastien Guerry committed Aug 15, 2011 577 * OpenDocumentText export:: Exporting to OpenDocumentText  Glenn Morris committed Sep 08, 2010 578 579 580 581 * TaskJuggler export:: Exporting to TaskJuggler * Freemind export:: Exporting to Freemind mind maps * XOXO export:: Exporting to XOXO * iCalendar export:: Exporting in iCalendar format  Carsten Dominik committed Jun 17, 2008 582   Glenn Morris committed Sep 06, 2007 583 584 HTML export  Glenn Morris committed Sep 08, 2010 585 * HTML Export commands:: How to invoke HTML export  Bastien Guerry committed Aug 15, 2011 586 * HTML preamble and postamble:: How to insert a preamble and a postamble  Glenn Morris committed Sep 08, 2010 587 588 589 590 * Quoting HTML tags:: Using direct HTML in Org-mode * Links in HTML export:: How links will be interpreted and formatted * Tables in HTML export:: How to modify the formatting of tables * Images in HTML export:: How to insert figures into HTML output  Carsten Dominik committed Nov 11, 2010 591 * Math formatting in HTML export:: Beautiful math also on the web  Glenn Morris committed Sep 08, 2010 592 593 594 * Text areas in HTML export:: An alternative way to show an example * CSS support:: Changing the appearance of the output * JavaScript support:: Info and Folding in a web browser  Glenn Morris committed Sep 06, 2007 595   Carsten Dominik committed Dec 11, 2010 596 @LaTeX{} and PDF export  Glenn Morris committed Sep 06, 2007 597   Glenn Morris committed Sep 08, 2010 598 599 * LaTeX/PDF export commands:: Which key invokes which commands * Header and sectioning:: Setting up the export file structure  Carsten Dominik committed Dec 11, 2010 600 601 602 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code * Tables in LaTeX export:: Options for exporting tables to @LaTeX{} * Images in LaTeX export:: How to insert figures into @LaTeX{} output  Glenn Morris committed Sep 08, 2010 603 * Beamer class export:: Turning the file into a presentation  Carsten Dominik committed Aug 06, 2009 604 605 606  DocBook export  Glenn Morris committed Sep 08, 2010 607 608 609 610 611 612 * DocBook export commands:: How to invoke DocBook export * Quoting DocBook code:: Incorporating DocBook code in Org files * Recursive sections:: Recursive sections in DocBook * Tables in DocBook export:: Tables are exported as HTML tables * Images in DocBook export:: How to insert figures into DocBook output * Special characters:: How to handle special characters  Glenn Morris committed Sep 06, 2007 613   Bastien Guerry committed Aug 15, 2011 614 615 616 617 618 619 620 621 622 623 OpenDocument export * OpenDocumentText export commands:: How to invoke OpenDocumentText export * Applying Custom Styles:: How to apply custom styles to the output * Converting to Other formats:: How to convert to formats like doc, docx etc * Links in OpenDocumentText export:: How links will be interpreted and formatted * Tables in OpenDocumentText export:: How Tables are handled * Images in OpenDocumentText export:: How to insert figures * Additional Documentation:: How to handle special characters  Glenn Morris committed Sep 06, 2007 624 625 Publishing  Glenn Morris committed Sep 08, 2010 626 627 628 629 * Configuration:: Defining projects * Uploading files:: How to get files up on the server * Sample configuration:: Example projects * Triggering publication:: Publication commands  Glenn Morris committed Sep 06, 2007 630 631 632  Configuration  Glenn Morris committed Sep 08, 2010 633 634 635 636 * Project alist:: The central configuration variable * Sources and destinations:: From here to there * Selecting files:: What files are part of the project? * Publishing action:: Setting the function doing the publishing  Bastien Guerry committed Aug 15, 2011 637 * Publishing options:: Tweaking HTML/@LaTeX{} export  Glenn Morris committed Sep 08, 2010 638 639 640 * Publishing links:: Which links keep working after publishing? * Sitemap:: Generating a list of all pages * Generating an index:: An index that reaches across pages  Glenn Morris committed Sep 06, 2007 641 642 643  Sample configuration  Glenn Morris committed Sep 08, 2010 644 645 * Simple example:: One-component publishing * Complex example:: A multi-component publishing example  Carsten Dominik committed Jul 19, 2010 646 647 648  Working with source code  Glenn Morris committed Sep 08, 2010 649 650 651 652 653 654 655 656 657 658 * Structure of code blocks:: Code block syntax described * Editing source code:: Language major-mode editing * Exporting code blocks:: Export contents and/or results * Extracting source code:: Create pure source code files * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer * Library of Babel:: Use and contribute to a library of useful code blocks * Languages:: List of supported code block languages * Header arguments:: Configure code block functionality * Results of evaluation:: How evaluation results are handled * Noweb reference syntax:: Literate programming in Org-mode  Carsten Dominik committed Jul 19, 2010 659 * Key bindings and useful functions:: Work quickly with code blocks  Glenn Morris committed Sep 08, 2010 660 * Batch execution:: Call functions from the command line  Carsten Dominik committed Jul 19, 2010 661 662 663  Header arguments  Glenn Morris committed Sep 08, 2010 664 665 * Using header arguments:: Different ways to set header arguments * Specific header arguments:: List of header arguments  Carsten Dominik committed Jul 19, 2010 666 667 668 669  Using header arguments * System-wide header arguments:: Set global default values  Glenn Morris committed Sep 08, 2010 670 * Language-specific header arguments:: Set default values by language  Carsten Dominik committed Jul 19, 2010 671 672 673 * Buffer-wide header arguments:: Set default values for a specific buffer * Header arguments in Org-mode properties:: Set default values for a buffer or heading * Code block specific header arguments:: The most common way to set values  Carsten Dominik committed Nov 11, 2010 674 * Header arguments in function calls:: The most specific level  Carsten Dominik committed Jul 19, 2010 675 676 677  Specific header arguments  Glenn Morris committed Sep 08, 2010 678 * var:: Pass arguments to code blocks  Carsten Dominik committed Nov 11, 2010 679 680 * results:: Specify the type of results and how they will be collected and handled  Glenn Morris committed Sep 08, 2010 681 * file:: Specify a path for file output  Carsten Dominik committed Nov 11, 2010 682 683 * dir:: Specify the default (possibly remote) directory for code block execution  Glenn Morris committed Sep 08, 2010 684 685 * exports:: Export code and/or results * tangle:: Toggle tangling and specify file name  Bastien Guerry committed Aug 15, 2011 686 687 * mkdirp:: Toggle creation of parent directories of target files during tangling  Carsten Dominik committed Nov 11, 2010 688 689 * comments:: Toggle insertion of comments in tangled code files  Bastien Guerry committed Aug 15, 2011 690 691 * padline:: Control insertion of padding lines in tangled code files  Carsten Dominik committed Nov 11, 2010 692 693 * no-expand:: Turn off variable assignment and noweb expansion during tangling  Glenn Morris committed Sep 08, 2010 694 695 * session:: Preserve the state of code evaluation * noweb:: Toggle expansion of noweb references  Bastien Guerry committed Aug 15, 2011 696 * noweb-ref:: Specify block's noweb reference resolution target  Glenn Morris committed Sep 08, 2010 697 * cache:: Avoid re-evaluating unchanged code blocks  Bastien Guerry committed Aug 15, 2011 698 * sep:: Delimiter for writing tabular results outside Org  Glenn Morris committed Sep 08, 2010 699 700 701 702 * hlines:: Handle horizontal lines in tables * colnames:: Handle column names in tables * rownames:: Handle row names in tables * shebang:: Make tangled files executable  Carsten Dominik committed Nov 11, 2010 703 * eval:: Limit evaluation of specific code blocks  Glenn Morris committed Sep 06, 2007 704 705 706  Miscellaneous  Glenn Morris committed Sep 08, 2010 707 * Completion:: M-TAB knows what you need  Carsten Dominik committed Nov 11, 2010 708 * Easy Templates:: Quick insertion of structural elements  Glenn Morris committed Sep 08, 2010 709 710 711 712 713 714 715 716 * Speed keys:: Electric commands at the beginning of a headline * Code evaluation security:: Org mode files evaluate inline code * Customization:: Adapting Org to your taste * In-buffer settings:: Overview of the #+KEYWORDS * The very busy C-c C-c key:: When in doubt, press C-c C-c * Clean view:: Getting rid of leading stars in the outline * TTY keys:: Using Org on a tty * Interaction:: Other Emacs packages  Bastien Guerry committed Aug 15, 2011 717 * org-crypt.el:: Encrypting Org files  Glenn Morris committed Sep 06, 2007 718 719 720  Interaction with other packages  Glenn Morris committed Sep 08, 2010 721 722 * Cooperation:: Packages Org cooperates with * Conflicts:: Packages that lead to conflicts  Glenn Morris committed Sep 06, 2007 723   Carsten Dominik committed Jun 17, 2008 724 Hacking  Glenn Morris committed Sep 06, 2007 725   Glenn Morris committed Sep 08, 2010 726 727 728 729 * Hooks:: Who to reach into Org's internals * Add-on packages:: Available extensions * Adding hyperlink types:: New custom link types * Context-sensitive commands:: How to add functionality to such commands  Carsten Dominik committed Dec 11, 2010 730 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs  Glenn Morris committed Sep 08, 2010 731 732 * Dynamic blocks:: Automatically filled blocks * Special agenda views:: Customized views  Carsten Dominik committed Aug 06, 2009 733 * Extracting agenda information:: Postprocessing of agenda information  Glenn Morris committed Sep 08, 2010 734 735 * Using the property API:: Writing programs that use entry properties * Using the mapping API:: Mapping over all or selected entries  Glenn Morris committed Sep 06, 2007 736   Carsten Dominik committed Apr 27, 2008 737 Tables and lists in arbitrary syntax  Glenn Morris committed Sep 06, 2007 738   Glenn Morris committed Sep 08, 2010 739 740 741 742 * Radio tables:: Sending and receiving radio tables * A LaTeX example:: Step by step, almost a tutorial * Translator functions:: Copy and modify * Radio lists:: Doing the same for lists  Glenn Morris committed Sep 06, 2007 743   Carsten Dominik committed Oct 01, 2009 744 745 MobileOrg  Glenn Morris committed Sep 08, 2010 746 747 748 * Setting up the staging area:: Where to interact with the mobile device * Pushing to MobileOrg:: Uploading Org files and agendas * Pulling from MobileOrg:: Integrating captured and flagged items  Carsten Dominik committed Oct 01, 2009 749   Glenn Morris committed Sep 06, 2007 750 751 752 @end detailmenu @end menu  Carsten Dominik committed Apr 27, 2008 753 @node Introduction, Document Structure, Top, Top  Glenn Morris committed Sep 06, 2007 754 755 756 757 @chapter Introduction @cindex introduction @menu  Glenn Morris committed Sep 08, 2010 758 759 760 761 762 * Summary:: Brief summary of what Org does * Installation:: How to install a downloaded version of Org * Activation:: How to activate Org for certain buffers * Feedback:: Bug reports, ideas, patches etc. * Conventions:: Type-setting conventions in the manual  Glenn Morris committed Sep 06, 2007 763 764 765 766 767 768 @end menu @node Summary, Installation, Introduction, Introduction @section Summary @cindex summary  Carsten Dominik committed Apr 27, 2008 769 Org is a mode for keeping notes, maintaining TODO lists, and doing  Glenn Morris committed Sep 06, 2007 770 771 project planning with a fast and effective plain-text system.  Carsten Dominik committed Apr 27, 2008 772 773 774 Org develops organizational tasks around NOTES files that contain lists or information about projects as plain text. Org is implemented on top of Outline mode, which makes it possible to keep the  Glenn Morris committed Sep 06, 2007 775 776 content of large files well structured. Visibility cycling and structure editing help to work with the tree. Tables are easily created  Carsten Dominik committed Apr 27, 2008 777 with a built-in table editor. Org supports TODO items, deadlines,  Carsten Dominik committed Aug 06, 2009 778 timestamps, and scheduling. It dynamically compiles entries into an  Glenn Morris committed Sep 06, 2007 779 780 781 agenda that utilizes and smoothly integrates much of the Emacs calendar and diary. Plain text URL-like links connect to websites, emails, Usenet messages, BBDB entries, and any files related to the projects.  Carsten Dominik committed Apr 27, 2008 782 For printing and sharing of notes, an Org file can be exported as a  Carsten Dominik committed Jan 18, 2008 783 structured ASCII file, as HTML, or (TODO and agenda items only) as an  Glenn Morris committed Sep 06, 2007 784 iCalendar file. It can also serve as a publishing tool for a set of  Carsten Dominik committed Apr 27, 2008 785 linked web pages.  Glenn Morris committed Sep 06, 2007 786   Carsten Dominik committed Jul 19, 2010 787 788 789 790 As a project planning environment, Org works by adding metadata to outline nodes. Based on this data, specific entries can be extracted in queries and create dynamic @i{agenda views}.  Carsten Dominik committed Dec 11, 2010 791 792 Org mode contains the Org Babel environment which allows you to work with embedded source code blocks in a file, to facilitate code evaluation,  Bastien Guerry committed Aug 15, 2011 793 documentation, and literate programming techniques.  Carsten Dominik committed Jul 19, 2010 794 795 796 797  Org's automatic, context-sensitive table editor with spreadsheet capabilities can be integrated into any major mode by activating the minor Orgtbl mode. Using a translation step, it can be used to maintain  Carsten Dominik committed Dec 11, 2010 798 tables in arbitrary file types, for example in @LaTeX{}. The structure  Carsten Dominik committed Jul 19, 2010 799 800 editing and list creation capabilities can be used outside Org with the minor Orgstruct mode.  Glenn Morris committed Sep 06, 2007 801   Carsten Dominik committed Apr 27, 2008 802 Org keeps simple things simple. When first fired up, it should  Glenn Morris committed Sep 06, 2007 803 804 feel like a straightforward, easy to use outliner. Complexity is not imposed, but a large amount of functionality is available when you need  Carsten Dominik committed Jul 19, 2010 805 806 it. Org is a toolbox and can be used in different ways and for different ends, for example:  Glenn Morris committed Sep 06, 2007 807 808  @example  Carsten Dominik committed Aug 06, 2009 809 810 811 812 813 @r{@bullet{} an outline extension with visibility cycling and structure editing} @r{@bullet{} an ASCII system and table editor for taking structured notes} @r{@bullet{} a TODO list editor} @r{@bullet{} a full agenda and planner with deadlines and work scheduling} @pindex GTD, Getting Things Done  Carsten Dominik committed Jul 19, 2010 814 @r{@bullet{} an environment in which to implement David Allen's GTD system}  Carsten Dominik committed Dec 11, 2010 815 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}  Carsten Dominik committed Aug 06, 2009 816 @r{@bullet{} a publishing tool to create a set of interlinked webpages}  Carsten Dominik committed Jul 19, 2010 817 @r{@bullet{} an environment for literate programming}  Glenn Morris committed Sep 06, 2007 818 819 820 821 @end example @cindex FAQ  Carsten Dominik committed Apr 27, 2008 822 823 There is a website for Org which provides links to the newest version of Org, as well as additional information, frequently asked  Carsten Dominik committed Aug 06, 2009 824 questions (FAQ), links to tutorials, etc@. This page is located at  Carsten Dominik committed Jan 18, 2008 825 @uref{http://orgmode.org}.  Glenn Morris committed Sep 06, 2007 826   Bastien Guerry committed Aug 15, 2011 827 828 829 830 831 @cindex print edition The version 7.3 of this manual is available as a @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network Theory Ltd.}  Glenn Morris committed Sep 06, 2007 832 833 834 835 836 837 838 839 @page @node Installation, Activation, Summary, Introduction @section Installation @cindex installation @cindex XEmacs  Carsten Dominik committed Oct 01, 2009 840 841 @b{Important:} @i{If you are using a version of Org that is part of the Emacs distribution or an XEmacs package, please skip this section and go directly  Bastien Guerry committed Aug 15, 2011 842 843 844 to @ref{Activation}. To see what version of Org (if any) is part of your Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x org-version}.}  Glenn Morris committed Sep 06, 2007 845   Carsten Dominik committed Apr 27, 2008 846 If you have downloaded Org from the Web, either as a distribution @file{.zip}  Carsten Dominik committed Aug 06, 2009 847 848 or @file{.tar} file, or as a Git archive, you must take the following steps to install it: go into the unpacked Org distribution directory and edit the  Carsten Dominik committed Apr 27, 2008 849 850 851 852 853 854 top section of the file @file{Makefile}. You must set the name of the Emacs binary (likely either @file{emacs} or @file{xemacs}), and the paths to the directories where local Lisp and Info files are kept. If you don't have access to the system-wide directories, you can simply run Org directly from the distribution directory by adding the @file{lisp} subdirectory to the Emacs load path. To do this, add the following line to @file{.emacs}:  Glenn Morris committed Sep 06, 2007 855 856  @example  Carsten Dominik committed Apr 27, 2008 857 858 859 860 861 862 863 864 865 (setq load-path (cons "~/path/to/orgdir/lisp" load-path)) @end example @noindent If you plan to use code from the @file{contrib} subdirectory, do a similar step for this directory: @example (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))  Glenn Morris committed Sep 06, 2007 866 867 @end example  Carsten Dominik committed Apr 27, 2008 868 @noindent Now byte-compile the Lisp files with the shell command:  Glenn Morris committed Sep 06, 2007 869 870 871 872 873  @example make @end example  Carsten Dominik committed Apr 27, 2008 874 @noindent If you are running Org from the distribution directory, this is  Carsten Dominik committed Aug 06, 2009 875 876 all. If you want to install Org into the system directories, use (as administrator)  Glenn Morris committed Sep 06, 2007 877 878  @example  Carsten Dominik committed Apr 27, 2008 879 make install  Carsten Dominik committed Aug 06, 2009 880 881 882 @end example Installing Info files is system dependent, because of differences in the  Bastien Guerry committed Aug 15, 2011 883 884 885 886 887 888 889 890 891 892 893 894 @file{install-info} program. The following should correctly install the Info files on most systems, please send a bug report if not@footnote{The output from install-info (if any) is also system dependent. In particular Debian and its derivatives use two different versions of install-info and you may see the message: @example This is not dpkg install-info anymore, but GNU install-info See the man page for ginstall-info for command line arguments @end example @noindent which can be safely ignored.}.  Carsten Dominik committed Aug 06, 2009 895 896  @example  Glenn Morris committed Sep 06, 2007 897 898 899 make install-info @end example  Carsten Dominik committed Oct 01, 2009 900 901 902 Then add the following line to @file{.emacs}. It is needed so that Emacs can autoload functions that are located in files not immediately loaded when Org-mode starts.  Glenn Morris committed Sep 06, 2007 903 904 905 906 @lisp (require 'org-install) @end lisp  Carsten Dominik committed Jan 25, 2009 907 Do not forget to activate Org as described in the following section.  Carsten Dominik committed Oct 01, 2009 908 @page  Carsten Dominik committed Apr 27, 2008 909   Glenn Morris committed Sep 06, 2007 910 911 912 913 @node Activation, Feedback, Installation, Introduction @section Activation @cindex activation @cindex autoload  Carsten Dominik committed Apr 27, 2008 914 915 @cindex global key bindings @cindex key bindings, global  Glenn Morris committed Sep 06, 2007 916   Bastien Guerry committed Aug 15, 2011 917 918 To make sure files with extension @file{.org} use Org mode, add the following line to your @file{.emacs} file.  Glenn Morris committed Sep 06, 2007 919 920 @lisp (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))  Bastien Guerry committed Aug 15, 2011 921 922 923 924 925 926 927 928 929 930 931 @end lisp @noindent Org mode buffers need font-lock to be turned on - this is the default in Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}. The four Org commands @command{org-store-link}, @command{org-capture}, @command{org-agenda}, and @command{org-iswitchb} should be accessible through global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are suggested bindings for these keys, please modify the keys to your own liking. @lisp  Glenn Morris committed Sep 06, 2007 932 (global-set-key "\C-cl" 'org-store-link)  Bastien Guerry committed Aug 15, 2011 933 (global-set-key "\C-cc" 'org-capture)  Glenn Morris committed Sep 06, 2007 934 (global-set-key "\C-ca" 'org-agenda)  Carsten Dominik committed Apr 27, 2008 935 (global-set-key "\C-cb" 'org-iswitchb)  Glenn Morris committed Sep 06, 2007 936 937 @end lisp  Carsten Dominik committed Jul 19, 2010 938 @cindex Org-mode, turning on  Glenn Morris committed Sep 06, 2007 939 With this setup, all files with extension @samp{.org} will be put  Carsten Dominik committed Jul 19, 2010 940 into Org-mode. As an alternative, make the first line of a file look  Glenn Morris committed Sep 06, 2007 941 942 943 944 945 946 like this: @example MY PROJECTS -*- mode: org; -*- @end example  Carsten Dominik committed Aug 06, 2009 947 @vindex org-insert-mode-line-in-empty-file  Carsten Dominik committed Jul 19, 2010 948 @noindent which will select Org-mode for this buffer no matter what  Glenn Morris committed Sep 06, 2007 949 950 951 the file's name is. See also the variable @code{org-insert-mode-line-in-empty-file}.  Carsten Dominik committed Aug 06, 2009 952 953 954 955 Many commands in Org work on the region if the region is @i{active}. To make use of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to do this yourself with  Carsten Dominik committed Dec 20, 2008 956 957 958 @lisp (transient-mark-mode 1) @end lisp  Carsten Dominik committed Aug 06, 2009 959 960 961 @noindent If you do not like @code{transient-mark-mode}, you can create an active region by using the mouse to select a region, or pressing @kbd{C-@key{SPC}} twice before moving the cursor.  Carsten Dominik committed Dec 20, 2008 962   Carsten Dominik committed Jan 18, 2008 963 @node Feedback, Conventions, Activation, Introduction  Glenn Morris committed Sep 06, 2007 964 965 966 967 968 969 @section Feedback @cindex feedback @cindex bug reports @cindex maintainer @cindex author  Carsten Dominik committed Jun 17, 2008 970 If you find problems with Org, or if you have questions, remarks, or ideas  Carsten Dominik committed Aug 06, 2009 971 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.  Carsten Dominik committed Sep 02, 2009 972 If you are not a member of the mailing list, your mail will be passed to the  Carsten Dominik committed Nov 11, 2010 973 974 975 976 977 list after a moderator has approved it@footnote{Please consider subscribing to the mailing list, in order to minimize the work the mailing list moderators have to do.}. For bug reports, please first try to reproduce the bug with the latest  Carsten Dominik committed Dec 11, 2010 978 version of Org available---if you are running an outdated version, it is  Carsten Dominik committed Nov 11, 2010 979 980 981 quite possible that the bug has been fixed already. If the bug persists, prepare a report and provide as much information as possible, including the version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org  Carsten Dominik committed Sep 02, 2009 982 983 984 985 986 987 988 989 990 991 992 993 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in @file{.emacs}. The easiest way to do this is to use the command @example @kbd{M-x org-submit-bug-report} @end example @noindent which will put all this information into an Emacs mail buffer so that you only need to add your description. If you re not sending the Email from within Emacs, please copy and paste the content into your Email program. If an error occurs, a backtrace can be very useful (see below on how to create one). Often a small example file helps, along with clear information about:  Glenn Morris committed Sep 06, 2007 994 995 996 997 998 999  @enumerate @item What exactly did you do? @item What did you expect to happen? @item What happened instead? @end enumerate  Carsten Dominik committed Nov 11, 2010 1000 @noindent Thank you for helping to improve this program.  Glenn Morris committed Sep 06, 2007 1001 1002 1003 1004  @subsubheading How to create a useful backtrace @cindex backtrace of an error  Carsten Dominik committed Apr 27, 2008 1005 If working with Org produces an error with a message you don't  Glenn Morris committed Sep 06, 2007 1006 understand, you may have hit a bug. The best way to report this is by  Carsten Dominik committed Aug 06, 2009 1007 providing, in addition to what was mentioned above, a @emph{backtrace}.  Glenn Morris committed Sep 06, 2007 1008 1009 1010 1011 1012 This is information from the built-in debugger about where and how the error occurred. Here is how to produce a useful backtrace: @enumerate @item  Carsten Dominik committed Aug 06, 2009 1013 1014 1015 Reload uncompiled versions of all Org-mode Lisp files. The backtrace contains much more information if it is produced with uncompiled code. To do this, use  Glenn Morris committed Sep 06, 2007 1016 @example  Carsten Dominik committed Aug 06, 2009 1017 C-u M-x org-reload RET  Glenn Morris committed Sep 06, 2007 1018 @end example  Carsten Dominik committed Aug 06, 2009 1019 1020 1021 @noindent or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the menu.  Glenn Morris committed Sep 06, 2007 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 @item Go to the @code{Options} menu and select @code{Enter Debugger on Error} (XEmacs has this option in the @code{Troubleshooting} sub-menu). @item Do whatever you have to do to hit the error. Don't forget to document the steps you take. @item When you hit the error, a @file{*Backtrace*} buffer will appear on the screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and attach it to your bug report. @end enumerate  Carsten Dominik committed Jan 18, 2008 1034 1035 1036 @node Conventions, , Feedback, Introduction @section Typesetting conventions used in this manual  Carsten Dominik committed Apr 27, 2008 1037 Org uses three types of keywords: TODO keywords, tags, and property  Carsten Dominik committed Jan 18, 2008 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 names. In this manual we use the following conventions: @table @code @item TODO @itemx WAITING TODO keywords are written with all capitals, even if they are user-defined. @item boss @itemx ARCHIVE User-defined tags are written in lowercase; built-in tags with special meaning are written with all capitals. @item Release @itemx PRIORITY User-defined properties are capitalized; built-in properties with special meaning are written with all capitals. @end table  Carsten Dominik committed Dec 11, 2010 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 The manual lists both the keys and the corresponding commands for accessing functionality. Org mode often uses the same key for different functions, depending on context. The command that is bound to such keys has a generic name, like @code{org-metaright}. In the manual we will, wherever possible, give the function that is internally called by the generic command. For example, in the chapter on document structure, @kbd{M-@key{right}} will be listed to call @code{org-do-demote}, while in the chapter on tables, it will be listed to call org-table-move-column-right. If you prefer, you can compile the manual without the command names by unsetting the flag @code{cmdnames} in @file{org.texi}.  Carsten Dominik committed Apr 27, 2008 1067 @node Document Structure, Tables, Introduction, Top  Carsten Dominik committed Jul 19, 2010 1068 @chapter Document structure  Glenn Morris committed Sep 06, 2007 1069 1070 1071 @cindex document structure @cindex structure of document  Carsten Dominik committed Aug 06, 2009 1072 Org is based on Outline mode and provides flexible commands to  Glenn Morris committed Sep 06, 2007 1073 1074 1075 edit the structure of the document. @menu  Glenn Morris committed Sep 08, 2010 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 * Outlines:: Org is based on Outline mode * Headlines:: How to typeset Org tree headlines * Visibility cycling:: Show and hide, much simplified * Motion:: Jumping to other headlines * Structure editing:: Changing sequence and level of headlines * Sparse trees:: Matches embedded in context * Plain lists:: Additional structure within an entry * Drawers:: Tucking stuff away * Blocks:: Folding blocks * Footnotes:: How footnotes are defined in Org's syntax * Orgstruct mode:: Structure editing outside Org  Glenn Morris committed Sep 06, 2007 1087 1088 @end menu  Carsten Dominik committed Apr 27, 2008 1089 @node Outlines, Headlines, Document Structure, Document Structure  Glenn Morris committed Sep 06, 2007 1090 1091 @section Outlines @cindex outlines  Carsten Dominik committed Apr 27, 2008 1092 @cindex Outline mode  Glenn Morris committed Sep 06, 2007 1093   Carsten Dominik committed Apr 27, 2008 1094 Org is implemented on top of Outline mode. Outlines allow a  Glenn Morris committed Sep 06, 2007 1095 1096 1097 1098 document to be organized in a hierarchical structure, which (at least for me) is the best representation of notes and thoughts. An overview of this structure is achieved by folding (hiding) large parts of the document to show only the general document structure and the parts  Carsten Dominik committed Apr 27, 2008 1099 currently being worked on. Org greatly simplifies the use of  Glenn Morris committed Sep 06, 2007 1100 outlines by compressing the entire show/hide functionality into a single  Carsten Dominik committed Aug 06, 2009 1101 command, @command{org-cycle}, which is bound to the @key{TAB} key.  Glenn Morris committed Sep 06, 2007 1102   Carsten Dominik committed Apr 27, 2008 1103 @node Headlines, Visibility cycling, Outlines, Document Structure  Glenn Morris committed Sep 06, 2007 1104 1105 1106 @section Headlines @cindex headlines @cindex outline tree  Carsten Dominik committed Aug 06, 2009 1107 @vindex org-special-ctrl-a/e  Carsten Dominik committed Jul 19, 2010 1108 1109 @vindex org-special-ctrl-k @vindex org-ctrl-k-protect-subtree  Glenn Morris committed Sep 06, 2007 1110   Carsten Dominik committed Jul 19, 2010 1111 1112 1113 1114 1115 Headlines define the structure of an outline tree. The headlines in Org start with one or more stars, on the left margin@footnote{See the variables @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a}, @kbd{C-e}, and @kbd{C-k} in headlines.}. For example:  Glenn Morris committed Sep 06, 2007 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129  @example * Top level headline ** Second level *** 3rd level some text *** 3rd level more text * Another top level headline @end example @noindent Some people find the many stars too noisy and would prefer an outline that has whitespace followed by a single star as headline  Carsten Dominik committed Aug 06, 2009 1130 starters. @ref{Clean view}, describes a setup to realize this.  Glenn Morris committed Sep 06, 2007 1131   Carsten Dominik committed Aug 06, 2009 1132 @vindex org-cycle-separator-lines  Glenn Morris committed Sep 06, 2007 1133 1134 1135 1136 1137 1138 An empty line after the end of a subtree is considered part of it and will be hidden when the subtree is folded. However, if you leave at least two empty lines, one empty line will remain visible after folding the subtree, in order to structure the collapsed view. See the variable @code{org-cycle-separator-lines} to modify this behavior.  Carsten Dominik committed Apr 27, 2008 1139 @node Visibility cycling, Motion, Headlines, Document Structure  Glenn Morris committed Sep 06, 2007 1140 1141 1142 1143 1144 1145 1146 1147 @section Visibility cycling @cindex cycling, visibility @cindex visibility cycling @cindex trees, visibility @cindex show hidden text @cindex hide text Outlines make it possible to hide parts of the text in the buffer.