@copying
This manual is for Org version @value{VERSION}.
-Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
+Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010
+Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
@end ifnottex
@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
-* Variable Index:: Variables mentioned in the manual
+* 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
+* Variable Index:: Variables mentioned in the manual
@detailmenu
--- 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
+* 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
+* 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
+* 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
+* 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
+* 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
+* 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
+* 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
+* 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
+* 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?
+* 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
+* 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
+* 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:: 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
+* 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
-* Resolving idle time:: Resolving time if you've been idle
-* Effort estimates:: Planning work effort in advance
-* Relative timer:: Notes with a running timer
+* 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
+* Resolving idle time:: Resolving time if you've been idle
+* Effort estimates:: Planning work effort in advance
+* Relative timer:: Notes with a running timer
Creating timestamps
-* The date/time prompt:: How Org-mode helps you entering date and time
-* Custom time format:: Making dates look different
+* 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
+* Inserting deadline/schedule:: Planning items
+* Repeated tasks:: Items that show up again and again
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:: 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
+* 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
+* 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
+* 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
+* 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
+* 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
+* 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
+* 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
+* 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:: 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
+* 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 La@TeX{}
-* 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
+* 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 La@TeX{}, 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
+* 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 La@TeX{}, 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
-* 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
+* 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
+* 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
La@TeX{} 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 La@TeX{} code
-* Tables in LaTeX export:: Options for exporting tables to La@TeX{}
-* Images in LaTeX export:: How to insert figures into La@TeX{} output
-* Beamer class export:: Turning the file into a presentation
+* LaTeX/PDF export commands:: Which key invokes which commands
+* Header and sectioning:: Setting up the export file structure
+* Quoting LaTeX code:: Incorporating literal La@TeX{} code
+* Tables in LaTeX export:: Options for exporting tables to La@TeX{}
+* Images in LaTeX export:: How to insert figures into La@TeX{} 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
+* 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:: 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
+* 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
+* 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
+* 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
+* 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:: 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
+* 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
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 directory for code block execution
-* exports:: Export code and/or results
-* tangle:: Toggle tangling and specify file name
-* 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
+* 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 directory for code block execution
+* exports:: Export code and/or results
+* tangle:: Toggle tangling and specify file name
+* 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
Miscellaneous
-* Completion:: M-TAB knows what you need
-* 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
+* Completion:: M-TAB knows what you need
+* 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
+* 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 La@TeX{} and other programs
-* Dynamic blocks:: Automatically filled blocks
-* Special agenda views:: Customized views
+* 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 La@TeX{} 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
+* 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
+* 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
+* 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
@end detailmenu
@end menu
@cindex 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
+* 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
@end menu
@node Summary, Installation, Introduction, Introduction
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
+* 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
@end menu
@node Outlines, Headlines, Document Structure, Document Structure
@end ifnotinfo
@menu
-* 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
+* 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
@end menu
@node Built-in table editor, Column width and alignment, Tables, Tables
formula, moving these references by arrow keys
@menu
-* 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
+* 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
+* Updating the table:: Recomputing all dependent fields
+* Advanced features:: Field names, parameters and automatic recalc
@end menu
@node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
other files, Usenet articles, emails, and much more.
@menu
-* 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
+* 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
@end menu
@node Link format, Internal links, Hyperlinks, Hyperlinks
earlier.
@menu
-* Radio targets:: Make targets trigger links in plain text
+* Radio targets:: Make targets trigger links in plain text
@end menu
@node Radio targets, , Internal links, Internal links
methods to give you an overview of all the things that you have to do.
@menu
-* 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
+* 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
@end menu
@node TODO basics, TODO extensions, TODO Items, TODO Items
TODO items in particular (@pxref{Tags}).
@menu
-* 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
+* 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
@end menu
@node Workflow states, TODO types, TODO extensions, TODO extensions
work time}.
@menu
-* 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?
+* 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?
@end menu
@node Closing items, Tracking TODO state changes, Progress logging, Progress logging
(@pxref{Faces for TODO keywords}).
@menu
-* 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
+* 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
@end menu
@node Tag inheritance, Setting tags, Tags, Tags
(@pxref{Column view}).
@menu
-* 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
+* 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
@end menu
@node Property syntax, Special properties, Properties and Columns, Properties and Columns
queries have collected selected items, possibly from a number of files.
@menu
-* 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:: The COLUMNS format property
+* Using column view:: How to create and use column view
+* Capturing column view:: A dynamic block for column view
@end menu
@node Defining columns, Using column view, Column view, Column view
done by defining a column format line.
@menu
-* Scope of column definitions:: Where defined, where valid?
-* Column attributes:: Appearance and content of a column
+* Scope of column definitions:: Where defined, where valid?
+* Column attributes:: Appearance and content of a column
@end menu
@node Scope of column definitions, Column attributes, Defining columns, Defining columns
@example
:COLUMNS: %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.}
- %10Time_Estimate@{:@} %CLOCKSUM
+ %10Time_Estimate@{:@} %CLOCKSUM
:Owner_ALL: Tammy Mark Karl Lisa Don
:Status_ALL: "In progress" "Not started yet" "Finished" ""
:Approved_ALL: "[ ]" "[X]"
is used in a much wider sense.
@menu
-* 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
-* Resolving idle time:: Resolving time if you've been idle
-* Effort estimates:: Planning work effort in advance
-* Relative timer:: Notes with a running timer
+* 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
+* Resolving idle time:: Resolving time if you've been idle
+* Effort estimates:: Planning work effort in advance
+* Relative timer:: Notes with a running timer
@end menu
@menu
-* The date/time prompt:: How Org-mode helps you entering date and time
-* Custom time format:: Making dates look different
+* The date/time prompt:: How Org-mode helps you entering date and time
+* Custom time format:: Making dates look different
@end menu
@node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
sexp entry matches.
@menu
-* Inserting deadline/schedule:: Planning items
-* Repeated tasks:: Items that show up again and again
+* Inserting deadline/schedule:: Planning items
+* Repeated tasks:: Items that show up again and again
@end menu
@node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
trees to an archive file keeps the system compact and fast.
@menu
-* 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:: 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
@end menu
@node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
does enhance it with templates and more.
@menu
-* 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
+* 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
@end menu
@node Setting up capture, Using capture, Capture, Capture
@menu
-* Template elements:: What is needed for a complete template entry
-* Template expansion:: Filling in information about time and context
+* Template elements:: What is needed for a complete template entry
+* Template expansion:: Filling in information about time and context
@end menu
@node Template elements, Template expansion, Capture templates, Capture templates
@example
(setq org-feed-alist
'(("Slashdot"
- "http://rss.slashdot.org/Slashdot/slashdot"
- "~/txt/org/feeds.org" "Slashdot Entries")))
+ "http://rss.slashdot.org/Slashdot/slashdot"
+ "~/txt/org/feeds.org" "Slashdot Entries")))
@end example
@noindent
@end table
@menu
-* Moving subtrees:: Moving a tree to an archive file
-* Internal archiving:: Switch off a tree but keep it in the file
+* Moving subtrees:: Moving a tree to an archive file
+* Internal archiving:: Switch off a tree but keep it in the file
@end menu
@node Moving subtrees, Internal archiving, Archiving, Archiving
@code{org-agenda-restore-windows-after-quit}.
@menu
-* 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
+* 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
@end menu
@node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
In this section we describe the built-in views.
@menu
-* Weekly/daily agenda:: The calendar page with current tasks
-* Global TODO list:: All unfinished action items
+* 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
+* Timeline:: Time-sorted view for single file
+* Search view:: Find entries by searching for text
+* Stuck projects:: Find projects you need to review
@end menu
@node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
associated with the item.
@menu
-* Categories:: Not all tasks are equal
-* Time-of-day specifications:: How the agenda knows the time
-* Sorting of agenda items:: The order of things
+* Categories:: Not all tasks are equal
+* Time-of-day specifications:: How the agenda knows the time
+* Sorting of agenda items:: The order of things
@end menu
@node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
@group
(defun org-my-auto-exclude-function (tag)
(and (cond
- ((string= tag "Net")
- (/= 0 (call-process "/sbin/ping" nil nil nil
- "-c1" "-q" "-t1" "mail.gnu.org")))
- ((or (string= tag "Errand") (string= tag "Call"))
- (let ((hour (nth 2 (decode-time))))
- (or (< hour 8) (> hour 21)))))
+ ((string= tag "Net")
+ (/= 0 (call-process "/sbin/ping" nil nil nil
+ "-c1" "-q" "-t1" "mail.gnu.org")))
+ ((or (string= tag "Errand") (string= tag "Call"))
+ (let ((hour (nth 2 (decode-time))))
+ (or (< hour 8) (> hour 21)))))
(concat "-" tag)))
(setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
@menu
-* Storing searches:: Type once, use often
-* Block agenda:: All the stuff you need in a single buffer
-* Setting Options:: Changing the rules
+* Storing searches:: Type once, use often
+* Block agenda:: All the stuff you need in a single buffer
+* Setting Options:: Changing the rules
@end menu
@node Storing searches, Block agenda, Custom agenda views, Custom agenda views
summarizes the markup rules used in an Org-mode buffer.
@menu
-* 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:: 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
@end menu
@node Structural markup elements, Images and tables, Markup, Markup
@section Structural markup elements
@menu
-* 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
+* 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
@end menu
@node Document title, Headings and sections, Structural markup elements, Structural markup elements
to do with it.
@menu
-* 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
+* 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
@end menu
@node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
enabled (default in Emacs 23).
@menu
-* 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 La@TeX{}, 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
+* 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 La@TeX{}, 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
@end menu
@node Selective export, Export options, Exporting, Exporting
language, but with additional support for tables.
@menu
-* 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
-* 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
+* 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
+* 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
@end menu
@node HTML Export commands, Quoting HTML tags, HTML export, HTML export
linked.
@menu
-* LaTeX/PDF export commands:: Which key invokes which commands
-* Header and sectioning:: Setting up the export file structure
-* Quoting LaTeX code:: Incorporating literal La@TeX{} code
-* Tables in LaTeX export:: Options for exporting tables to La@TeX{}
-* Images in LaTeX export:: How to insert figures into La@TeX{} output
-* Beamer class export:: Turning the file into a presentation
+* LaTeX/PDF export commands:: Which key invokes which commands
+* Header and sectioning:: Setting up the export file structure
+* Quoting LaTeX code:: Incorporating literal La@TeX{} code
+* Tables in LaTeX export:: Options for exporting tables to La@TeX{}
+* Images in LaTeX export:: How to insert figures into La@TeX{} output
+* Beamer class export:: Turning the file into a presentation
@end menu
@node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
Currently DocBook exporter only supports DocBook V5.0.
@menu
-* 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
+* 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
@end menu
@node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
Publishing has been contributed to Org by David O'Toole.
@menu
-* Configuration:: Defining projects
-* Uploading files:: How to get files up on the server
-* Sample configuration:: Example projects
-* Triggering publication:: Publication commands
+* Configuration:: Defining projects
+* Uploading files:: How to get files up on the server
+* Sample configuration:: Example projects
+* Triggering publication:: Publication commands
@end menu
@node Configuration, Uploading files, Publishing, Publishing
and many other properties of a project.
@menu
-* 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
+* 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
@end menu
@node Project alist, Sources and destinations, Configuration, Configuration
more complex, with a multi-component project.
@menu
-* Simple example:: One-component publishing
-* Complex example:: A multi-component publishing example
+* Simple example:: One-component publishing
+* Complex example:: A multi-component publishing example
@end menu
@node Simple example, Complex example, Sample configuration, Sample configuration
The following sections describe Org-mode's code block handling facilities.
@menu
-* 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
+* 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
+* Batch execution:: Call functions from the command line
@end menu
@comment node-name, next, previous, up
describes each header argument in detail.
@menu
-* Using header arguments:: Different ways to set header arguments
-* Specific header arguments:: List of header arguments
+* Using header arguments:: Different ways to set header arguments
+* Specific header arguments:: List of header arguments
@end menu
@node Using header arguments, Specific header arguments, Header arguments, Header arguments
specific (and having higher priority) than the last.
@menu
* System-wide header arguments:: Set global default values
-* Language-specific header arguments:: Set default values by language
+* 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
The following header arguments are defined:
@menu
-* var:: Pass arguments to code blocks
-* results:: Specify the type of results and how they will
+* 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)
+* 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
-* no-expand:: Turn off variable assignment and noweb
+* exports:: Export code and/or results
+* tangle:: Toggle tangling and specify file name
+* no-expand:: Turn off variable assignment and noweb
expansion during tangling
* comments:: Toggle insertion of comments in tangled
code files
-* 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
+* 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
@end menu
@chapter Miscellaneous
@menu
-* Completion:: M-TAB knows what you need
-* 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
+* Completion:: M-TAB knows what you need
+* 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
@end menu
with other code out there.
@menu
-* Cooperation:: Packages Org cooperates with
-* Conflicts:: Packages that lead to conflicts
+* Cooperation:: Packages Org cooperates with
+* Conflicts:: Packages that lead to conflicts
@end menu
@node Cooperation, Conflicts, Interaction, Interaction
@lisp
(add-hook 'org-mode-hook
- (lambda ()
- (org-set-local 'yas/trigger-key [tab])
- (define-key yas/keymap [tab] 'yas/next-field-group)))
+ (lambda ()
+ (org-set-local 'yas/trigger-key [tab])
+ (define-key yas/keymap [tab] 'yas/next-field-group)))
@end lisp
@item @file{windmove.el} by Hovav Shacham
Org.
@menu
-* 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 La@TeX{} and other programs
-* Dynamic blocks:: Automatically filled blocks
-* Special agenda views:: Customized views
+* 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 La@TeX{} 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
+* Using the property API:: Writing programs that use entry properties
+* Using the mapping API:: Mapping over all or selected entries
@end menu
@node Hooks, Add-on packages, Hacking, Hacking
@menu
-* 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
+* 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
@end menu
@node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
(@pxref{Setting tags}) only for those set in these variables.
@menu
-* 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
+* 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
@end menu
@node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
projects / emacs.git / commitdiff