-
Notifications
You must be signed in to change notification settings - Fork 2
/
org-1
6953 lines (5475 loc) · 294 KB
/
org-1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
これは org、org.texi より makeinfo バージョン 4.8
によって作成されました。
This manual is for Org version 7.4.
Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software
Foundation, Inc.
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.3 or any later version published by the Free Software
Foundation; with no Invariant Sections, with the Front-Cover texts
being "A GNU Manual," 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."
(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."
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.
INFO-DIR-SECTION Emacs
START-INFO-DIR-ENTRY
* Org Mode: (org). Outline-based notes management and organizer
END-INFO-DIR-ENTRY
File: org, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
Org Mode Manual
***************
This manual is for Org version 7.4.
Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software
Foundation, Inc.
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.3 or any later version published by the Free Software
Foundation; with no Invariant Sections, with the Front-Cover texts
being "A GNU Manual," 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."
(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."
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.
* Menu:
* 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
* Command and Function Index:: Command names and some internal functions
* Variable Index:: Variables mentioned in the manual
--- The Detailed Node Listing ---
Introduction
* 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
Document structure
* 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
Tables
* 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
The spreadsheet
* 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
* Field formulas:: Formulas valid for a single field
* Column formulas:: Formulas valid for an entire column
* Editing and debugging formulas:: Fixing formulas
* Updating the table:: Recomputing all dependent fields
* Advanced features:: Field names, parameters and automatic recalc
Hyperlinks
* 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
Internal links
* Radio targets:: Make targets trigger links in plain text
TODO items
* 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
Extended use of TODO keywords
* 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
Progress logging
* 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?
Tags
* 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
Properties and columns
* 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
Column view
* 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
Defining columns
* Scope of column definitions:: Where defined, where valid?
* Column attributes:: Appearance and content of a column
Dates and times
* 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
* Countdown timer:: Starting a countdown timer for a task
Creating timestamps
* The date/time prompt:: How Org-mode helps you entering date and time
* Custom time format:: Making dates look different
Deadlines and scheduling
* Inserting deadline/schedule:: Planning items
* Repeated tasks:: Items that show up again and again
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
Capture - Refile - Archive
* Capture:: Capturing new stuff
* Attachments:: Add files to tasks
* RSS Feeds:: Getting input from RSS feeds
* Protocols:: External (e.g. Browser) access to Emacs and Org
* Refiling notes:: Moving a tree from one place to another
* Archiving:: What to do with finished projects
Capture
* 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
Capture templates
* Template elements:: What is needed for a complete template entry
* Template expansion:: Filling in information about time and context
Archiving
* Moving subtrees:: Moving a tree to an archive file
* Internal archiving:: Switch off a tree but keep it in the file
Agenda views
* 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
The built-in agenda views
* Weekly/daily agenda:: The calendar page with current tasks
* Global TODO list:: All unfinished action items
* Matching tags and properties:: Structured information with fine-tuned search
* Timeline:: Time-sorted view for single file
* Search view:: Find entries by searching for text
* Stuck projects:: Find projects you need to review
Presentation and sorting
* Categories:: Not all tasks are equal
* Time-of-day specifications:: How the agenda knows the time
* Sorting of agenda items:: The order of things
Custom agenda views
* Storing searches:: Type once, use often
* Block agenda:: All the stuff you need in a single buffer
* Setting Options:: Changing the rules
Markup for rich export
* 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
Structural markup elements
* 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
Embedded LaTeX
* 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
Exporting
* 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
* LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
* DocBook export:: Exporting to DocBook
* TaskJuggler export:: Exporting to TaskJuggler
* Freemind export:: Exporting to Freemind mind maps
* XOXO export:: Exporting to XOXO
* iCalendar export:: Exporting in iCalendar format
HTML export
* HTML Export commands:: How to invoke HTML export
* 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
* Math formatting in HTML export:: Beautiful math also on the web
* 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
LaTeX and PDF export
* LaTeX/PDF export commands:: Which key invokes which commands
* Header and sectioning:: Setting up the export file structure
* 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
* Beamer class export:: Turning the file into a presentation
DocBook export
* 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
Publishing
* Configuration:: Defining projects
* Uploading files:: How to get files up on the server
* Sample configuration:: Example projects
* Triggering publication:: Publication commands
Configuration
* 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
* Publishing options:: Tweaking HTML export
* Publishing links:: Which links keep working after publishing?
* Sitemap:: Generating a list of all pages
* Generating an index:: An index that reaches across pages
Sample configuration
* Simple example:: One-component publishing
* Complex example:: A multi-component publishing example
Working with source code
* 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
* Key bindings and useful functions:: Work quickly with code blocks
* Batch execution:: Call functions from the command line
Header arguments
* Using header arguments:: Different ways to set header arguments
* Specific header arguments:: List of header arguments
Using header arguments
* System-wide header arguments:: Set global default values
* Language-specific header arguments:: Set default values by language
* 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
* Header arguments in function calls:: The most specific level
Specific header arguments
* var:: Pass arguments to code blocks
* results:: Specify the type of results and how they will
be collected and handled
* file:: Specify a path for file output
* dir:: Specify the default (possibly remote)
directory for code block execution
* exports:: Export code and/or results
* tangle:: Toggle tangling and specify file name
* comments:: Toggle insertion of comments in tangled
code files
* no-expand:: Turn off variable assignment and noweb
expansion during tangling
* session:: Preserve the state of code evaluation
* noweb:: Toggle expansion of noweb references
* cache:: Avoid re-evaluating unchanged code blocks
* hlines:: Handle horizontal lines in tables
* colnames:: Handle column names in tables
* rownames:: Handle row names in tables
* shebang:: Make tangled files executable
* eval:: Limit evaluation of specific code blocks
Miscellaneous
* Completion:: M-TAB knows what you need
* Easy Templates:: Quick insertion of structural elements
* 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
Interaction with other packages
* Cooperation:: Packages Org cooperates with
* Conflicts:: Packages that lead to conflicts
Hacking
* 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
* Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
* Dynamic blocks:: Automatically filled blocks
* Special agenda views:: Customized views
* Extracting agenda information:: Postprocessing of agenda information
* Using the property API:: Writing programs that use entry properties
* Using the mapping API:: Mapping over all or selected entries
Tables and lists in arbitrary syntax
* 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
MobileOrg
* 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
File: org, Node: Introduction, Next: Document Structure, Prev: Top, Up: Top
1 Introduction
**************
* Menu:
* 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
File: org, Node: Summary, Next: Installation, Prev: Introduction, Up: Introduction
1.1 Summary
===========
Org is a mode for keeping notes, maintaining TODO lists, and doing
project planning with a fast and effective plain-text system.
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 content of
large files well structured. Visibility cycling and structure editing
help to work with the tree. Tables are easily created with a built-in
table editor. Org supports TODO items, deadlines, timestamps, and
scheduling. It dynamically compiles entries into an 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. For printing and
sharing of notes, an Org file can be exported as a structured ASCII
file, as HTML, or (TODO and agenda items only) as an iCalendar file.
It can also serve as a publishing tool for a set of linked web pages.
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 agenda views.
Org mode contains the Org Babel environment which allows you to work
with embedded source code blocks in a file, to facilitate code
evaluation, documentation, and tangling.
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
tables in arbitrary file types, for example in LaTeX. The structure
editing and list creation capabilities can be used outside Org with the
minor Orgstruct mode.
Org keeps simple things simple. When first fired up, it should feel
like a straightforward, easy to use outliner. Complexity is not
imposed, but a large amount of functionality is available when you need
it. Org is a toolbox and can be used in different ways and for
different ends, for example:
* an outline extension with visibility cycling and structure editing
* an ASCII system and table editor for taking structured notes
* a TODO list editor
* a full agenda and planner with deadlines and work scheduling
* an environment in which to implement David Allen's GTD system
* a simple hypertext system, with HTML and LaTeX export
* a publishing tool to create a set of interlinked webpages
* an environment for literate programming
There is a website for Org which provides links to the newest
version of Org, as well as additional information, frequently asked
questions (FAQ), links to tutorials, etc. This page is located at
`http://orgmode.org'.
File: org, Node: Installation, Next: Activation, Prev: Summary, Up: Introduction
1.2 Installation
================
Important: 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 to *Note Activation::.
If you have downloaded Org from the Web, either as a distribution
`.zip' or `.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 top section of the file `Makefile'. You must set the name
of the Emacs binary (likely either `emacs' or `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 `lisp'
subdirectory to the Emacs load path. To do this, add the following
line to `.emacs':
(setq load-path (cons "~/path/to/orgdir/lisp" load-path))
If you plan to use code from the `contrib' subdirectory, do a similar
step for this directory:
(setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
Now byte-compile the Lisp files with the shell command:
make
If you are running Org from the distribution directory, this is all.
If you want to install Org into the system directories, use (as
administrator)
make install
Installing Info files is system dependent, because of differences in
the `install-info' program. In Debian it copies the info files into the
correct directory and modifies the info directory file. In many other
systems, the files need to be copied to the correct directory
separately, and `install-info' then only modifies the directory file.
Check your system documentation to find out which of the following
commands you need:
make install-info
make install-info-debian
Then add the following line to `.emacs'. It is needed so that Emacs
can autoload functions that are located in files not immediately loaded
when Org-mode starts.
(require 'org-install)
Do not forget to activate Org as described in the following section.
File: org, Node: Activation, Next: Feedback, Prev: Installation, Up: Introduction
1.3 Activation
==============
Add the following lines to your `.emacs' file. The last three lines
define _global_ keys for the commands `org-store-link', `org-agenda',
and `org-iswitchb'--please choose suitable keys yourself.
;; The following lines are always needed. Choose your own keys.
(add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
(global-set-key "\C-cl" 'org-store-link)
(global-set-key "\C-ca" 'org-agenda)
(global-set-key "\C-cb" 'org-iswitchb)
Furthermore, you must activate `font-lock-mode' in Org buffers,
because significant functionality depends on font-locking being active.
You can do this with either one of the following two lines (XEmacs
users must use the second option):
(global-font-lock-mode 1) ; for all buffers
(add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
With this setup, all files with extension `.org' will be put into
Org-mode. As an alternative, make the first line of a file look like
this:
MY PROJECTS -*- mode: org; -*-
which will select Org-mode for this buffer no matter what the file's
name is. See also the variable `org-insert-mode-line-in-empty-file'.
Many commands in Org work on the region if the region is active. To
make use of this, you need to have `transient-mark-mode'
(`zmacs-regions' in XEmacs) turned on. In Emacs 23 this is the default,
in Emacs 22 you need to do this yourself with
(transient-mark-mode 1)
If you do not like `transient-mark-mode', you can create an active
region by using the mouse to select a region, or pressing `C-<SPC>'
twice before moving the cursor.
File: org, Node: Feedback, Next: Conventions, Prev: Activation, Up: Introduction
1.4 Feedback
============
If you find problems with Org, or if you have questions, remarks, or
ideas about it, please mail to the Org mailing list
<[email protected]>. If you are not a member of the mailing list,
your mail will be passed to the list after a moderator has approved
it(1).
For bug reports, please first try to reproduce the bug with the
latest version of Org available--if you are running an outdated
version, it is 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 (`M-x
emacs-version <RET>') and Org (`M-x org-version <RET>'), as well as the
Org related setup in `.emacs'. The easiest way to do this is to use
the command
M-x org-submit-bug-report
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:
1. What exactly did you do?
2. What did you expect to happen?
3. What happened instead?
Thank you for helping to improve this program.
How to create a useful backtrace
................................
If working with Org produces an error with a message you don't
understand, you may have hit a bug. The best way to report this is by
providing, in addition to what was mentioned above, a _backtrace_.
This is information from the built-in debugger about where and how the
error occurred. Here is how to produce a useful backtrace:
1. 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
C-u M-x org-reload RET
or select `Org -> Refresh/Reload -> Reload Org uncompiled' from the
menu.
2. Go to the `Options' menu and select `Enter Debugger on Error'
(XEmacs has this option in the `Troubleshooting' sub-menu).
3. Do whatever you have to do to hit the error. Don't forget to
document the steps you take.
4. When you hit the error, a `*Backtrace*' buffer will appear on the
screen. Save this buffer to a file (for example using `C-x C-w')
and attach it to your bug report.
---------- Footnotes ----------
(1) Please consider subscribing to the mailing list, in order to
minimize the work the mailing list moderators have to do.
File: org, Node: Conventions, Prev: Feedback, Up: Introduction
1.5 Typesetting conventions used in this manual
===============================================
Org uses three types of keywords: TODO keywords, tags, and property
names. In this manual we use the following conventions:
`TODO'
`WAITING'
TODO keywords are written with all capitals, even if they are
user-defined.
`boss'
`ARCHIVE'
User-defined tags are written in lowercase; built-in tags with
special meaning are written with all capitals.
`Release'
`PRIORITY'
User-defined properties are capitalized; built-in properties with
special meaning are written with all capitals.
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 `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, `M-<right>' will be listed to call `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 `cmdnames' in `org.texi'.
File: org, Node: Document Structure, Next: Tables, Prev: Introduction, Up: Top
2 Document structure
********************
Org is based on Outline mode and provides flexible commands to edit the
structure of the document.
* Menu:
* 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
File: org, Node: Outlines, Next: Headlines, Prev: Document Structure, Up: Document Structure
2.1 Outlines
============
Org is implemented on top of Outline mode. Outlines allow a 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 currently
being worked on. Org greatly simplifies the use of outlines by
compressing the entire show/hide functionality into a single command,
`org-cycle', which is bound to the <TAB> key.
File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document Structure
2.2 Headlines
=============
Headlines define the structure of an outline tree. The headlines in Org
start with one or more stars, on the left margin(1). For example:
* Top level headline
** Second level
*** 3rd level
some text
*** 3rd level
more text
* Another top level headline
Some people find the many stars too noisy and would prefer an outline
that has whitespace followed by a single star as headline starters.
*Note Clean view::, describes a setup to realize this.
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 `org-cycle-separator-lines' to modify this behavior.
---------- Footnotes ----------
(1) See the variables `org-special-ctrl-a/e', `org-special-ctrl-k',
and `org-ctrl-k-protect-subtree' to configure special behavior of `C-a',
`C-e', and `C-k' in headlines.
File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document Structure
2.3 Visibility cycling
======================
Outlines make it possible to hide parts of the text in the buffer. Org
uses just two commands, bound to <TAB> and `S-<TAB>' to change the
visibility in the buffer.
`<TAB>' (`org-cycle')
_Subtree cycling_: Rotate current subtree among the states
,-> FOLDED -> CHILDREN -> SUBTREE --.
'-----------------------------------'
The cursor must be on a headline for this to work(1). When the
cursor is at the beginning of the buffer and the first line is not
a headline, then <TAB> actually runs global cycling (see
below)(2). Also when called with a prefix argument (`C-u <TAB>'),
global cycling is invoked.
`S-<TAB>' (`org-global-cycle')
C-u <TAB>
_Global cycling_: Rotate the entire buffer among the states
,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
'--------------------------------------'
When `S-<TAB>' is called with a numeric prefix argument N, the
CONTENTS view up to headlines of level N will be shown. Note that
inside tables, `S-<TAB>' jumps to the previous field.
`C-u C-u C-u <TAB>' (`show-all')
Show all, including drawers.
`C-c C-r' (`org-reveal')
Reveal context around point, showing the current entry, the
following heading and the hierarchy above. Useful for working
near a location that has been exposed by a sparse tree command
(*note Sparse trees::) or an agenda command (*note Agenda
commands::). With a prefix argument show, on each level, all
sibling headings. With double prefix arg, also show the entire
subtree of the parent.
`C-c C-k' (`show-branches')
Expose all the headings of the subtree, CONTENT view for just one
subtree.
`C-c C-x b' (`org-tree-to-indirect-buffer')
Show the current subtree in an indirect buffer(3). With a numeric
prefix argument N, go up to level N and then take that tree. If N
is negative then go up that many levels. With a `C-u' prefix, do
not remove the previously used indirect buffer.
When Emacs first visits an Org file, the global state is set to
OVERVIEW, i.e. only the top level headlines are visible. This can be
configured through the variable `org-startup-folded', or on a per-file
basis by adding one of the following lines anywhere in the buffer:
#+STARTUP: overview
#+STARTUP: content
#+STARTUP: showall
#+STARTUP: showeverything
Furthermore, any entries with a `VISIBILITY' property (*note Properties
and Columns::) will get their visibility adapted accordingly. Allowed
values for this property are `folded', `children', `content', and `all'.
`C-u C-u <TAB>' (`org-set-startup-visibility')
Switch back to the startup visibility of the buffer, i.e. whatever
is requested by startup options and `VISIBILITY' properties in
individual entries.
---------- Footnotes ----------
(1) see, however, the option `org-cycle-emulate-tab'.
(2) see the option `org-cycle-global-at-bob'.
(3) The indirect buffer (*note Indirect Buffers: (emacs)Indirect
Buffers.) will contain the entire buffer, but will be narrowed to the
current tree. Editing the indirect buffer will also change the
original buffer, but without affecting visibility in that buffer.
File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document Structure
2.4 Motion
==========
The following commands jump to other headlines in the buffer.
`C-c C-n' (`outline-next-visible-heading')
Next heading.
`C-c C-p' (`outline-previous-visible-heading')
Previous heading.
`C-c C-f' (`org-forward-same-level')
Next heading same level.
`C-c C-b' (`org-backward-same-level')
Previous heading same level.
`C-c C-u' (`outline-up-heading')
Backward to higher level heading.
`C-c C-j' (`org-goto')
Jump to a different place without changing the current outline
visibility. Shows the document structure in a temporary buffer,
where you can use the following keys to find your destination:
<TAB> Cycle visibility.
<down> / <up> Next/previous visible headline.
<RET> Select this location.
/ Do a Sparse-tree search
The following keys work if you turn off `org-goto-auto-isearch'
n / p Next/previous visible headline.
f / b Next/previous headline same level.
u One level up.
0-9 Digit argument.
q Quit
See also the variable `org-goto-interface'.
File: org, Node: Structure editing, Next: Sparse trees, Prev: Motion, Up: Document Structure
2.5 Structure editing
=====================
`M-<RET>' (`org-insert-heading')
Insert new heading with same level as current. If the cursor is
in a plain list item, a new item is created (*note Plain lists::).
To force creation of a new headline, use a prefix argument, or
first press <RET> to get to the beginning of the next line. When
this command is used in the middle of a line, the line is split
and the rest of the line becomes the new headline(1). If the
command is used at the beginning of a headline, the new headline is
created before the current line. If at the beginning of any other
line, the content of that line is made the new heading. If the
command is used at the end of a folded subtree (i.e. behind the
ellipses at the end of a headline), then a headline like the
current one will be inserted after the end of the subtree.
`C-<RET>' (`org-insert-heading-respect-content')
Just like `M-<RET>', except when adding a new heading below the
current heading, the new heading is placed after the body instead
of before it. This command works from anywhere in the entry.
`M-S-<RET>' (`org-insert-todo-heading')
Insert new TODO entry with same level as current heading. See
also the variable `org-treat-insert-todo-heading-as-state-change'.
`C-S-<RET>' (`org-insert-todo-heading-respect-content')
Insert new TODO entry with same level as current heading. Like
`C-<RET>', the new headline will be inserted after the current
subtree.
`<TAB>' (`org-cycle')
In a new entry with no text yet, the first <TAB> demotes the entry
to become a child of the previous one. The next <TAB> makes it a
parent, and so on, all the way to top level. Yet another <TAB>,
and you are back to the initial level.
`M-<left>' (`org-do-promote')
Promote current heading by one level.
`M-<right>' (`org-do-demote')
Demote current heading by one level.
`M-S-<left>' (`org-promote-subtree')
Promote the current subtree by one level.
`M-S-<right>' (`org-demote-subtree')
Demote the current subtree by one level.
`M-S-<up>' (`org-move-subtree-up')
Move subtree up (swap with previous subtree of same level).
`M-S-<down>' (`org-move-subtree-down')
Move subtree down (swap with next subtree of same level).
`C-c C-x C-w' (`org-cut-subtree')