aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorBastien Guerry2012-12-12 17:47:07 +0100
committerBastien Guerry2012-12-12 17:47:07 +0100
commit63aa098259339e924d8a7d40c59a34e579132af6 (patch)
treea23b00ff5e7fd931aadc58f1cffdd00f1f27db5f /doc
parent14b8c3d926ef813f621f95b0dcd059192d3d898c (diff)
downloademacs-63aa098259339e924d8a7d40c59a34e579132af6.tar.gz
emacs-63aa098259339e924d8a7d40c59a34e579132af6.zip
Merge upstream Org (from commit 488eea)
Diffstat (limited to 'doc')
-rw-r--r--doc/misc/ChangeLog18
-rw-r--r--doc/misc/org.texi65
2 files changed, 53 insertions, 30 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index ae9f099de50..b96345ba135 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,21 @@
12012-12-12 Bastien Guerry <bzg@gnu.org>
2
3 * org.texi (Summary, Code block specific header arguments)
4 (Code block specific header arguments)
5 (Header arguments in function calls, var, noweb)
6 (Results of evaluation, Code evaluation security): Small
7 reformatting: add a blank line before some example.
8
9 * org.texi (System-wide header arguments)
10 (Header arguments in Org mode properties, Conflicts)
11 (Dynamic blocks, Using the mapping API): Fix indendation of
12 Elisp code examples.
13
14 * org.texi (Comment lines): Fix description of the comment syntax.
15
16 * org.texi (Installation): Mention "make test" in the correct
17 section.
18
12012-12-02 Michael Albinus <michael.albinus@gmx.de> 192012-12-02 Michael Albinus <michael.albinus@gmx.de>
2 20
3 * tramp.texi (Top, Obtaining Tramp): Replace CVS by Git. 21 * tramp.texi (Top, Obtaining Tramp): Replace CVS by Git.
diff --git a/doc/misc/org.texi b/doc/misc/org.texi
index 700dffd26bf..b8c385fab29 100644
--- a/doc/misc/org.texi
+++ b/doc/misc/org.texi
@@ -834,7 +834,6 @@ ends, for example:
834@r{@bullet{} an environment for literate programming} 834@r{@bullet{} an environment for literate programming}
835@end example 835@end example
836 836
837
838@cindex FAQ 837@cindex FAQ
839There is a website for Org which provides links to the newest 838There is a website for Org which provides links to the newest
840version of Org, as well as additional information, frequently asked 839version of Org, as well as additional information, frequently asked
@@ -879,8 +878,6 @@ Lisp and Info files will be installed. If the Emacs binary is not in your
879path, give the full path to the executable. Avoid spaces in any path names. 878path, give the full path to the executable. Avoid spaces in any path names.
880@item Run @code{make config} 879@item Run @code{make config}
881again to check the configuration. 880again to check the configuration.
882@item Optionally run @code{make test}
883to build Org mode and then run the full testsuite.
884@item Run @code{make install} or @code{sudo make install} 881@item Run @code{make install} or @code{sudo make install}
885to build and install Org mode on your system. 882to build and install Org mode on your system.
886@end itemize 883@end itemize
@@ -903,6 +900,8 @@ Emacs binary is not in your path, you must give the full path to the
903executable. Avoid spaces in any path names. 900executable. Avoid spaces in any path names.
904@item Run @code{make config} 901@item Run @code{make config}
905to check the configuration. 902to check the configuration.
903@item Optionally run @code{make test}
904to build Org mode and then run the full testsuite.
906@item Run @code{make update2} or @code{make up2} 905@item Run @code{make update2} or @code{make up2}
907to update the Git repository and build and install Org mode. The latter 906to update the Git repository and build and install Org mode. The latter
908invocation runs the complete test suite before installation and installs only 907invocation runs the complete test suite before installation and installs only
@@ -947,7 +946,7 @@ description on Worg}.
947Installing Info files is system dependent, because of differences in the 946Installing Info files is system dependent, because of differences in the
948@file{install-info} program. The Info documentation is installed together 947@file{install-info} program. The Info documentation is installed together
949with the rest of Org mode. If you don't install Org mode, it is possible to 948with the rest of Org mode. If you don't install Org mode, it is possible to
950install the Info documentation separately (you need to have 949install the Info documentation seperately (you need to have
951install-info@footnote{The output from install-info (if any) is system 950install-info@footnote{The output from install-info (if any) is system
952dependent. In particular Debian and its derivatives use two different 951dependent. In particular Debian and its derivatives use two different
953versions of install-info and you may see the message: 952versions of install-info and you may see the message:
@@ -9222,11 +9221,11 @@ a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
9222@cindex exporting, not 9221@cindex exporting, not
9223@cindex #+BEGIN_COMMENT 9222@cindex #+BEGIN_COMMENT
9224 9223
9225Lines starting with zero or more whitespace characters followed by @samp{#} 9224Lines starting with zero or more whitespace characters followed by one
9226are treated as comments and will never be exported. Also entire subtrees 9225@samp{#} and a whitespace are treated as comments and will never be exported.
9227starting with the word @samp{COMMENT} will never be exported. Finally, 9226Also entire subtrees starting with the word @samp{COMMENT} will never be
9228regions surrounded by @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will 9227exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
9229not be exported. 9228... @samp{#+END_COMMENT} will not be exported.
9230 9229
9231@table @kbd 9230@table @kbd
9232@kindex C-c ; 9231@kindex C-c ;
@@ -13155,8 +13154,8 @@ blocks.
13155 13154
13156@lisp 13155@lisp
13157(setq org-babel-default-header-args 13156(setq org-babel-default-header-args
13158(cons '(:noweb . "yes") 13157 (cons '(:noweb . "yes")
13159(assq-delete-all :noweb org-babel-default-header-args))) 13158 (assq-delete-all :noweb org-babel-default-header-args)))
13160@end lisp 13159@end lisp
13161 13160
13162@node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments 13161@node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
@@ -13201,9 +13200,9 @@ blocks in the subtree rooted at the following heading:
13201 13200
13202@example 13201@example
13203* outline header 13202* outline header
13204:PROPERTIES: 13203 :PROPERTIES:
13205:cache: yes 13204 :cache: yes
13206:END: 13205 :END:
13207@end example 13206@end example
13208 13207
13209@kindex C-c C-x p 13208@kindex C-c C-x p
@@ -13247,6 +13246,7 @@ Code block header arguments can span multiple lines using @code{#+HEADER:} or
13247@cindex #+HEADERS: 13246@cindex #+HEADERS:
13248 13247
13249Multi-line header arguments on an un-named code block: 13248Multi-line header arguments on an un-named code block:
13249
13250@example 13250@example
13251 #+HEADERS: :var data1=1 13251 #+HEADERS: :var data1=1
13252 #+BEGIN_SRC emacs-lisp :var data2=2 13252 #+BEGIN_SRC emacs-lisp :var data2=2
@@ -13258,6 +13258,7 @@ Multi-line header arguments on an un-named code block:
13258@end example 13258@end example
13259 13259
13260Multi-line header arguments on a named code block: 13260Multi-line header arguments on a named code block:
13261
13261@example 13262@example
13262 #+NAME: named-block 13263 #+NAME: named-block
13263 #+HEADER: :var data=2 13264 #+HEADER: :var data=2
@@ -13280,12 +13281,14 @@ blocks}.
13280 13281
13281The following will apply the @code{:exports results} header argument to the 13282The following will apply the @code{:exports results} header argument to the
13282evaluation of the @code{#+CALL:} line. 13283evaluation of the @code{#+CALL:} line.
13284
13283@example 13285@example
13284#+CALL: factorial(n=5) :exports results 13286#+CALL: factorial(n=5) :exports results
13285@end example 13287@end example
13286 13288
13287The following will apply the @code{:session special} header argument to the 13289The following will apply the @code{:session special} header argument to the
13288evaluation of the @code{factorial} code block. 13290evaluation of the @code{factorial} code block.
13291
13289@example 13292@example
13290#+CALL: factorial[:session special](n=5) 13293#+CALL: factorial[:session special](n=5)
13291@end example 13294@end example
@@ -13366,6 +13369,7 @@ Here are examples of passing values by reference:
13366 13369
13367@item table 13370@item table
13368an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line 13371an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
13372
13369@example 13373@example
13370#+TBLNAME: example-table 13374#+TBLNAME: example-table
13371| 1 | 13375| 1 |
@@ -13948,7 +13952,6 @@ This code block:
13948-- <<example>> 13952-- <<example>>
13949@end example 13953@end example
13950 13954
13951
13952expands to: 13955expands to:
13953 13956
13954@example 13957@example
@@ -14331,6 +14334,7 @@ process. For example, compare the following two blocks:
14331@end example 14334@end example
14332 14335
14333In non-session mode, the `2' is not printed and does not appear. 14336In non-session mode, the `2' is not printed and does not appear.
14337
14334@example 14338@example
14335#+BEGIN_SRC python :results output :session 14339#+BEGIN_SRC python :results output :session
14336 print "hello" 14340 print "hello"
@@ -14705,6 +14709,7 @@ ask and nil not to ask.
14705 14709
14706For example, here is how to execute "ditaa" code (which is considered safe) 14710For example, here is how to execute "ditaa" code (which is considered safe)
14707without asking: 14711without asking:
14712
14708@example 14713@example
14709(defun my-org-confirm-babel-evaluate (lang body) 14714(defun my-org-confirm-babel-evaluate (lang body)
14710 (not (string= lang "ditaa"))) ; don't ask for ditaa 14715 (not (string= lang "ditaa"))) ; don't ask for ditaa
@@ -14806,7 +14811,7 @@ buffer, most useful for specifying the allowed values of a property.
14806@item #+SETUPFILE: file 14811@item #+SETUPFILE: file
14807This line defines a file that holds more in-buffer setup. Normally this is 14812This line defines a file that holds more in-buffer setup. Normally this is
14808entirely ignored. Only when the buffer is parsed for option-setting lines 14813entirely ignored. Only when the buffer is parsed for option-setting lines
14809(i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a 14814(i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
14810settings line, or when exporting), then the contents of this file are parsed 14815settings line, or when exporting), then the contents of this file are parsed
14811as if they had been included in the buffer. In particular, the file can be 14816as if they had been included in the buffer. In particular, the file can be
14812any other Org mode file with internal setup. You can visit the file the 14817any other Org mode file with internal setup. You can visit the file the
@@ -15168,7 +15173,7 @@ example using the color @code{grey90} on a white background.
15168Things become cleaner still if you skip all the even levels and use only odd 15173Things become cleaner still if you skip all the even levels and use only odd
15169levels 1, 3, 5..., effectively adding two stars to go from one outline level 15174levels 1, 3, 5..., effectively adding two stars to go from one outline level
15170to the next@footnote{When you need to specify a level for a property search 15175to the next@footnote{When you need to specify a level for a property search
15171or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this 15176or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
15172way we get the outline view shown at the beginning of this section. In order 15177way we get the outline view shown at the beginning of this section. In order
15173to make the structure editing and export commands handle this convention 15178to make the structure editing and export commands handle this convention
15174correctly, configure the variable @code{org-odd-levels-only}, or set this on 15179correctly, configure the variable @code{org-odd-levels-only}, or set this on
@@ -15259,7 +15264,7 @@ names for natural constants or units. Instead of defining your own
15259constants in the variable @code{org-table-formula-constants}, install 15264constants in the variable @code{org-table-formula-constants}, install
15260the @file{constants} package which defines a large number of constants 15265the @file{constants} package which defines a large number of constants
15261and units, and lets you use unit prefixes like @samp{M} for 15266and units, and lets you use unit prefixes like @samp{M} for
15262@samp{Mega}, etc. You will need version 2.0 of this package, available 15267@samp{Mega}, etc@. You will need version 2.0 of this package, available
15263at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for 15268at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
15264the function @code{constants-get}, which has to be autoloaded in your 15269the function @code{constants-get}, which has to be autoloaded in your
15265setup. See the installation instructions in the file 15270setup. See the installation instructions in the file
@@ -15401,7 +15406,7 @@ function:
15401 15406
15402@lisp 15407@lisp
15403(defun yas/org-very-safe-expand () 15408(defun yas/org-very-safe-expand ()
15404 (let ((yas/fallback-behavior 'return-nil)) (yas/expand))) 15409 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
15405@end lisp 15410@end lisp
15406 15411
15407Then, tell Org mode what to do with the new function: 15412Then, tell Org mode what to do with the new function:
@@ -15409,10 +15414,10 @@ Then, tell Org mode what to do with the new function:
15409@lisp 15414@lisp
15410(add-hook 'org-mode-hook 15415(add-hook 'org-mode-hook
15411 (lambda () 15416 (lambda ()
15412 (make-variable-buffer-local 'yas/trigger-key) 15417 (make-variable-buffer-local 'yas/trigger-key)
15413 (setq yas/trigger-key [tab]) 15418 (setq yas/trigger-key [tab])
15414 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand) 15419 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
15415 (define-key yas/keymap [tab] 'yas/next-field))) 15420 (define-key yas/keymap [tab] 'yas/next-field)))
15416@end lisp 15421@end lisp
15417 15422
15418@item @file{windmove.el} by Hovav Shacham 15423@item @file{windmove.el} by Hovav Shacham
@@ -16053,9 +16058,9 @@ The corresponding block writer function could look like this:
16053 16058
16054@lisp 16059@lisp
16055(defun org-dblock-write:block-update-time (params) 16060(defun org-dblock-write:block-update-time (params)
16056 (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) 16061 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
16057 (insert "Last block update at: " 16062 (insert "Last block update at: "
16058 (format-time-string fmt (current-time))))) 16063 (format-time-string fmt (current-time)))))
16059@end lisp 16064@end lisp
16060 16065
16061If you want to make sure that all dynamic blocks are always up-to-date, 16066If you want to make sure that all dynamic blocks are always up-to-date,
@@ -16450,8 +16455,8 @@ Entries in comment trees and in archive trees will be ignored.
16450 16455
16451@lisp 16456@lisp
16452(org-map-entries 16457(org-map-entries
16453 '(org-todo "UPCOMING") 16458 '(org-todo "UPCOMING")
16454 "+TOMORROW" 'file 'archive 'comment) 16459 "+TOMORROW" 'file 'archive 'comment)
16455@end lisp 16460@end lisp
16456 16461
16457The following example counts the number of entries with TODO keyword 16462The following example counts the number of entries with TODO keyword
@@ -16693,7 +16698,7 @@ on @file{org-element.el} and @file{org-export.el} has been outstanding, and
16693opened the doors for many new ideas and features. 16698opened the doors for many new ideas and features.
16694 16699
16695@item Jambunathan K 16700@item Jambunathan K
16696Jambunathan contributed the ODT exporter, definitely a killer feature of 16701Jambunathan contributed the ODT exporter, definitly a killer feature of
16697Org mode. He also contributed the new HTML exporter, which is another core 16702Org mode. He also contributed the new HTML exporter, which is another core
16698feature of Org. Here too, I knew I could rely on him to fix bugs in these 16703feature of Org. Here too, I knew I could rely on him to fix bugs in these
16699areas and to patiently explain the users what was the problems and solutions. 16704areas and to patiently explain the users what was the problems and solutions.
@@ -16701,7 +16706,7 @@ areas and to patiently explain the users what was the problems and solutions.
16701@item Achim Gratz 16706@item Achim Gratz
16702Achim rewrote the building process of Org, turning some @emph{ad hoc} tools 16707Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
16703into a flexible and conceptually clean process. He patiently coped with the 16708into a flexible and conceptually clean process. He patiently coped with the
16704many hiccups that such a change can create for users. 16709many hicups that such a change can create for users.
16705 16710
16706@item Nick Dokos 16711@item Nick Dokos
16707The Org mode mailing list would not be such a nice place without Nick, who 16712The Org mode mailing list would not be such a nice place without Nick, who