Commit Graph

888 Commits

Author SHA1 Message Date
Carsten Dominik c3cfb22fcc Merge branch 'master' of git+ssh://repo.or.cz/srv/git/org-mode 2010-07-18 07:33:53 +02:00
Carsten Dominik d5810cf41c Minor documentation fix
Patch by Sebastian Rose
2010-07-18 07:33:50 +02:00
Eric Schulte 49586dfdbd minor babel documentation fixes 2010-07-16 17:28:53 -07:00
Carsten Dominik 619b8591fc More credit in the manual 2010-07-16 14:27:23 +02:00
Dan Davison 94361a58d6 babel doc: minor edits 2010-07-14 15:20:29 -04:00
Eric Schulte e3af061f90 doc: two tiny tweaks to the babel indexing documentation 2010-07-14 11:08:58 -07:00
Eric Schulte 32b7a76d41 babel: cleaned up code and improved documentation of indexing into variables
* lisp/ob-ref.el (org-babel-ref-index-list): slight code cleanup, also
  now allowing an empty index to mean the entire range

* doc/org.texi (var): updated the documentation of Babel index
  referencing to include working examples covering the full range of
  index behavior
2010-07-14 11:01:57 -07:00
Eric Schulte e6a274824d babel doc: cleaned up documentation on "Evaluating code blocks" 2010-07-14 09:53:59 -07:00
Carsten Dominik d5229333cd Finalize documentation about radio lists 2010-07-13 13:42:03 +02:00
Carsten Dominik acf44c879a Fix radio lists
* lisp/org-list.el (org-list-send-list): Parse list from its true beginning.
* lisp/org.el (org-ctrl-c-ctrl-c): Maybe send the list when at a list item.
* doc/org.texi (Radio lists): Fix bug in description of radio lists.
2010-07-13 13:36:14 +02:00
Carsten Dominik ceb63ae94e Fix typo, ORGLIST versus ORGLST 2010-07-12 19:06:14 +02:00
Carsten Dominik c1efc0a1d7 Use Slashdot.org as feed example in the documentation
* doc/org.texi (RSS Feeds): Use slashdot.org as the example,
and mention atoms feeds as well.
2010-07-12 14:01:35 +02:00
Nicolas Goaziou 94689a04b0 Fix regexp for `org-list-send-list'.
* lisp/org-list.el (org-list-send-list): regexp defining the start of
a radio list is now on par with the one used for radio tables.
2010-07-12 11:48:44 +02:00
Carsten Dominik 227b24f517 Merge branch 'master' of git+ssh://repo.or.cz/srv/git/org-mode 2010-07-12 07:46:30 +02:00
Carsten Dominik fb732b2a15 Fix typo ORGLST versus ORGLIST in the manual
Reported by Nick Dokos
2010-07-12 07:46:22 +02:00
Eric Schulte f95a8b7d2f documentation for `org-babel-post-tangle-hook
* doc/org.texi (Extracting source code): documentation for
`org-babel-post-tangle-hook
'
2010-07-11 21:37:10 -07:00
Eric Schulte 19e98b1b0f documentation of new `org-export-babel-evaluate' variable
* doc/org.texi (Exporting code blocks): adding documentation of the
  `org-export-babel-evaluate' variable
2010-07-08 10:47:22 -07:00
Philip Rooke ca2d633d51 A few typos
Correct a few spelling mistakes.  Some of these are American vs British
spelling disagreements but the Org documentation uses the US spellings.
2010-07-08 06:43:05 +02:00
Carsten Dominik 04e21124c3 Fix typo 2010-07-06 08:25:59 +02:00
Eric Schulte 07b8908903 ob-mscgen: support for mscgen code blocks by Juan Pechiar
from the comments of the new file

This software provides EMACS org-babel export support for message
sequence charts. The mscgen utility is used for processing the
sequence definition, and must therefore be installed in the system.

Mscgen is available and documented at
http://www.mcternan.me.uk/mscgen/index.html

This code is directly inspired by Eric Schulte's ob-dot.el

Example:

msc {
 A,B;
 A -> B [ label = "send message" ];
 A <- B [ label = "get answer" ];
}

Header for alternative file type:

This differs from most standard languages in that

1) there is no such thing as a "session" in mscgen
2) we are generally only going to return results of type "file"
3) we are adding the "file" and "filetype" header arguments
4) there are no variables
2010-07-05 18:48:47 -07:00
Eric Schulte e4cfd468a0 babel: :eval header argument takes arguments "never" and "query" to limit evaluation
* lisp/ob.el (org-babel-confirm-evaluate): adding a new :eval header
  argument which can be used to control evaluation

* doc/org.texi (eval): adding documentation for the new :eval header
  argument
2010-07-05 15:51:36 -07:00
Eric Schulte 5ded079a1a Merge branch 'safety-babel' 2010-07-05 11:31:03 -07:00
Eric Schulte f268317f70 babel: added documentation of the :comments header argument 2010-07-05 11:14:51 -07:00
Eric Schulte b2734943ca babel doc points to code security doc and to babel security variables 2010-07-05 11:14:50 -07:00
Carsten Dominik 040b2aa6b2 Indent-mode: Disable in Emacs 21 and earlier
* lisp/org-indent.el (org-indent-mode): Refuse to turn on prior to Emacs 23.2
2010-07-05 17:46:19 +02:00
Carsten Dominik 3c4b18c00c Capture: Fix documentation bug (%! and %& o longer meaningful) 2010-07-05 15:27:07 +02:00
Stephen Eglen 586ce3f7f2 Fix typos and wording in the new manual section about capture.
patch by Stephen Eglen.

Here is a patch for the 'capture' section of org.texi .  I've added a
few lines of @comments:

+@comment SJE: Should be Org file or Org-mode file (see prev two items)?

+@comment SJE: should these sentences terminate in period?
(i.e. the following lines in the table)

+@comment SJE: org-feed is not autoloaded - should that be mentioned?

Stephen
2010-07-05 15:03:48 +02:00
Carsten Dominik b3c9fedef0 Fix leftover merge conflicts 2010-07-02 07:04:57 +02:00
Carsten Dominik 42f239cb0e Merge branch 'new-pw'
Conflicts:
	doc/org.texi
2010-07-02 06:06:27 +02:00
Carsten Dominik 15829f207f Add section on code evaluation security
* doc/org.texi (Code evaluation security): New section
2010-07-02 06:04:17 +02:00
Carsten Dominik 929f8b385d Add section on code evaluation security
* doc/org.texi (Code evaluation security): New section
2010-07-02 05:50:52 +02:00
Carsten Dominik 48730be21f Fix typo 2010-07-01 13:52:43 +02:00
Carsten Dominik 1318128a24 Make Org-babel key table more readable
Insert extra space around "or".
2010-06-29 06:25:01 +02:00
Carsten Dominik ec51d1fee3 Clean up capitalization of headings in the manual
Patch by Thomas S Dye.
2010-06-27 00:23:33 +02:00
Carsten Dominik d3e3a3ce0a Document nil as a special property value 2010-06-26 07:59:00 +02:00
Carsten Dominik 6aac0a449f Merge branch 'master' of git+ssh://repo.or.cz/srv/git/org-mode 2010-06-26 06:38:31 +02:00
Julien Danjou 8c17c53002 Fix missing : in documentation
Signed-off-by: Julien Danjou <julien@danjou.info>
2010-06-26 06:37:01 +02:00
Carsten Dominik 41c832ef6f Fix typo 2010-06-25 20:49:55 +02:00
Carsten Dominik 312081b376 More tweaks at the capture documentation 2010-06-25 18:28:04 +02:00
Carsten Dominik 9bf78c7db4 Point to a PDF copy of the old org-remember documentation 2010-06-25 17:32:29 +02:00
Carsten Dominik 8f83ac51ee Add documentation for capture 2010-06-25 16:40:47 +02:00
Carsten Dominik eae7ccd5b0 Augment the acknowledgements to reflect the addition of Org Babel 2010-06-25 09:51:57 +02:00
Carsten Dominik 6724bcfa94 Clean up org-babel documentation
Patch by Thomas S. Dye
2010-06-25 09:09:34 +02:00
Eric Schulte 024974299c babel: updating documentation for new babel 'ob* require syntax
Thanks to Bernt Hansen for pointing this out

* doc/org.texi (Languages): updating require statements for the next
  org-babel syntax

  (Batch execution): updating require statements for the next
  org-babel syntax
2010-06-23 17:27:23 -07:00
Eric Schulte 3429a496a3 merged with master 2010-06-22 11:55:19 -07:00
Carsten Dominik 36b6471858 Merge branch 'improve-todo-match-documentation' 2010-06-22 14:47:45 +02:00
Carsten Dominik 2e73ce2177 Clarify that TODO matches only match not-DONE states by default
Bernt Hansen writes:

> I was talking to Jeff Stern about tags todo matching offlist and we
> think the documentation for tags-todo matching can probably be improved.
>
> The description of C-c a M at
> http://orgmode.org/manual/Matching-tags-and-properties.html
> states
>
> C-c a M
>
>    Like C-c a m, but only select headlines that are also TODO items and
>    force checking subitems (see variable
>    org-tags-match-list-sublevels). To exclude scheduled/deadline items,
>    see the variable org-agenda-tags-todo-honor-ignore-options. Matching
>    specific TODO keywords together with a tags match is also possible,
>    see Tag searches.
>
> When I read this I think TODO items is any todo keyword but this isn't
> the case.  It is only non-done TODO state keywords.  This makes
> tags-todo matching not work for finding tasks to archive (normally
> DONE | CANCELLED keywords in my setup)
>
> Should we explicitly state that 'headlines that are also TODO items'
> does not match DONE state keywords?  Or alternatively should TODO items
> and DONE items be separate (and explicitly defined) in the documentation
> -- like org-todo-keywords and org-done-keywords?
>
> I still think 'TODO keyword' matches any todo keyword defined in
> org-todo-keywords and maybe I need to be re-educated :)

Bernt is right, and this patch tries to clarify the issue.
2010-06-22 14:47:37 +02:00
Carsten Dominik 1d52e54efd New capture system org-capture
* lisp/org-agenda.el (org-agenda-action): Make `c' key call org-capture.
* lisp/org-capture.el: New file.
* lisp/org-compat.el (org-get-x-clipboard): Function moved here from
remember.el.
* lisp/org-mks.el: New file
* lisp/org.el (org-set-regexps-and-options): Allow statistic cookies as
part of complex headlines.
(org-find-olp): New argument THIS-BUFFER.  When set, assume that the
OLP does not contain a file name.
2010-06-22 14:19:18 +02:00
Eric Schulte cab1e23d61 babel-doc: adding c++ and sqlite as supported languages, and removing table comment 2010-06-17 18:15:35 -07:00
Eric Schulte 9c7bad1fab babel-doc: adding buffer-wide header argument documentation 2010-06-17 18:15:35 -07:00
Eric Schulte 7b19b0e547 delete trailing whitespace 2010-06-17 18:15:35 -07:00
Tom Dye b5efd50fb5 Last chance clean-up of org.texi 2010-06-17 18:15:35 -07:00
Eric Schulte 0f633df264 babel-doc: now compiling again 2010-06-17 18:15:34 -07:00
Tom Dye 3afe60dcde babel-doc: Changed description of function that asks before switching buffers 2010-06-17 18:15:34 -07:00
Tom Dye cbd9bba834 First pass through babel documentation (on airplane) 2010-06-17 18:15:34 -07:00
Eric Schulte 7dba834dbe minor bug fix 2010-06-17 18:15:34 -07:00
Tom Dye b548c3e794 Minor editorial changes to babel documentation (Seattle Airport) 2010-06-17 18:15:33 -07:00
Tom Dye 5fa1dcccad babel-doc: edits 2010-06-17 18:15:31 -07:00
Eric Schulte 97928ae08e babel-doc: tiny doc tweak 2010-06-17 18:15:31 -07:00
Eric Schulte 3bb8bdb7e5 babel-doc: changed header-argument order 2010-06-17 18:15:31 -07:00
Eric Schulte bb834903dd babel-doc: adding no-expand header argument 2010-06-17 18:15:31 -07:00
Eric Schulte bb6f835d12 babel-doc: tweak 2010-06-17 18:15:31 -07:00
Eric Schulte 16fa9b6c99 babel-doc: adding information on hlines colnames and rownames header args 2010-06-17 18:15:31 -07:00
Eric Schulte b89ce3712e babel-doc: host of minor aesthetic changes to babel documentation
also stripped out superfluous function documentation.
2010-06-17 18:15:31 -07:00
Eric Schulte 8d2e2caa37 babel-doc: a completed first pass through and it's looking pretty good 2010-06-17 18:15:31 -07:00
Eric Schulte 653694fff7 babel-doc: exhausting formulation of babel documentation into texinfo 2010-06-17 18:15:31 -07:00
Eric Schulte 33cc42ef53 babel-doc: stripped some @code{} wrappers and everything is now compiling 2010-06-17 18:15:30 -07:00
Eric Schulte 2760c8e798 babel-doc: working on Header Arguments -- not quite compiling 2010-06-17 18:15:30 -07:00
Eric Schulte d7b2397184 pushing through first half or so of babel documentation, compiling 2010-06-17 18:15:30 -07:00
Tom Dye 9e8b6c0831 Changed old C-c M-b prefixes to C-c C-v 2010-06-17 18:15:30 -07:00
Dan Davison 3ac08f1b4e Edits, mainly to header args section 2010-06-17 18:15:30 -07:00
Dan Davison f5e8f5e878 Work on initial sections. 2010-06-17 18:15:30 -07:00
Dan Davison 77fd62ec3b Add entry to main menu 2010-06-17 18:15:30 -07:00
Dan Davison 27dcffe592 Minor edits 2010-06-17 18:15:30 -07:00
Dan Davison f2b1a0fd7c Use angle bracket tags to refer to structural elements of code block 2010-06-17 18:15:30 -07:00
Dan Davison e25035855f Move new chapter into main org.texi file
It is currently impractical to work with it as an @included file,
because the automatic node pointer updates do not work by default.
2010-06-17 18:15:30 -07:00
Dan Davison 10010aa326 Create texinfo node structures for new chapter 2010-06-17 18:15:30 -07:00
Dan Davison df2252b87f Initialise new source code chapter with reference.org from Worg
source-code-chapter.texi is just reference.org with level 1 headings
replaced with @section, and level 2 headings replaced with
@subsection, and with a top level @chapter node. This file is included
in org.texi with an @include line for now.
2010-06-17 18:15:29 -07:00
Bastien Guerry 76d212e8fd Fix an error in documentation of date/time prompt section.
Thanks to Puneeth Chaganti <punchagan@gmail.com> for this patch.
2010-06-16 21:34:04 +02:00
Bastien Guerry 476d24320c org.texi: Fix tiny typo. 2010-06-16 16:04:11 +02:00
Eric Schulte d3b7952159 Fix typo in documentation
thanks to Puneeth Chaganti for the patch
2010-06-12 10:46:12 -07:00
Christian Egli 964f8dab5b Add documentation for TaskJuggler export 2010-06-08 09:20:34 +02:00
Carsten Dominik fd1d2992f6 Make it possible to protect hidden subtrees to be killed by `C-k'
* lisp/org.el (org-ctrl-k-protect-subtree): New option.
(org-kill-line): Protect hidden subtrees if the user wants it.
* doc/org.texi (Headlines): Mention the special behavior of C-k
in headlines.

Scott Otterson writes:

> For what must be the dozenth time, I've just accidentally deleted a
> large tree by typing C-k while in a headline.
>
> This is really easy to do because emacs users have "C-k deletes to the
> end of the line" worn deeply into their neural pathways -- it's so
> automatic for me that the keystroke is close to subconscious.  A
> mistaken C-k is especially hard to detect because org-mode displays
> the result exactly like what your subconscious expects, that is, a
> collapsed headline is deleted to the end -- and the tree underneath is
> wiped out with no noticeable warning.
>
> Feature request: add an option preventing tree deletion with C-k
> without user confirmation.  Actually, I'd like an option to prevent it
> period.
>
> If this option is already in there, then you're encouraged to tell me
> to RTFM.  But then also please tell me where it is, because I can't
> find it.

Carsten replies

> This is now possible due to the variable
> `org-ctrl-k-protect-subtree'.  But I predict that you are going to set
> it to nil again soon :D
2010-06-03 00:18:44 +02:00
Carsten Dominik 70d24c5d03 Implement pretty display of sub- and superscripts.
* doc/org.texi (Subscripts and superscripts): Document that `C-c C-x \'
will also format sub and superscripts.
* doc/orgcard.tex: Document that `C-c C-x \'
will also format sub and superscripts.
* lisp/org.el (org-use-sub-superscripts):
(org-pretty-entities-include-sub-superscripts): Move here from
org-exp.el.
(org-set-regexps-and-options): Parse subscript option and set
`org-use-sub-superscripts' as a local variable.
(org-match-sexp-depth):
(org-create-multibrace-regexp):
(org-match-substring-regexp):
(org-match-substring-with-braces-regexp): Moved here from org-exp.el
(org-set-font-lock-defaults): Call `org-raise-scripts'.
(org-remove-font-lock-display-properties): New function.
(org-unfontify-region): Call
`org-remove-font-lock-display-properties'.
(org-script-display): New constant.
(org-raise-scripts): New function.

When turning on entity display with `C-c C-x \', sub- and superscripts
will also be displayed in a smaller font, and raised/lowered.
2010-06-03 00:06:19 +02:00
Carsten Dominik 5f168ad614 Minor documentation fix 2010-06-01 06:01:10 +02:00
Carsten Dominik ea3cdc75f8 Improve MobileOrg documentation
* doc/org.texi (MobileOrg): Improve documentation about MobileOrg,
move all webdav server configuration to the FAQ.
2010-05-31 09:14:58 +02:00
Carsten Dominik 03c98ecabd Document Emacs crashes with org-indent-mode prior to Emacs 23.2
* doc/org.texi (Clean view): Mention that org-indent-mode can
crash Emacs prior to 23.2.
2010-05-28 08:41:58 +02:00
Carsten Dominik a49a64575b Document the use of `org-list-demote-modify-bullet'.
* doc/org.texi (Plain lists): Document
`org-list-demote-modify-bullet'.

