diff options
| author | Bastien Guerry | 2011-12-21 15:02:38 +0100 |
|---|---|---|
| committer | Bastien Guerry | 2011-12-21 15:02:38 +0100 |
| commit | 5da6dcc815adb1dbcaf0c43141dacdf7aa4b0589 (patch) | |
| tree | 03db721986862b1337c189b7a816d1284ac59401 | |
| parent | 728a1f2bbbf6af5166f52af7fefac72fa83b495c (diff) | |
| download | emacs-5da6dcc815adb1dbcaf0c43141dacdf7aa4b0589.tar.gz emacs-5da6dcc815adb1dbcaf0c43141dacdf7aa4b0589.zip | |
text.texi: add a section about Org Mode.
This section describes general concepts behind Org Mode
and redirects to the Org Manual when necessary.
| -rw-r--r-- | doc/emacs/text.texi | 143 |
1 files changed, 142 insertions, 1 deletions
diff --git a/doc/emacs/text.texi b/doc/emacs/text.texi index c27a2c2936d..37a85a89ea2 100644 --- a/doc/emacs/text.texi +++ b/doc/emacs/text.texi | |||
| @@ -21,7 +21,10 @@ are also often useful for editing programs. | |||
| 21 | the file contains ordinary text, use Text mode, which customizes Emacs | 21 | the file contains ordinary text, use Text mode, which customizes Emacs |
| 22 | in small ways for the syntactic conventions of text. Outline mode | 22 | in small ways for the syntactic conventions of text. Outline mode |
| 23 | provides special commands for operating on text with an outline | 23 | provides special commands for operating on text with an outline |
| 24 | structure. | 24 | structure. Org mode extends Outline mode and turn Emacs into a |
| 25 | full-fledged organizer: you can manage TODO lists, store notes and | ||
| 26 | publish them in many formats. | ||
| 27 | |||
| 25 | @iftex | 28 | @iftex |
| 26 | @xref{Outline Mode}. | 29 | @xref{Outline Mode}. |
| 27 | @end iftex | 30 | @end iftex |
| @@ -70,6 +73,7 @@ for editing such pictures. | |||
| 70 | * Case:: Changing the case of text. | 73 | * Case:: Changing the case of text. |
| 71 | * Text Mode:: The major modes for editing text files. | 74 | * Text Mode:: The major modes for editing text files. |
| 72 | * Outline Mode:: Editing outlines. | 75 | * Outline Mode:: Editing outlines. |
| 76 | * Org Mode:: The Emacs organizer. | ||
| 73 | * TeX Mode:: Editing input to the formatter TeX. | 77 | * TeX Mode:: Editing input to the formatter TeX. |
| 74 | * HTML Mode:: Editing HTML and SGML files. | 78 | * HTML Mode:: Editing HTML and SGML files. |
| 75 | * Nroff Mode:: Editing input to the formatter nroff. | 79 | * Nroff Mode:: Editing input to the formatter nroff. |
| @@ -1250,6 +1254,143 @@ automatically by putting this in your init file (@pxref{Init File}): | |||
| 1250 | (eval-after-load "outline" '(require 'foldout)) | 1254 | (eval-after-load "outline" '(require 'foldout)) |
| 1251 | @end example | 1255 | @end example |
| 1252 | 1256 | ||
| 1257 | @node Org Mode | ||
| 1258 | @section Org Mode | ||
| 1259 | @kindex TAB @r{(Org Mode)} | ||
| 1260 | @kindex S-TAB @r{(Org Mode)} | ||
| 1261 | @cindex organizer | ||
| 1262 | @cindex planner | ||
| 1263 | @findex org-mode | ||
| 1264 | @cindex fold | ||
| 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 | |||
| 1278 | When editing a file ending with the @file{.org} extension, Emacs | ||
| 1279 | automatically uses @code{org-mode} as the major mode. In this mode, | ||
| 1280 | headlines start with one (or more) leading star(s) and comments start | ||
| 1281 | with the @code{#} character at the beginning of a line. | ||
| 1282 | |||
| 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 | |||
| 1290 | # Some comment here. | ||
| 1291 | @end example | ||
| 1292 | |||
| 1293 | From here, you can use Org mode as a simple outliner: @key{TAB} on a | ||
| 1294 | headline will cycle through the various folding states of a subtree, | ||
| 1295 | and @key{S-TAB} anywhere in the buffer will (un)fold the whole | ||
| 1296 | structure. | ||
| 1297 | |||
| 1298 | You can also manipulate the structure of your document by moving a | ||
| 1299 | headline up and down with @key{M-<up>} and @key{M-<down>}, or by | ||
| 1300 | promoting and demoting a headline with @key{M-<left>} and | ||
| 1301 | @key{M-<left>}. If you want to act on the whole subtree (i.e. the | ||
| 1302 | headline and its content, including other headlines), simply add the | ||
| 1303 | @kbd{Shift} key and use @key{S-M-<up>}, @key{S-M-<down>}, | ||
| 1304 | @key{S-M-<left>} and @key{S-M-<right>}. | ||
| 1305 | |||
| 1306 | For further details, see @ref{Document Structure,,,org, The Org Manual}. | ||
| 1307 | |||
| 1308 | @menu | ||
| 1309 | * Org as an organizer:: Manage TODO lists and agendas | ||
| 1310 | * Org as an authoring system:: Export to various formats | ||
| 1311 | @end menu | ||
| 1312 | |||
| 1313 | @node Org as an organizer | ||
| 1314 | @subsection Org as an organizer | ||
| 1315 | |||
| 1316 | @cindex TODO keywords | ||
| 1317 | @kindex C-c C-t @r{(Org Mode)} | ||
| 1318 | @kindex C-c C-s @r{(Org Mode)} | ||
| 1319 | @kindex C-c C-d @r{(Org Mode)} | ||
| 1320 | @vindex org-todo-keywords | ||
| 1321 | @findex org-todo | ||
| 1322 | @findex org-agenda | ||
| 1323 | @cindex scheduled | ||
| 1324 | @cindex deadline | ||
| 1325 | @cindex agenda | ||
| 1326 | |||
| 1327 | Each headline can be turned into a TODO item calling @code{org-todo} | ||
| 1328 | with @key{C-c C-t} anywhere on it. This will add the TODO keyword | ||
| 1329 | @code{TODO}. Hit @key{C-c C-t} to cycle through the list of available | ||
| 1330 | TODO keywords: you can configure the variable @code{org-todo-keywords} | ||
| 1331 | to use your own list of keywords. | ||
| 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 | ||
| 1350 | @cindex export | ||
| 1351 | @findex org-export | ||
| 1352 | @cindex publish | ||
| 1353 | @cindex code block | ||
| 1354 | @cindex quote | ||
| 1355 | |||
| 1356 | You may want to format your Org notes nicely and to prepare them for | ||
| 1357 | export and publication. Org supports simple text formatting: | ||
| 1358 | |||
| 1359 | @example | ||
| 1360 | - This text is /emphasized/ | ||
| 1361 | - This item uses *a bold font* | ||
| 1362 | - This text is _underlined_ | ||
| 1363 | - 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 | |||
| 1369 | @example | ||
| 1370 | #+begin_quote | ||
| 1371 | ``This is a quote.'' | ||
| 1372 | #+end_quote | ||
| 1373 | |||
| 1374 | #+begin_example | ||
| 1375 | This is an example. | ||
| 1376 | #+end_example | ||
| 1377 | @end example | ||
| 1378 | |||
| 1379 | These environments will be displayed in a specific way with respect | ||
| 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}. | ||
| 1393 | |||
| 1253 | @node TeX Mode | 1394 | @node TeX Mode |
| 1254 | @section @TeX{} Mode | 1395 | @section @TeX{} Mode |
| 1255 | @cindex @TeX{} mode | 1396 | @cindex @TeX{} mode |