diff options
| author | Chong Yidong | 2011-12-29 23:58:42 +0800 |
|---|---|---|
| committer | Chong Yidong | 2011-12-29 23:58:42 +0800 |
| commit | 0ed49f9399f8865af366b7b8763aa07dd181f325 (patch) | |
| tree | c321571db6a124b2c1239fe1c73c87e9678dc625 | |
| parent | fec0aaa40d858f86395a9b684d97a62c99bac2c2 (diff) | |
| download | emacs-0ed49f9399f8865af366b7b8763aa07dd181f325.tar.gz emacs-0ed49f9399f8865af366b7b8763aa07dd181f325.zip | |
Cleanups for the new Org section in the Emacs manual.
* doc/emacs/text.texi (Org Mode): Copyedits. Refer to Outline Format for
example. Add index entries.
(Org Organizer, Org Authoring): Nodes renamed. Copyedits.
| -rw-r--r-- | doc/emacs/ChangeLog | 6 | ||||
| -rw-r--r-- | doc/emacs/emacs.texi | 1 | ||||
| -rw-r--r-- | doc/emacs/text.texi | 208 |
3 files changed, 116 insertions, 99 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 7857295de92..6e0819621a2 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,9 @@ | |||
| 1 | 2011-12-29 Chong Yidong <cyd@gnu.org> | ||
| 2 | |||
| 3 | * text.texi (Org Mode): Copyedits. Refer to Outline Format for | ||
| 4 | example. Add index entries. | ||
| 5 | (Org Organizer, Org Authoring): Nodes renamed. Copyedits. | ||
| 6 | |||
| 1 | 2011-12-26 Chong Yidong <cyd@gnu.org> | 7 | 2011-12-26 Chong Yidong <cyd@gnu.org> |
| 2 | 8 | ||
| 3 | * dired.texi (Dired Enter, Misc Dired Features): Document | 9 | * dired.texi (Dired Enter, Misc Dired Features): Document |
diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index 7f703fbaad0..f5f0ffe8ef4 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi | |||
| @@ -548,6 +548,7 @@ Commands for Human Languages | |||
| 548 | * Case:: Changing the case of text. | 548 | * Case:: Changing the case of text. |
| 549 | * Text Mode:: The major modes for editing text files. | 549 | * Text Mode:: The major modes for editing text files. |
| 550 | * Outline Mode:: Editing outlines. | 550 | * Outline Mode:: Editing outlines. |
| 551 | * Org Mode:: The Emacs organizer. | ||
| 551 | * TeX Mode:: Editing input to the formatter TeX. | 552 | * TeX Mode:: Editing input to the formatter TeX. |
| 552 | * HTML Mode:: Editing HTML and SGML files. | 553 | * HTML Mode:: Editing HTML and SGML files. |
| 553 | * Nroff Mode:: Editing input to the formatter nroff. | 554 | * Nroff Mode:: Editing input to the formatter nroff. |
diff --git a/doc/emacs/text.texi b/doc/emacs/text.texi index 37a85a89ea2..e4bc31e0266 100644 --- a/doc/emacs/text.texi +++ b/doc/emacs/text.texi | |||
| @@ -1256,117 +1256,139 @@ automatically by putting this in your init file (@pxref{Init File}): | |||
| 1256 | 1256 | ||
| 1257 | @node Org Mode | 1257 | @node Org Mode |
| 1258 | @section Org Mode | 1258 | @section Org Mode |
| 1259 | @kindex TAB @r{(Org Mode)} | ||
| 1260 | @kindex S-TAB @r{(Org Mode)} | ||
| 1261 | @cindex organizer | 1259 | @cindex organizer |
| 1262 | @cindex planner | 1260 | @cindex planner |
| 1263 | @findex org-mode | 1261 | @findex Org mode |
| 1264 | @cindex fold | 1262 | @findex mode, Org |
| 1265 | @cindex headline | ||
| 1266 | @kindex M-<up> @r{(Org Mode)} | ||
| 1267 | @kindex M-<down> @r{(Org Mode)} | ||
| 1268 | @kindex M-<left> @r{(Org Mode)} | ||
| 1269 | @kindex M-<right> @r{(Org Mode)} | ||
| 1270 | @kindex S-M-<up> @r{(Org Mode)} | ||
| 1271 | @kindex S-M-<down> @r{(Org Mode)} | ||
| 1272 | @kindex S-M-<left> @r{(Org Mode)} | ||
| 1273 | @kindex S-M-<right> @r{(Org Mode)} | ||
| 1274 | |||
| 1275 | Org mode extends Outline mode to turn Emacs into an organizer and an | ||
| 1276 | authoring system. | ||
| 1277 | 1263 | ||
| 1278 | When editing a file ending with the @file{.org} extension, Emacs | 1264 | @findex org-mode |
| 1279 | automatically uses @code{org-mode} as the major mode. In this mode, | 1265 | Org mode is a variant of Outline mode for using Emacs as an |
| 1280 | headlines start with one (or more) leading star(s) and comments start | 1266 | organizer and/or authoring system. Files with names ending in the |
| 1281 | with the @code{#} character at the beginning of a line. | 1267 | extension @file{.org} are opened in Org mode (@pxref{Choosing Modes}). |
| 1282 | 1268 | To explicitly switch to Org mode, type @kbd{M-x org-mode}. | |
| 1283 | @example | ||
| 1284 | * This is the first headline | ||
| 1285 | ** This is a first sub-headline | ||
| 1286 | * This is the second headline | ||
| 1287 | |||
| 1288 | Some content here. | ||
| 1289 | 1269 | ||
| 1290 | # Some comment here. | 1270 | In Org mode, as in Outline mode, each entry has a heading line that |
| 1291 | @end example | 1271 | starts with one or more @samp{*} characters. @xref{Outline Format}. |
| 1272 | In addition, any line that begins with the @samp{#} character is | ||
| 1273 | treated as a comment. | ||
| 1292 | 1274 | ||
| 1293 | From here, you can use Org mode as a simple outliner: @key{TAB} on a | 1275 | @kindex TAB @r{(Org Mode)} |
| 1294 | headline will cycle through the various folding states of a subtree, | 1276 | @findex org-cycle |
| 1295 | and @key{S-TAB} anywhere in the buffer will (un)fold the whole | 1277 | Org mode provides commands for easily viewing and manipulating the |
| 1296 | structure. | 1278 | outline structure. The simplest of these commands is @key{TAB} |
| 1279 | (@code{org-cycle}). If invoked on a heading line, it cycles through | ||
| 1280 | the different visibility states of the subtree: (i) showing only that | ||
| 1281 | heading line, (ii) showing only the heading line and the heading lines | ||
| 1282 | of its direct children, if any, and (iii) showing the entire subtree. | ||
| 1283 | If invoked in a body line, the global binding for @key{TAB} is | ||
| 1284 | executed. | ||
| 1297 | 1285 | ||
| 1298 | You can also manipulate the structure of your document by moving a | 1286 | @kindex S-TAB @r{(Org Mode)} |
| 1299 | headline up and down with @key{M-<up>} and @key{M-<down>}, or by | 1287 | @findex org-shifttab |
| 1300 | promoting and demoting a headline with @key{M-<left>} and | 1288 | Typing @key{S-TAB} (@code{org-shifttab}) anywhere in an Org mode |
| 1301 | @key{M-<left>}. If you want to act on the whole subtree (i.e. the | 1289 | buffer cycles the visibility of the entire outline structure, between |
| 1302 | headline and its content, including other headlines), simply add the | 1290 | (i) showing only top-level heading lines, (ii) showing all heading |
| 1303 | @kbd{Shift} key and use @key{S-M-<up>}, @key{S-M-<down>}, | 1291 | lines but no body lines, and (iii) showing everything. |
| 1304 | @key{S-M-<left>} and @key{S-M-<right>}. | ||
| 1305 | 1292 | ||
| 1306 | For further details, see @ref{Document Structure,,,org, The Org Manual}. | 1293 | @kindex M-<up> @r{(Org Mode)} |
| 1294 | @kindex M-<down> @r{(Org Mode)} | ||
| 1295 | @kindex M-<left> @r{(Org Mode)} | ||
| 1296 | @kindex M-<right> @r{(Org Mode)} | ||
| 1297 | @findex org-metaup | ||
| 1298 | @findex org-metadown | ||
| 1299 | @findex org-metaleft | ||
| 1300 | @findex org-metaright | ||
| 1301 | You can move an entire entry up or down in the buffer, including its | ||
| 1302 | body lines and subtree (if any), by typing @kbd{M-<up>} | ||
| 1303 | (@code{org-metaup}) or @kbd{M-<down>} (@code{org-metadown}) on the | ||
| 1304 | heading line. Similarly, you can promote or demote a heading line | ||
| 1305 | with @kbd{M-<left>} (@code{org-metaleft}) and @kbd{M-<left>} | ||
| 1306 | (@code{org-metaright}). These commands execute their global bindings | ||
| 1307 | if invoked on a body line. | ||
| 1308 | |||
| 1309 | The following subsections give basic instructions for using Org mode | ||
| 1310 | as an organizer and as an authoring system. @xref{Top,The Org Mode | ||
| 1311 | Manual,,org, The Org Manual}, for details. | ||
| 1307 | 1312 | ||
| 1308 | @menu | 1313 | @menu |
| 1309 | * Org as an organizer:: Manage TODO lists and agendas | 1314 | * Org Organizer:: Managing TODO lists and agendas. |
| 1310 | * Org as an authoring system:: Export to various formats | 1315 | * Org Authoring:: Exporting Org buffers to various formats. |
| 1311 | @end menu | 1316 | @end menu |
| 1312 | 1317 | ||
| 1313 | @node Org as an organizer | 1318 | @node Org Organizer |
| 1314 | @subsection Org as an organizer | 1319 | @subsection Org as an organizer |
| 1320 | @cindex TODO item | ||
| 1321 | @cindex Org agenda | ||
| 1315 | 1322 | ||
| 1316 | @cindex TODO keywords | ||
| 1317 | @kindex C-c C-t @r{(Org Mode)} | 1323 | @kindex C-c C-t @r{(Org Mode)} |
| 1324 | @findex org-todo | ||
| 1325 | @vindex org-todo-keywords | ||
| 1326 | You can tag an Org entry as a @dfn{TODO} item by typing @kbd{C-c | ||
| 1327 | C-t} (@code{org-todo}) anywhere in the entry. This adds the keyword | ||
| 1328 | @samp{TODO} to the heading line. Typing @kbd{C-c C-t} again switches | ||
| 1329 | the keyword to @samp{DONE}; another @kbd{C-c C-t} removes the keyword | ||
| 1330 | entirely, and so forth. You can customize the keywords used by | ||
| 1331 | @kbd{C-c C-t} via the variable @code{org-todo-keywords}. | ||
| 1332 | |||
| 1318 | @kindex C-c C-s @r{(Org Mode)} | 1333 | @kindex C-c C-s @r{(Org Mode)} |
| 1319 | @kindex C-c C-d @r{(Org Mode)} | 1334 | @kindex C-c C-d @r{(Org Mode)} |
| 1320 | @vindex org-todo-keywords | 1335 | @findex org-schedule |
| 1321 | @findex org-todo | 1336 | @findex org-deadline |
| 1337 | Apart from marking an entry as TODO, you can attach a date to it, by | ||
| 1338 | typing @kbd{C-c C-s} (@code{org-schedule}) in the entry. This prompts | ||
| 1339 | for a date by popping up the Emacs Calendar (@pxref{Calendar/Diary}), | ||
| 1340 | and then adds the tag @samp{SCHEDULED}, together with the selected | ||
| 1341 | date, beneath the heading line. The command @kbd{C-c C-d} | ||
| 1342 | (@code{org-deadline}) has the same effect, except that it uses the tag | ||
| 1343 | @code{DEADLINE}. | ||
| 1344 | |||
| 1345 | @kindex C-c [ @r{(Org Mode)} | ||
| 1346 | @findex org-agenda-file-to-front | ||
| 1347 | @vindex org-agenda-files | ||
| 1348 | Once you have some TODO items planned in an Org file, you can add | ||
| 1349 | that file to the list of @dfn{agenda files} by typing @kbd{C-c [} | ||
| 1350 | (@code{org-agenda-file-to-front}). Org mode is designed to let you | ||
| 1351 | easily maintain multiple agenda files, e.g.@: for organizing different | ||
| 1352 | aspects of your life. The list of agenda files is stored in the | ||
| 1353 | variable @code{org-agenda-files}. | ||
| 1354 | |||
| 1322 | @findex org-agenda | 1355 | @findex org-agenda |
| 1323 | @cindex scheduled | 1356 | To view items coming from your agenda files, type @kbd{M-x |
| 1324 | @cindex deadline | 1357 | org-agenda}. This command prompts for what you want to see: a list of |
| 1325 | @cindex agenda | 1358 | things to do this week, a list of TODO items with specific keywords, |
| 1326 | 1359 | etc. | |
| 1327 | Each headline can be turned into a TODO item calling @code{org-todo} | 1360 | @ifnottex |
| 1328 | with @key{C-c C-t} anywhere on it. This will add the TODO keyword | 1361 | @xref{Agenda Views,,,org, The Org Manual}, for details. |
| 1329 | @code{TODO}. Hit @key{C-c C-t} to cycle through the list of available | 1362 | @end ifnottex |
| 1330 | TODO keywords: you can configure the variable @code{org-todo-keywords} | 1363 | |
| 1331 | to use your own list of keywords. | 1364 | @node Org Authoring |
| 1332 | |||
| 1333 | Now that you have something to do, let's add a date to it: pressing | ||
| 1334 | @key{C-c C-s} on a headline will add @code{SCHEDULED} below it, and | ||
| 1335 | you will be prompted for a date through the calendar. @key{C-c C-d} | ||
| 1336 | has the same effect, except that the item will have a @code{DEADLINE} | ||
| 1337 | instead. | ||
| 1338 | |||
| 1339 | Now that some TODO items are planned in the current file, add it to | ||
| 1340 | the list of agenda files with @key{C-c [}. Calling the interactive | ||
| 1341 | command @code{org-agenda} will prompt you for what you want to see: a | ||
| 1342 | list of things to do this week, a list of TODO items with specific | ||
| 1343 | keywords, etc. | ||
| 1344 | |||
| 1345 | For further details, see @ref{TODO items,,,org, The Org Manual} and | ||
| 1346 | @ref{Dates and times,,,org, The Org Manual}. | ||
| 1347 | |||
| 1348 | @node Org as an authoring system | ||
| 1349 | @subsection Org as an authoring system | 1365 | @subsection Org as an authoring system |
| 1350 | @cindex export | 1366 | @cindex Org exporting |
| 1351 | @findex org-export | ||
| 1352 | @cindex publish | ||
| 1353 | @cindex code block | ||
| 1354 | @cindex quote | ||
| 1355 | 1367 | ||
| 1356 | You may want to format your Org notes nicely and to prepare them for | 1368 | @findex org-export |
| 1357 | export and publication. Org supports simple text formatting: | 1369 | @kindex C-c C-e @r{(Org mode)} |
| 1370 | You may want to format your Org notes nicely and to prepare them for | ||
| 1371 | export and publication. To export the current buffer, type @kbd{C-c | ||
| 1372 | C-e} (@code{org-export}) anywhere in an Org buffer. This command | ||
| 1373 | prompts for an export format; currently supported formats include | ||
| 1374 | HTML, La@TeX{}, OpenDocument (@file{.odt}), and PDF. Some formats, | ||
| 1375 | such as PDF, require certain system tools to be installed. | ||
| 1376 | |||
| 1377 | @vindex org-publish-project-alist | ||
| 1378 | To export several files at once to a specific directory, either | ||
| 1379 | locally or over the network, you must define a list of projects | ||
| 1380 | through the variable @code{org-publish-project-alist}. See its | ||
| 1381 | documentation for details. | ||
| 1382 | |||
| 1383 | Org supports a simple markup scheme for applying text formatting to | ||
| 1384 | exported documents: | ||
| 1358 | 1385 | ||
| 1359 | @example | 1386 | @example |
| 1360 | - This text is /emphasized/ | 1387 | - This text is /emphasized/ |
| 1361 | - This item uses *a bold font* | 1388 | - This text is *in bold* |
| 1362 | - This text is _underlined_ | 1389 | - This text is _underlined_ |
| 1363 | - This text uses =a teletype font= | 1390 | - This text uses =a teletype font= |
| 1364 | @end example | ||
| 1365 | |||
| 1366 | If a paragraph is a quote or an example, you can use specific | ||
| 1367 | environments: | ||
| 1368 | 1391 | ||
| 1369 | @example | ||
| 1370 | #+begin_quote | 1392 | #+begin_quote |
| 1371 | ``This is a quote.'' | 1393 | ``This is a quote.'' |
| 1372 | #+end_quote | 1394 | #+end_quote |
| @@ -1376,19 +1398,7 @@ This is an example. | |||
| 1376 | #+end_example | 1398 | #+end_example |
| 1377 | @end example | 1399 | @end example |
| 1378 | 1400 | ||
| 1379 | These environments will be displayed in a specific way with respect | 1401 | For further details, see @ref{Exporting,,,org, The Org Manual} and |
| 1380 | to the selected export/publish backend. | ||
| 1381 | |||
| 1382 | To export the current buffer, press the @key{C-c C-e} key anywhere in | ||
| 1383 | an Org buffer. Supported export formats include @code{HTML}, La@TeX{} | ||
| 1384 | and @file{.odt} (OpenDocument format.) Depending on your system | ||
| 1385 | installation, you can also directly export to @code{pdf}. | ||
| 1386 | |||
| 1387 | To export several files at once to a specific directory either locally | ||
| 1388 | or on the Internet, you will need to define a list of projects through | ||
| 1389 | the variable @code{org-publish-project-alist}. | ||
| 1390 | |||
| 1391 | For further details, see @ref{Exporting,,,org, The Org Manual} and | ||
| 1392 | @ref{Publishing,,,org, The Org Manual}. | 1402 | @ref{Publishing,,,org, The Org Manual}. |
| 1393 | 1403 | ||
| 1394 | @node TeX Mode | 1404 | @node TeX Mode |