diff options
| author | Carsten Dominik | 2006-02-22 07:14:18 +0000 |
|---|---|---|
| committer | Carsten Dominik | 2006-02-22 07:14:18 +0000 |
| commit | 6bae0337cc443d3216e947271fccb1ecf7e41ed3 (patch) | |
| tree | 4eb2172e6e71ff83b35aca78582255b78e0e76ae | |
| parent | 2e2055128f3c78ad5d4de9ff32b0b3b51e84c792 (diff) | |
| download | emacs-6bae0337cc443d3216e947271fccb1ecf7e41ed3.tar.gz emacs-6bae0337cc443d3216e947271fccb1ecf7e41ed3.zip | |
* org.texi (Internal Links): Rewritten to cover the modified
linking system.
| -rw-r--r-- | man/org.texi | 158 |
1 files changed, 106 insertions, 52 deletions
diff --git a/man/org.texi b/man/org.texi index cf0881ff3ff..a93de06235e 100644 --- a/man/org.texi +++ b/man/org.texi | |||
| @@ -4,8 +4,8 @@ | |||
| 4 | @setfilename ../info/org | 4 | @setfilename ../info/org |
| 5 | @settitle Org Mode Manual | 5 | @settitle Org Mode Manual |
| 6 | 6 | ||
| 7 | @set VERSION 4.04 | 7 | @set VERSION 4.05 |
| 8 | @set DATE January 2006 | 8 | @set DATE February 2006 |
| 9 | 9 | ||
| 10 | @dircategory Emacs | 10 | @dircategory Emacs |
| 11 | @direntry | 11 | @direntry |
| @@ -35,7 +35,7 @@ | |||
| 35 | @copying | 35 | @copying |
| 36 | This manual is for Org-mode (version @value{VERSION}). | 36 | This manual is for Org-mode (version @value{VERSION}). |
| 37 | 37 | ||
| 38 | Copyright @copyright{} 2004, 2005, 2006 Free Software Foundation, Inc. | 38 | Copyright @copyright{} 2004, 2005, 2006 Free Software Foundation |
| 39 | 39 | ||
| 40 | @quotation | 40 | @quotation |
| 41 | Permission is granted to copy, distribute and/or modify this document | 41 | Permission is granted to copy, distribute and/or modify this document |
| @@ -126,12 +126,17 @@ Calculations in tables | |||
| 126 | 126 | ||
| 127 | Hyperlinks | 127 | Hyperlinks |
| 128 | 128 | ||
| 129 | * Internal Links:: CamelCaseWords as internal links | 129 | * Internal Links:: Links to other places in the current file |
| 130 | * External Links:: URL-like links to the world | 130 | * External Links:: URL-like links to the world |
| 131 | * Managing links:: Creating, inserting and following | 131 | * Managing links:: Creating, inserting and following |
| 132 | * Search Options:: Linking to a specific location | 132 | * Search Options:: Linking to a specific location |
| 133 | * Remember:: Org-trees store quick notes | 133 | * Remember:: Org-trees store quick notes |
| 134 | 134 | ||
| 135 | Internal Links | ||
| 136 | |||
| 137 | * Radio targets:: Make targets trigger links in plain text. | ||
| 138 | * CamelCase links:: Activating CamelCase words as links | ||
| 139 | |||
| 135 | TODO items | 140 | TODO items |
| 136 | 141 | ||
| 137 | * TODO basics:: Marking and displaying TODO entries | 142 | * TODO basics:: Marking and displaying TODO entries |
| @@ -155,12 +160,12 @@ Agenda Views | |||
| 155 | * Agenda files:: Files being searched for agenda information | 160 | * Agenda files:: Files being searched for agenda information |
| 156 | * Agenda dispatcher:: Keyboard access to agenda views | 161 | * Agenda dispatcher:: Keyboard access to agenda views |
| 157 | * Weekly/Daily Agenda:: The calendar page with current tasks | 162 | * Weekly/Daily Agenda:: The calendar page with current tasks |
| 158 | * Global TODO list:: All infinished action items | 163 | * Global TODO list:: All unfinished action items |
| 159 | * Matching headline tags:: Structured information with fine-tuned search | 164 | * Matching headline tags:: Structured information with fine-tuned search |
| 160 | * Timeline:: Time-sorted view for single file | 165 | * Timeline:: Time-sorted view for single file |
| 161 | * Agenda commands:: Remote editing of org trees | 166 | * Agenda commands:: Remote editing of org trees |
| 162 | 167 | ||
| 163 | Weekly/Daily Agenda | 168 | The weekly/daily agenda |
| 164 | 169 | ||
| 165 | * Categories:: Not all tasks are equal | 170 | * Categories:: Not all tasks are equal |
| 166 | * Time-of-day specifications:: How the agenda knows the time | 171 | * Time-of-day specifications:: How the agenda knows the time |
| @@ -1314,7 +1319,8 @@ example in mail mode, use | |||
| 1314 | 1319 | ||
| 1315 | Complex ASCII tables with automatic line wrapping, column- and | 1320 | Complex ASCII tables with automatic line wrapping, column- and |
| 1316 | row-spanning, and alignment can be created using the Emacs table | 1321 | row-spanning, and alignment can be created using the Emacs table |
| 1317 | package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}). | 1322 | package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, |
| 1323 | and also part of Emacs 22). | ||
| 1318 | When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode | 1324 | When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode |
| 1319 | will call @command{table-recognize-table} and move the cursor into the | 1325 | will call @command{table-recognize-table} and move the cursor into the |
| 1320 | table. Inside a table, the keymap of Org-mode is inactive. In order | 1326 | table. Inside a table, the keymap of Org-mode is inactive. In order |
| @@ -1343,7 +1349,7 @@ Just like HMTL, Org-mode provides links inside a file, and external | |||
| 1343 | links to other files, Usenet articles, emails and much more. | 1349 | links to other files, Usenet articles, emails and much more. |
| 1344 | 1350 | ||
| 1345 | @menu | 1351 | @menu |
| 1346 | * Internal Links:: CamelCaseWords as internal links | 1352 | * Internal Links:: Links to other places in the current file |
| 1347 | * External Links:: URL-like links to the world | 1353 | * External Links:: URL-like links to the world |
| 1348 | * Managing links:: Creating, inserting and following | 1354 | * Managing links:: Creating, inserting and following |
| 1349 | * Search Options:: Linking to a specific location | 1355 | * Search Options:: Linking to a specific location |
| @@ -1356,44 +1362,73 @@ links to other files, Usenet articles, emails and much more. | |||
| 1356 | @cindex links, internal | 1362 | @cindex links, internal |
| 1357 | @cindex CamelCase links | 1363 | @cindex CamelCase links |
| 1358 | 1364 | ||
| 1359 | Similar to Wiki implementations, Org-mode interprets words spelled in | 1365 | Strings inside double brackets like @samp{[[My Target]]} are links |
| 1360 | CamelCase (i.e. mixed case with at least one capital letter following | 1366 | that lead to a text search in the current file. The link can be |
| 1361 | on a small letter inside the word) as links. While in Wiki these | 1367 | followed with @kbd{C-c C-o} or with a mouse click (@pxref{Managing |
| 1362 | links usually point to another file, in Org-mode they point to a | 1368 | links}). The preferred match for such a link is a dedicated target: |
| 1363 | target in the current file. Targets are CamelCased words in double | 1369 | The same string in double angular brackets. Targets may be located |
| 1364 | angular brackets, and may be located anywhere, also in a comment line. | 1370 | anywhere, often it is convenient to put them into a comment line, for |
| 1365 | For example | 1371 | example |
| 1366 | @example | 1372 | @example |
| 1367 | # <<MyTarget>> | 1373 | # <<My Target>> |
| 1368 | @end example | 1374 | @end example |
| 1369 | 1375 | ||
| 1370 | Each occurrence of @samp{MyTarget} in the file is an active link that | 1376 | If no dedicated target exists, Org-mode will search for the words in |
| 1371 | can be followed with @kbd{C-c C-o} or with a mouse click | 1377 | the link, in the above example for @samp{my target}. Links starting |
| 1372 | (@pxref{Managing links}). If no dedicated target exists, org-mode will | 1378 | with a star like @samp{*My Target} restrict the search to headlines. |
| 1373 | search for the words in the link separated by white space, in the | 1379 | When searching, Org-mode will first try an exact match, but then move |
| 1374 | above example for @samp{my target}. If the link starts with a star | 1380 | on to more and more lenient searches. For example, the link |
| 1375 | like @samp{*MyTarget}, the search is restricted to headlines. | 1381 | @samp{[[*My Targets]]} will find any of the following |
| 1376 | Org-mode will first try an exact match of a full headline, but then | ||
| 1377 | move on to more and more lenient searches. The link @samp{*MyTargets} | ||
| 1378 | will find any of the following | ||
| 1379 | @example | 1382 | @example |
| 1380 | ** My targets | 1383 | ** My targets |
| 1381 | ** TODO my targets are bright | 1384 | ** TODO my targets are bright |
| 1382 | ** my 20 targets are | 1385 | ** my 20 targets are |
| 1383 | @end example | 1386 | @end example |
| 1387 | It is therefore often not necessary to set a dedicated target. To | ||
| 1388 | insert a link targeting a headline, in-buffer completion can be used. | ||
| 1389 | Just type a star followed by a few optional letters into the buffer | ||
| 1390 | and press @kbd{M-@key{TAB}}. All headlines in the current buffer will | ||
| 1391 | be offered as completions. @xref{Managing links}, for more commands | ||
| 1392 | creating links. | ||
| 1393 | |||
| 1394 | Following a link pushes a mark onto Org-mode's own mark ring. You can | ||
| 1395 | return to the previous position with @kbd{C-c &}. Using this command | ||
| 1396 | several times in direct succession goes back to positions recorded | ||
| 1397 | earlier. | ||
| 1398 | |||
| 1399 | @menu | ||
| 1400 | * Radio targets:: Make targets trigger links in plain text. | ||
| 1401 | * CamelCase links:: Activating CamelCase words as links | ||
| 1402 | @end menu | ||
| 1403 | |||
| 1404 | @node Radio targets, CamelCase links, Internal Links, Internal Links | ||
| 1405 | @subsection Radio targets | ||
| 1406 | |||
| 1407 | You can configure Org-mode to link any occurrences of certain target | ||
| 1408 | names in normal text. So without explicitly creating a link, the text | ||
| 1409 | connects to the target radioing its position. Radio targets are | ||
| 1410 | enclosed by triple angular brackets. For example, a target | ||
| 1411 | @samp{<<<My Target>>>} causes each occurrence of @samp{my target} in | ||
| 1412 | normal text to become activated as a link. The Org-mode file is | ||
| 1413 | scanned automatically for radio targets only when the file is first | ||
| 1414 | loaded into Emacs. To update the target list during editing, press | ||
| 1415 | @kbd{C-c C-c} with the cursor on or at a target. | ||
| 1416 | |||
| 1417 | @node CamelCase links, , Radio targets, Internal Links | ||
| 1418 | @subsection CamelCase words as links | ||
| 1384 | @cindex completion, of CamelCase links | 1419 | @cindex completion, of CamelCase links |
| 1385 | @cindex CamelCase links, completion of | 1420 | @cindex CamelCase links, completion of |
| 1386 | It is therefore often not even necessary to set a dedicated target. | 1421 | |
| 1387 | The link will automatically find a target. If you want to see what | 1422 | As an alternative to @samp{[[...]]} links, Org-mode also supports |
| 1388 | lines in the current buffer are matched by a given CamelCase link, | 1423 | CamelCase words as links. This feature is not turned on by default |
| 1389 | open the link with @kbd{C-u C-c C-o}. Even if there are several | 1424 | because of the occasional inconsistencies this system suffers from. |
| 1390 | matches, org-mode will usually find the right one since it tries | 1425 | To activate CamelCase words as links, and to make headline completion |
| 1391 | targets and exact matches first. To insert links targeting a | 1426 | offer CamelCase version of headlines, the following customization is |
| 1392 | headline, in-buffer completion can be used. Just type a star followed | 1427 | needed: |
| 1393 | by a few optional letters into the buffer and press @kbd{M-@key{TAB}}. | 1428 | @lisp |
| 1394 | CamelCased versions of all headlines in the current buffer will be | 1429 | (setq org-activate-camels t |
| 1395 | offered as completions. @xref{Managing links}, for more commands | 1430 | org-file-link-context-use-camel-case t) |
| 1396 | creating links. | 1431 | @end lisp |
| 1397 | 1432 | ||
| 1398 | @node External Links, Managing links, Internal Links, Hyperlinks | 1433 | @node External Links, Managing links, Internal Links, Hyperlinks |
| 1399 | @section External Links | 1434 | @section External Links |
| @@ -1407,6 +1442,7 @@ creating links. | |||
| 1407 | @cindex VM links | 1442 | @cindex VM links |
| 1408 | @cindex RMAIL links | 1443 | @cindex RMAIL links |
| 1409 | @cindex WANDERLUST links | 1444 | @cindex WANDERLUST links |
| 1445 | @cindex MH-E links | ||
| 1410 | @cindex USENET links | 1446 | @cindex USENET links |
| 1411 | @cindex SHELL links | 1447 | @cindex SHELL links |
| 1412 | 1448 | ||
| @@ -1426,6 +1462,8 @@ shows examples for each link type. | |||
| 1426 | <vm://myself@@some.where.org/folder#id> @r{VM on remote machine} | 1462 | <vm://myself@@some.where.org/folder#id> @r{VM on remote machine} |
| 1427 | <wl:folder> @r{WANDERLUST folder link} | 1463 | <wl:folder> @r{WANDERLUST folder link} |
| 1428 | <wl:folder#id> @r{WANDERLUST message link} | 1464 | <wl:folder#id> @r{WANDERLUST message link} |
| 1465 | <mhe:folder> @r{MH-E folder link} | ||
| 1466 | <mhe:folder#id> @r{MH-E message link} | ||
| 1429 | <rmail:folder> @r{RMAIL folder link} | 1467 | <rmail:folder> @r{RMAIL folder link} |
| 1430 | <rmail:folder#id> @r{RMAIL message link} | 1468 | <rmail:folder#id> @r{RMAIL message link} |
| 1431 | <gnus:group> @r{GNUS group link} | 1469 | <gnus:group> @r{GNUS group link} |
| @@ -1458,7 +1496,7 @@ VM, RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will point to | |||
| 1458 | the current article/entry. For W3 and W3M buffer, the link goes to | 1496 | the current article/entry. For W3 and W3M buffer, the link goes to |
| 1459 | the current URL. For Org-mode files, the current headline is | 1497 | the current URL. For Org-mode files, the current headline is |
| 1460 | targeted. For any other files, the link will point to the file, with | 1498 | targeted. For any other files, the link will point to the file, with |
| 1461 | a CamelCase (@pxref{Search Options}) search string pointing to the | 1499 | a search string (@pxref{Search Options}) pointing to the |
| 1462 | contents of the current line. If there is an active region, the | 1500 | contents of the current line. If there is an active region, the |
| 1463 | selected words will form the basis of the search string. The key | 1501 | selected words will form the basis of the search string. The key |
| 1464 | binding @kbd{C-c l} is only a suggestion - see @ref{Installation and | 1502 | binding @kbd{C-c l} is only a suggestion - see @ref{Installation and |
| @@ -1510,6 +1548,20 @@ On links, @kbd{mouse-2} will open the link just like @kbd{C-c C-o} would. | |||
| 1510 | @kindex mouse-3 | 1548 | @kindex mouse-3 |
| 1511 | @item mouse-3 | 1549 | @item mouse-3 |
| 1512 | Like @kbd{mouse-2}, but force file links to be opened with Emacs. | 1550 | Like @kbd{mouse-2}, but force file links to be opened with Emacs. |
| 1551 | |||
| 1552 | @cindex mark ring | ||
| 1553 | @kindex C-c % | ||
| 1554 | @item C-c % | ||
| 1555 | Push the current position onto the mark ring, to be able to return | ||
| 1556 | easily. Commands following an internal link do this automatically. | ||
| 1557 | |||
| 1558 | @cindex links, returning to | ||
| 1559 | @kindex C-c & | ||
| 1560 | @item C-c & | ||
| 1561 | Jump back to a recorded position. A position is recorded by the | ||
| 1562 | commands following internal links, and by @kbd{C-c %}. Using this | ||
| 1563 | command several times in direct succession moves through a ring of | ||
| 1564 | previously recorded positions. | ||
| 1513 | @end table | 1565 | @end table |
| 1514 | 1566 | ||
| 1515 | 1567 | ||
| @@ -1525,8 +1577,8 @@ compatibility, line numbers can also follow a single colon.} colon. | |||
| 1525 | For example: | 1577 | For example: |
| 1526 | @example | 1578 | @example |
| 1527 | <file:~/code/main.c::255> | 1579 | <file:~/code/main.c::255> |
| 1528 | <file:~/xx.org::MyTarget> | 1580 | <file:~/xx.org::My Target> |
| 1529 | <file:~/xx.org::find me> | 1581 | <file:~/xx.org::*My Target> |
| 1530 | <file:~/xx.org::/regexp/> | 1582 | <file:~/xx.org::/regexp/> |
| 1531 | @end example | 1583 | @end example |
| 1532 | @noindent Here is what these options do. | 1584 | @noindent Here is what these options do. |
| @@ -1534,12 +1586,12 @@ For example: | |||
| 1534 | @table @code | 1586 | @table @code |
| 1535 | @item 255 | 1587 | @item 255 |
| 1536 | Jump to line 255. | 1588 | Jump to line 255. |
| 1537 | @item MyGoal | 1589 | @item My Target |
| 1538 | Search for a link target with name MyGoal, or do a text search for | 1590 | Search for a link target @samp{<<My Target>>}, or do a text search for |
| 1539 | @samp{my target}, similar to the CamelCase search in internal links, | 1591 | @samp{my target}, similar to the search in internal links, see |
| 1540 | see @ref{Internal Links}. | 1592 | @ref{Internal Links}. |
| 1541 | @item find me | 1593 | @item *My Target |
| 1542 | Do a normal text search for the text @samp{find me}. | 1594 | In an Org-mode file, restrict search to headlines. |
| 1543 | @item /regexp/ | 1595 | @item /regexp/ |
| 1544 | Do a regular expression search for @code{regexp}. This uses the Emacs | 1596 | Do a regular expression search for @code{regexp}. This uses the Emacs |
| 1545 | command @code{occur} to list all matches in a separate window. If the | 1597 | command @code{occur} to list all matches in a separate window. If the |
| @@ -1549,10 +1601,10 @@ sparse tree with the matches. | |||
| 1549 | @c @code{grep} will be used to search all files in the directory. | 1601 | @c @code{grep} will be used to search all files in the directory. |
| 1550 | @end table | 1602 | @end table |
| 1551 | 1603 | ||
| 1552 | To use the search options also for a search in the current file, a | 1604 | As a degenerate case, a file link with an empty file name can be used |
| 1553 | file link with an empty file name can be used. For example, | 1605 | to search the current file. For example, @code{<file:::find me>} does |
| 1554 | @code{<file:::find me>} does a search for @samp{find me} in the | 1606 | a search for @samp{find me} in the current file, just like |
| 1555 | current file. | 1607 | @samp{[[find me]]} would. |
| 1556 | 1608 | ||
| 1557 | @node Remember, , Search Options, Hyperlinks | 1609 | @node Remember, , Search Options, Hyperlinks |
| 1558 | @section Remember | 1610 | @section Remember |
| @@ -3248,6 +3300,8 @@ Org-mode would not be what it is without your input. | |||
| 3248 | 3300 | ||
| 3249 | @itemize @bullet | 3301 | @itemize @bullet |
| 3250 | @item | 3302 | @item |
| 3303 | Thomas Baumann contributed the code for links to the MH-E email system. | ||
| 3304 | @item | ||
| 3251 | Pavel Chalmoviansky reported bugs and suggested improvements | 3305 | Pavel Chalmoviansky reported bugs and suggested improvements |
| 3252 | related to the agenda treatment of items with specified time. | 3306 | related to the agenda treatment of items with specified time. |
| 3253 | @item | 3307 | @item |
| @@ -3267,7 +3321,7 @@ Emacs-Lisp compiler happy. | |||
| 3267 | Tim O'Callaghan suggested in-file links, search options for | 3321 | Tim O'Callaghan suggested in-file links, search options for |
| 3268 | general file links, and TAGS. | 3322 | general file links, and TAGS. |
| 3269 | @item | 3323 | @item |
| 3270 | Oliver Oppitz made useful suggestions. | 3324 | Oliver Oppitz suggested multi-state TODO items. |
| 3271 | @item | 3325 | @item |
| 3272 | Pete Phillips helped the development of the TAGS feature with beta | 3326 | Pete Phillips helped the development of the TAGS feature with beta |
| 3273 | testing and suggestions. | 3327 | testing and suggestions. |
| @@ -3289,8 +3343,8 @@ Linking to VM/BBDB/GNUS was inspired by Tom Shannon's | |||
| 3289 | Juergen Vollmer contributed code generating the table of contents | 3343 | Juergen Vollmer contributed code generating the table of contents |
| 3290 | in HTML output, and other export improvements. | 3344 | in HTML output, and other export improvements. |
| 3291 | @item | 3345 | @item |
| 3292 | David Wainberg suggested to implement an archiving mechanism and helped | 3346 | David Wainberg suggested the archiving mechanism and shaped the |
| 3293 | testing. | 3347 | internal link system with many suggestions and ideas. |
| 3294 | @item | 3348 | @item |
| 3295 | Scheduling TODO items was inspired by John Wiegley's @file{planner.el}. | 3349 | Scheduling TODO items was inspired by John Wiegley's @file{planner.el}. |
| 3296 | @item | 3350 | @item |