* lisp/org-list.el (org-list-demote-modify-bullet): Improve docstring
by showing an example.

This change was triggered by a request by Livin Stephen Sharma.
2010-05-23 07:11:01 +02:00
Carsten Dominik 5b68cf4c4f Allow to skip steps in clock reports that have zero time
* org-clock.el (org-dblock-write:clocktable): Return total time.
(org-clocktable-steps): Skip step when time is zero and the
:stepskip0 property is set.

Rainer Stengele writes:

> Creating clocktables for each day of a month is an excellent feature
> in org!  Problem for me is that many resulting tables have a total
> time of 0:00.  The problem is not really the zero time I spent but the
> appearance of the tables with zero total time.
>
> Is there a possibility to skip getting such tables?  Rational: I do
> not need to show my boss or customer days where I spent 0:00 time on
> the project.

Now you can set :stepskip0 to achieve this.
2010-05-22 08:18:20 +02:00
Carsten Dominik 7403cb1992 Hide subtree before exposing the headings with `C-c C-k'
Proposed by Ali Tofigh.

Now `C-c C-k' always creates the same view, independent of what the
subtree visibility was before.
2010-05-20 08:51:54 +02:00
Carsten Dominik 80133cb059 Documentation fix 2010-05-19 11:37:13 +02:00
Carsten Dominik 245b300a2e Fix documentation about link abbreviations 2010-05-19 01:05:50 +02:00
Carsten Dominik 679e3b7f03 Implement caching of refile targets 2010-05-17 19:27:08 +02:00
Carsten Dominik b84aa975e0 Fix some typos 2010-05-17 11:24:10 +02:00
Carsten Dominik 7f86e0dedb Display entites as UTF8 characters
Based on code by Eric Schulte
2010-05-16 07:46:37 +02:00
Carsten Dominik 2d3817d51a LaTeX export: Implement table* environment for wide tables
Patch by Chris Gray.
2010-05-15 14:26:38 +02:00
Carsten Dominik f4ac28844e Document the use of the org-export-docbook-xslt-stylesheet variable
Patch by Baoqiu Cui.
2010-05-15 08:07:02 +02:00
Carsten Dominik c069b7c5c6 Make update of ascii refcard auomatic 2010-05-12 16:22:06 +02:00
Carsten Dominik 70354f0898 Minor doc fixes 2010-05-12 08:12:01 +02:00
Carsten Dominik 3d8b6de2ad Free up the `C-c C-v' key for Org Babel
TODO sparse trees are also accessible with `C-c / t'.
2010-05-12 08:04:27 +02:00