comparison man/org.texi @ 71098:b98399840395

Small typo fixes.

71097:440be7e69f07

\input texinfo

@c %**start of header
@setfilename ../info/org
@c @settitle Org Mode Manual

@set VERSION 4.34
@set DATE May 2006

@dircategory Emacs
@direntry
* Org Mode: (org).	outline-based notes management and organizer

will change the display so that @samp{description} is displayed instead
of @samp{[[link][description]]} and @samp{link} is displayed instead of
@samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
which by default is an underlined face.  You can directly edit the
visible part of a link.  Note that this can be either the @samp{link}
part (if there is not description) or the @samp{description} part.  To
edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
cursor on the link.

If you place the cursor at the beginning or just behind the end of the
displayed text and press @key{BACKSPACE}, you will remove the

@table @var
@item Plain time stamp
@cindex timestamp
A simple time stamp just assigns a date/time to an item.  This is just
like writing down an appointment in a paper agenda, or like writing down
an event in a diary, when you want to take not of when something
happened.  In the timeline and agenda displays, the headline of an entry
associated with a plain time stamp will be shown exactly on that date.

@item Time stamp range
@cindex timerange

automatically present you with a special interface, listing inherited
tags, the tags of the current headline, and a list of all legal tags
with corresponding keys.  Pressing keys for the tags will add or remove
them from the list of tags in the current line.  @key{SPC} clears all
tags for this line, @kbd{RET} accepts the modified set, and @kbd{C-g}
aborts without installing changes.  This method lets you assing tags to
a headline with very few keys.  With the above setup, you could clear
the current tags and set @samp{@@HOME}, @samp{Laptop} and @samp{PC} tags
with just the following keys: @kbd{C-c C-c @key{SPC} h l p @key{RET}}.

What if you have globally defined your preferred set of tags using the

@node ASCII export, HTML export, Exporting, Exporting
@section ASCII export
@cindex ASCII export

ASCII export produces an simple and very readable version of an Org-mode
file.

@cindex region, active
@cindex active region
@cindex transient-mark-mode

@node HTML export, XOXO export, ASCII export, Exporting
@section HTML export
@cindex HTML export

Org-mode contains an HTML exporter with extensive HTML formatting, in
ways similar to John Grubers @emph{markdown} language, but with
additional support for tables.

@cindex region, active
@cindex active region
@cindex transient-mark-mode
@table @kbd

@lisp
("project-name"  :property value :property value ...)

@r{or} 
 
("project-name"  
    ("component1" :property value :property value ...)
    ("component2" :property value :property value ...)
    ...)
@end lisp

In both cases, projects are configured by specifying property values.
A project defines the set of files that will be published, as well as
the publishing configuration to use when publishing those files. 
When a project takes the second form listed above, the individual
property lists are taken to be "components" of the project, which
group together files requiring different publishing options. 

@node File sources and destinations, Selecting files, Project alist, Configuration
@subsection Sources and destinations for files

Most properties are optional, but some should always be set. In

same. You can accomplish this by setting up an "images" folder in the
right place on the webserver, and publishing images to it.

@lisp
(setq org-publish-project-alist
      '(("website"
         ("orgfiles"
          :base-directory "~/org/"
          :base-extension "org"
          :publishing-directory "/ssh:user@@host:~/html/notebook/"
          :publishing-function org-publish-org-to-html
          :exclude "PrivatePage.org"   ;; regexp

 
         ("other"
          :base-directory "~/other/"
          :base-extension "css\\|el"
          :publishing-directory "/ssh:user@@host:~/html/other/"
          :publishing-function org-publish-attachment))))
@end lisp

@node Triggering publication,  , Sample configuration, Publishing
@section Triggering publication

