diff options
| author | Carsten Dominik | 2005-11-18 16:09:49 +0000 |
|---|---|---|
| committer | Carsten Dominik | 2005-11-18 16:09:49 +0000 |
| commit | 6fd41b1fab46111c109897d90e8ab9ac8d09ff44 (patch) | |
| tree | bd48fd858c85d4176473cedc1848a4213157c98d | |
| parent | e0e66b8ec4f60e5f98020ec537bc0a2164d9dc93 (diff) | |
| download | emacs-6fd41b1fab46111c109897d90e8ab9ac8d09ff44.tar.gz emacs-6fd41b1fab46111c109897d90e8ab9ac8d09ff44.zip | |
(FAQ): Document `org-table-tab-jumps-over-hlines'.
(Agenda): Document commands `org-cycle-agenda-files' and
`org-agenda-file-to-front'
(Built-in table editor): Document `org-table-sort-lines'.
(HTML formatting): Export of hand-formatted lists.
| -rw-r--r-- | man/org.texi | 89 |
1 files changed, 76 insertions, 13 deletions
diff --git a/man/org.texi b/man/org.texi index 88c22dc35a7..5a8d45638bd 100644 --- a/man/org.texi +++ b/man/org.texi | |||
| @@ -4,7 +4,7 @@ | |||
| 4 | @setfilename ../info/org | 4 | @setfilename ../info/org |
| 5 | @settitle Org Mode Manual | 5 | @settitle Org Mode Manual |
| 6 | 6 | ||
| 7 | @set VERSION 3.19 | 7 | @set VERSION 3.20 |
| 8 | @set DATE October 2005 | 8 | @set DATE October 2005 |
| 9 | 9 | ||
| 10 | @dircategory Emacs | 10 | @dircategory Emacs |
| @@ -698,6 +698,13 @@ Insert a new row above (with arg: below) the current row. | |||
| 698 | Insert a horizontal line below current row. With prefix arg, the line | 698 | Insert a horizontal line below current row. With prefix arg, the line |
| 699 | is created above the current line. | 699 | is created above the current line. |
| 700 | 700 | ||
| 701 | @kindex C-c ^ | ||
| 702 | @item C-c ^ | ||
| 703 | Sort the table lines in the region. Point and mark must be in the first | ||
| 704 | and last line to be included, and must be in the column that should be | ||
| 705 | used for sorting. The command prompts for numerical versus | ||
| 706 | alphnumerical sorting. | ||
| 707 | |||
| 701 | @tsubheading{Regions} | 708 | @tsubheading{Regions} |
| 702 | @kindex C-c C-x M-w | 709 | @kindex C-c C-x M-w |
| 703 | @item C-c C-x M-w | 710 | @item C-c C-x M-w |
| @@ -859,13 +866,13 @@ substitution takes place: | |||
| 859 | @end example | 866 | @end example |
| 860 | 867 | ||
| 861 | The range vectors can be directly fed into the calc vector functions | 868 | The range vectors can be directly fed into the calc vector functions |
| 862 | like functions @samp{vmean} and @samp{vsum}. | 869 | like @samp{vmean} and @samp{vsum}. |
| 863 | 870 | ||
| 864 | @samp{$name} is interpreted as the name of a column, parameter or | 871 | @samp{$name} is interpreted as the name of a column, parameter or |
| 865 | constant. Constants are defined globally through the variable | 872 | constant. Constants are defined globally through the variable |
| 866 | @code{org-table-formula-constants}. If you have the | 873 | @code{org-table-formula-constants}. If you have the |
| 867 | @file{constants.el} package, it will also be used to resolve | 874 | @file{constants.el} package, it will also be used to resolve |
| 868 | constants, including natural constants like @samp{$k} for Planck's | 875 | constants, including natural constants like @samp{$h} for Planck's |
| 869 | constant, units like @samp{$km} for kilometers. Column names and | 876 | constant, units like @samp{$km} for kilometers. Column names and |
| 870 | parameters can be specified in special table lines. These are | 877 | parameters can be specified in special table lines. These are |
| 871 | described below, see @ref{Advanced features}. | 878 | described below, see @ref{Advanced features}. |
| @@ -972,7 +979,7 @@ The marking characters have the following meaning: | |||
| 972 | The fields in this line define names for the columns, so that you may | 979 | The fields in this line define names for the columns, so that you may |
| 973 | refer to a column as @samp{$Tot} instead of @samp{$6}. | 980 | refer to a column as @samp{$Tot} instead of @samp{$6}. |
| 974 | @item ^ | 981 | @item ^ |
| 975 | This row define names for the fields @emph{above} the row. With such | 982 | This row defines names for the fields @emph{above} the row. With such |
| 976 | a definition, any formula in the table may use @samp{$m1} to refer to | 983 | a definition, any formula in the table may use @samp{$m1} to refer to |
| 977 | the value @samp{10}. Also, named fields can have their own formula | 984 | the value @samp{10}. Also, named fields can have their own formula |
| 978 | associated with them. | 985 | associated with them. |
| @@ -1762,10 +1769,15 @@ following commands | |||
| 1762 | @table @kbd | 1769 | @table @kbd |
| 1763 | @kindex C-c [ | 1770 | @kindex C-c [ |
| 1764 | @item C-c [ | 1771 | @item C-c [ |
| 1765 | Add current file to the list of agenda files | 1772 | Add current file to the list of agenda files. The file is added to |
| 1773 | the front of the list. If it was already in the list, it is moved to | ||
| 1774 | the front. With prefix arg, file is added/moved to the end. | ||
| 1766 | @kindex C-c ] | 1775 | @kindex C-c ] |
| 1767 | @item C-c ] | 1776 | @item C-c ] |
| 1768 | Remove current file from the list of agenda files. | 1777 | Remove current file from the list of agenda files. |
| 1778 | @kindex C-, | ||
| 1779 | @item C-, | ||
| 1780 | Cycle through agenda file list. | ||
| 1769 | @end table | 1781 | @end table |
| 1770 | @noindent | 1782 | @noindent |
| 1771 | The Org menu contains the list of all files and can be used to quickly | 1783 | The Org menu contains the list of all files and can be used to quickly |
| @@ -2202,7 +2214,9 @@ will not be exported. | |||
| 2202 | @section HTML export | 2214 | @section HTML export |
| 2203 | @cindex HTML export | 2215 | @cindex HTML export |
| 2204 | 2216 | ||
| 2205 | Org-mode contains an HTML exporter with extensive HTML formatting. | 2217 | Org-mode contains an HTML exporter with extensive HTML formatting, in |
| 2218 | ways similar to John Grubers @emph{markdown} language, but with | ||
| 2219 | additional support for tables. | ||
| 2206 | 2220 | ||
| 2207 | @cindex region, active | 2221 | @cindex region, active |
| 2208 | @cindex active region | 2222 | @cindex active region |
| @@ -2246,6 +2260,34 @@ Not all text is transferred literally to the exported HTML file. The | |||
| 2246 | exporter implements the following interpretation: | 2260 | exporter implements the following interpretation: |
| 2247 | 2261 | ||
| 2248 | @itemize @bullet | 2262 | @itemize @bullet |
| 2263 | |||
| 2264 | @cindex hand-formatted lists | ||
| 2265 | @cindex lists, hand-formatted | ||
| 2266 | @item | ||
| 2267 | Hand-formatted lists with @samp{-}, @samp{*} or @samp{+} as | ||
| 2268 | bullet@footnote{When using @samp{*} as a bullet, lines must be | ||
| 2269 | indented or they will be seen as top-level headlines.}, or | ||
| 2270 | with @samp{1.}, @samp{2.} as enumerator will be recognized and | ||
| 2271 | transformed into HTML lists. The | ||
| 2272 | lists is terminated by the next headline, or by a line that is | ||
| 2273 | indented like the bullet/enumerator in the first line, or less. For | ||
| 2274 | example: | ||
| 2275 | @example | ||
| 2276 | ** Lord of the Rings | ||
| 2277 | Some of my favorite scenes are | ||
| 2278 | - Eowyns fight | ||
| 2279 | - The attack of the Roherim | ||
| 2280 | (this may be favorite one) | ||
| 2281 | - Peter Jackson being shot by Legolas, | ||
| 2282 | in the extended DVD edition only | ||
| 2283 | My favorite characters are (in this sequence): | ||
| 2284 | 1. Sam | ||
| 2285 | 2. Eowyn | ||
| 2286 | 3. Aragorn | ||
| 2287 | Among the others I don't really have a preference. | ||
| 2288 | @end example | ||
| 2289 | By default, only no nesting of lists is allowed, but see the variable | ||
| 2290 | @code{org-export-local-list-max-depth}. | ||
| 2249 | @cindex underlined text | 2291 | @cindex underlined text |
| 2250 | @cindex bold text | 2292 | @cindex bold text |
| 2251 | @cindex italic text | 2293 | @cindex italic text |
| @@ -2337,6 +2379,26 @@ toc: @r{turn on/off table of contents} | |||
| 2337 | TeX: @r{turn on/off @TeX{} macros} | 2379 | TeX: @r{turn on/off @TeX{} macros} |
| 2338 | @end example | 2380 | @end example |
| 2339 | 2381 | ||
| 2382 | You can also give style information for the exported file. The | ||
| 2383 | default specification can be configured through the option | ||
| 2384 | @code{org-export-html-style}. If you want to use a file-local style, | ||
| 2385 | you may use file variables, best wrapped into a COMMENT section at the | ||
| 2386 | end of the outline tree. For example: | ||
| 2387 | |||
| 2388 | @example | ||
| 2389 | * COMMENT HTML style specifications | ||
| 2390 | |||
| 2391 | # Local Variables: | ||
| 2392 | # org-export-html-style: " <style type=\"text/css\"> | ||
| 2393 | p @{font-weight: normal; color: gray; @} | ||
| 2394 | h1 @{color: black; @} | ||
| 2395 | </style>" | ||
| 2396 | # End: *** | ||
| 2397 | @end example | ||
| 2398 | |||
| 2399 | Remember to execute @kbd{M-x normal-mode} after changing this to make | ||
| 2400 | the new style visible to Emacs. | ||
| 2401 | |||
| 2340 | @node Comment lines, , Export options, HTML export | 2402 | @node Comment lines, , Export options, HTML export |
| 2341 | @subsection Comment lines | 2403 | @subsection Comment lines |
| 2342 | @cindex comment lines | 2404 | @cindex comment lines |
| @@ -2532,6 +2594,7 @@ horizontal line in the table, pressing TAB creates a new table line | |||
| 2532 | @i{before} the horizontal line. How can I quickly move to the line | 2594 | @i{before} the horizontal line. How can I quickly move to the line |
| 2533 | @i{below} the horizontal line instead?}@* | 2595 | @i{below} the horizontal line instead?}@* |
| 2534 | Press @key{down} (to get on the separator line) and then @key{TAB}. | 2596 | Press @key{down} (to get on the separator line) and then @key{TAB}. |
| 2597 | Or configure the variable @code{org-table-tab-jumps-over-hlines}. | ||
| 2535 | 2598 | ||
| 2536 | @item @b{How can I change the indentation of an entire table without | 2599 | @item @b{How can I change the indentation of an entire table without |
| 2537 | fixing every line by hand?}@* | 2600 | fixing every line by hand?}@* |
| @@ -2649,13 +2712,13 @@ Here is a list of things which should work differently, but which I | |||
| 2649 | have found too hard to fix. | 2712 | have found too hard to fix. |
| 2650 | 2713 | ||
| 2651 | @itemize @bullet | 2714 | @itemize @bullet |
| 2652 | @item | 2715 | @c @item |
| 2653 | If you call @code{fill-paragraph} (bound to @kbd{M-q}) in a table, the | 2716 | @c If you call @code{fill-paragraph} (bound to @kbd{M-q}) in a table, the |
| 2654 | filling is correctly disabled. However, if some text directly | 2717 | @c filling is correctly disabled. However, if some text directly |
| 2655 | (without an empty line in between) precedes or follows a table, calling | 2718 | @c (without an empty line in between) precedes or follows a table, calling |
| 2656 | @code{fill-paragraph} in that text will also fill the table like | 2719 | @c @code{fill-paragraph} in that text will also fill the table like |
| 2657 | normal text. Also, @code{fill-region} does bypass the | 2720 | @c normal text. Also, @code{fill-region} does bypass the |
| 2658 | @code{fill-paragraph} code and will fill tables like normal text. | 2721 | @c @code{fill-paragraph} code and will fill tables like normal text. |
| 2659 | @item | 2722 | @item |
| 2660 | Text in an entry protected with the @samp{QUOTE} keyword should not | 2723 | Text in an entry protected with the @samp{QUOTE} keyword should not |
| 2661 | autowrap. | 2724 | autowrap. |