Mercurial > emacs
comparison man/org.texi @ 66264:d979e1d45f97
(Summary): Mention iCalendar support.
(Exporting): Document iCalendar support.
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Fri, 21 Oct 2005 05:56:26 +0000 |
parents | 927e31d586ca |
children | 4beb6b8b80fc |
comparison
equal
deleted
inserted
replaced
66263:340d6b4c8e29 | 66264:d979e1d45f97 |
---|---|
2 @c %**start of header | 2 @c %**start of header |
3 @c @setfilename org | 3 @c @setfilename org |
4 @setfilename ../info/org | 4 @setfilename ../info/org |
5 @settitle Org Mode Manual | 5 @settitle Org Mode Manual |
6 | 6 |
7 @set VERSION 3.17 | 7 @set VERSION 3.18 |
8 @set DATE October 2005 | 8 @set DATE October 2005 |
9 | 9 |
10 @dircategory Emacs | 10 @dircategory Emacs |
11 @direntry | 11 @direntry |
12 * Org Mode: (org). Outline-based notes management and organizer | 12 * Org Mode: (org). Outline-based notes management and organizer |
156 * Diary to agenda:: Agenda incorporates the diary | 156 * Diary to agenda:: Agenda incorporates the diary |
157 * Agenda to diary:: Diary incorporates the agenda | 157 * Agenda to diary:: Diary incorporates the agenda |
158 | 158 |
159 Exporting | 159 Exporting |
160 | 160 |
161 * Export commands:: Commands which export and display | 161 * ASCII export:: Export as a structured ASCII file |
162 * HTML export:: Export as an HTML file | |
163 * iCalendar export:: Create calendar entries. | |
164 | |
165 HTML export | |
166 | |
162 * HTML formatting:: Interpretation of the buffer content | 167 * HTML formatting:: Interpretation of the buffer content |
163 * Export options:: How to influence exports | 168 * Export options:: How to influence exports |
164 * Comment lines:: Lines which will not be exported | 169 * Comment lines:: Lines which will not be exported |
165 | 170 |
166 Miscellaneous | 171 Miscellaneous |
202 and scheduling. It dynamically compiles entries into an agenda that | 207 and scheduling. It dynamically compiles entries into an agenda that |
203 utilizes and smoothly integrates much of the Emacs calendar and diary. | 208 utilizes and smoothly integrates much of the Emacs calendar and diary. |
204 Plain text URL-like links connect to websites, emails, Usenet | 209 Plain text URL-like links connect to websites, emails, Usenet |
205 messages, BBDB entries, and any files related to the projects. For | 210 messages, BBDB entries, and any files related to the projects. For |
206 printing and sharing of notes, an Org-mode file can be exported as a | 211 printing and sharing of notes, an Org-mode file can be exported as a |
207 structured ASCII file, or as HTML. | 212 structured ASCII file, as HTML, or (todo and agenda items only) as an |
213 iCalendar file. | |
208 | 214 |
209 Org-mode keeps simple things simple. Not every outline branch needs | 215 Org-mode keeps simple things simple. Not every outline branch needs |
210 to be an action item, not every action item needs to have priority or | 216 to be an action item, not every action item needs to have priority or |
211 scheduling information associated with it. Org-mode can be used on | 217 scheduling information associated with it. Org-mode can be used on |
212 different levels and in different ways, for example | 218 different levels and in different ways, for example |
2046 | 2052 |
2047 @kindex H | 2053 @kindex H |
2048 @item H | 2054 @item H |
2049 Show holidays for three month around the cursor date. | 2055 Show holidays for three month around the cursor date. |
2050 | 2056 |
2057 @kindex C-c C-x C-c | |
2058 @item C-c C-x C-c | |
2059 Export a single iCalendar file containing entries from all agenda files. | |
2060 Not available in timelines. | |
2061 | |
2051 @tsubheading{Quit and Exit} | 2062 @tsubheading{Quit and Exit} |
2052 @kindex q | 2063 @kindex q |
2053 @item q | 2064 @item q |
2054 Quit Agenda, remove the agenda buffer. | 2065 Quit Agenda, remove the agenda buffer. |
2055 | 2066 |
2144 also the documentation of the @command{org-diary} function. | 2155 also the documentation of the @command{org-diary} function. |
2145 | 2156 |
2146 @node Exporting, Miscellaneous, Timeline and Agenda, Top | 2157 @node Exporting, Miscellaneous, Timeline and Agenda, Top |
2147 @chapter Exporting | 2158 @chapter Exporting |
2148 @cindex exporting | 2159 @cindex exporting |
2160 | |
2161 For printing and sharing of notes, Org-mode documents can be exported | |
2162 as ASCII or HTML files. To incorporate entries with associated times | |
2163 like deadlines or appointments into a desktop calendar program like | |
2164 iCal, Org-mode can also produce extracts in the iCalendar format. | |
2165 | |
2166 @menu | |
2167 * ASCII export:: Export as a structured ASCII file | |
2168 * HTML export:: Export as an HTML file | |
2169 * iCalendar export:: Create calendar entries. | |
2170 @end menu | |
2171 | |
2172 @node ASCII export, HTML export, Exporting, Exporting | |
2173 @section ASCII export | |
2149 @cindex ASCII export | 2174 @cindex ASCII export |
2150 @cindex HTML export | |
2151 | |
2152 @cindex headline levels, for exporting | |
2153 For printing and sharing of notes, an Org-mode document can be | |
2154 exported as an ASCII file, or as HTML. In the exported version, the | |
2155 first 3 outline levels will become headlines, defining a general | |
2156 document structure. Additional levels will be exported as itemize | |
2157 lists. If you want that transition to occur at a different level, | |
2158 specify it with a prefix argument. For example, | |
2159 | |
2160 @example | |
2161 @kbd{M-1 M-x org-export-as-html} | |
2162 @end example | |
2163 @noindent | |
2164 creates only top level headlines and does the rest as items. | |
2165 | |
2166 @menu | |
2167 * Export commands:: Commands which export and display | |
2168 * HTML formatting:: Interpretation of the buffer content | |
2169 * Export options:: How to influence exports | |
2170 * Comment lines:: Lines which will not be exported | |
2171 @end menu | |
2172 | |
2173 @node Export commands, HTML formatting, Exporting, Exporting | |
2174 @section Export commands | |
2175 | 2175 |
2176 @cindex region, active | 2176 @cindex region, active |
2177 @cindex active region | 2177 @cindex active region |
2178 @cindex transient-mark-mode | 2178 @cindex transient-mark-mode |
2179 @table @kbd | 2179 @table @kbd |
2181 @item C-c C-x a | 2181 @item C-c C-x a |
2182 Export as ASCII file. If there is an active region, only the region | 2182 Export as ASCII file. If there is an active region, only the region |
2183 will be exported. For an org file @file{myfile.org}, the ASCII file | 2183 will be exported. For an org file @file{myfile.org}, the ASCII file |
2184 will be @file{myfile.txt}. The file will be overwritten without | 2184 will be @file{myfile.txt}. The file will be overwritten without |
2185 warning. | 2185 warning. |
2186 @end table | |
2187 | |
2188 @cindex headline levels, for exporting | |
2189 In the exported version, the first 3 outline levels will become | |
2190 headlines, defining a general document structure. Additional levels | |
2191 will be exported as itemize lists. If you want that transition to occur | |
2192 at a different level, specify it with a prefix argument. For example, | |
2193 @example | |
2194 @kbd{C-1 C-c C-x a org-export-as-ascii} | |
2195 @end example | |
2196 @noindent | |
2197 creates only top level headlines and does the rest as items. Lines | |
2198 starting with @samp{#} and subtree starting with the word @samp{COMMENT} | |
2199 will not be exported. | |
2200 | |
2201 @node HTML export, iCalendar export, ASCII export, Exporting | |
2202 @section HTML export | |
2203 @cindex HTML export | |
2204 | |
2205 Org-mode contains an HTML exporter with extensive HTML formatting. | |
2206 | |
2207 @cindex region, active | |
2208 @cindex active region | |
2209 @cindex transient-mark-mode | |
2210 @table @kbd | |
2186 @kindex C-c C-x h | 2211 @kindex C-c C-x h |
2187 @item C-c C-x h | 2212 @item C-c C-x h |
2188 Export as HTML file @file{myfile.html}. | 2213 Export as HTML file @file{myfile.html}. |
2189 @kindex C-c C-x b | 2214 @kindex C-c C-x b |
2190 @item C-c C-x b | 2215 @item C-c C-x b |
2195 @kindex C-c : | 2220 @kindex C-c : |
2196 @item C-c : | 2221 @item C-c : |
2197 Toggle fixed-width for entry (QUOTE) or region, see below. | 2222 Toggle fixed-width for entry (QUOTE) or region, see below. |
2198 @end table | 2223 @end table |
2199 | 2224 |
2200 @node HTML formatting, Export options, Export commands, Exporting | 2225 @cindex headline levels, for exporting |
2201 @section HTML formatting | 2226 In the exported version, the first 3 outline levels will become |
2227 headlines, defining a general document structure. Additional levels | |
2228 will be exported as itemize lists. If you want that transition to occur | |
2229 at a different level, specify it with a prefix argument. For example, | |
2230 @example | |
2231 @kbd{C-2 C-c C-x b} | |
2232 @end example | |
2233 @noindent | |
2234 creates two levels of headings and does the rest as items. | |
2235 | |
2236 @menu | |
2237 * HTML formatting:: Interpretation of the buffer content | |
2238 * Export options:: How to influence exports | |
2239 * Comment lines:: Lines which will not be exported | |
2240 @end menu | |
2241 | |
2242 @node HTML formatting, Export options, HTML export, HTML export | |
2243 @subsection HTML formatting | |
2202 | 2244 |
2203 Not all text is transferred literally to the exported HTML file. The | 2245 Not all text is transferred literally to the exported HTML file. The |
2204 exporter implements the following interpretation: | 2246 exporter implements the following interpretation: |
2205 | 2247 |
2206 @itemize @bullet | 2248 @itemize @bullet |
2246 @end itemize | 2288 @end itemize |
2247 | 2289 |
2248 If these conversions conflict with your habits of typing ASCII text, | 2290 If these conversions conflict with your habits of typing ASCII text, |
2249 they can all be turned off with corresponding variables. | 2291 they can all be turned off with corresponding variables. |
2250 | 2292 |
2251 @node Export options, Comment lines, HTML formatting, Exporting | 2293 @node Export options, Comment lines, HTML formatting, HTML export |
2252 @section Export options | 2294 @subsection Export options |
2253 @cindex options, for export | 2295 @cindex options, for export |
2254 | 2296 |
2255 @cindex completion, of option keywords | 2297 @cindex completion, of option keywords |
2256 The exporter recognizes special lines in the buffer which provide | 2298 The exporter recognizes special lines in the buffer which provide |
2257 additional information. These lines may be put anywhere in the file. | 2299 additional information. These lines may be put anywhere in the file. |
2293 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts.} | 2335 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts.} |
2294 *: @r{turn on/off emphasized text (bold, italic, underlined)} | 2336 *: @r{turn on/off emphasized text (bold, italic, underlined)} |
2295 TeX: @r{turn on/off @TeX{} macros} | 2337 TeX: @r{turn on/off @TeX{} macros} |
2296 @end example | 2338 @end example |
2297 | 2339 |
2298 @node Comment lines, , Export options, Exporting | 2340 @node Comment lines, , Export options, HTML export |
2299 @section Comment lines | 2341 @subsection Comment lines |
2300 @cindex comment lines | 2342 @cindex comment lines |
2301 @cindex exporting, not | 2343 @cindex exporting, not |
2302 | 2344 |
2303 Lines starting with @samp{#} in column zero are treated as comments | 2345 Lines starting with @samp{#} in column zero are treated as comments |
2304 and will never be exported. Also entire subtrees starting with the | 2346 and will never be exported. Also entire subtrees starting with the |
2305 word @samp{COMMENT} will never be exported. Finally, any text before | 2347 word @samp{COMMENT} will never be exported. Finally, any text before |
2306 the first headline will not be exported either. | 2348 the first headline will not be exported either. This applies also for |
2349 ASCII export. | |
2307 | 2350 |
2308 @table @kbd | 2351 @table @kbd |
2309 @kindex C-c ; | 2352 @kindex C-c ; |
2310 @item C-c ; | 2353 @item C-c ; |
2311 Toggle the COMMENT keyword at the beginning of an entry. | 2354 Toggle the COMMENT keyword at the beginning of an entry. |
2312 @end table | 2355 @end table |
2356 | |
2357 @node iCalendar export, , HTML export, Exporting | |
2358 @section iCalendar export | |
2359 | |
2360 Some people like to use Org-mode for keeping track of projects, but | |
2361 still prefer a standard calendar application for anniversaries and | |
2362 appointments. In this case it can be useful to have deadlines and | |
2363 other time-stamped items in Org-mode files show up in the calendar | |
2364 application. Org-mode can export calendar information in the standard | |
2365 iCalendar format. | |
2366 | |
2367 @table @kbd | |
2368 @kindex C-c C-x i | |
2369 @item C-c C-x i | |
2370 Create iCalendar entries for the current file and store them in the same | |
2371 directory, using a file extension @file{.ics}. | |
2372 @kindex C-c C-x C-i | |
2373 @item C-c C-x C-i | |
2374 Like @kbd{C-c C-x i}, but do this for all files in | |
2375 @code{org-agenda-files}. For each of these files, a separate iCalendar | |
2376 file will be written. | |
2377 @kindex C-c C-x c | |
2378 @item C-c C-x c | |
2379 Create a single large iCalendar file from all files in | |
2380 @code{org-agenda-files} and write it to the file given by | |
2381 @code{org-combined-agenda-icalendar-file}. | |
2382 @end table | |
2383 | |
2384 How this calendar is best read and updated, depends on the on the | |
2385 application you are using. For example, when using iCal under Apple | |
2386 MacOS X, you could create a new calendar @samp{OrgMode} (the default | |
2387 name for the calendar created by @kbd{C-c C-x c}, see the variables | |
2388 @code{org-icalendar-combined-name} and | |
2389 @code{org-combined-agenda-icalendar-file}). Then set Org-mode to | |
2390 overwrite the corresponding file | |
2391 @file{~/Library/Calendars/OrgMode.ics}. You may even use AppleScript | |
2392 to make iCal re-read the calendar files each time a new version of | |
2393 @file{OrgMode.ics} is produced. Here is the setup needed for this: | |
2394 | |
2395 @lisp | |
2396 (setq org-combined-agenda-icalendar-file | |
2397 "~/Library/Calendars/OrgMode.ics") | |
2398 (add-hook 'org-after-save-iCalendar-file-hook | |
2399 (lambda () | |
2400 (shell-command | |
2401 "osascript -e 'tell application \"iCal\" to reload calendars'"))) | |
2402 @end lisp | |
2313 | 2403 |
2314 @node Miscellaneous, Index, Exporting, Top | 2404 @node Miscellaneous, Index, Exporting, Top |
2315 @chapter Miscellaneous | 2405 @chapter Miscellaneous |
2316 | 2406 |
2317 @menu | 2407 @menu |