diff options
| author | Bastien Guerry | 2012-12-12 17:47:07 +0100 |
|---|---|---|
| committer | Bastien Guerry | 2012-12-12 17:47:07 +0100 |
| commit | 63aa098259339e924d8a7d40c59a34e579132af6 (patch) | |
| tree | a23b00ff5e7fd931aadc58f1cffdd00f1f27db5f /doc | |
| parent | 14b8c3d926ef813f621f95b0dcd059192d3d898c (diff) | |
| download | emacs-63aa098259339e924d8a7d40c59a34e579132af6.tar.gz emacs-63aa098259339e924d8a7d40c59a34e579132af6.zip | |
Merge upstream Org (from commit 488eea)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/ChangeLog | 18 | ||||
| -rw-r--r-- | doc/misc/org.texi | 65 |
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 @@ | |||
| 1 | 2012-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 | |||
| 1 | 2012-12-02 Michael Albinus <michael.albinus@gmx.de> | 19 | 2012-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 |
| 839 | There is a website for Org which provides links to the newest | 838 | There is a website for Org which provides links to the newest |
| 840 | version of Org, as well as additional information, frequently asked | 839 | version 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 | |||
| 879 | path, give the full path to the executable. Avoid spaces in any path names. | 878 | path, 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} |
| 881 | again to check the configuration. | 880 | again to check the configuration. |
| 882 | @item Optionally run @code{make test} | ||
| 883 | to 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} |
| 885 | to build and install Org mode on your system. | 882 | to 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 | |||
| 903 | executable. Avoid spaces in any path names. | 900 | executable. Avoid spaces in any path names. |
| 904 | @item Run @code{make config} | 901 | @item Run @code{make config} |
| 905 | to check the configuration. | 902 | to check the configuration. |
| 903 | @item Optionally run @code{make test} | ||
| 904 | to 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} |
| 907 | to update the Git repository and build and install Org mode. The latter | 906 | to update the Git repository and build and install Org mode. The latter |
| 908 | invocation runs the complete test suite before installation and installs only | 907 | invocation runs the complete test suite before installation and installs only |
| @@ -947,7 +946,7 @@ description on Worg}. | |||
| 947 | Installing Info files is system dependent, because of differences in the | 946 | Installing 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 |
| 949 | with the rest of Org mode. If you don't install Org mode, it is possible to | 948 | with the rest of Org mode. If you don't install Org mode, it is possible to |
| 950 | install the Info documentation separately (you need to have | 949 | install the Info documentation seperately (you need to have |
| 951 | install-info@footnote{The output from install-info (if any) is system | 950 | install-info@footnote{The output from install-info (if any) is system |
| 952 | dependent. In particular Debian and its derivatives use two different | 951 | dependent. In particular Debian and its derivatives use two different |
| 953 | versions of install-info and you may see the message: | 952 | versions 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 | ||
| 9225 | Lines starting with zero or more whitespace characters followed by @samp{#} | 9224 | Lines starting with zero or more whitespace characters followed by one |
| 9226 | are 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. |
| 9227 | starting with the word @samp{COMMENT} will never be exported. Finally, | 9226 | Also entire subtrees starting with the word @samp{COMMENT} will never be |
| 9228 | regions surrounded by @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will | 9227 | exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT} |
| 9229 | not 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 | ||
| 13249 | Multi-line header arguments on an un-named code block: | 13248 | Multi-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 | ||
| 13260 | Multi-line header arguments on a named code block: | 13260 | Multi-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 | ||
| 13281 | The following will apply the @code{:exports results} header argument to the | 13282 | The following will apply the @code{:exports results} header argument to the |
| 13282 | evaluation of the @code{#+CALL:} line. | 13283 | evaluation 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 | ||
| 13287 | The following will apply the @code{:session special} header argument to the | 13289 | The following will apply the @code{:session special} header argument to the |
| 13288 | evaluation of the @code{factorial} code block. | 13290 | evaluation 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 |
| 13368 | an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line | 13371 | an 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 | |||
| 13952 | expands to: | 13955 | expands 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 | ||
| 14333 | In non-session mode, the `2' is not printed and does not appear. | 14336 | In 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 | ||
| 14706 | For example, here is how to execute "ditaa" code (which is considered safe) | 14710 | For example, here is how to execute "ditaa" code (which is considered safe) |
| 14707 | without asking: | 14711 | without 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 |
| 14807 | This line defines a file that holds more in-buffer setup. Normally this is | 14812 | This line defines a file that holds more in-buffer setup. Normally this is |
| 14808 | entirely ignored. Only when the buffer is parsed for option-setting lines | 14813 | entirely 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 |
| 14810 | settings line, or when exporting), then the contents of this file are parsed | 14815 | settings line, or when exporting), then the contents of this file are parsed |
| 14811 | as if they had been included in the buffer. In particular, the file can be | 14816 | as if they had been included in the buffer. In particular, the file can be |
| 14812 | any other Org mode file with internal setup. You can visit the file the | 14817 | any 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. | |||
| 15168 | Things become cleaner still if you skip all the even levels and use only odd | 15173 | Things become cleaner still if you skip all the even levels and use only odd |
| 15169 | levels 1, 3, 5..., effectively adding two stars to go from one outline level | 15174 | levels 1, 3, 5..., effectively adding two stars to go from one outline level |
| 15170 | to the next@footnote{When you need to specify a level for a property search | 15175 | to the next@footnote{When you need to specify a level for a property search |
| 15171 | or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this | 15176 | or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this |
| 15172 | way we get the outline view shown at the beginning of this section. In order | 15177 | way we get the outline view shown at the beginning of this section. In order |
| 15173 | to make the structure editing and export commands handle this convention | 15178 | to make the structure editing and export commands handle this convention |
| 15174 | correctly, configure the variable @code{org-odd-levels-only}, or set this on | 15179 | correctly, 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 | |||
| 15259 | constants in the variable @code{org-table-formula-constants}, install | 15264 | constants in the variable @code{org-table-formula-constants}, install |
| 15260 | the @file{constants} package which defines a large number of constants | 15265 | the @file{constants} package which defines a large number of constants |
| 15261 | and units, and lets you use unit prefixes like @samp{M} for | 15266 | and 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 |
| 15263 | at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for | 15268 | at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for |
| 15264 | the function @code{constants-get}, which has to be autoloaded in your | 15269 | the function @code{constants-get}, which has to be autoloaded in your |
| 15265 | setup. See the installation instructions in the file | 15270 | setup. 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 | ||
| 15407 | Then, tell Org mode what to do with the new function: | 15412 | Then, 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 | ||
| 16061 | If you want to make sure that all dynamic blocks are always up-to-date, | 16066 | If 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 | ||
| 16457 | The following example counts the number of entries with TODO keyword | 16462 | The 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 | |||
| 16693 | opened the doors for many new ideas and features. | 16698 | opened the doors for many new ideas and features. |
| 16694 | 16699 | ||
| 16695 | @item Jambunathan K | 16700 | @item Jambunathan K |
| 16696 | Jambunathan contributed the ODT exporter, definitely a killer feature of | 16701 | Jambunathan contributed the ODT exporter, definitly a killer feature of |
| 16697 | Org mode. He also contributed the new HTML exporter, which is another core | 16702 | Org mode. He also contributed the new HTML exporter, which is another core |
| 16698 | feature of Org. Here too, I knew I could rely on him to fix bugs in these | 16703 | feature of Org. Here too, I knew I could rely on him to fix bugs in these |
| 16699 | areas and to patiently explain the users what was the problems and solutions. | 16704 | areas 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 |
| 16702 | Achim rewrote the building process of Org, turning some @emph{ad hoc} tools | 16707 | Achim rewrote the building process of Org, turning some @emph{ad hoc} tools |
| 16703 | into a flexible and conceptually clean process. He patiently coped with the | 16708 | into a flexible and conceptually clean process. He patiently coped with the |
| 16704 | many hiccups that such a change can create for users. | 16709 | many hicups that such a change can create for users. |
| 16705 | 16710 | ||
| 16706 | @item Nick Dokos | 16711 | @item Nick Dokos |
| 16707 | The Org mode mailing list would not be such a nice place without Nick, who | 16712 | The Org mode mailing list would not be such a nice place without Nick, who |