diff options
| author | Carsten Dominik | 2008-12-20 14:39:23 +0000 |
|---|---|---|
| committer | Carsten Dominik | 2008-12-20 14:39:23 +0000 |
| commit | b6cb4cd58c83b86d4d348256ef71e6b28882a661 (patch) | |
| tree | efbdd451e5236bf8729b03dfec40829d17df6273 | |
| parent | 4c65b56654a0efba1dfe29c820d79077ed2c3817 (diff) | |
| download | emacs-b6cb4cd58c83b86d4d348256ef71e6b28882a661.tar.gz emacs-b6cb4cd58c83b86d4d348256ef71e6b28882a661.zip | |
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
* org.texi (Activation, Exporting, ASCII export, HTML export)
(HTML Export commands, LaTeX/PDF export commands): Improve
documentation about transient-mark-mode.
(References): DOcuemtn the use of special names like $LR1 to reference
to fields in the last table row.
| -rw-r--r-- | doc/misc/org.texi | 63 | ||||
| -rw-r--r-- | etc/ChangeLog | 4 |
2 files changed, 48 insertions, 19 deletions
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index b54db8cfffc..edd8d0c7f29 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -3,7 +3,7 @@ | |||
| 3 | @setfilename ../../info/org | 3 | @setfilename ../../info/org |
| 4 | @settitle The Org Manual | 4 | @settitle The Org Manual |
| 5 | 5 | ||
| 6 | @set VERSION 6.15d | 6 | @set VERSION 6.16 |
| 7 | @set DATE December 2008 | 7 | @set DATE December 2008 |
| 8 | 8 | ||
| 9 | @dircategory Emacs | 9 | @dircategory Emacs |
| @@ -580,6 +580,15 @@ MY PROJECTS -*- mode: org; -*- | |||
| 580 | the file's name is. See also the variable | 580 | the file's name is. See also the variable |
| 581 | @code{org-insert-mode-line-in-empty-file}. | 581 | @code{org-insert-mode-line-in-empty-file}. |
| 582 | 582 | ||
| 583 | Many commands in Org work on the region is the region is active. To make use | ||
| 584 | of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in | ||
| 585 | XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to | ||
| 586 | do this yourself with | ||
| 587 | |||
| 588 | @lisp | ||
| 589 | (transient-mark-mode 1) | ||
| 590 | @end lisp | ||
| 591 | |||
| 583 | @node Feedback, Conventions, Activation, Introduction | 592 | @node Feedback, Conventions, Activation, Introduction |
| 584 | @section Feedback | 593 | @section Feedback |
| 585 | @cindex feedback | 594 | @cindex feedback |
| @@ -1809,6 +1818,9 @@ Org's references with @emph{signed} numbers are floating | |||
| 1809 | references because the same reference operator can reference different | 1818 | references because the same reference operator can reference different |
| 1810 | fields depending on the field being calculated by the formula. | 1819 | fields depending on the field being calculated by the formula. |
| 1811 | 1820 | ||
| 1821 | As a special case references like @samp{$LR5} and @samp{$LR12} can be used to | ||
| 1822 | refer in a stable way to the 5th and 12th field in the last row of the table. | ||
| 1823 | |||
| 1812 | Here are a few examples: | 1824 | Here are a few examples: |
| 1813 | 1825 | ||
| 1814 | @example | 1826 | @example |
| @@ -1991,6 +2003,8 @@ with the appropriate commands, @i{absolute references} (but not relative | |||
| 1991 | ones) in stored formulas are modified in order to still reference the | 2003 | ones) in stored formulas are modified in order to still reference the |
| 1992 | same field. Of cause this is not true if you edit the table structure | 2004 | same field. Of cause this is not true if you edit the table structure |
| 1993 | with normal editing commands - then you must fix the equations yourself. | 2005 | with normal editing commands - then you must fix the equations yourself. |
| 2006 | The left hand side of a formula may also be a named field (@pxref{Advanced | ||
| 2007 | features}), or a last-row reference like @samp{$LR3}. | ||
| 1994 | 2008 | ||
| 1995 | Instead of typing an equation into the field, you may also use the | 2009 | Instead of typing an equation into the field, you may also use the |
| 1996 | following command | 2010 | following command |
| @@ -5973,6 +5987,8 @@ Previous line (same as @key{down} and @kbd{C-n}). | |||
| 5973 | @item mouse-3 | 5987 | @item mouse-3 |
| 5974 | @itemx @key{SPC} | 5988 | @itemx @key{SPC} |
| 5975 | Display the original location of the item in another window. | 5989 | Display the original location of the item in another window. |
| 5990 | With prefix arg, make sure that the entire entry is made visible in the | ||
| 5991 | outline, not only the heading. | ||
| 5976 | @c | 5992 | @c |
| 5977 | @kindex L | 5993 | @kindex L |
| 5978 | @item L | 5994 | @item L |
| @@ -7072,6 +7088,9 @@ deadlines or appointments into a desktop calendar program like iCal, | |||
| 7072 | Org mode can also produce extracts in the iCalendar format. Currently | 7088 | Org mode can also produce extracts in the iCalendar format. Currently |
| 7073 | Org mode only supports export, not import of these different formats. | 7089 | Org mode only supports export, not import of these different formats. |
| 7074 | 7090 | ||
| 7091 | Org supports export of selected regions when @code{transient-mark-mode} is | ||
| 7092 | enabled (default in Emacs 23). | ||
| 7093 | |||
| 7075 | @menu | 7094 | @menu |
| 7076 | * Markup rules:: Which structures are recognized? | 7095 | * Markup rules:: Which structures are recognized? |
| 7077 | * Selective export:: Using tags to select and exclude trees | 7096 | * Selective export:: Using tags to select and exclude trees |
| @@ -7597,13 +7616,14 @@ file. | |||
| 7597 | 7616 | ||
| 7598 | @cindex region, active | 7617 | @cindex region, active |
| 7599 | @cindex active region | 7618 | @cindex active region |
| 7600 | @cindex Transient mark mode | 7619 | @cindex transient-mark-mode |
| 7601 | @table @kbd | 7620 | @table @kbd |
| 7602 | @kindex C-c C-e a | 7621 | @kindex C-c C-e a |
| 7603 | @item C-c C-e a | 7622 | @item C-c C-e a |
| 7604 | Export as ASCII file. For an org file @file{myfile.org}, the ASCII file | 7623 | Export as ASCII file. For an org file @file{myfile.org}, the ASCII file |
| 7605 | will be @file{myfile.txt}. The file will be overwritten without | 7624 | will be @file{myfile.txt}. The file will be overwritten without |
| 7606 | warning. If there is an active region, only the region will be | 7625 | warning. If there is an active region@footnote{this requires |
| 7626 | @code{transient-mark-mode} to be turned on}, only the region will be | ||
| 7607 | exported. If the selected region is a single tree@footnote{To select the | 7627 | exported. If the selected region is a single tree@footnote{To select the |
| 7608 | current subtree, use @kbd{C-c @@}.}, the tree head will | 7628 | current subtree, use @kbd{C-c @@}.}, the tree head will |
| 7609 | become the document title. If the tree head entry has or inherits an | 7629 | become the document title. If the tree head entry has or inherits an |
| @@ -7638,7 +7658,7 @@ indentation than the first, these are left alone. | |||
| 7638 | @cindex HTML export | 7658 | @cindex HTML export |
| 7639 | 7659 | ||
| 7640 | Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive | 7660 | Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive |
| 7641 | HTML formatting, in ways similar to John Grubers @emph{markdown} | 7661 | HTML formatting, in ways similar to John Gruber's @emph{markdown} |
| 7642 | language, but with additional support for tables. | 7662 | language, but with additional support for tables. |
| 7643 | 7663 | ||
| 7644 | @menu | 7664 | @menu |
| @@ -7655,16 +7675,17 @@ language, but with additional support for tables. | |||
| 7655 | 7675 | ||
| 7656 | @cindex region, active | 7676 | @cindex region, active |
| 7657 | @cindex active region | 7677 | @cindex active region |
| 7658 | @cindex Transient mark mode | 7678 | @cindex transient-mark-mode |
| 7659 | @table @kbd | 7679 | @table @kbd |
| 7660 | @kindex C-c C-e h | 7680 | @kindex C-c C-e h |
| 7661 | @item C-c C-e h | 7681 | @item C-c C-e h |
| 7662 | Export as HTML file @file{myfile.html}. For an org file @file{myfile.org}, | 7682 | Export as HTML file @file{myfile.html}. For an org file @file{myfile.org}, |
| 7663 | the ASCII file will be @file{myfile.html}. The file will be overwritten | 7683 | the ASCII file will be @file{myfile.html}. The file will be overwritten |
| 7664 | without warning. If there is an active region, only the region will be | 7684 | without warning. If there is an active region@footnote{this requires |
| 7685 | @code{transient-mark-mode} to be turned on}, only the region will be | ||
| 7665 | exported. If the selected region is a single tree@footnote{To select the | 7686 | exported. If the selected region is a single tree@footnote{To select the |
| 7666 | current subtree, use @kbd{C-c @@}.}, the tree head will become the document | 7687 | current subtree, use @kbd{C-c @@}.}, the tree head will become the document |
| 7667 | title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} | 7688 | title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} |
| 7668 | property, that name will be used for the export. | 7689 | property, that name will be used for the export. |
| 7669 | @kindex C-c C-e b | 7690 | @kindex C-c C-e b |
| 7670 | @item C-c C-e b | 7691 | @item C-c C-e b |
| @@ -7825,11 +7846,11 @@ referring to an external file. | |||
| 7825 | 7846 | ||
| 7826 | @emph{Sebastian Rose} has written a JavaScript program especially designed to | 7847 | @emph{Sebastian Rose} has written a JavaScript program especially designed to |
| 7827 | enhance the web viewing experience of HTML files created with Org. This | 7848 | enhance the web viewing experience of HTML files created with Org. This |
| 7828 | program allows to view large files in two different ways. The first one is | 7849 | program allows you to view large files in two different ways. The first one is |
| 7829 | an @emph{Info}-like mode where each section is displayed separately and | 7850 | an @emph{Info}-like mode where each section is displayed separately and |
| 7830 | navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys | 7851 | navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys |
| 7831 | as well, press @kbd{?} for an overview of the available keys). The second | 7852 | as well, press @kbd{?} for an overview of the available keys). The second |
| 7832 | view type is a @emph{folding} view much like Org provides it inside Emacs. | 7853 | view type is a @emph{folding} view much like Org provides inside Emacs. |
| 7833 | The script is available at @url{http://orgmode.org/org-info.js} and you can | 7854 | The script is available at @url{http://orgmode.org/org-info.js} and you can |
| 7834 | find the documentation for it at | 7855 | find the documentation for it at |
| 7835 | @url{http://orgmode.org/worg/code/org-info-js/org-info.js.html}. We are | 7856 | @url{http://orgmode.org/worg/code/org-info-js/org-info.js.html}. We are |
| @@ -7838,10 +7859,10 @@ to be dependent on @url{orgmode.org} and prefer to install a local copy on | |||
| 7838 | your own web server. | 7859 | your own web server. |
| 7839 | 7860 | ||
| 7840 | To use the script, you need to make sure that the @file{org-jsinfo.el} module | 7861 | To use the script, you need to make sure that the @file{org-jsinfo.el} module |
| 7841 | gets loaded. It should be loaded by default, try @kbd{M-x customize-variable | 7862 | gets loaded. It should be loaded by default, but you can try @kbd{M-x |
| 7842 | @key{RET} org-modules @key{RET}} to convince yourself that this is indeed the | 7863 | customize-variable @key{RET} org-modules @key{RET}} to convince yourself that |
| 7843 | case. All it then takes to make use of the program is adding a single line | 7864 | this is indeed the case. All it then takes to make use of the program is |
| 7844 | to the Org file: | 7865 | adding a single line to the Org file: |
| 7845 | 7866 | ||
| 7846 | @example | 7867 | @example |
| 7847 | #+INFOJS_OPT: view:info toc:nil | 7868 | #+INFOJS_OPT: view:info toc:nil |
| @@ -7904,16 +7925,20 @@ references, the PDF output file will be fully linked. | |||
| 7904 | @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export | 7925 | @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export |
| 7905 | @subsection LaTeX export commands | 7926 | @subsection LaTeX export commands |
| 7906 | 7927 | ||
| 7928 | @cindex region, active | ||
| 7929 | @cindex active region | ||
| 7930 | @cindex transient-mark-mode | ||
| 7907 | @table @kbd | 7931 | @table @kbd |
| 7908 | @kindex C-c C-e l | 7932 | @kindex C-c C-e l |
| 7909 | @item C-c C-e l | 7933 | @item C-c C-e l |
| 7910 | Export as La@TeX{} file @file{myfile.tex}. For an org file | 7934 | Export as La@TeX{} file @file{myfile.tex}. For an org file |
| 7911 | @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will | 7935 | @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will |
| 7912 | be overwritten without warning. If there is an active region, only the | 7936 | be overwritten without warning. If there is an active region@footnote{this |
| 7913 | region will be exported. If the selected region is a single tree@footnote{To | 7937 | requires @code{transient-mark-mode} to be turned on}, only the region will be |
| 7914 | select the current subtree, use @kbd{C-c @@}.}, the tree head will become the | 7938 | exported. If the selected region is a single tree@footnote{To select the |
| 7915 | document title. If the tree head entry has or inherits an | 7939 | current subtree, use @kbd{C-c @@}.}, the tree head will become the document |
| 7916 | @code{EXPORT_FILE_NAME} property, that name will be used for the export. | 7940 | title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} |
| 7941 | property, that name will be used for the export. | ||
| 7917 | @kindex C-c C-e L | 7942 | @kindex C-c C-e L |
| 7918 | @item C-c C-e L | 7943 | @item C-c C-e L |
| 7919 | Export to a temporary buffer, do not create a file. | 7944 | Export to a temporary buffer, do not create a file. |
| @@ -8332,7 +8357,7 @@ you publish them to HTML. | |||
| 8332 | You may also link to related files, such as images. Provided you are | 8357 | You may also link to related files, such as images. Provided you are |
| 8333 | careful with relative pathnames, and provided you have also configured | 8358 | careful with relative pathnames, and provided you have also configured |
| 8334 | @code{org-publish} to upload the related files, these links will work | 8359 | @code{org-publish} to upload the related files, these links will work |
| 8335 | too. @ref{Complex example} for an example of this usage. | 8360 | too. See @ref{Complex example} for an example of this usage. |
| 8336 | 8361 | ||
| 8337 | Sometime an Org file to be published may contain links that are | 8362 | Sometime an Org file to be published may contain links that are |
| 8338 | only valid in your production environment, but not in the publishing | 8363 | only valid in your production environment, but not in the publishing |
diff --git a/etc/ChangeLog b/etc/ChangeLog index 8c2fd18de31..fc608bf166f 100644 --- a/etc/ChangeLog +++ b/etc/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2008-12-20 Carsten Dominik <dominik@science.uva.nl> | ||
| 2 | |||
| 3 | * refcards/orgcard.tex: Version number change. | ||
| 4 | |||
| 1 | 2008-12-19 Eli Zaretskii <eliz@gnu.org> | 5 | 2008-12-19 Eli Zaretskii <eliz@gnu.org> |
| 2 | 6 | ||
| 3 | * PROBLEMS (MS-DOS): Document the problems on Vista. | 7 | * PROBLEMS (MS-DOS): Document the problems on Vista. |