(org)Top


Org Mode Manual
***************

This manual is for Org-mode (version 4.67).

   Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation

     Permission is granted to copy, distribute and/or modify this
     document under the terms of the GNU Free Documentation License,
     Version 1.1 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 freedom to copy and
     modify this GNU Manual, like GNU software.  Copies published by
     the Free Software Foundation raise funds for GNU development."

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
Timestamps: Assign date and time to items
Tags: Tagging headlines and matching sets of tags
Agenda views: Collecting information into views
Embedded LaTeX: LaTeX fragments and formulas
Exporting: Sharing and publishing of notes
Publishing: Create a web site of linked Org-mode files
Miscellaneous: All the rest which did not fit elsewhere
Extensions and Hacking: It is possible to write add-on code
History and Acknowledgments: How Org-mode came into being
GNU Free Documentation License: The license for this documentation.
Index: The fast road to specific information
Key Index: Key bindings and where they are described

--- The Detailed Node Listing --- Introduction

Summary: Brief summary of what Org-mode does
Installation: How to install a downloaded version of Org-mode
Activation: How to activate Org-mode for certain buffers.
Feedback: Bug reports, ideas, patches etc.

Document Structure

Outlines: Org-mode 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
Archiving: Move done task trees to a different place
Sparse trees: Matches embedded in context
Plain lists: Additional structure within an entry

Archiving

ARCHIVE tag: Marking a tree as inactive
Moving subtrees: Moving a tree to an archive file

Tables

Built-in table editor: Simple tables
Narrow columns: Stop wasting space in tables
orgtbl-mode: The table editor as minor mode
The spreadsheet: The table editor has spreadsheet capabilities.

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-mode 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
Link abbreviations: Shortcuts for writing complex links
Search options: Linking to a specific location
Custom searches: When the default search is not enough
Remember: Org-trees store quick notes

Internal links

Radio targets: Make targets trigger links in plain text.

Remember

Setting up remember: Some code for .emacs to get things going
Remember templates: Define the outline of different note types
Storing notes: Directly get the note to where it belongs

TODO items

TODO basics: Marking and displaying TODO entries
TODO extensions: Workflow and assignments
Priorities: Some things are more important than others
Breaking down tasks: Splitting a task into managable pieces
Checkboxes: Tick-off lists

Extended use of TODO keywords

Workflow states: From TODO to DONE in steps
TODO types: I do this, Fred the rest
Per file keywords: Different files, different requirements

Timestamps

Time stamps: Assigning a time to a tree entry
Creating timestamps: Commands which insert timestamps
Custom time format: If you cannot work with the ISO format
Repeating items: Deadlines that come back again and again
Progress logging: Documenting when what work was done.

Creating timestamps

The date/time prompt: How org-mode helps you entering date and time

Progress Logging

Closing items: When was this entry marked DONE?
Tracking TODO state changes: When did the status change?
Clocking work time: When exactly did you work on this item?

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

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

The built-in agenda views

Weekly/Daily agenda: The calendar page with current tasks
Global TODO list: All unfinished action items
Matching headline tags: Structured information with fine-tuned search
Timeline: Time-sorted view for single file
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
Batch processing: Agenda views from the command line

Embedded LaTeX

Math symbols: TeX macros for symbols and Greek letters
Subscripts and Superscripts: Simple syntax for raising/lowering text
LaTeX fragments: Complex formulas made easy
Processing LaTeX fragments: Previewing LaTeX processing
CDLaTeX mode: Speed up entering of formulas

Exporting

ASCII export: Exporting to plain ASCII
HTML export: Exporting to HTML
XOXO export: Exporting to XOXO
iCalendar export: Exporting in iCalendar format
Text interpretation: How the exporter looks at the file

HTML export

Export commands: How to invode HTML export
Quoting HTML tags: Using direct HTML in Org-mode
Links: How hyperlinks get transferred to HTML
Images: To inline or not to inline?
CSS support: Style specifications

Text interpretation by the exporter

Comment lines: Some lines will not be exported
Enhancing text: Subscripts, symbols and more
Export options: How to influence the export settings

Publishing

Configuration: Defining projects
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?
Project page index: Publishing a list of project files

Sample configuration

Simple example: One-component publishing
Complex example: A multi-component publishing example

Miscellaneous

Completion: M-TAB knows what you need
Customization: Adapting Org-mode 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-mode on a tty
Interaction: Other Emacs packages
Bugs: Things which do not work perfectly

Interaction with other packages

Cooperation: Packages Org-mode cooperates with
Conflicts: Packages that lead to conflicts

Extensions, Hooks and Hacking

Extensions: Existing 3rd-part extensions
Tables in arbitrary syntax: Orgtbl for LaTeX and other programs
Dynamic blocks: Automatically filled blocks
Special agenda views: Customized views

Tables in arbitrary syntax

Radio tables: Sending and receiving
A LaTeX example: Step by step, almost a tutorial
Translator functions: Copy and modify

automatically generated by info2www version 1.2.2.9