These lines set the TODO keywords and their interpretation in the
current file.  The corresponding variables are @code{org-todo-keywords}
and @code{org-todo-interpretation}.
@item #+TAGS:  TAG1(c1) TAG2(c2)
These lines (several such lines are allowed) specify the legal tags in
this file, and (potionally) the corresponding @emph{fast tag selection}
keys.  The corresponding variable is @code{org-tag-alist}.
@item #+CATEGORY:
This line sets the category for the agenda file.  The category applies
for all subsequent lines until the next @samp{#+CATEGORY} line, or the
end of the file.
@item #+TBLFM:
This line contains the formulas for the table directly above the line.
@item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:
These lines provide setting for exporting files.  For more details see
@ref{Export options}.
@end table

@node The very busy C-c C-c key, Clean view, Summary of in-buffer settings, Miscellaneous
@section The very busy C-c C-c key

@lisp
(add-to-list 'auto-mode-alist '("README$" . org-mode))
@end lisp

@item @b{I would like to use editing features of org-mode in other
modes, is his possible?}@*
@c
Not really.  For tables there is @code{orgtbl-mode} which implements the
table editor as a minor mode.  For other features you need to switch to
Org-mode temporarily, or prepare text in a different buffer.

other things.
@item
Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s
@file{organizer-mode.el}.
@item
@i{David O'Toole} wrote @file{org-publish.el} and came up with lots is
ideas for small changes.
@item
@i{J@"urgen Vollmer} contributed code generating the table of contents
in HTML output.
@item

71098:b98399840395

\input texinfo

@c %**start of header
@setfilename ../info/org
@settitle Org Mode Manual

@set VERSION 4.35
@set DATE May 2006

@dircategory Emacs
@direntry
* Org Mode: (org).	outline-based notes management and organizer

will change the display so that @samp{description} is displayed instead
of @samp{[[link][description]]} and @samp{link} is displayed instead of
@samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
which by default is an underlined face.  You can directly edit the
visible part of a link.  Note that this can be either the @samp{link}
part (if there is no description) or the @samp{description} part.  To
edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
cursor on the link.

If you place the cursor at the beginning or just behind the end of the
displayed text and press @key{BACKSPACE}, you will remove the

@table @var
@item Plain time stamp
@cindex timestamp
A simple time stamp just assigns a date/time to an item.  This is just
like writing down an appointment in a paper agenda, or like writing down
an event in a diary, when you want to take note of when something
happened.  In the timeline and agenda displays, the headline of an entry
associated with a plain time stamp will be shown exactly on that date.

@item Time stamp range
@cindex timerange

automatically present you with a special interface, listing inherited
tags, the tags of the current headline, and a list of all legal tags
with corresponding keys.  Pressing keys for the tags will add or remove
them from the list of tags in the current line.  @key{SPC} clears all
tags for this line, @kbd{RET} accepts the modified set, and @kbd{C-g}
aborts without installing changes.  This method lets you assign tags to
a headline with very few keys.  With the above setup, you could clear
the current tags and set @samp{@@HOME}, @samp{Laptop} and @samp{PC} tags
with just the following keys: @kbd{C-c C-c @key{SPC} h l p @key{RET}}.

What if you have globally defined your preferred set of tags using the

@node ASCII export, HTML export, Exporting, Exporting
@section ASCII export
@cindex ASCII export

ASCII export produces a simple and very readable version of an Org-mode
file.

@cindex region, active
@cindex active region
@cindex transient-mark-mode

@node HTML export, XOXO export, ASCII export, Exporting
@section HTML export
@cindex HTML export

Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
HTML formatting, in ways similar to John Grubers @emph{markdown}
language, but with additional support for tables.

@cindex region, active
@cindex active region
@cindex transient-mark-mode
@table @kbd

@lisp
("project-name"  :property value :property value ...)

@r{or} 
 
("project-name"  :components ("project-name" "project-name" ...))

@end lisp

In both cases, projects are configured by specifying property values.
A project defines the set of files that will be published, as well as
the publishing configuration to use when publishing those files.  When
a project takes the second form listed above, the individual members
of the ``components'' property are taken to be components of the
project, which group together files requiring different publishing
options. When you publish such a ``meta-project'' all the components
will also publish.

@node File sources and destinations, Selecting files, Project alist, Configuration
@subsection Sources and destinations for files

Most properties are optional, but some should always be set. In

same. You can accomplish this by setting up an "images" folder in the
right place on the webserver, and publishing images to it.

@lisp
(setq org-publish-project-alist
      '(("orgfiles"
          :base-directory "~/org/"
          :base-extension "org"
          :publishing-directory "/ssh:user@@host:~/html/notebook/"
          :publishing-function org-publish-org-to-html
          :exclude "PrivatePage.org"   ;; regexp

 
         ("other"
          :base-directory "~/other/"
          :base-extension "css\\|el"
          :publishing-directory "/ssh:user@@host:~/html/other/"
          :publishing-function org-publish-attachment)
         ("website" :components ("orgfiles" "images" "other"))))
@end lisp

@node Triggering publication,  , Sample configuration, Publishing
@section Triggering publication

These lines set the TODO keywords and their interpretation in the
current file.  The corresponding variables are @code{org-todo-keywords}
and @code{org-todo-interpretation}.
@item #+TAGS:  TAG1(c1) TAG2(c2)
These lines (several such lines are allowed) specify the legal tags in
this file, and (potentially) the corresponding @emph{fast tag selection}
keys.  The corresponding variable is @code{org-tag-alist}.
@item #+CATEGORY:
This line sets the category for the agenda file.  The category applies
for all subsequent lines until the next @samp{#+CATEGORY} line, or the
end of the file.
@item #+TBLFM:
This line contains the formulas for the table directly above the line.
@item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:
These lines provide settings for exporting files.  For more details see
@ref{Export options}.
@end table

@node The very busy C-c C-c key, Clean view, Summary of in-buffer settings, Miscellaneous
@section The very busy C-c C-c key

@lisp
(add-to-list 'auto-mode-alist '("README$" . org-mode))
@end lisp

@item @b{I would like to use editing features of org-mode in other
modes, is this possible?}@*
@c
Not really.  For tables there is @code{orgtbl-mode} which implements the
table editor as a minor mode.  For other features you need to switch to
Org-mode temporarily, or prepare text in a different buffer.

other things.
@item
Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s
@file{organizer-mode.el}.
@item
@i{David O'Toole} wrote @file{org-publish.el} and came up with lots of
ideas for small changes.
@item
@i{J@"urgen Vollmer} contributed code generating the table of contents
in HTML output.
@item