diff options
| author | Paul Eggert | 2014-04-22 14:32:51 -0700 |
|---|---|---|
| committer | Paul Eggert | 2014-04-22 14:32:51 -0700 |
| commit | 42e910349d699ee3f8024371ca1e60e015fc6aa7 (patch) | |
| tree | ba589f3f7c278671f0ae9c5c8f15c241ae8dd674 /doc/misc | |
| parent | 4f96579371290b201a973072a1c2f237755bb954 (diff) | |
| parent | 34e856d5ac828753b7be20e2471f39fb613f7f40 (diff) | |
| download | emacs-42e910349d699ee3f8024371ca1e60e015fc6aa7.tar.gz emacs-42e910349d699ee3f8024371ca1e60e015fc6aa7.zip | |
Merge from emacs-24; up to 2014-04-22T20:19:17Z!eggert@cs.ucla.edu
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/ChangeLog | 30 | ||||
| -rw-r--r-- | doc/misc/org.texi | 63 |
2 files changed, 66 insertions, 27 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index fb54cd30b12..4f336cdbce4 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,31 @@ | |||
| 1 | 2014-04-22 Bastien Guerry <bzg@gnu.org> | ||
| 2 | |||
| 3 | * org.texi (Installation): Be more clear on why installing Org | ||
| 4 | through ELPA should be done without loading any Org file. | ||
| 5 | |||
| 6 | * org.texi (Emphasis and monospace): Document the use of | ||
| 7 | =verbatim= and ~code~ to be consistent with | ||
| 8 | `org-element-text-markup-successor'. | ||
| 9 | |||
| 10 | * org.texi (In-buffer settings, Radio tables): Tiny fixes. | ||
| 11 | |||
| 12 | * org.texi (Initial visibility): | ||
| 13 | * org.texi (Literal examples): Fix typos. | ||
| 14 | |||
| 15 | 2014-04-22 Michael Brand <michael.ch.brand@gmail.com> | ||
| 16 | |||
| 17 | * org.texi (Column attributes): Add a sentence to point out | ||
| 18 | the dependency on the format specifier. | ||
| 19 | |||
| 20 | 2014-04-22 Nicolas Goaziou <n.goaziou@gmail.com> | ||
| 21 | |||
| 22 | * org.texi (The Export Dispatcher): Reformulation. | ||
| 23 | |||
| 24 | * org.texi (@LaTeX{} specific attributes): Update manual. | ||
| 25 | |||
| 26 | * org.texi (Top, Exporting): Org has its own documentation and | ||
| 27 | should therefore be removed from "Other build-in back-ends". | ||
| 28 | |||
| 1 | 2014-04-22 Stefan Monnier <monnier@iro.umontreal.ca> | 29 | 2014-04-22 Stefan Monnier <monnier@iro.umontreal.ca> |
| 2 | 30 | ||
| 3 | * cl.texi (Structures): Remove cl-struct-set-slot-value. | 31 | * cl.texi (Structures): Remove cl-struct-set-slot-value. |
| @@ -1614,7 +1642,7 @@ | |||
| 1614 | * ede.texi (Top): Rename from top, all uses changed. | 1642 | * ede.texi (Top): Rename from top, all uses changed. |
| 1615 | * eshell.texi: Add missing argument to @sp. | 1643 | * eshell.texi: Add missing argument to @sp. |
| 1616 | * forms.texi (Top): Reorder menu to match structure. | 1644 | * forms.texi (Top): Reorder menu to match structure. |
| 1617 | * htmlfontify.texi (Customisation): Add missing @item in | 1645 | * htmlfontify.texi (Customization): Add missing @item in |
| 1618 | @enumerate. | 1646 | @enumerate. |
| 1619 | * org.texi (Advanced features): Add missing argument for @item. | 1647 | * org.texi (Advanced features): Add missing argument for @item. |
| 1620 | (Property searches): Use @backslashchar{} in macro argument. | 1648 | (Property searches): Use @backslashchar{} in macro argument. |
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index c6b8c90293f..48a6fe56cf6 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -2,7 +2,7 @@ | |||
| 2 | @c %**start of header | 2 | @c %**start of header |
| 3 | @setfilename ../../info/org | 3 | @setfilename ../../info/org |
| 4 | @settitle The Org Manual | 4 | @settitle The Org Manual |
| 5 | @set VERSION 8.2.5c | 5 | @set VERSION 8.2.6 |
| 6 | 6 | ||
| 7 | @c Version and Contact Info | 7 | @c Version and Contact Info |
| 8 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page} | 8 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page} |
| @@ -275,7 +275,7 @@ modify this GNU manual.'' | |||
| 275 | 275 | ||
| 276 | @dircategory Emacs editing modes | 276 | @dircategory Emacs editing modes |
| 277 | @direntry | 277 | @direntry |
| 278 | * Org Mode: (org). Outline-based notes management and organizer. | 278 | * Org Mode: (org). Outline-based notes management and organizer |
| 279 | @end direntry | 279 | @end direntry |
| 280 | 280 | ||
| 281 | @titlepage | 281 | @titlepage |
| @@ -585,8 +585,8 @@ Exporting | |||
| 585 | * OpenDocument Text export:: Exporting to OpenDocument Text | 585 | * OpenDocument Text export:: Exporting to OpenDocument Text |
| 586 | * Org export:: Exporting to Org | 586 | * Org export:: Exporting to Org |
| 587 | * iCalendar export:: Exporting to iCalendar | 587 | * iCalendar export:: Exporting to iCalendar |
| 588 | * Other built-in back-ends:: Exporting to @code{Texinfo}, a man page, or Org | 588 | * Other built-in back-ends:: Exporting to @code{Texinfo} or a man page |
| 589 | * Export in foreign buffers:: Author tables in lists in Org syntax | 589 | * Export in foreign buffers:: Author tables and lists in Org syntax |
| 590 | * Advanced configuration:: Fine-tuning the export output | 590 | * Advanced configuration:: Fine-tuning the export output |
| 591 | 591 | ||
| 592 | HTML export | 592 | HTML export |
| @@ -877,7 +877,11 @@ We @b{strongly recommend} to stick to a single installation method. | |||
| 877 | 877 | ||
| 878 | Recent Emacs distributions include a packaging system which lets you install | 878 | Recent Emacs distributions include a packaging system which lets you install |
| 879 | Elisp libraries. You can install Org with @kbd{M-x package-install RET org}. | 879 | Elisp libraries. You can install Org with @kbd{M-x package-install RET org}. |
| 880 | You need to do this in a session where no @code{.org} file has been visited. | 880 | |
| 881 | @noindent @b{Important}: you need to do this in a session where no @code{.org} file has | ||
| 882 | been visited, i.e. where no Org built-in function have been loaded. | ||
| 883 | Otherwise autoload Org functions will mess up the installation. | ||
| 884 | |||
| 881 | Then, to make sure your Org configuration is taken into account, initialize | 885 | Then, to make sure your Org configuration is taken into account, initialize |
| 882 | the package system with @code{(package-initialize)} in your @file{.emacs} | 886 | the package system with @code{(package-initialize)} in your @file{.emacs} |
| 883 | before setting any Org option. If you want to use Org's package repository, | 887 | before setting any Org option. If you want to use Org's package repository, |
| @@ -1339,7 +1343,7 @@ When Emacs first visits an Org file, the global state is set to OVERVIEW, | |||
| 1339 | i.e., only the top level headlines are visible@footnote{When | 1343 | i.e., only the top level headlines are visible@footnote{When |
| 1340 | @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default | 1344 | @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default |
| 1341 | visibility state when first opening a file for the agenda (@pxref{Speeding up | 1345 | visibility state when first opening a file for the agenda (@pxref{Speeding up |
| 1342 | your agendas}).} This can be configured through the variable | 1346 | your agendas}).}. This can be configured through the variable |
| 1343 | @code{org-startup-folded}, or on a per-file basis by adding one of the | 1347 | @code{org-startup-folded}, or on a per-file basis by adding one of the |
| 1344 | following lines anywhere in the buffer: | 1348 | following lines anywhere in the buffer: |
| 1345 | 1349 | ||
| @@ -5525,6 +5529,9 @@ of 5 to 20 days, representing what to expect if everything goes either | |||
| 5525 | extremely well or extremely poorly. In contrast, @code{est+} estimates the | 5529 | extremely well or extremely poorly. In contrast, @code{est+} estimates the |
| 5526 | full job more realistically, at 10--15 days. | 5530 | full job more realistically, at 10--15 days. |
| 5527 | 5531 | ||
| 5532 | Numbers are right-aligned when a format specifier with an explicit width like | ||
| 5533 | @code{%5d} or @code{%5.1f} is used. | ||
| 5534 | |||
| 5528 | Here is an example for a complete columns definition, along with allowed | 5535 | Here is an example for a complete columns definition, along with allowed |
| 5529 | values. | 5536 | values. |
| 5530 | 5537 | ||
| @@ -9729,8 +9736,8 @@ multiple footnotes side by side. | |||
| 9729 | @vindex org-fontify-emphasized-text | 9736 | @vindex org-fontify-emphasized-text |
| 9730 | @vindex org-emphasis-regexp-components | 9737 | @vindex org-emphasis-regexp-components |
| 9731 | @vindex org-emphasis-alist | 9738 | @vindex org-emphasis-alist |
| 9732 | You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=} | 9739 | You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=} |
| 9733 | and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text | 9740 | and @code{~code~}, and, if you must, @samp{+strike-through+}. Text |
| 9734 | in the code and verbatim string is not processed for Org mode specific | 9741 | in the code and verbatim string is not processed for Org mode specific |
| 9735 | syntax, it is exported verbatim. | 9742 | syntax, it is exported verbatim. |
| 9736 | 9743 | ||
| @@ -9888,7 +9895,7 @@ Here is an example: | |||
| 9888 | @example | 9895 | @example |
| 9889 | #+BEGIN_SRC emacs-lisp -n -r | 9896 | #+BEGIN_SRC emacs-lisp -n -r |
| 9890 | (save-excursion (ref:sc) | 9897 | (save-excursion (ref:sc) |
| 9891 | (goto-char (point-min)) (ref:jump) | 9898 | (goto-char (point-min))) (ref:jump) |
| 9892 | #+END_SRC | 9899 | #+END_SRC |
| 9893 | In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]] | 9900 | In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]] |
| 9894 | jumps to point-min. | 9901 | jumps to point-min. |
| @@ -10358,8 +10365,8 @@ in the iCalendar format. | |||
| 10358 | * OpenDocument Text export:: Exporting to OpenDocument Text | 10365 | * OpenDocument Text export:: Exporting to OpenDocument Text |
| 10359 | * Org export:: Exporting to Org | 10366 | * Org export:: Exporting to Org |
| 10360 | * iCalendar export:: Exporting to iCalendar | 10367 | * iCalendar export:: Exporting to iCalendar |
| 10361 | * Other built-in back-ends:: Exporting to @code{Texinfo}, a man page, or Org | 10368 | * Other built-in back-ends:: Exporting to @code{Texinfo} or a man page |
| 10362 | * Export in foreign buffers:: Author tables in lists in Org syntax | 10369 | * Export in foreign buffers:: Author tables and lists in Org syntax |
| 10363 | * Advanced configuration:: Fine-tuning the export output | 10370 | * Advanced configuration:: Fine-tuning the export output |
| 10364 | @end menu | 10371 | @end menu |
| 10365 | 10372 | ||
| @@ -10400,10 +10407,10 @@ export dispatcher with the following key combinations: | |||
| 10400 | Toggle asynchronous export. Asynchronous export uses an external Emacs | 10407 | Toggle asynchronous export. Asynchronous export uses an external Emacs |
| 10401 | process that is configured with a specified initialization file. | 10408 | process that is configured with a specified initialization file. |
| 10402 | 10409 | ||
| 10403 | While exporting asynchronously, the output is not displayed. It is stored in | 10410 | While exporting asynchronously, the output is not displayed, but stored in |
| 10404 | a list called ``the export stack'', and can be viewed from there. The stack | 10411 | a place called ``the export stack''. This stack can be displayed by calling |
| 10405 | can be reached by calling the dispatcher with a double @kbd{C-u} prefix | 10412 | the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key |
| 10406 | argument, or with @kbd{&} key from the dispatcher. | 10413 | from the dispatcher menu. |
| 10407 | 10414 | ||
| 10408 | @vindex org-export-in-background | 10415 | @vindex org-export-in-background |
| 10409 | To make this behavior the default, customize the variable | 10416 | To make this behavior the default, customize the variable |
| @@ -11762,13 +11769,12 @@ the @LaTeX{} @code{\includegraphics} macro will be commented out. | |||
| 11762 | @cindex plain lists, in @LaTeX{} export | 11769 | @cindex plain lists, in @LaTeX{} export |
| 11763 | 11770 | ||
| 11764 | Plain lists accept two optional attributes: @code{:environment} and | 11771 | Plain lists accept two optional attributes: @code{:environment} and |
| 11765 | @code{:options}. The first one allows the use of a non-standard | 11772 | @code{:options}. The first one allows the use of a non-standard environment |
| 11766 | environment (e.g., @samp{inparaenum}). The second one specifies | 11773 | (e.g., @samp{inparaenum}). The second one specifies additional arguments for |
| 11767 | optional arguments for that environment (square brackets may be | 11774 | that environment. |
| 11768 | omitted). | ||
| 11769 | 11775 | ||
| 11770 | @example | 11776 | @example |
| 11771 | #+ATTR_LATEX: :environment compactitem :options $\circ$ | 11777 | #+ATTR_LATEX: :environment compactitem :options [$\circ$] |
| 11772 | - you need ``paralist'' package to reproduce this example. | 11778 | - you need ``paralist'' package to reproduce this example. |
| 11773 | @end example | 11779 | @end example |
| 11774 | 11780 | ||
| @@ -13773,8 +13779,13 @@ can be used to map arbitrary language names to existing major modes. | |||
| 13773 | @item org-src-window-setup | 13779 | @item org-src-window-setup |
| 13774 | Controls the way Emacs windows are rearranged when the edit buffer is created. | 13780 | Controls the way Emacs windows are rearranged when the edit buffer is created. |
| 13775 | @item org-src-preserve-indentation | 13781 | @item org-src-preserve-indentation |
| 13776 | This variable is especially useful for tangling languages such as | 13782 | By default, the value is @code{nil}, which means that when code blocks are |
| 13777 | Python, in which whitespace indentation in the output is critical. | 13783 | evaluated during export or tangled, they are re-inserted into the code block, |
| 13784 | which may replace sequences of spaces with tab characters. When non-nil, | ||
| 13785 | whitespace in code blocks will be preserved during export or tangling, | ||
| 13786 | exactly as it appears. This variable is especially useful for tangling | ||
| 13787 | languages such as Python, in which whitespace indentation in the output is | ||
| 13788 | critical. | ||
| 13778 | @item org-src-ask-before-returning-to-edit-buffer | 13789 | @item org-src-ask-before-returning-to-edit-buffer |
| 13779 | By default, Org will ask before returning to an open edit buffer. Set this | 13790 | By default, Org will ask before returning to an open edit buffer. Set this |
| 13780 | variable to @code{nil} to switch without asking. | 13791 | variable to @code{nil} to switch without asking. |
| @@ -15827,7 +15838,7 @@ The corresponding variable is @code{org-archive-location}. | |||
| 15827 | This line sets the category for the agenda file. The category applies | 15838 | This line sets the category for the agenda file. The category applies |
| 15828 | for all subsequent lines until the next @samp{#+CATEGORY} line, or the | 15839 | for all subsequent lines until the next @samp{#+CATEGORY} line, or the |
| 15829 | end of the file. The first such line also applies to any entries before it. | 15840 | end of the file. The first such line also applies to any entries before it. |
| 15830 | @item #+COLUMNS: %25ITEM ..... | 15841 | @item #+COLUMNS: %25ITEM ... |
| 15831 | @cindex property, COLUMNS | 15842 | @cindex property, COLUMNS |
| 15832 | Set the default format for columns view. This format applies when | 15843 | Set the default format for columns view. This format applies when |
| 15833 | columns view is invoked in locations where no @code{COLUMNS} property | 15844 | columns view is invoked in locations where no @code{COLUMNS} property |
| @@ -15842,11 +15853,11 @@ The global version of this variable is | |||
| 15842 | @item #+FILETAGS: :tag1:tag2:tag3: | 15853 | @item #+FILETAGS: :tag1:tag2:tag3: |
| 15843 | Set tags that can be inherited by any entry in the file, including the | 15854 | Set tags that can be inherited by any entry in the file, including the |
| 15844 | top-level entries. | 15855 | top-level entries. |
| 15845 | @item #+DRAWERS: NAME1 ..... | 15856 | @item #+DRAWERS: NAME1 ... |
| 15846 | @vindex org-drawers | 15857 | @vindex org-drawers |
| 15847 | Set the file-local set of additional drawers. The corresponding global | 15858 | Set the file-local set of additional drawers. The corresponding global |
| 15848 | variable is @code{org-drawers}. | 15859 | variable is @code{org-drawers}. |
| 15849 | @item #+LINK: linkword replace | 15860 | @item #+LINK: linkword replace |
| 15850 | @vindex org-link-abbrev-alist | 15861 | @vindex org-link-abbrev-alist |
| 15851 | These lines (several are allowed) specify link abbreviations. | 15862 | These lines (several are allowed) specify link abbreviations. |
| 15852 | @xref{Link abbreviations}. The corresponding variable is | 15863 | @xref{Link abbreviations}. The corresponding variable is |
| @@ -16862,7 +16873,7 @@ Orgtbl mode how to translate this table and where to install it. For | |||
| 16862 | example: | 16873 | example: |
| 16863 | @cindex #+ORGTBL | 16874 | @cindex #+ORGTBL |
| 16864 | @example | 16875 | @example |
| 16865 | #+ORGTBL: SEND table_name translation_function arguments.... | 16876 | #+ORGTBL: SEND table_name translation_function arguments... |
| 16866 | @end example | 16877 | @end example |
| 16867 | 16878 | ||
| 16868 | @noindent | 16879 | @noindent |