* keys and command name info
@ 2010-07-28 19:36 Andreas Röhler
2010-07-29 6:45 ` Tassilo Horn
` (2 more replies)
0 siblings, 3 replies; 44+ messages in thread
From: Andreas Röhler @ 2010-07-28 19:36 UTC (permalink / raw)
To: emacs-orgmode
Hi,
what about delivering mnemonic command names alongside
with its keys in org-info?
For example
8.1. Agenda files
[ ... ]
`C-c ['
Add current file to the list of agenda files. The file is added to
the front of the list. If it was already in the list, it is moved
to the front. With prefix arg, file is added/moved to the end.
might be provided as
8.1. Agenda files
[ ... ]
`C-c [', org-agenda-file-to-front
Add current file to the list of agenda files. The file is added to
the front of the list. If it was already in the list, it is moved
to the front. With prefix arg, file is added/moved to the end.
IMHO it's useful for emacs-beginners, but for hackers
too, as remembering function names may precede
remembering keys - which are to change individually
anyway.
Should you be interested, I'll consider to take action
with texi-files.
Andreas
--
https://code.launchpad.net/~a-roehler/python-mode
https://code.launchpad.net/s-x-emacs-werkstatt/
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-07-28 19:36 keys and command name info Andreas Röhler
@ 2010-07-29 6:45 ` Tassilo Horn
2010-07-29 13:47 ` Andreas Röhler
2010-08-02 6:32 ` Carsten Dominik
2010-08-20 11:20 ` keys and command name info Carsten Dominik
2 siblings, 1 reply; 44+ messages in thread
From: Tassilo Horn @ 2010-07-29 6:45 UTC (permalink / raw)
To: emacs-orgmode
Andreas Röhler <andreas.roehler@easy-emacs.de> writes:
Hi Andreas,
> what about delivering mnemonic command names alongside with its keys
> in org-info?
That would be good practice, and I think it's more or less standard for
emacs packages. For example, that is from Gnus:
,----[ (info "(gnus)Summary Post Commands") ]
| `S p'
| `a'
| Prepare for posting an article (`gnus-summary-post-news'). By
| default, post to the current group. If given a prefix, disable
| that. If the prefix is 1, prompt for another group instead.
|
| `S f'
| `f'
| Post a followup to the current article (`gnus-summary-followup').
`----
> 8.1. Agenda files
>
> [ ... ]
> `C-c ['
> Add current file to the list of agenda files. The file is added to
> the front of the list. If it was already in the list, it is moved
> to the front. With prefix arg, file is added/moved to the end.
>
> might be provided as
>
> 8.1. Agenda files
>
> [ ... ]
> `C-c [', org-agenda-file-to-front
> Add current file to the list of agenda files. The file is added to
> the front of the list. If it was already in the list, it is moved
> to the front. With prefix arg, file is added/moved to the end.
I'd write it in parens with the usual function markup at the end of the
first sentence, just like it's done in Gnus. The 2 Gnus entries above
have this definition:
--8<---------------cut here---------------start------------->8---
@table @kbd
@item S p
@itemx a
@kindex a (Summary)
@kindex S p (Summary)
@findex gnus-summary-post-news
@c @icon{gnus-summary-post-news}
Prepare for posting an article (@code{gnus-summary-post-news}). By
default, post to the current group. If given a prefix, disable that.
If the prefix is 1, prompt for another group instead.
@item S f
@itemx f
@kindex f (Summary)
@kindex S f (Summary)
@findex gnus-summary-followup
@c @icon{gnus-summary-followup}
Post a followup to the current article (@code{gnus-summary-followup}).
--8<---------------cut here---------------end--------------->8---
So basically, you only have to add the command name with @code{} at the
appropriate place and add an index item to the function index with
@findex{}.
> IMHO it's useful for emacs-beginners, but for hackers too, as
> remembering function names may precede remembering keys - which are to
> change individually anyway.
Exactly, and using `C-h f' you can easily switch to *Help* to lookup the
exact docstring and signature. And from *Help*, the function definition
is only one click away.
> Should you be interested, I'll consider to take action with
> texi-files.
I'd welcome such an enhancement to the docs, and I'm pretty sure nobody
will object. :-)
Bye,
Tassilo
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-07-29 6:45 ` Tassilo Horn
@ 2010-07-29 13:47 ` Andreas Röhler
2010-07-29 15:19 ` Andreas Röhler
2010-07-31 8:53 ` Bastien
0 siblings, 2 replies; 44+ messages in thread
From: Andreas Röhler @ 2010-07-29 13:47 UTC (permalink / raw)
To: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 3083 bytes --]
Am 29.07.2010 08:45, schrieb Tassilo Horn:
> Andreas Röhler<andreas.roehler@easy-emacs.de> writes:
>
> Hi Andreas,
>
>> what about delivering mnemonic command names alongside with its keys
>> in org-info?
>
> That would be good practice, and I think it's more or less standard for
> emacs packages. For example, that is from Gnus:
>
> ,----[ (info "(gnus)Summary Post Commands") ]
> | `S p'
> | `a'
> | Prepare for posting an article (`gnus-summary-post-news'). By
> | default, post to the current group. If given a prefix, disable
> | that. If the prefix is 1, prompt for another group instead.
> |
> | `S f'
> | `f'
> | Post a followup to the current article (`gnus-summary-followup').
> `----
>
>> 8.1. Agenda files
>>
>> [ ... ]
>> `C-c ['
>> Add current file to the list of agenda files. The file is added to
>> the front of the list. If it was already in the list, it is moved
>> to the front. With prefix arg, file is added/moved to the end.
>>
>> might be provided as
>>
>> 8.1. Agenda files
>>
>> [ ... ]
>> `C-c [', org-agenda-file-to-front
>> Add current file to the list of agenda files. The file is added to
>> the front of the list. If it was already in the list, it is moved
>> to the front. With prefix arg, file is added/moved to the end.
>
> I'd write it in parens with the usual function markup at the end of the
> first sentence, just like it's done in Gnus. The 2 Gnus entries above
> have this definition:
>
> --8<---------------cut here---------------start------------->8---
> @table @kbd
> @item S p
> @itemx a
> @kindex a (Summary)
> @kindex S p (Summary)
> @findex gnus-summary-post-news
> @c @icon{gnus-summary-post-news}
> Prepare for posting an article (@code{gnus-summary-post-news}). By
> default, post to the current group. If given a prefix, disable that.
> If the prefix is 1, prompt for another group instead.
>
> @item S f
> @itemx f
> @kindex f (Summary)
> @kindex S f (Summary)
> @findex gnus-summary-followup
> @c @icon{gnus-summary-followup}
> Post a followup to the current article (@code{gnus-summary-followup}).
> --8<---------------cut here---------------end--------------->8---
>
> So basically, you only have to add the command name with @code{} at the
> appropriate place and add an index item to the function index with
> @findex{}.
>
>> IMHO it's useful for emacs-beginners, but for hackers too, as
>> remembering function names may precede remembering keys - which are to
>> change individually anyway.
>
> Exactly, and using `C-h f' you can easily switch to *Help* to lookup the
> exact docstring and signature. And from *Help*, the function definition
> is only one click away.
>
>> Should you be interested, I'll consider to take action with
>> texi-files.
>
> I'd welcome such an enhancement to the docs, and I'm pretty sure nobody
> will object. :-)
>
> Bye,
> Tassilo
>
Fine.
Attached a patch against latest org-texi, starting that kind of work.
Please not I signed the FSF-disclaimer but not the paper transferring
copyright under US-law.
Andreas
[-- Attachment #2: org-texi.patch --]
[-- Type: text/x-patch, Size: 36752 bytes --]
diff --git a/doc/org.texi b/doc/org.texi
index 38fd4b9..1928419 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -928,7 +928,7 @@ tables, @kbd{S-@key{TAB}} jumps to the previous field.
@item C-u C-u C-u @key{TAB}
Show all, including drawers.
@kindex C-c C-r
-@item C-c C-r
+@item C-c C-r, (@code{org-reveal})
Reveal context around point, showing the current entry, the following heading
and the hierarchy above. Useful for working near a location that has been
exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
@@ -936,10 +936,10 @@ exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
level, all sibling headings. With double prefix arg, also show the entire
subtree of the parent.
@kindex C-c C-k
-@item C-c C-k
+@item C-c C-k, (@code{org-kill-note-or-show-branches})
Expose all the headings of the subtree, CONTENT view for just one subtree.
@kindex C-c C-x b
-@item C-c C-x b
+@item C-c C-x b, (@code{org-tree-to-indirect-buffer})
Show the current subtree in an indirect buffer@footnote{The indirect
buffer
@ifinfo
@@ -1004,16 +1004,16 @@ Next heading.
@item C-c C-p
Previous heading.
@kindex C-c C-f
-@item C-c C-f
+@item C-c C-f, (@code{org-forward-same-level})
Next heading same level.
@kindex C-c C-b
-@item C-c C-b
+@item C-c C-b, (@code{org-backward-same-level})
Previous heading same level.
@kindex C-c C-u
@item C-c C-u
Backward to higher level heading.
@kindex C-c C-j
-@item C-c C-j
+@item C-c C-j, (@code{org-goto})
Jump to a different place without changing the current outline
visibility. Shows the document structure in a temporary buffer, where
you can use the following keys to find your destination:
@@ -1106,15 +1106,15 @@ level).
@item M-S-@key{down}
Move subtree down (swap with next subtree of same level).
@kindex C-c C-x C-w
-@item C-c C-x C-w
+@item C-c C-x C-w, (@code{org-cut-special})
Kill subtree, i.e. remove it from buffer but save in kill ring.
With a numeric prefix argument N, kill N sequential subtrees.
@kindex C-c C-x M-w
-@item C-c C-x M-w
+@item C-c C-x M-w, (@code{org-copy-special})
Copy subtree to kill ring. With a numeric prefix argument N, copy the N
sequential subtrees.
@kindex C-c C-x C-y
-@item C-c C-x C-y
+@item C-c C-x C-y, (@code{org-paste-special})
Yank subtree from kill ring. This does modify the level of the subtree to
make sure the tree fits in nicely at the yank position. The yank level can
also be specified with a numeric prefix argument, or by yanking after a
@@ -1134,7 +1134,7 @@ force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
yank, it will yank previous kill items plainly, without adjustment and
folding.
@kindex C-c C-x c
-@item C-c C-x c
+@item C-c C-x c, (@code{org-clone-subtree-with-time-shift})
Clone a subtree by making a number of sibling copies of it. You will be
prompted for the number of copies to make, and you can also specify if any
timestamps in the entry should be shifted. This can be useful, for example,
@@ -1142,10 +1142,10 @@ to create a number of tasks related to a series of lectures to prepare. For
more details, see the docstring of the command
@code{org-clone-subtree-with-time-shift}.
@kindex C-c C-w
-@item C-c C-w
+@item C-c C-w, (@code{org-refile})
Refile entry or region to a different location. @xref{Refiling notes}.
@kindex C-c ^
-@item C-c ^
+@item C-c ^, (@code{org-sort})
Sort same-level entries. When there is an active region, all entries in the
region will be sorted. Otherwise the children of the current headline are
sorted. The command prompts for the sorting method, which can be
@@ -1163,7 +1163,7 @@ Narrow buffer to current subtree.
@item C-x n w
Widen buffer to remove narrowing.
@kindex C-c *
-@item C-c *
+@item C-c *, (@code{org-ctrl-c-star})
Turn a normal line or plain list item into a headline (so that it becomes a
subheading at its location). Also turn a headline into a normal line by
removing the stars. If there is an active region, turn all lines in the
@@ -1209,7 +1209,7 @@ commands can be accessed through a dispatcher:
@table @kbd
@kindex C-c /
-@item C-c /
+@item C-c /, (@code{org-sparse-tree})
This prompts for an extra key to select a sparse-tree creating command.
@kindex C-c / r
@item C-c / r
@@ -1401,13 +1401,13 @@ the initially selected region is used, even if the new indentation
would imply a different hierarchy. To use the new hierarchy, break
the command chain with a cursor motion or so.
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
state of the checkbox. If not, this command makes sure that all the
items on this list level use the same bullet. Furthermore, if this is
an ordered list, make sure the numbering is OK.
@kindex C-c -
-@item C-c -
+@item C-c -, (@code{org-ctrl-c-minus})
Cycle the entire list level through the different itemize/enumerate bullets
(@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
argument N, select the Nth bullet from this list. If there is an active
@@ -1416,7 +1416,7 @@ first line already was a list item, any item markers will be removed from the
list. Finally, even without an active region, a normal line will be
converted into a list item.
@kindex C-c *
-@item C-c *
+@item C-c *, (@code{org-ctrl-c-star})
Turn a plain list item into a headline (so that it becomes a subheading at
its location). @xref{Structure editing}, for a detailed explanation.
@kindex S-@key{left}
@@ -1427,7 +1427,7 @@ This command also cycles bullet styles when the cursor in on the bullet or
anywhere in an item line, details depending on
@code{org-support-shift-select}.
@kindex C-c ^
-@item C-c ^
+@item C-c ^, (@code{org-sort})
Sort the plain list. You will be prompted for the sorting method:
numerically, alphabetically, by time, or by custom function.
@end table
@@ -1467,7 +1467,7 @@ done by state changes, use
@table @kbd
@kindex C-c C-z
-@item C-c C-z
+@item C-c C-z, (@code{org-add-note})
Add a time-stamped note to the LOGBOOK drawer.
@end table
@@ -1542,7 +1542,7 @@ for details.
@table @kbd
@kindex C-c C-x f
-@item C-c C-x f
+@item C-c C-x f, (@code{org-footnote-action})
The footnote action command.
When the cursor is on a footnote reference, jump to the definition. When it
@@ -1586,7 +1586,7 @@ renumbering and sorting footnotes can be automatic after each insertion or
deletion.
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
If the cursor is on a footnote reference, jump to the definition. If it is a
the definition, jump back to the reference. When called at a footnote
location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
@@ -1696,7 +1696,7 @@ unpredictable for you, configure the variables
@table @kbd
@tsubheading{Creation and conversion}
@kindex C-c |
-@item C-c |
+@item C-c |, (@code{org-table-create-or-convert-from-region})
Convert the active region to table. If every line contains at least one
TAB character, the function assumes that the material is tab separated.
If every line contains a comma, comma-separated values (CSV) are assumed.
@@ -1711,7 +1711,7 @@ table. But it's easier just to start typing, like
@tsubheading{Re-aligning and field motion}
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
Re-align the table without moving the cursor.
@c
@kindex @key{TAB}
@@ -1767,7 +1767,7 @@ Insert a new row above the current row. With a prefix argument, the line is
created below the current one.
@c
@kindex C-c -
-@item C-c -
+@item C-c -, (@code{org-ctrl-c-minus})
Insert a horizontal line below current row. With a prefix argument, the line
is created above the current line.
@c
@@ -1777,7 +1777,7 @@ Insert a horizontal line below current row, and move the cursor into the row
below that line.
@c
@kindex C-c ^
-@item C-c ^
+@item C-c ^, (@code{org-sort})
Sort the table lines in the region. The position of point indicates the
column to be used for sorting, and the range of lines is the range
between the nearest horizontal separator lines, or the entire table. If
@@ -1790,18 +1790,18 @@ argument, alphabetic sorting will be case-sensitive.
@tsubheading{Regions}
@kindex C-c C-x M-w
-@item C-c C-x M-w
+@item C-c C-x M-w, (@code{org-copy-special})
Copy a rectangular region from a table to a special clipboard. Point and
mark determine edge fields of the rectangle. If there is no active region,
copy just the current field. The process ignores horizontal separator lines.
@c
@kindex C-c C-x C-w
-@item C-c C-x C-w
+@item C-c C-x C-w, (@code{org-cut-special})
Copy a rectangular region from a table to a special clipboard, and
blank all fields in the rectangle. So this is the ``cut'' operation.
@c
@kindex C-c C-x C-y
-@item C-c C-x C-y
+@item C-c C-x C-y, (@code{org-paste-special})
Paste a rectangular region into a table.
The upper left corner ends up in the current field. All involved fields
will be overwritten. If the rectangle does not fit into the present table,
@@ -1826,7 +1826,7 @@ field is made blank, and the content is appended to the field above.
@cindex active region
@cindex transient mark mode
@kindex C-c +
-@item C-c +
+@item C-c +, (@code{org-table-sum})
Sum the numbers in the current column, or in the rectangle defined by
the active region. The result is shown in the echo area and can
be inserted with @kbd{C-y}.
@@ -1844,7 +1844,7 @@ increment. This key is also used by shift-selection and related modes
@tsubheading{Miscellaneous}
@kindex C-c `
-@item C-c `
+@item C-c `, (@code{org-table-edit-field})
Edit the current field in a separate window. This is useful for fields that
are not fully visible (@pxref{Column width and alignment}). When called with
a @kbd{C-u} prefix, just make the full field visible, so that it can be
@@ -1858,7 +1858,7 @@ TAB-separated text files. This command works by inserting the file into
the buffer and then converting the region to a table. Any prefix
argument is passed on to the converter, which uses it to determine the
separator.
-@item C-c |
+@item C-c |, (@code{org-table-create-or-convert-from-region})
Tables can also be imported by pasting tabular text into the Org
buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
@kbd{C-c |} command (see above under @i{Creation and conversion}).
@@ -2374,7 +2374,7 @@ following command:
@table @kbd
@kindex C-c =
-@item C-c =
+@item C-c =, (@code{org-table-eval-formula})
Install a new formula for the current column and replace current field with
the result of the formula. The command prompts for a formula, with default
taken from the @samp{#+TBLFM} line, applies it to the current field and
@@ -2399,7 +2399,7 @@ if possible. If you prefer to only work with the internal format (like
@table @kbd
@kindex C-c =
@kindex C-u C-c =
-@item C-c =
+@item C-c =, (@code{org-table-eval-formula})
@itemx C-u C-c =
Edit the formula associated with the current column/field in the
minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
@@ -2410,7 +2410,7 @@ field formula, or a column formula) into the current field, so that you
can edit it directly in the field. The advantage over editing in the
minibuffer is that you can use the command @kbd{C-c ?}.
@kindex C-c ?
-@item C-c ?
+@item C-c ?, (@code{org-table-field-info})
While editing a formula in a table field, highlight the field(s)
referenced by the reference at the cursor position in the formula.
@kindex C-c @}
@@ -2422,7 +2422,7 @@ force it with @kbd{C-c C-c}.
@item C-c @{
Toggle the formula debugger on and off. See below.
@kindex C-c '
-@item C-c '
+@item C-c ', (@code{org-edit-special})
Edit all formulas for the current table in a special buffer, where the
formulas will be displayed one per line. If the current field has an
active formula, the cursor in the formula editor will mark it.
@@ -2432,15 +2432,15 @@ remove and add formulas, and use the following commands:
@table @kbd
@kindex C-c C-c
@kindex C-x C-s
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
@itemx C-x C-s
Exit the formula editor and store the modified formulas. With @kbd{C-u}
prefix, also apply the new formulas to the entire table.
@kindex C-c C-q
-@item C-c C-q
+@item C-c C-q, (@code{org-set-tags-command})
Exit the formula editor without installing changes.
@kindex C-c C-r
-@item C-c C-r
+@item C-c C-r, (@code{org-reveal})
Toggle all references in the formula editor between standard (like
@code{B3}) and internal (like @code{@@3$2}).
@kindex @key{TAB}
@@ -2510,7 +2510,7 @@ following commands:
@table @kbd
@kindex C-c *
-@item C-c *
+@item C-c *, (@code{org-ctrl-c-star})
Recalculate the current row by first applying the stored column formulas
from left to right, and all field formulas in the current row.
@c
@@ -3002,7 +3002,7 @@ entry referenced by the current line.
@cindex link completion
@cindex completion, of links
@cindex inserting links
-@item C-c C-l
+@item C-c C-l, (@code{org-insert-link})
@vindex org-keep-stored-link-after-insertion
Insert a link@footnote{ Note that you don't have to use this command to
insert a link. Links in Org are plain text, and you can type or paste them
@@ -3093,13 +3093,13 @@ be inlined during export. When called with a prefix argument, also display
images that do have a link description.
@cindex mark ring
@kindex C-c %
-@item C-c %
+@item C-c %, (@code{org-mark-ring-push})
Push the current position onto the mark ring, to be able to return
easily. Commands following an internal link do this automatically.
@c
@cindex links, returning to
@kindex C-c &
-@item C-c &
+@item C-c &, (@code{org-mark-ring-goto})
Jump back to a recorded position. A position is recorded by the
commands following internal links, and by @kbd{C-c %}. Using this
command several times in direct succession moves through a ring of
@@ -3108,7 +3108,7 @@ previously recorded positions.
@kindex C-c C-x C-n
@kindex C-c C-x C-p
@cindex links, finding next/previous
-@item C-c C-x C-n
+@item C-c C-x C-n, (@code{org-next-link})
@itemx C-c C-x C-p
Move forward/backward to the next link in the buffer. At the limit of
the buffer, the search fails once, and then wraps around. The key
@@ -3309,7 +3309,7 @@ The most important commands to work with TODO entries are:
@table @kbd
@kindex C-c C-t
@cindex cycling, of TODO states
-@item C-c C-t
+@item C-c C-t, (@code{org-todo})
Rotate the TODO state of the current item among
@example
@@ -3636,7 +3636,7 @@ example:
@table @kbd
@kindex C-c C-x o
-@item C-c C-x o
+@item C-c C-x o, (@code{org-toggle-ordered-property})
@vindex org-track-ordered-property-with-tag
@cindex property, ORDERED
Toggle the @code{ORDERED} property of the current entry. A property is used
@@ -4075,12 +4075,12 @@ off a box while there are unchecked boxes above it.
@table @kbd
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
Toggle checkbox status or (with prefix arg) checkbox presence at point. With
double prefix argument, set it to @samp{[-]}, which is considered to be an
intermediate state.
@kindex C-c C-x C-b
-@item C-c C-x C-b
+@item C-c C-x C-b, (@code{org-toggle-checkbox})
Toggle checkbox status or (with prefix arg) checkbox presence at point. With
double prefix argument, set it to @samp{[-]}, which is considered to be an
intermediate state.
@@ -4101,7 +4101,7 @@ Insert a new item with a checkbox.
This works only if the cursor is already in a plain list item
(@pxref{Plain lists}).
@kindex C-c C-x o
-@item C-c C-x o
+@item C-c C-x o, (@code{org-toggle-ordered-property})
@vindex org-track-ordered-property-with-tag
@cindex property, ORDERED
Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
@@ -4111,7 +4111,7 @@ However, if you would like to @i{track} the value of this property with a tag
for better visibility, customize the variable
@code{org-track-ordered-property-with-tag}.
@kindex C-c #
-@item C-c #
+@item C-c #, (@code{org-update-statistics-cookies})
Update the statistics cookie in the current outline entry. When called with
a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
@@ -4206,7 +4206,7 @@ also a special command for inserting tags:
@table @kbd
@kindex C-c C-q
-@item C-c C-q
+@item C-c C-q, (@code{org-set-tags-command})
@cindex completion, of tags
@vindex org-tags-column
Enter new tags for the current headline. Org-mode will either offer
@@ -4217,7 +4217,7 @@ tags in the current buffer will be aligned to that column, just to make
things look nice. TAGS are automatically realigned after promotion,
demotion, and TODO state changes (@pxref{TODO basics}).
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
@end table
@@ -4386,7 +4386,7 @@ information into special lists.
@table @kbd
@kindex C-c \
@kindex C-c / m
-@item C-c \
+@item C-c \, (@code{org-match-sparse-tree})
@itemx C-c / m
Create a sparse tree with all headlines matching a tags search. With a
@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
@@ -4501,7 +4501,7 @@ The following commands help to work with properties:
After an initial colon in a line, complete property keys. All keys used
in the current file will be offered as possible completions.
@kindex C-c C-x p
-@item C-c C-x p
+@item C-c C-x p, (@code{org-set-property})
Set a property. This prompts for a property name and a value. If
necessary, the property drawer is created as well.
@item M-x org-insert-property-drawer
@@ -4509,7 +4509,7 @@ Insert a property drawer into the current entry. The drawer will be
inserted early in the entry, but after the lines with planning
information like deadlines.
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
With the cursor in a property drawer, this executes property commands.
@item C-c C-c s
Set a property in the current entry. Both the property and the value
@@ -4579,7 +4579,7 @@ the same commands are used as for tag searches (@pxref{Tag searches}).
@table @kbd
@kindex C-c \
@kindex C-c / m
-@item C-c \
+@item C-c \, (@code{org-match-sparse-tree})
@itemx C-c / m
Create a sparse tree with all matching entries. With a
@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
@@ -4815,7 +4815,7 @@ in the subtree.
@table @kbd
@tsubheading{Turning column view on and off}
@kindex C-c C-x C-c
-@item C-c C-x C-c
+@item C-c C-x C-c, (@code{org-columns})
@vindex org-columns-default-format
Turn on column view. If the cursor is before the first headline in the file,
column view is turned on for the entire file, using the @code{#+COLUMNS}
@@ -4856,7 +4856,7 @@ invoke the same interface that you normally use to change that
property. For example, when editing a TAGS property, the tag completion
or fast selection interface will pop up.
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
When there is a checkbox at point, toggle it.
@kindex v
@item v
@@ -4934,11 +4934,11 @@ The following commands insert or update the dynamic block:
@table @kbd
@kindex C-c C-x i
-@item C-c C-x i
+@item C-c C-x i, (@code{org-insert-columns-dblock})
Insert a dynamic block capturing a column view. You will be prompted
for the scope or ID of the view.
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
@kindex C-c C-x C-u
@itemx C-c C-x C-u
Update dynamic block at point. The cursor needs to be in the
@@ -5084,14 +5084,14 @@ format.
@table @kbd
@kindex C-c .
-@item C-c .
+@item C-c ., (@code{org-time-stamp})
Prompt for a date and insert a corresponding timestamp. When the cursor is
at an existing timestamp in the buffer, the command is used to modify this
timestamp instead of inserting a new one. When this command is used twice in
succession, a time range is inserted.
@c
@kindex C-c !
-@item C-c !
+@item C-c !, (@code{org-time-stamp-inactive})
Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
an agenda entry.
@c
@@ -5105,17 +5105,17 @@ contains date and time. The default time can be rounded to multiples of 5
minutes, see the option @code{org-time-stamp-rounding-minutes}.
@c
@kindex C-c <
-@item C-c <
+@item C-c <, (@code{org-date-from-calendar})
Insert a timestamp corresponding to the cursor date in the Calendar.
@c
@kindex C-c >
-@item C-c >
+@item C-c >, (@code{org-goto-calendar})
Access the Emacs calendar for the current date. If there is a
timestamp in the current line, go to the corresponding date
instead.
@c
@kindex C-c C-o
-@item C-c C-o
+@item C-c C-o, (@code{org-open-at-point})
Access the agenda for the date given by the timestamp or -range at
point (@pxref{Weekly/daily agenda}).
@c
@@ -5141,7 +5141,7 @@ related modes (@pxref{Conflicts}).
@c
@kindex C-c C-y
@cindex evaluate time range
-@item C-c C-y
+@item C-c C-y, (@code{org-evaluate-time-range})
Evaluate a time range by computing the difference between start and end.
With a prefix argument, insert result after the time range (in a table: into
the following column).
@@ -5278,7 +5278,7 @@ customizing the variables @code{org-display-custom-times} and
@table @kbd
@kindex C-c C-x C-t
-@item C-c C-x C-t
+@item C-c C-x C-t, (@code{org-toggle-time-stamp-overlays})
Toggle the display of custom formats for dates and times.
@end table
@@ -5395,7 +5395,7 @@ an item:
@table @kbd
@c
@kindex C-c C-d
-@item C-c C-d
+@item C-c C-d, (@code{org-deadline})
Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
in the line directly following the headline. When called with a prefix arg,
an existing deadline will be removed from the entry. Depending on the
@@ -5406,7 +5406,7 @@ deadline.
@c FIXME Any CLOSED timestamp will be removed.????????
@c
@kindex C-c C-s
-@item C-c C-s
+@item C-c C-s, (@code{org-schedule})
Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
happen in the line directly following the headline. Any CLOSED timestamp
will be removed. When called with a prefix argument, remove the scheduling
@@ -5419,7 +5419,7 @@ scheduling time.
@kindex C-c C-x C-k
@kindex k a
@kindex k s
-@item C-c C-x C-k
+@item C-c C-x C-k, (@code{org-mark-entry-for-agenda-action})
Mark the current entry for agenda action. After you have marked the entry
like this, you can open the agenda or the calendar to find an appropriate
date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
@@ -5581,7 +5581,7 @@ show all time clocked on this tasks today (see also the variable
@code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
mode line entry will pop up a menu with clocking options.
@kindex C-c C-x C-o
-@item C-c C-x C-o
+@item C-c C-x C-o, (@code{org-clock-out})
@vindex org-log-note-clock-out
Stop the clock (clock-out). This inserts another timestamp at the same
location where the clock was last started. It also directly computes
@@ -5600,20 +5600,20 @@ Recompute the time interval after changing one of the timestamps. This
is only necessary if you edit the timestamps directly. If you change
them with @kbd{S-@key{cursor}} keys, the update is automatic.
@kindex C-c C-t
-@item C-c C-t
+@item C-c C-t, (@code{org-todo})
Changing the TODO state of an item to DONE automatically stops the clock
if it is running in this same item.
@kindex C-c C-x C-x
-@item C-c C-x C-x
+@item C-c C-x C-x, (@code{org-clock-cancel})
Cancel the current clock. This is useful if a clock was started by
mistake, or if you ended up working on something else.
@kindex C-c C-x C-j
-@item C-c C-x C-j
+@item C-c C-x C-j, (@code{org-clock-goto})
Jump to the entry that contains the currently running clock. With a
@kbd{C-u} prefix arg, select the target task from a list of recently clocked
tasks.
@kindex C-c C-x C-d
-@item C-c C-x C-d
+@item C-c C-x C-d, (@code{org-clock-display})
@vindex org-remove-highlights-with-change
Display time summaries for each subtree in the current buffer. This
puts overlays at the end of each headline, showing the total time
@@ -5622,7 +5622,7 @@ can use visibility cycling to study the tree, but the overlays disappear
when you change the buffer (see variable
@code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
@kindex C-c C-x C-r
-@item C-c C-x C-r
+@item C-c C-x C-r, (@code{org-clock-report})
Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
report as an Org-mode table into the current file. When the cursor is
at an existing clock table, just update it. When called with a prefix
@@ -5696,7 +5696,7 @@ A summary of the current subtree with % times would be
#+END: clocktable
@end example
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
@kindex C-c C-x C-u
@itemx C-c C-x C-u
Update dynamic block at point. The cursor needs to be in the
@@ -5803,7 +5803,7 @@ for an entry with the following commands:
@table @kbd
@kindex C-c C-x e
-@item C-c C-x e
+@item C-c C-x e, (@code{org-set-effort})
Set the effort estimate for the current entry. With a numeric prefix
argument, set it to the NTH allowed value (see below). This command is also
accessible from the agenda with the @kbd{e} key.
@@ -5861,12 +5861,12 @@ such a relative timer and make it easy to create timed notes.
@table @kbd
@kindex C-c C-x .
-@item C-c C-x .
+@item C-c C-x ., (@code{org-timer})
Insert a relative time into the buffer. The first time you use this, the
timer will be started. When called with a prefix argument, the timer is
restarted.
@kindex C-c C-x -
-@item C-c C-x -
+@item C-c C-x -, (@code{org-timer-item})
Insert a description list item with the current relative time. With a prefix
argument, first reset the timer to 0.
@kindex M-@key{RET}
@@ -5882,7 +5882,7 @@ Pause the timer, or continue it if it is already paused.
Stop the timer. After this, you can only start a new timer, not continue the
old one. This command also removes the timer from the mode line.
@kindex C-c C-x 0
-@item C-c C-x 0
+@item C-c C-x 0, (@code{org-timer-start})
Reset the timer without inserting anything into the buffer. By default, the
timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
specific starting offset. The user is prompted for the offset, with a
@@ -5969,18 +5969,18 @@ into the target file and switch to an indirect buffer narrowed to this new
node. You may then insert the information you want.
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
Once you have finished entering information into the capture buffer,
@kbd{C-c C-c} will return you to the window configuration before the capture
process, so that you can resume your work without further distraction.
@kindex C-c C-w
-@item C-c C-w
+@item C-c C-w, (@code{org-refile})
Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
a different place.
@kindex C-c C-k
-@item C-c C-k
+@item C-c C-k, (@code{org-kill-note-or-show-branches})
Abort the capture process and return to the previous state.
@end table
@@ -6259,7 +6259,7 @@ directory.
@table @kbd
@kindex C-c C-a
-@item C-c C-a
+@item C-c C-a, (@code{org-attach})
The dispatcher for commands related to the attachment system. After these
keys, a list of commands is displayed and you must press an additional key
to select a command:
@@ -6358,11 +6358,11 @@ the following command is used:
@table @kbd
@kindex C-c C-x g
-@item C-c C-x g
+@item C-c C-x g, (@code{org-feed-update-all})
Collect items from the feeds configured in @code{org-feed-alist} and act upon
them.
@kindex C-c C-x G
-@item C-c C-x G
+@item C-c C-x G, (@code{org-feed-goto-inbox})
Prompt for a feed name and go to the inbox configured for this feed.
@end table
@@ -6403,7 +6403,7 @@ process, you can use the following special command:
@table @kbd
@kindex C-c C-w
-@item C-c C-w
+@item C-c C-w, (@code{org-refile})
@vindex org-reverse-note-order
@vindex org-refile-targets
@vindex org-refile-use-outline-path
@@ -6453,7 +6453,7 @@ searches like the construction of agenda views fast.
@table @kbd
@kindex C-c C-x C-a
-@item C-c C-x C-a
+@item C-c C-x C-a, (@code{org-archive-subtree-default})
@vindex org-archive-default-command
Archive the current entry using the command specified in the variable
@code{org-archive-default-command}.
@@ -6563,7 +6563,7 @@ The following commands help manage the ARCHIVE tag:
@table @kbd
@kindex C-c C-x a
-@item C-c C-x a
+@item C-c C-x a, (@code{org-toggle-archive-tag})
Toggle the ARCHIVE tag for the current headline. When the tag is set,
the headline changes to a shadowed face, and the subtree below it is
hidden.
@@ -6578,7 +6578,7 @@ level 1 trees will be checked.
@item C-@kbd{TAB}
Cycle a tree even if it is tagged with ARCHIVE.
@kindex C-c C-x A
-@item C-c C-x A
+@item C-c C-x A, (@code{org-archive-to-archive-sibling})
Move the current entry to the @emph{Archive Sibling}. This is a sibling of
the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
entry becomes a child of that sibling and in this way retains a lot of its
@@ -6672,12 +6672,12 @@ the easiest way to maintain it is through the following commands
@cindex files, adding to agenda list
@table @kbd
@kindex C-c [
-@item C-c [
+@item C-c [, (@code{org-agenda-file-to-front})
Add current file to the list of agenda files. The file is added to
the front of the list. If it was already in the list, it is moved to
the front. With a prefix argument, file is added/moved to the end.
@kindex C-c ]
-@item C-c ]
+@item C-c ], (@code{org-remove-file})
Remove current file from the list of agenda files.
@kindex C-,
@kindex C-'
@@ -6703,7 +6703,7 @@ extended period, use the following commands:
@table @kbd
@kindex C-c C-x <
-@item C-c C-x <
+@item C-c C-x <, (@code{org-agenda-set-restriction-lock})
Permanently restrict the agenda to the current subtree. When with a
prefix argument, or with the cursor before the first headline in a file,
the agenda scope is set to the entire file. This restriction remains in
@@ -6711,7 +6711,7 @@ effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
or @kbd{>} in the agenda dispatcher. If there is a window displaying an
agenda view, the new restriction takes effect immediately.
@kindex C-c C-x >
-@item C-c C-x >
+@item C-c C-x >, (@code{org-agenda-remove-restriction-lock})
Remove the permanent restriction created by @kbd{C-c C-x <}.
@end table
@@ -7435,14 +7435,14 @@ agenda buffers can be set with the variable
@code{org-agenda-start-with-follow-mode}.
@c
@kindex C-c C-x b
-@item C-c C-x b
+@item C-c C-x b, (@code{org-tree-to-indirect-buffer})
Display the entire subtree of the current item in an indirect buffer. With a
numeric prefix argument N, go up to level N and then take that tree. If N is
negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
previously used indirect buffer.
@kindex C-c C-o
-@item C-c C-o
+@item C-c C-o, (@code{org-open-at-point})
Follow a link in the entry. This will offer a selection of any links in the
text belonging to the referenced Org node. If there is only one link, it
will be followed without a selection prompt.
@@ -7574,7 +7574,7 @@ Save all Org buffers in the current Emacs session, and also the locations of
IDs.
@c
@kindex C-c C-x C-c
-@item C-c C-x C-c
+@item C-c C-x C-c, (@code{org-columns})
@vindex org-columns-default-format
Invoke column view (@pxref{Column view}) in the agenda buffer. The column
view format is taken from the entry at point, or (if there is no entry at
@@ -7584,7 +7584,7 @@ that entry would be in the original buffer (taken from a property, from a
@code{org-columns-default-format}), will be used in the agenda.
@kindex C-c C-x >
-@item C-c C-x >
+@item C-c C-x >, (@code{org-agenda-remove-restriction-lock})
Remove the restriction lock on the agenda, if it is currently restricted to a
file or subtree (@pxref{Agenda files}).
@@ -7717,7 +7717,7 @@ is longer than one line, the kill needs to be confirmed by the user. See
variable @code{org-agenda-confirm-kill}.
@c
@kindex C-c C-w
-@item C-c C-w
+@item C-c C-w, (@code{org-refile})
Refile the entry at point.
@c
@kindex C-c C-x C-a
@@ -7729,11 +7729,11 @@ archiving command set in @code{org-archive-default-command}. When using the
@code{a} key, confirmation will be required.
@c
@kindex C-c C-x a
-@item C-c C-x a
+@item C-c C-x a, (@code{org-toggle-archive-tag})
Toggle the ARCHIVE tag for the current headline.
@c
@kindex C-c C-x A
-@item C-c C-x A
+@item C-c C-x A, (@code{org-archive-to-archive-sibling})
Move the subtree corresponding to the current entry to its @emph{archive
sibling}.
@c
@@ -7789,15 +7789,15 @@ same location where state change notes are put. Depending on
@code{org-log-into-drawer}, this maybe inside a drawer.
@c
@kindex C-c C-a
-@item C-c C-a
+@item C-c C-a, (@code{org-attach})
Dispatcher for all command related to attachments.
@c
@kindex C-c C-s
-@item C-c C-s
+@item C-c C-s, (@code{org-schedule})
Schedule this item, with prefix arg remove the scheduling timestamp
@c
@kindex C-c C-d
-@item C-c C-d
+@item C-c C-d, (@code{org-deadline})
Set a deadline for this item, with prefix arg remove the deadline.
@c
@kindex k
@@ -8317,7 +8317,7 @@ collected by certain criteria.
@table @kbd
@kindex C-c C-x C-c
-@item C-c C-x C-c
+@item C-c C-x C-c, (@code{org-columns})
Turn on column view in the agenda.
@end table
@@ -8578,7 +8578,7 @@ start it with @samp{#+ }. Also entire subtrees starting with the word
@table @kbd
@kindex C-c ;
-@item C-c ;
+@item C-c ;, (@code{org-toggle-comment})
Toggle the COMMENT keyword at the beginning of an entry.
@end table
@@ -8706,7 +8706,7 @@ areas in HTML export}.
@table @kbd
@kindex C-c '
-@item C-c '
+@item C-c ', (@code{org-edit-special})
Edit the source code example at point in its native mode. This works by
switching to a temporary buffer with the source code. You need to exit by
pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
@@ -8756,7 +8756,7 @@ the selected markup. For example, to include a file as an item, use
@table @kbd
@kindex C-c '
-@item C-c '
+@item C-c ', (@code{org-edit-special})
Visit the include file at point.
@end table
@@ -8978,7 +8978,7 @@ typeset expressions:
@table @kbd
@kindex C-c C-x C-l
-@item C-c C-x C-l
+@item C-c C-x C-l, (@code{org-preview-latex-fragment})
Produce a preview image of the La@TeX{} fragment at point and overlay it
over the source code. If there is no fragment at point, process all
fragments in the current entry (between two headlines). When called
@@ -8986,7 +8986,7 @@ with a prefix argument, process the entire subtree. When called with
two prefix arguments, or when the cursor is before the first headline,
process the entire buffer.
@kindex C-c C-c
-@item C-c C-c
+@item C-c C-c, (@code{org-ctrl-c-ctrl-c})
Remove the overlay preview images.
@end table
@@ -9252,7 +9252,7 @@ the subtrees are exported.
@table @kbd
@kindex C-c C-e
-@item C-c C-e
+@item C-c C-e, (@code{org-export})
@vindex org-export-run-in-background
Dispatcher for export and publishing commands. Displays a help-window
listing the additional key(s) needed to launch an export or publishing
@@ -9970,7 +9970,7 @@ support with
@table @kbd
@kindex C-c C-b
-@item C-c C-b
+@item C-c C-b, (@code{org-backward-same-level})
In @code{org-beamer-mode}, this key offers fast selection of a beamer
environment or the @code{BEAMER_col} property.
@end table
@@ -13025,11 +13025,11 @@ these tables directly in the buffer. Instead, you need to use the command
@table @kbd
@kindex C-c '
-@item C-c '
+@item C-c ', (@code{org-edit-special})
Edit a @file{table.el} table. Works when the cursor is in a table.el table.
@c
@kindex C-c ~
-@item C-c ~
+@item C-c ~, (@code{org-table-create-with-table.el})
Insert a @file{table.el} table. If there is already a table at point, this
command converts it between the @file{table.el} format and the Org-mode
format. See the documentation string of the command
@@ -13668,7 +13668,7 @@ Dynamic blocks are updated with the following commands
@table @kbd
@kindex C-c C-x C-u
-@item C-c C-x C-u
+@item C-c C-x C-u, (@code{org-dblock-update})
Update dynamic block at point.
@kindex C-u C-c C-x C-u
@item C-u C-c C-x C-u
[-- Attachment #3: Type: text/plain, Size: 201 bytes --]
_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply related [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-07-29 13:47 ` Andreas Röhler
@ 2010-07-29 15:19 ` Andreas Röhler
2010-07-29 18:08 ` Tassilo Horn
2010-07-31 8:53 ` Bastien
1 sibling, 1 reply; 44+ messages in thread
From: Andreas Röhler @ 2010-07-29 15:19 UTC (permalink / raw)
To: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 68 bytes --]
attached another patch replacing the former, due to a bug at texi
[-- Attachment #2: org-texi.patch --]
[-- Type: text/x-patch, Size: 32281 bytes --]
diff --git a/doc/org.texi b/doc/org.texi
index 38fd4b9..20425a2 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -929,6 +929,7 @@ tables, @kbd{S-@key{TAB}} jumps to the previous field.
Show all, including drawers.
@kindex C-c C-r
@item C-c C-r
+(@code{org-reveal})
Reveal context around point, showing the current entry, the following heading
and the hierarchy above. Useful for working near a location that has been
exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
@@ -937,9 +938,11 @@ level, all sibling headings. With double prefix arg, also show the entire
subtree of the parent.
@kindex C-c C-k
@item C-c C-k
+(@code{org-kill-note-or-show-branches})
Expose all the headings of the subtree, CONTENT view for just one subtree.
@kindex C-c C-x b
@item C-c C-x b
+(@code{org-tree-to-indirect-buffer})
Show the current subtree in an indirect buffer@footnote{The indirect
buffer
@ifinfo
@@ -1005,15 +1008,18 @@ Next heading.
Previous heading.
@kindex C-c C-f
@item C-c C-f
+(@code{org-forward-same-level})
Next heading same level.
@kindex C-c C-b
@item C-c C-b
+(@code{org-backward-same-level})
Previous heading same level.
@kindex C-c C-u
@item C-c C-u
Backward to higher level heading.
@kindex C-c C-j
@item C-c C-j
+(@code{org-goto})
Jump to a different place without changing the current outline
visibility. Shows the document structure in a temporary buffer, where
you can use the following keys to find your destination:
@@ -1107,14 +1113,17 @@ level).
Move subtree down (swap with next subtree of same level).
@kindex C-c C-x C-w
@item C-c C-x C-w
+(@code{org-cut-special})
Kill subtree, i.e. remove it from buffer but save in kill ring.
With a numeric prefix argument N, kill N sequential subtrees.
@kindex C-c C-x M-w
@item C-c C-x M-w
+(@code{org-copy-special})
Copy subtree to kill ring. With a numeric prefix argument N, copy the N
sequential subtrees.
@kindex C-c C-x C-y
@item C-c C-x C-y
+(@code{org-paste-special})
Yank subtree from kill ring. This does modify the level of the subtree to
make sure the tree fits in nicely at the yank position. The yank level can
also be specified with a numeric prefix argument, or by yanking after a
@@ -1135,6 +1144,7 @@ yank, it will yank previous kill items plainly, without adjustment and
folding.
@kindex C-c C-x c
@item C-c C-x c
+(@code{org-clone-subtree-with-time-shift})
Clone a subtree by making a number of sibling copies of it. You will be
prompted for the number of copies to make, and you can also specify if any
timestamps in the entry should be shifted. This can be useful, for example,
@@ -1143,9 +1153,11 @@ more details, see the docstring of the command
@code{org-clone-subtree-with-time-shift}.
@kindex C-c C-w
@item C-c C-w
+(@code{org-refile})
Refile entry or region to a different location. @xref{Refiling notes}.
@kindex C-c ^
@item C-c ^
+(@code{org-sort})
Sort same-level entries. When there is an active region, all entries in the
region will be sorted. Otherwise the children of the current headline are
sorted. The command prompts for the sorting method, which can be
@@ -1164,6 +1176,7 @@ Narrow buffer to current subtree.
Widen buffer to remove narrowing.
@kindex C-c *
@item C-c *
+(@code{org-ctrl-c-star})
Turn a normal line or plain list item into a headline (so that it becomes a
subheading at its location). Also turn a headline into a normal line by
removing the stars. If there is an active region, turn all lines in the
@@ -1210,6 +1223,7 @@ commands can be accessed through a dispatcher:
@table @kbd
@kindex C-c /
@item C-c /
+(@code{org-sparse-tree})
This prompts for an extra key to select a sparse-tree creating command.
@kindex C-c / r
@item C-c / r
@@ -1402,12 +1416,14 @@ would imply a different hierarchy. To use the new hierarchy, break
the command chain with a cursor motion or so.
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
state of the checkbox. If not, this command makes sure that all the
items on this list level use the same bullet. Furthermore, if this is
an ordered list, make sure the numbering is OK.
@kindex C-c -
@item C-c -
+(@code{org-ctrl-c-minus})
Cycle the entire list level through the different itemize/enumerate bullets
(@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
argument N, select the Nth bullet from this list. If there is an active
@@ -1417,6 +1433,7 @@ list. Finally, even without an active region, a normal line will be
converted into a list item.
@kindex C-c *
@item C-c *
+(@code{org-ctrl-c-star})
Turn a plain list item into a headline (so that it becomes a subheading at
its location). @xref{Structure editing}, for a detailed explanation.
@kindex S-@key{left}
@@ -1428,6 +1445,7 @@ anywhere in an item line, details depending on
@code{org-support-shift-select}.
@kindex C-c ^
@item C-c ^
+(@code{org-sort})
Sort the plain list. You will be prompted for the sorting method:
numerically, alphabetically, by time, or by custom function.
@end table
@@ -1468,6 +1486,7 @@ done by state changes, use
@table @kbd
@kindex C-c C-z
@item C-c C-z
+(@code{org-add-note})
Add a time-stamped note to the LOGBOOK drawer.
@end table
@@ -1543,6 +1562,7 @@ for details.
@table @kbd
@kindex C-c C-x f
@item C-c C-x f
+(@code{org-footnote-action})
The footnote action command.
When the cursor is on a footnote reference, jump to the definition. When it
@@ -1587,6 +1607,7 @@ deletion.
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
If the cursor is on a footnote reference, jump to the definition. If it is a
the definition, jump back to the reference. When called at a footnote
location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
@@ -1697,6 +1718,7 @@ unpredictable for you, configure the variables
@tsubheading{Creation and conversion}
@kindex C-c |
@item C-c |
+(@code{org-table-create-or-convert-from-region})
Convert the active region to table. If every line contains at least one
TAB character, the function assumes that the material is tab separated.
If every line contains a comma, comma-separated values (CSV) are assumed.
@@ -1712,6 +1734,7 @@ table. But it's easier just to start typing, like
@tsubheading{Re-aligning and field motion}
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
Re-align the table without moving the cursor.
@c
@kindex @key{TAB}
@@ -1768,6 +1791,7 @@ created below the current one.
@c
@kindex C-c -
@item C-c -
+(@code{org-ctrl-c-minus})
Insert a horizontal line below current row. With a prefix argument, the line
is created above the current line.
@c
@@ -1778,6 +1802,7 @@ below that line.
@c
@kindex C-c ^
@item C-c ^
+(@code{org-sort})
Sort the table lines in the region. The position of point indicates the
column to be used for sorting, and the range of lines is the range
between the nearest horizontal separator lines, or the entire table. If
@@ -1791,17 +1816,20 @@ argument, alphabetic sorting will be case-sensitive.
@tsubheading{Regions}
@kindex C-c C-x M-w
@item C-c C-x M-w
+(@code{org-copy-special})
Copy a rectangular region from a table to a special clipboard. Point and
mark determine edge fields of the rectangle. If there is no active region,
copy just the current field. The process ignores horizontal separator lines.
@c
@kindex C-c C-x C-w
@item C-c C-x C-w
+(@code{org-cut-special})
Copy a rectangular region from a table to a special clipboard, and
blank all fields in the rectangle. So this is the ``cut'' operation.
@c
@kindex C-c C-x C-y
@item C-c C-x C-y
+(@code{org-paste-special})
Paste a rectangular region into a table.
The upper left corner ends up in the current field. All involved fields
will be overwritten. If the rectangle does not fit into the present table,
@@ -1827,6 +1855,7 @@ field is made blank, and the content is appended to the field above.
@cindex transient mark mode
@kindex C-c +
@item C-c +
+(@code{org-table-sum})
Sum the numbers in the current column, or in the rectangle defined by
the active region. The result is shown in the echo area and can
be inserted with @kbd{C-y}.
@@ -1845,6 +1874,7 @@ increment. This key is also used by shift-selection and related modes
@tsubheading{Miscellaneous}
@kindex C-c `
@item C-c `
+(@code{org-table-edit-field})
Edit the current field in a separate window. This is useful for fields that
are not fully visible (@pxref{Column width and alignment}). When called with
a @kbd{C-u} prefix, just make the full field visible, so that it can be
@@ -1859,6 +1889,7 @@ the buffer and then converting the region to a table. Any prefix
argument is passed on to the converter, which uses it to determine the
separator.
@item C-c |
+(@code{org-table-create-or-convert-from-region})
Tables can also be imported by pasting tabular text into the Org
buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
@kbd{C-c |} command (see above under @i{Creation and conversion}).
@@ -2375,6 +2406,7 @@ following command:
@table @kbd
@kindex C-c =
@item C-c =
+(@code{org-table-eval-formula})
Install a new formula for the current column and replace current field with
the result of the formula. The command prompts for a formula, with default
taken from the @samp{#+TBLFM} line, applies it to the current field and
@@ -2400,6 +2432,7 @@ if possible. If you prefer to only work with the internal format (like
@kindex C-c =
@kindex C-u C-c =
@item C-c =
+(@code{org-table-eval-formula})
@itemx C-u C-c =
Edit the formula associated with the current column/field in the
minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
@@ -2411,6 +2444,7 @@ can edit it directly in the field. The advantage over editing in the
minibuffer is that you can use the command @kbd{C-c ?}.
@kindex C-c ?
@item C-c ?
+(@code{org-table-field-info})
While editing a formula in a table field, highlight the field(s)
referenced by the reference at the cursor position in the formula.
@kindex C-c @}
@@ -2423,6 +2457,7 @@ force it with @kbd{C-c C-c}.
Toggle the formula debugger on and off. See below.
@kindex C-c '
@item C-c '
+(@code{org-edit-special})
Edit all formulas for the current table in a special buffer, where the
formulas will be displayed one per line. If the current field has an
active formula, the cursor in the formula editor will mark it.
@@ -2433,14 +2468,17 @@ remove and add formulas, and use the following commands:
@kindex C-c C-c
@kindex C-x C-s
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
@itemx C-x C-s
Exit the formula editor and store the modified formulas. With @kbd{C-u}
prefix, also apply the new formulas to the entire table.
@kindex C-c C-q
@item C-c C-q
+(@code{org-set-tags-command})
Exit the formula editor without installing changes.
@kindex C-c C-r
@item C-c C-r
+(@code{org-reveal})
Toggle all references in the formula editor between standard (like
@code{B3}) and internal (like @code{@@3$2}).
@kindex @key{TAB}
@@ -2511,6 +2549,7 @@ following commands:
@table @kbd
@kindex C-c *
@item C-c *
+(@code{org-ctrl-c-star})
Recalculate the current row by first applying the stored column formulas
from left to right, and all field formulas in the current row.
@c
@@ -3003,6 +3042,7 @@ entry referenced by the current line.
@cindex completion, of links
@cindex inserting links
@item C-c C-l
+(@code{org-insert-link})
@vindex org-keep-stored-link-after-insertion
Insert a link@footnote{ Note that you don't have to use this command to
insert a link. Links in Org are plain text, and you can type or paste them
@@ -3094,12 +3134,14 @@ images that do have a link description.
@cindex mark ring
@kindex C-c %
@item C-c %
+(@code{org-mark-ring-push})
Push the current position onto the mark ring, to be able to return
easily. Commands following an internal link do this automatically.
@c
@cindex links, returning to
@kindex C-c &
@item C-c &
+(@code{org-mark-ring-goto})
Jump back to a recorded position. A position is recorded by the
commands following internal links, and by @kbd{C-c %}. Using this
command several times in direct succession moves through a ring of
@@ -3109,6 +3151,7 @@ previously recorded positions.
@kindex C-c C-x C-p
@cindex links, finding next/previous
@item C-c C-x C-n
+(@code{org-next-link})
@itemx C-c C-x C-p
Move forward/backward to the next link in the buffer. At the limit of
the buffer, the search fails once, and then wraps around. The key
@@ -3310,6 +3353,7 @@ The most important commands to work with TODO entries are:
@kindex C-c C-t
@cindex cycling, of TODO states
@item C-c C-t
+(@code{org-todo})
Rotate the TODO state of the current item among
@example
@@ -3637,6 +3681,7 @@ example:
@table @kbd
@kindex C-c C-x o
@item C-c C-x o
+(@code{org-toggle-ordered-property})
@vindex org-track-ordered-property-with-tag
@cindex property, ORDERED
Toggle the @code{ORDERED} property of the current entry. A property is used
@@ -4076,11 +4121,13 @@ off a box while there are unchecked boxes above it.
@table @kbd
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
Toggle checkbox status or (with prefix arg) checkbox presence at point. With
double prefix argument, set it to @samp{[-]}, which is considered to be an
intermediate state.
@kindex C-c C-x C-b
@item C-c C-x C-b
+(@code{org-toggle-checkbox})
Toggle checkbox status or (with prefix arg) checkbox presence at point. With
double prefix argument, set it to @samp{[-]}, which is considered to be an
intermediate state.
@@ -4102,6 +4149,7 @@ This works only if the cursor is already in a plain list item
(@pxref{Plain lists}).
@kindex C-c C-x o
@item C-c C-x o
+(@code{org-toggle-ordered-property})
@vindex org-track-ordered-property-with-tag
@cindex property, ORDERED
Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
@@ -4112,6 +4160,7 @@ for better visibility, customize the variable
@code{org-track-ordered-property-with-tag}.
@kindex C-c #
@item C-c #
+(@code{org-update-statistics-cookies})
Update the statistics cookie in the current outline entry. When called with
a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
@@ -4207,6 +4256,7 @@ also a special command for inserting tags:
@table @kbd
@kindex C-c C-q
@item C-c C-q
+(@code{org-set-tags-command})
@cindex completion, of tags
@vindex org-tags-column
Enter new tags for the current headline. Org-mode will either offer
@@ -4218,6 +4268,7 @@ things look nice. TAGS are automatically realigned after promotion,
demotion, and TODO state changes (@pxref{TODO basics}).
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
@end table
@@ -4387,6 +4438,7 @@ information into special lists.
@kindex C-c \
@kindex C-c / m
@item C-c \
+(@code{org-match-sparse-tree})
@itemx C-c / m
Create a sparse tree with all headlines matching a tags search. With a
@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
@@ -4502,6 +4554,7 @@ After an initial colon in a line, complete property keys. All keys used
in the current file will be offered as possible completions.
@kindex C-c C-x p
@item C-c C-x p
+(@code{org-set-property})
Set a property. This prompts for a property name and a value. If
necessary, the property drawer is created as well.
@item M-x org-insert-property-drawer
@@ -4510,6 +4563,7 @@ inserted early in the entry, but after the lines with planning
information like deadlines.
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
With the cursor in a property drawer, this executes property commands.
@item C-c C-c s
Set a property in the current entry. Both the property and the value
@@ -4580,6 +4634,7 @@ the same commands are used as for tag searches (@pxref{Tag searches}).
@kindex C-c \
@kindex C-c / m
@item C-c \
+(@code{org-match-sparse-tree})
@itemx C-c / m
Create a sparse tree with all matching entries. With a
@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
@@ -4816,6 +4871,7 @@ in the subtree.
@tsubheading{Turning column view on and off}
@kindex C-c C-x C-c
@item C-c C-x C-c
+(@code{org-columns})
@vindex org-columns-default-format
Turn on column view. If the cursor is before the first headline in the file,
column view is turned on for the entire file, using the @code{#+COLUMNS}
@@ -4857,6 +4913,7 @@ property. For example, when editing a TAGS property, the tag completion
or fast selection interface will pop up.
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
When there is a checkbox at point, toggle it.
@kindex v
@item v
@@ -4935,10 +4992,12 @@ The following commands insert or update the dynamic block:
@table @kbd
@kindex C-c C-x i
@item C-c C-x i
+(@code{org-insert-columns-dblock})
Insert a dynamic block capturing a column view. You will be prompted
for the scope or ID of the view.
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
@kindex C-c C-x C-u
@itemx C-c C-x C-u
Update dynamic block at point. The cursor needs to be in the
@@ -5085,6 +5144,7 @@ format.
@table @kbd
@kindex C-c .
@item C-c .
+(@code{org-time-stamp})
Prompt for a date and insert a corresponding timestamp. When the cursor is
at an existing timestamp in the buffer, the command is used to modify this
timestamp instead of inserting a new one. When this command is used twice in
@@ -5092,6 +5152,7 @@ succession, a time range is inserted.
@c
@kindex C-c !
@item C-c !
+(@code{org-time-stamp-inactive})
Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
an agenda entry.
@c
@@ -5106,16 +5167,19 @@ minutes, see the option @code{org-time-stamp-rounding-minutes}.
@c
@kindex C-c <
@item C-c <
+(@code{org-date-from-calendar})
Insert a timestamp corresponding to the cursor date in the Calendar.
@c
@kindex C-c >
@item C-c >
+(@code{org-goto-calendar})
Access the Emacs calendar for the current date. If there is a
timestamp in the current line, go to the corresponding date
instead.
@c
@kindex C-c C-o
@item C-c C-o
+(@code{org-open-at-point})
Access the agenda for the date given by the timestamp or -range at
point (@pxref{Weekly/daily agenda}).
@c
@@ -5142,6 +5206,7 @@ related modes (@pxref{Conflicts}).
@kindex C-c C-y
@cindex evaluate time range
@item C-c C-y
+(@code{org-evaluate-time-range})
Evaluate a time range by computing the difference between start and end.
With a prefix argument, insert result after the time range (in a table: into
the following column).
@@ -5279,6 +5344,7 @@ customizing the variables @code{org-display-custom-times} and
@table @kbd
@kindex C-c C-x C-t
@item C-c C-x C-t
+(@code{org-toggle-time-stamp-overlays})
Toggle the display of custom formats for dates and times.
@end table
@@ -5396,6 +5462,7 @@ an item:
@c
@kindex C-c C-d
@item C-c C-d
+(@code{org-deadline})
Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
in the line directly following the headline. When called with a prefix arg,
an existing deadline will be removed from the entry. Depending on the
@@ -5407,6 +5474,7 @@ deadline.
@c
@kindex C-c C-s
@item C-c C-s
+(@code{org-schedule})
Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
happen in the line directly following the headline. Any CLOSED timestamp
will be removed. When called with a prefix argument, remove the scheduling
@@ -5420,6 +5488,7 @@ scheduling time.
@kindex k a
@kindex k s
@item C-c C-x C-k
+(@code{org-mark-entry-for-agenda-action})
Mark the current entry for agenda action. After you have marked the entry
like this, you can open the agenda or the calendar to find an appropriate
date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
@@ -5582,6 +5651,7 @@ show all time clocked on this tasks today (see also the variable
mode line entry will pop up a menu with clocking options.
@kindex C-c C-x C-o
@item C-c C-x C-o
+(@code{org-clock-out})
@vindex org-log-note-clock-out
Stop the clock (clock-out). This inserts another timestamp at the same
location where the clock was last started. It also directly computes
@@ -5601,19 +5671,23 @@ is only necessary if you edit the timestamps directly. If you change
them with @kbd{S-@key{cursor}} keys, the update is automatic.
@kindex C-c C-t
@item C-c C-t
+(@code{org-todo})
Changing the TODO state of an item to DONE automatically stops the clock
if it is running in this same item.
@kindex C-c C-x C-x
@item C-c C-x C-x
+(@code{org-clock-cancel})
Cancel the current clock. This is useful if a clock was started by
mistake, or if you ended up working on something else.
@kindex C-c C-x C-j
@item C-c C-x C-j
+(@code{org-clock-goto})
Jump to the entry that contains the currently running clock. With a
@kbd{C-u} prefix arg, select the target task from a list of recently clocked
tasks.
@kindex C-c C-x C-d
@item C-c C-x C-d
+(@code{org-clock-display})
@vindex org-remove-highlights-with-change
Display time summaries for each subtree in the current buffer. This
puts overlays at the end of each headline, showing the total time
@@ -5623,6 +5697,7 @@ when you change the buffer (see variable
@code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
@kindex C-c C-x C-r
@item C-c C-x C-r
+(@code{org-clock-report})
Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
report as an Org-mode table into the current file. When the cursor is
at an existing clock table, just update it. When called with a prefix
@@ -5697,6 +5772,7 @@ A summary of the current subtree with % times would be
@end example
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
@kindex C-c C-x C-u
@itemx C-c C-x C-u
Update dynamic block at point. The cursor needs to be in the
@@ -5804,6 +5880,7 @@ for an entry with the following commands:
@table @kbd
@kindex C-c C-x e
@item C-c C-x e
+(@code{org-set-effort})
Set the effort estimate for the current entry. With a numeric prefix
argument, set it to the NTH allowed value (see below). This command is also
accessible from the agenda with the @kbd{e} key.
@@ -5862,11 +5939,13 @@ such a relative timer and make it easy to create timed notes.
@table @kbd
@kindex C-c C-x .
@item C-c C-x .
+(@code{org-timer})
Insert a relative time into the buffer. The first time you use this, the
timer will be started. When called with a prefix argument, the timer is
restarted.
@kindex C-c C-x -
@item C-c C-x -
+(@code{org-timer-item})
Insert a description list item with the current relative time. With a prefix
argument, first reset the timer to 0.
@kindex M-@key{RET}
@@ -5883,6 +5962,7 @@ Stop the timer. After this, you can only start a new timer, not continue the
old one. This command also removes the timer from the mode line.
@kindex C-c C-x 0
@item C-c C-x 0
+(@code{org-timer-start})
Reset the timer without inserting anything into the buffer. By default, the
timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
specific starting offset. The user is prompted for the offset, with a
@@ -5970,17 +6050,20 @@ node. You may then insert the information you want.
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
Once you have finished entering information into the capture buffer,
@kbd{C-c C-c} will return you to the window configuration before the capture
process, so that you can resume your work without further distraction.
@kindex C-c C-w
@item C-c C-w
+(@code{org-refile})
Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
a different place.
@kindex C-c C-k
@item C-c C-k
+(@code{org-kill-note-or-show-branches})
Abort the capture process and return to the previous state.
@end table
@@ -6260,6 +6343,7 @@ directory.
@kindex C-c C-a
@item C-c C-a
+(@code{org-attach})
The dispatcher for commands related to the attachment system. After these
keys, a list of commands is displayed and you must press an additional key
to select a command:
@@ -6359,10 +6443,12 @@ the following command is used:
@table @kbd
@kindex C-c C-x g
@item C-c C-x g
+(@code{org-feed-update-all})
Collect items from the feeds configured in @code{org-feed-alist} and act upon
them.
@kindex C-c C-x G
@item C-c C-x G
+(@code{org-feed-goto-inbox})
Prompt for a feed name and go to the inbox configured for this feed.
@end table
@@ -6404,6 +6490,7 @@ process, you can use the following special command:
@table @kbd
@kindex C-c C-w
@item C-c C-w
+(@code{org-refile})
@vindex org-reverse-note-order
@vindex org-refile-targets
@vindex org-refile-use-outline-path
@@ -6454,6 +6541,7 @@ searches like the construction of agenda views fast.
@table @kbd
@kindex C-c C-x C-a
@item C-c C-x C-a
+(@code{org-archive-subtree-default})
@vindex org-archive-default-command
Archive the current entry using the command specified in the variable
@code{org-archive-default-command}.
@@ -6564,6 +6652,7 @@ The following commands help manage the ARCHIVE tag:
@table @kbd
@kindex C-c C-x a
@item C-c C-x a
+(@code{org-toggle-archive-tag})
Toggle the ARCHIVE tag for the current headline. When the tag is set,
the headline changes to a shadowed face, and the subtree below it is
hidden.
@@ -6579,6 +6668,7 @@ level 1 trees will be checked.
Cycle a tree even if it is tagged with ARCHIVE.
@kindex C-c C-x A
@item C-c C-x A
+(@code{org-archive-to-archive-sibling})
Move the current entry to the @emph{Archive Sibling}. This is a sibling of
the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
entry becomes a child of that sibling and in this way retains a lot of its
@@ -6673,11 +6763,13 @@ the easiest way to maintain it is through the following commands
@table @kbd
@kindex C-c [
@item C-c [
+(@code{org-agenda-file-to-front})
Add current file to the list of agenda files. The file is added to
the front of the list. If it was already in the list, it is moved to
the front. With a prefix argument, file is added/moved to the end.
@kindex C-c ]
@item C-c ]
+(@code{org-remove-file})
Remove current file from the list of agenda files.
@kindex C-,
@kindex C-'
@@ -6704,6 +6796,7 @@ extended period, use the following commands:
@table @kbd
@kindex C-c C-x <
@item C-c C-x <
+(@code{org-agenda-set-restriction-lock})
Permanently restrict the agenda to the current subtree. When with a
prefix argument, or with the cursor before the first headline in a file,
the agenda scope is set to the entire file. This restriction remains in
@@ -6712,6 +6805,7 @@ or @kbd{>} in the agenda dispatcher. If there is a window displaying an
agenda view, the new restriction takes effect immediately.
@kindex C-c C-x >
@item C-c C-x >
+(@code{org-agenda-remove-restriction-lock})
Remove the permanent restriction created by @kbd{C-c C-x <}.
@end table
@@ -7436,6 +7530,7 @@ agenda buffers can be set with the variable
@c
@kindex C-c C-x b
@item C-c C-x b
+(@code{org-tree-to-indirect-buffer})
Display the entire subtree of the current item in an indirect buffer. With a
numeric prefix argument N, go up to level N and then take that tree. If N is
negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
@@ -7443,6 +7538,7 @@ previously used indirect buffer.
@kindex C-c C-o
@item C-c C-o
+(@code{org-open-at-point})
Follow a link in the entry. This will offer a selection of any links in the
text belonging to the referenced Org node. If there is only one link, it
will be followed without a selection prompt.
@@ -7575,6 +7671,7 @@ IDs.
@c
@kindex C-c C-x C-c
@item C-c C-x C-c
+(@code{org-columns})
@vindex org-columns-default-format
Invoke column view (@pxref{Column view}) in the agenda buffer. The column
view format is taken from the entry at point, or (if there is no entry at
@@ -7585,6 +7682,7 @@ that entry would be in the original buffer (taken from a property, from a
@kindex C-c C-x >
@item C-c C-x >
+(@code{org-agenda-remove-restriction-lock})
Remove the restriction lock on the agenda, if it is currently restricted to a
file or subtree (@pxref{Agenda files}).
@@ -7718,6 +7816,7 @@ variable @code{org-agenda-confirm-kill}.
@c
@kindex C-c C-w
@item C-c C-w
+(@code{org-refile})
Refile the entry at point.
@c
@kindex C-c C-x C-a
@@ -7730,10 +7829,12 @@ archiving command set in @code{org-archive-default-command}. When using the
@c
@kindex C-c C-x a
@item C-c C-x a
+(@code{org-toggle-archive-tag})
Toggle the ARCHIVE tag for the current headline.
@c
@kindex C-c C-x A
@item C-c C-x A
+(@code{org-archive-to-archive-sibling})
Move the subtree corresponding to the current entry to its @emph{archive
sibling}.
@c
@@ -7790,14 +7891,17 @@ same location where state change notes are put. Depending on
@c
@kindex C-c C-a
@item C-c C-a
+(@code{org-attach})
Dispatcher for all command related to attachments.
@c
@kindex C-c C-s
@item C-c C-s
+(@code{org-schedule})
Schedule this item, with prefix arg remove the scheduling timestamp
@c
@kindex C-c C-d
@item C-c C-d
+(@code{org-deadline})
Set a deadline for this item, with prefix arg remove the deadline.
@c
@kindex k
@@ -8318,6 +8422,7 @@ collected by certain criteria.
@table @kbd
@kindex C-c C-x C-c
@item C-c C-x C-c
+(@code{org-columns})
Turn on column view in the agenda.
@end table
@@ -8579,6 +8684,7 @@ start it with @samp{#+ }. Also entire subtrees starting with the word
@table @kbd
@kindex C-c ;
@item C-c ;
+(@code{org-toggle-comment})
Toggle the COMMENT keyword at the beginning of an entry.
@end table
@@ -8707,6 +8813,7 @@ areas in HTML export}.
@table @kbd
@kindex C-c '
@item C-c '
+(@code{org-edit-special})
Edit the source code example at point in its native mode. This works by
switching to a temporary buffer with the source code. You need to exit by
pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
@@ -8757,6 +8864,7 @@ the selected markup. For example, to include a file as an item, use
@table @kbd
@kindex C-c '
@item C-c '
+(@code{org-edit-special})
Visit the include file at point.
@end table
@@ -8979,6 +9087,7 @@ typeset expressions:
@table @kbd
@kindex C-c C-x C-l
@item C-c C-x C-l
+(@code{org-preview-latex-fragment})
Produce a preview image of the La@TeX{} fragment at point and overlay it
over the source code. If there is no fragment at point, process all
fragments in the current entry (between two headlines). When called
@@ -8987,6 +9096,7 @@ two prefix arguments, or when the cursor is before the first headline,
process the entire buffer.
@kindex C-c C-c
@item C-c C-c
+(@code{org-ctrl-c-ctrl-c})
Remove the overlay preview images.
@end table
@@ -9253,6 +9363,7 @@ the subtrees are exported.
@table @kbd
@kindex C-c C-e
@item C-c C-e
+(@code{org-export})
@vindex org-export-run-in-background
Dispatcher for export and publishing commands. Displays a help-window
listing the additional key(s) needed to launch an export or publishing
@@ -9971,6 +10082,7 @@ support with
@table @kbd
@kindex C-c C-b
@item C-c C-b
+(@code{org-backward-same-level})
In @code{org-beamer-mode}, this key offers fast selection of a beamer
environment or the @code{BEAMER_col} property.
@end table
@@ -13026,10 +13138,12 @@ these tables directly in the buffer. Instead, you need to use the command
@table @kbd
@kindex C-c '
@item C-c '
+(@code{org-edit-special})
Edit a @file{table.el} table. Works when the cursor is in a table.el table.
@c
@kindex C-c ~
@item C-c ~
+(@code{org-table-create-with-table.el})
Insert a @file{table.el} table. If there is already a table at point, this
command converts it between the @file{table.el} format and the Org-mode
format. See the documentation string of the command
@@ -13669,6 +13783,7 @@ Dynamic blocks are updated with the following commands
@table @kbd
@kindex C-c C-x C-u
@item C-c C-x C-u
+(@code{org-dblock-update})
Update dynamic block at point.
@kindex C-u C-c C-x C-u
@item C-u C-c C-x C-u
[-- Attachment #3: Type: text/plain, Size: 201 bytes --]
_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply related [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-07-29 15:19 ` Andreas Röhler
@ 2010-07-29 18:08 ` Tassilo Horn
2010-07-30 9:40 ` Andreas Röhler
0 siblings, 1 reply; 44+ messages in thread
From: Tassilo Horn @ 2010-07-29 18:08 UTC (permalink / raw)
To: emacs-orgmode
Andreas Röhler <andreas.roehler@easy-emacs.de> writes:
> attached another patch replacing the former, due to a bug at texi
Please also add @findex{} entries.
Bye,
Tassilo
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-07-29 18:08 ` Tassilo Horn
@ 2010-07-30 9:40 ` Andreas Röhler
2010-08-07 19:39 ` Carsten Dominik
0 siblings, 1 reply; 44+ messages in thread
From: Andreas Röhler @ 2010-07-30 9:40 UTC (permalink / raw)
To: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 739 bytes --]
Am 29.07.2010 20:08, schrieb Tassilo Horn:
> Andreas Röhler<andreas.roehler@easy-emacs.de> writes:
>
>> attached another patch replacing the former, due to a bug at texi
>
> Please also add @findex{} entries.
>
> Bye,
> Tassilo
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
Done. Patch attached.
Seems the functions index node remains to write.
Looking into, I see a strange thing at line 14746:
@node Variable Index, , Key Index, Top
Cheers
Andreas
--
https://code.launchpad.net/~a-roehler/python-mode
https://code.launchpad.net/s-x-emacs-werkstatt/
[-- Attachment #2: org-texi.patch --]
[-- Type: text/x-patch, Size: 35895 bytes --]
diff --git a/doc/org.texi b/doc/org.texi
index 38fd4b9..c699731 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -929,6 +929,8 @@ tables, @kbd{S-@key{TAB}} jumps to the previous field.
Show all, including drawers.
@kindex C-c C-r
@item C-c C-r
+@findex org-reveal
+(@code{org-reveal})
Reveal context around point, showing the current entry, the following heading
and the hierarchy above. Useful for working near a location that has been
exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
@@ -937,9 +939,13 @@ level, all sibling headings. With double prefix arg, also show the entire
subtree of the parent.
@kindex C-c C-k
@item C-c C-k
+@findex org-kill-note-or-show-branches
+(@code{org-kill-note-or-show-branches})
Expose all the headings of the subtree, CONTENT view for just one subtree.
@kindex C-c C-x b
@item C-c C-x b
+@findex org-tree-to-indirect-buffer
+(@code{org-tree-to-indirect-buffer})
Show the current subtree in an indirect buffer@footnote{The indirect
buffer
@ifinfo
@@ -999,21 +1005,33 @@ The following commands jump to other headlines in the buffer.
@table @kbd
@kindex C-c C-n
@item C-c C-n
+@findex outline-next-visible-heading
+(@code{outline-next-visible-heading})
Next heading.
@kindex C-c C-p
@item C-c C-p
+@findex outline-previous-visible-heading
+(@code{outline-previous-visible-heading})
Previous heading.
@kindex C-c C-f
@item C-c C-f
+@findex org-forward-same-level
+(@code{org-forward-same-level})
Next heading same level.
@kindex C-c C-b
@item C-c C-b
+@findex org-backward-same-level
+(@code{org-backward-same-level})
Previous heading same level.
@kindex C-c C-u
@item C-c C-u
+@findex outline-up-heading
+(@code{outline-up-heading})
Backward to higher level heading.
@kindex C-c C-j
@item C-c C-j
+@findex org-goto
+(@code{org-goto})
Jump to a different place without changing the current outline
visibility. Shows the document structure in a temporary buffer, where
you can use the following keys to find your destination:
@@ -1107,14 +1125,20 @@ level).
Move subtree down (swap with next subtree of same level).
@kindex C-c C-x C-w
@item C-c C-x C-w
+@findex org-cut-special
+(@code{org-cut-special})
Kill subtree, i.e. remove it from buffer but save in kill ring.
With a numeric prefix argument N, kill N sequential subtrees.
@kindex C-c C-x M-w
@item C-c C-x M-w
+@findex org-copy-special
+(@code{org-copy-special})
Copy subtree to kill ring. With a numeric prefix argument N, copy the N
sequential subtrees.
@kindex C-c C-x C-y
@item C-c C-x C-y
+@findex org-paste-special
+(@code{org-paste-special})
Yank subtree from kill ring. This does modify the level of the subtree to
make sure the tree fits in nicely at the yank position. The yank level can
also be specified with a numeric prefix argument, or by yanking after a
@@ -1135,6 +1159,8 @@ yank, it will yank previous kill items plainly, without adjustment and
folding.
@kindex C-c C-x c
@item C-c C-x c
+@findex org-clone-subtree-with-time-shift
+(@code{org-clone-subtree-with-time-shift})
Clone a subtree by making a number of sibling copies of it. You will be
prompted for the number of copies to make, and you can also specify if any
timestamps in the entry should be shifted. This can be useful, for example,
@@ -1143,9 +1169,13 @@ more details, see the docstring of the command
@code{org-clone-subtree-with-time-shift}.
@kindex C-c C-w
@item C-c C-w
+@findex org-refile
+(@code{org-refile})
Refile entry or region to a different location. @xref{Refiling notes}.
@kindex C-c ^
@item C-c ^
+@findex org-sort
+(@code{org-sort})
Sort same-level entries. When there is an active region, all entries in the
region will be sorted. Otherwise the children of the current headline are
sorted. The command prompts for the sorting method, which can be
@@ -1164,6 +1194,8 @@ Narrow buffer to current subtree.
Widen buffer to remove narrowing.
@kindex C-c *
@item C-c *
+@findex org-ctrl-c-star
+(@code{org-ctrl-c-star})
Turn a normal line or plain list item into a headline (so that it becomes a
subheading at its location). Also turn a headline into a normal line by
removing the stars. If there is an active region, turn all lines in the
@@ -1210,6 +1242,8 @@ commands can be accessed through a dispatcher:
@table @kbd
@kindex C-c /
@item C-c /
+@findex org-sparse-tree
+(@code{org-sparse-tree})
This prompts for an extra key to select a sparse-tree creating command.
@kindex C-c / r
@item C-c / r
@@ -1402,12 +1436,16 @@ would imply a different hierarchy. To use the new hierarchy, break
the command chain with a cursor motion or so.
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
state of the checkbox. If not, this command makes sure that all the
items on this list level use the same bullet. Furthermore, if this is
an ordered list, make sure the numbering is OK.
@kindex C-c -
@item C-c -
+@findex org-ctrl-c-minus
+(@code{org-ctrl-c-minus})
Cycle the entire list level through the different itemize/enumerate bullets
(@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
argument N, select the Nth bullet from this list. If there is an active
@@ -1417,6 +1455,8 @@ list. Finally, even without an active region, a normal line will be
converted into a list item.
@kindex C-c *
@item C-c *
+@findex org-ctrl-c-star
+(@code{org-ctrl-c-star})
Turn a plain list item into a headline (so that it becomes a subheading at
its location). @xref{Structure editing}, for a detailed explanation.
@kindex S-@key{left}
@@ -1428,6 +1468,8 @@ anywhere in an item line, details depending on
@code{org-support-shift-select}.
@kindex C-c ^
@item C-c ^
+@findex org-sort
+(@code{org-sort})
Sort the plain list. You will be prompted for the sorting method:
numerically, alphabetically, by time, or by custom function.
@end table
@@ -1468,6 +1510,8 @@ done by state changes, use
@table @kbd
@kindex C-c C-z
@item C-c C-z
+@findex org-add-note
+(@code{org-add-note})
Add a time-stamped note to the LOGBOOK drawer.
@end table
@@ -1543,6 +1587,8 @@ for details.
@table @kbd
@kindex C-c C-x f
@item C-c C-x f
+@findex org-footnote-action
+(@code{org-footnote-action})
The footnote action command.
When the cursor is on a footnote reference, jump to the definition. When it
@@ -1587,6 +1633,8 @@ deletion.
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
If the cursor is on a footnote reference, jump to the definition. If it is a
the definition, jump back to the reference. When called at a footnote
location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
@@ -1697,6 +1745,8 @@ unpredictable for you, configure the variables
@tsubheading{Creation and conversion}
@kindex C-c |
@item C-c |
+@findex org-table-create-or-convert-from-region
+(@code{org-table-create-or-convert-from-region})
Convert the active region to table. If every line contains at least one
TAB character, the function assumes that the material is tab separated.
If every line contains a comma, comma-separated values (CSV) are assumed.
@@ -1712,6 +1762,8 @@ table. But it's easier just to start typing, like
@tsubheading{Re-aligning and field motion}
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
Re-align the table without moving the cursor.
@c
@kindex @key{TAB}
@@ -1768,6 +1820,8 @@ created below the current one.
@c
@kindex C-c -
@item C-c -
+@findex org-ctrl-c-minus
+(@code{org-ctrl-c-minus})
Insert a horizontal line below current row. With a prefix argument, the line
is created above the current line.
@c
@@ -1778,6 +1832,8 @@ below that line.
@c
@kindex C-c ^
@item C-c ^
+@findex org-sort
+(@code{org-sort})
Sort the table lines in the region. The position of point indicates the
column to be used for sorting, and the range of lines is the range
between the nearest horizontal separator lines, or the entire table. If
@@ -1791,17 +1847,23 @@ argument, alphabetic sorting will be case-sensitive.
@tsubheading{Regions}
@kindex C-c C-x M-w
@item C-c C-x M-w
+@findex org-copy-special
+(@code{org-copy-special})
Copy a rectangular region from a table to a special clipboard. Point and
mark determine edge fields of the rectangle. If there is no active region,
copy just the current field. The process ignores horizontal separator lines.
@c
@kindex C-c C-x C-w
@item C-c C-x C-w
+@findex org-cut-special
+(@code{org-cut-special})
Copy a rectangular region from a table to a special clipboard, and
blank all fields in the rectangle. So this is the ``cut'' operation.
@c
@kindex C-c C-x C-y
@item C-c C-x C-y
+@findex org-paste-special
+(@code{org-paste-special})
Paste a rectangular region into a table.
The upper left corner ends up in the current field. All involved fields
will be overwritten. If the rectangle does not fit into the present table,
@@ -1827,6 +1889,8 @@ field is made blank, and the content is appended to the field above.
@cindex transient mark mode
@kindex C-c +
@item C-c +
+@findex org-table-sum
+(@code{org-table-sum})
Sum the numbers in the current column, or in the rectangle defined by
the active region. The result is shown in the echo area and can
be inserted with @kbd{C-y}.
@@ -1845,6 +1909,8 @@ increment. This key is also used by shift-selection and related modes
@tsubheading{Miscellaneous}
@kindex C-c `
@item C-c `
+@findex org-table-edit-field
+(@code{org-table-edit-field})
Edit the current field in a separate window. This is useful for fields that
are not fully visible (@pxref{Column width and alignment}). When called with
a @kbd{C-u} prefix, just make the full field visible, so that it can be
@@ -1859,6 +1925,8 @@ the buffer and then converting the region to a table. Any prefix
argument is passed on to the converter, which uses it to determine the
separator.
@item C-c |
+@findex org-table-create-or-convert-from-region
+(@code{org-table-create-or-convert-from-region})
Tables can also be imported by pasting tabular text into the Org
buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
@kbd{C-c |} command (see above under @i{Creation and conversion}).
@@ -2375,6 +2443,8 @@ following command:
@table @kbd
@kindex C-c =
@item C-c =
+@findex org-table-eval-formula
+(@code{org-table-eval-formula})
Install a new formula for the current column and replace current field with
the result of the formula. The command prompts for a formula, with default
taken from the @samp{#+TBLFM} line, applies it to the current field and
@@ -2400,6 +2470,8 @@ if possible. If you prefer to only work with the internal format (like
@kindex C-c =
@kindex C-u C-c =
@item C-c =
+@findex org-table-eval-formula
+(@code{org-table-eval-formula})
@itemx C-u C-c =
Edit the formula associated with the current column/field in the
minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
@@ -2411,6 +2483,8 @@ can edit it directly in the field. The advantage over editing in the
minibuffer is that you can use the command @kbd{C-c ?}.
@kindex C-c ?
@item C-c ?
+@findex org-table-field-info
+(@code{org-table-field-info})
While editing a formula in a table field, highlight the field(s)
referenced by the reference at the cursor position in the formula.
@kindex C-c @}
@@ -2423,6 +2497,8 @@ force it with @kbd{C-c C-c}.
Toggle the formula debugger on and off. See below.
@kindex C-c '
@item C-c '
+@findex org-edit-special
+(@code{org-edit-special})
Edit all formulas for the current table in a special buffer, where the
formulas will be displayed one per line. If the current field has an
active formula, the cursor in the formula editor will mark it.
@@ -2433,14 +2509,20 @@ remove and add formulas, and use the following commands:
@kindex C-c C-c
@kindex C-x C-s
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
@itemx C-x C-s
Exit the formula editor and store the modified formulas. With @kbd{C-u}
prefix, also apply the new formulas to the entire table.
@kindex C-c C-q
@item C-c C-q
+@findex org-set-tags-command
+(@code{org-set-tags-command})
Exit the formula editor without installing changes.
@kindex C-c C-r
@item C-c C-r
+@findex org-reveal
+(@code{org-reveal})
Toggle all references in the formula editor between standard (like
@code{B3}) and internal (like @code{@@3$2}).
@kindex @key{TAB}
@@ -2511,6 +2593,8 @@ following commands:
@table @kbd
@kindex C-c *
@item C-c *
+@findex org-ctrl-c-star
+(@code{org-ctrl-c-star})
Recalculate the current row by first applying the stored column formulas
from left to right, and all field formulas in the current row.
@c
@@ -3003,6 +3087,8 @@ entry referenced by the current line.
@cindex completion, of links
@cindex inserting links
@item C-c C-l
+@findex org-insert-link
+(@code{org-insert-link})
@vindex org-keep-stored-link-after-insertion
Insert a link@footnote{ Note that you don't have to use this command to
insert a link. Links in Org are plain text, and you can type or paste them
@@ -3094,12 +3180,16 @@ images that do have a link description.
@cindex mark ring
@kindex C-c %
@item C-c %
+@findex org-mark-ring-push
+(@code{org-mark-ring-push})
Push the current position onto the mark ring, to be able to return
easily. Commands following an internal link do this automatically.
@c
@cindex links, returning to
@kindex C-c &
@item C-c &
+@findex org-mark-ring-goto
+(@code{org-mark-ring-goto})
Jump back to a recorded position. A position is recorded by the
commands following internal links, and by @kbd{C-c %}. Using this
command several times in direct succession moves through a ring of
@@ -3109,6 +3199,8 @@ previously recorded positions.
@kindex C-c C-x C-p
@cindex links, finding next/previous
@item C-c C-x C-n
+@findex org-next-link
+(@code{org-next-link})
@itemx C-c C-x C-p
Move forward/backward to the next link in the buffer. At the limit of
the buffer, the search fails once, and then wraps around. The key
@@ -3310,6 +3402,8 @@ The most important commands to work with TODO entries are:
@kindex C-c C-t
@cindex cycling, of TODO states
@item C-c C-t
+@findex org-todo
+(@code{org-todo})
Rotate the TODO state of the current item among
@example
@@ -3637,6 +3731,8 @@ example:
@table @kbd
@kindex C-c C-x o
@item C-c C-x o
+@findex org-toggle-ordered-property
+(@code{org-toggle-ordered-property})
@vindex org-track-ordered-property-with-tag
@cindex property, ORDERED
Toggle the @code{ORDERED} property of the current entry. A property is used
@@ -4076,11 +4172,15 @@ off a box while there are unchecked boxes above it.
@table @kbd
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
Toggle checkbox status or (with prefix arg) checkbox presence at point. With
double prefix argument, set it to @samp{[-]}, which is considered to be an
intermediate state.
@kindex C-c C-x C-b
@item C-c C-x C-b
+@findex org-toggle-checkbox
+(@code{org-toggle-checkbox})
Toggle checkbox status or (with prefix arg) checkbox presence at point. With
double prefix argument, set it to @samp{[-]}, which is considered to be an
intermediate state.
@@ -4102,6 +4202,8 @@ This works only if the cursor is already in a plain list item
(@pxref{Plain lists}).
@kindex C-c C-x o
@item C-c C-x o
+@findex org-toggle-ordered-property
+(@code{org-toggle-ordered-property})
@vindex org-track-ordered-property-with-tag
@cindex property, ORDERED
Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
@@ -4112,6 +4214,8 @@ for better visibility, customize the variable
@code{org-track-ordered-property-with-tag}.
@kindex C-c #
@item C-c #
+@findex org-update-statistics-cookies
+(@code{org-update-statistics-cookies})
Update the statistics cookie in the current outline entry. When called with
a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
@@ -4207,6 +4311,8 @@ also a special command for inserting tags:
@table @kbd
@kindex C-c C-q
@item C-c C-q
+@findex org-set-tags-command
+(@code{org-set-tags-command})
@cindex completion, of tags
@vindex org-tags-column
Enter new tags for the current headline. Org-mode will either offer
@@ -4218,6 +4324,8 @@ things look nice. TAGS are automatically realigned after promotion,
demotion, and TODO state changes (@pxref{TODO basics}).
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
@end table
@@ -4387,6 +4495,8 @@ information into special lists.
@kindex C-c \
@kindex C-c / m
@item C-c \
+@findex org-match-sparse-tree
+(@code{org-match-sparse-tree})
@itemx C-c / m
Create a sparse tree with all headlines matching a tags search. With a
@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
@@ -4502,6 +4612,8 @@ After an initial colon in a line, complete property keys. All keys used
in the current file will be offered as possible completions.
@kindex C-c C-x p
@item C-c C-x p
+@findex org-set-property
+(@code{org-set-property})
Set a property. This prompts for a property name and a value. If
necessary, the property drawer is created as well.
@item M-x org-insert-property-drawer
@@ -4510,6 +4622,8 @@ inserted early in the entry, but after the lines with planning
information like deadlines.
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
With the cursor in a property drawer, this executes property commands.
@item C-c C-c s
Set a property in the current entry. Both the property and the value
@@ -4580,6 +4694,8 @@ the same commands are used as for tag searches (@pxref{Tag searches}).
@kindex C-c \
@kindex C-c / m
@item C-c \
+@findex org-match-sparse-tree
+(@code{org-match-sparse-tree})
@itemx C-c / m
Create a sparse tree with all matching entries. With a
@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
@@ -4816,6 +4932,8 @@ in the subtree.
@tsubheading{Turning column view on and off}
@kindex C-c C-x C-c
@item C-c C-x C-c
+@findex org-columns
+(@code{org-columns})
@vindex org-columns-default-format
Turn on column view. If the cursor is before the first headline in the file,
column view is turned on for the entire file, using the @code{#+COLUMNS}
@@ -4857,6 +4975,8 @@ property. For example, when editing a TAGS property, the tag completion
or fast selection interface will pop up.
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
When there is a checkbox at point, toggle it.
@kindex v
@item v
@@ -4935,10 +5055,14 @@ The following commands insert or update the dynamic block:
@table @kbd
@kindex C-c C-x i
@item C-c C-x i
+@findex org-insert-columns-dblock
+(@code{org-insert-columns-dblock})
Insert a dynamic block capturing a column view. You will be prompted
for the scope or ID of the view.
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
@kindex C-c C-x C-u
@itemx C-c C-x C-u
Update dynamic block at point. The cursor needs to be in the
@@ -5085,6 +5209,8 @@ format.
@table @kbd
@kindex C-c .
@item C-c .
+@findex org-time-stamp
+(@code{org-time-stamp})
Prompt for a date and insert a corresponding timestamp. When the cursor is
at an existing timestamp in the buffer, the command is used to modify this
timestamp instead of inserting a new one. When this command is used twice in
@@ -5092,6 +5218,8 @@ succession, a time range is inserted.
@c
@kindex C-c !
@item C-c !
+@findex org-time-stamp-inactive
+(@code{org-time-stamp-inactive})
Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
an agenda entry.
@c
@@ -5106,16 +5234,22 @@ minutes, see the option @code{org-time-stamp-rounding-minutes}.
@c
@kindex C-c <
@item C-c <
+@findex org-date-from-calendar
+(@code{org-date-from-calendar})
Insert a timestamp corresponding to the cursor date in the Calendar.
@c
@kindex C-c >
@item C-c >
+@findex org-goto-calendar
+(@code{org-goto-calendar})
Access the Emacs calendar for the current date. If there is a
timestamp in the current line, go to the corresponding date
instead.
@c
@kindex C-c C-o
@item C-c C-o
+@findex org-open-at-point
+(@code{org-open-at-point})
Access the agenda for the date given by the timestamp or -range at
point (@pxref{Weekly/daily agenda}).
@c
@@ -5142,6 +5276,8 @@ related modes (@pxref{Conflicts}).
@kindex C-c C-y
@cindex evaluate time range
@item C-c C-y
+@findex org-evaluate-time-range
+(@code{org-evaluate-time-range})
Evaluate a time range by computing the difference between start and end.
With a prefix argument, insert result after the time range (in a table: into
the following column).
@@ -5279,6 +5415,8 @@ customizing the variables @code{org-display-custom-times} and
@table @kbd
@kindex C-c C-x C-t
@item C-c C-x C-t
+@findex org-toggle-time-stamp-overlays
+(@code{org-toggle-time-stamp-overlays})
Toggle the display of custom formats for dates and times.
@end table
@@ -5396,6 +5534,8 @@ an item:
@c
@kindex C-c C-d
@item C-c C-d
+@findex org-deadline
+(@code{org-deadline})
Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
in the line directly following the headline. When called with a prefix arg,
an existing deadline will be removed from the entry. Depending on the
@@ -5407,6 +5547,8 @@ deadline.
@c
@kindex C-c C-s
@item C-c C-s
+@findex org-schedule
+(@code{org-schedule})
Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
happen in the line directly following the headline. Any CLOSED timestamp
will be removed. When called with a prefix argument, remove the scheduling
@@ -5420,6 +5562,8 @@ scheduling time.
@kindex k a
@kindex k s
@item C-c C-x C-k
+@findex org-mark-entry-for-agenda-action
+(@code{org-mark-entry-for-agenda-action})
Mark the current entry for agenda action. After you have marked the entry
like this, you can open the agenda or the calendar to find an appropriate
date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
@@ -5582,6 +5726,8 @@ show all time clocked on this tasks today (see also the variable
mode line entry will pop up a menu with clocking options.
@kindex C-c C-x C-o
@item C-c C-x C-o
+@findex org-clock-out
+(@code{org-clock-out})
@vindex org-log-note-clock-out
Stop the clock (clock-out). This inserts another timestamp at the same
location where the clock was last started. It also directly computes
@@ -5601,19 +5747,27 @@ is only necessary if you edit the timestamps directly. If you change
them with @kbd{S-@key{cursor}} keys, the update is automatic.
@kindex C-c C-t
@item C-c C-t
+@findex org-todo
+(@code{org-todo})
Changing the TODO state of an item to DONE automatically stops the clock
if it is running in this same item.
@kindex C-c C-x C-x
@item C-c C-x C-x
+@findex org-clock-cancel
+(@code{org-clock-cancel})
Cancel the current clock. This is useful if a clock was started by
mistake, or if you ended up working on something else.
@kindex C-c C-x C-j
@item C-c C-x C-j
+@findex org-clock-goto
+(@code{org-clock-goto})
Jump to the entry that contains the currently running clock. With a
@kbd{C-u} prefix arg, select the target task from a list of recently clocked
tasks.
@kindex C-c C-x C-d
@item C-c C-x C-d
+@findex org-clock-display
+(@code{org-clock-display})
@vindex org-remove-highlights-with-change
Display time summaries for each subtree in the current buffer. This
puts overlays at the end of each headline, showing the total time
@@ -5623,6 +5777,8 @@ when you change the buffer (see variable
@code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
@kindex C-c C-x C-r
@item C-c C-x C-r
+@findex org-clock-report
+(@code{org-clock-report})
Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
report as an Org-mode table into the current file. When the cursor is
at an existing clock table, just update it. When called with a prefix
@@ -5697,6 +5853,8 @@ A summary of the current subtree with % times would be
@end example
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
@kindex C-c C-x C-u
@itemx C-c C-x C-u
Update dynamic block at point. The cursor needs to be in the
@@ -5804,6 +5962,8 @@ for an entry with the following commands:
@table @kbd
@kindex C-c C-x e
@item C-c C-x e
+@findex org-set-effort
+(@code{org-set-effort})
Set the effort estimate for the current entry. With a numeric prefix
argument, set it to the NTH allowed value (see below). This command is also
accessible from the agenda with the @kbd{e} key.
@@ -5862,11 +6022,15 @@ such a relative timer and make it easy to create timed notes.
@table @kbd
@kindex C-c C-x .
@item C-c C-x .
+@findex org-timer
+(@code{org-timer})
Insert a relative time into the buffer. The first time you use this, the
timer will be started. When called with a prefix argument, the timer is
restarted.
@kindex C-c C-x -
@item C-c C-x -
+@findex org-timer-item
+(@code{org-timer-item})
Insert a description list item with the current relative time. With a prefix
argument, first reset the timer to 0.
@kindex M-@key{RET}
@@ -5883,6 +6047,8 @@ Stop the timer. After this, you can only start a new timer, not continue the
old one. This command also removes the timer from the mode line.
@kindex C-c C-x 0
@item C-c C-x 0
+@findex org-timer-start
+(@code{org-timer-start})
Reset the timer without inserting anything into the buffer. By default, the
timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
specific starting offset. The user is prompted for the offset, with a
@@ -5970,17 +6136,23 @@ node. You may then insert the information you want.
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
Once you have finished entering information into the capture buffer,
@kbd{C-c C-c} will return you to the window configuration before the capture
process, so that you can resume your work without further distraction.
@kindex C-c C-w
@item C-c C-w
+@findex org-refile
+(@code{org-refile})
Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
a different place.
@kindex C-c C-k
@item C-c C-k
+@findex org-kill-note-or-show-branches
+(@code{org-kill-note-or-show-branches})
Abort the capture process and return to the previous state.
@end table
@@ -6260,6 +6432,8 @@ directory.
@kindex C-c C-a
@item C-c C-a
+@findex org-attach
+(@code{org-attach})
The dispatcher for commands related to the attachment system. After these
keys, a list of commands is displayed and you must press an additional key
to select a command:
@@ -6359,10 +6533,14 @@ the following command is used:
@table @kbd
@kindex C-c C-x g
@item C-c C-x g
+@findex org-feed-update-all
+(@code{org-feed-update-all})
Collect items from the feeds configured in @code{org-feed-alist} and act upon
them.
@kindex C-c C-x G
@item C-c C-x G
+@findex org-feed-goto-inbox
+(@code{org-feed-goto-inbox})
Prompt for a feed name and go to the inbox configured for this feed.
@end table
@@ -6404,6 +6582,8 @@ process, you can use the following special command:
@table @kbd
@kindex C-c C-w
@item C-c C-w
+@findex org-refile
+(@code{org-refile})
@vindex org-reverse-note-order
@vindex org-refile-targets
@vindex org-refile-use-outline-path
@@ -6454,6 +6634,8 @@ searches like the construction of agenda views fast.
@table @kbd
@kindex C-c C-x C-a
@item C-c C-x C-a
+@findex org-archive-subtree-default
+(@code{org-archive-subtree-default})
@vindex org-archive-default-command
Archive the current entry using the command specified in the variable
@code{org-archive-default-command}.
@@ -6564,6 +6746,8 @@ The following commands help manage the ARCHIVE tag:
@table @kbd
@kindex C-c C-x a
@item C-c C-x a
+@findex org-toggle-archive-tag
+(@code{org-toggle-archive-tag})
Toggle the ARCHIVE tag for the current headline. When the tag is set,
the headline changes to a shadowed face, and the subtree below it is
hidden.
@@ -6579,6 +6763,8 @@ level 1 trees will be checked.
Cycle a tree even if it is tagged with ARCHIVE.
@kindex C-c C-x A
@item C-c C-x A
+@findex org-archive-to-archive-sibling
+(@code{org-archive-to-archive-sibling})
Move the current entry to the @emph{Archive Sibling}. This is a sibling of
the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
entry becomes a child of that sibling and in this way retains a lot of its
@@ -6673,11 +6859,15 @@ the easiest way to maintain it is through the following commands
@table @kbd
@kindex C-c [
@item C-c [
+@findex org-agenda-file-to-front
+(@code{org-agenda-file-to-front})
Add current file to the list of agenda files. The file is added to
the front of the list. If it was already in the list, it is moved to
the front. With a prefix argument, file is added/moved to the end.
@kindex C-c ]
@item C-c ]
+@findex org-remove-file
+(@code{org-remove-file})
Remove current file from the list of agenda files.
@kindex C-,
@kindex C-'
@@ -6704,6 +6894,8 @@ extended period, use the following commands:
@table @kbd
@kindex C-c C-x <
@item C-c C-x <
+@findex org-agenda-set-restriction-lock
+(@code{org-agenda-set-restriction-lock})
Permanently restrict the agenda to the current subtree. When with a
prefix argument, or with the cursor before the first headline in a file,
the agenda scope is set to the entire file. This restriction remains in
@@ -6712,6 +6904,8 @@ or @kbd{>} in the agenda dispatcher. If there is a window displaying an
agenda view, the new restriction takes effect immediately.
@kindex C-c C-x >
@item C-c C-x >
+@findex org-agenda-remove-restriction-lock
+(@code{org-agenda-remove-restriction-lock})
Remove the permanent restriction created by @kbd{C-c C-x <}.
@end table
@@ -7436,6 +7630,8 @@ agenda buffers can be set with the variable
@c
@kindex C-c C-x b
@item C-c C-x b
+@findex org-tree-to-indirect-buffer
+(@code{org-tree-to-indirect-buffer})
Display the entire subtree of the current item in an indirect buffer. With a
numeric prefix argument N, go up to level N and then take that tree. If N is
negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
@@ -7443,6 +7639,8 @@ previously used indirect buffer.
@kindex C-c C-o
@item C-c C-o
+@findex org-open-at-point
+(@code{org-open-at-point})
Follow a link in the entry. This will offer a selection of any links in the
text belonging to the referenced Org node. If there is only one link, it
will be followed without a selection prompt.
@@ -7575,6 +7773,8 @@ IDs.
@c
@kindex C-c C-x C-c
@item C-c C-x C-c
+@findex org-columns
+(@code{org-columns})
@vindex org-columns-default-format
Invoke column view (@pxref{Column view}) in the agenda buffer. The column
view format is taken from the entry at point, or (if there is no entry at
@@ -7585,6 +7785,8 @@ that entry would be in the original buffer (taken from a property, from a
@kindex C-c C-x >
@item C-c C-x >
+@findex org-agenda-remove-restriction-lock
+(@code{org-agenda-remove-restriction-lock})
Remove the restriction lock on the agenda, if it is currently restricted to a
file or subtree (@pxref{Agenda files}).
@@ -7718,6 +7920,8 @@ variable @code{org-agenda-confirm-kill}.
@c
@kindex C-c C-w
@item C-c C-w
+@findex org-refile
+(@code{org-refile})
Refile the entry at point.
@c
@kindex C-c C-x C-a
@@ -7730,10 +7934,14 @@ archiving command set in @code{org-archive-default-command}. When using the
@c
@kindex C-c C-x a
@item C-c C-x a
+@findex org-toggle-archive-tag
+(@code{org-toggle-archive-tag})
Toggle the ARCHIVE tag for the current headline.
@c
@kindex C-c C-x A
@item C-c C-x A
+@findex org-archive-to-archive-sibling
+(@code{org-archive-to-archive-sibling})
Move the subtree corresponding to the current entry to its @emph{archive
sibling}.
@c
@@ -7790,14 +7998,20 @@ same location where state change notes are put. Depending on
@c
@kindex C-c C-a
@item C-c C-a
+@findex org-attach
+(@code{org-attach})
Dispatcher for all command related to attachments.
@c
@kindex C-c C-s
@item C-c C-s
+@findex org-schedule
+(@code{org-schedule})
Schedule this item, with prefix arg remove the scheduling timestamp
@c
@kindex C-c C-d
@item C-c C-d
+@findex org-deadline
+(@code{org-deadline})
Set a deadline for this item, with prefix arg remove the deadline.
@c
@kindex k
@@ -8318,6 +8532,8 @@ collected by certain criteria.
@table @kbd
@kindex C-c C-x C-c
@item C-c C-x C-c
+@findex org-columns
+(@code{org-columns})
Turn on column view in the agenda.
@end table
@@ -8579,6 +8795,8 @@ start it with @samp{#+ }. Also entire subtrees starting with the word
@table @kbd
@kindex C-c ;
@item C-c ;
+@findex org-toggle-comment
+(@code{org-toggle-comment})
Toggle the COMMENT keyword at the beginning of an entry.
@end table
@@ -8707,6 +8925,8 @@ areas in HTML export}.
@table @kbd
@kindex C-c '
@item C-c '
+@findex org-edit-special
+(@code{org-edit-special})
Edit the source code example at point in its native mode. This works by
switching to a temporary buffer with the source code. You need to exit by
pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
@@ -8757,6 +8977,8 @@ the selected markup. For example, to include a file as an item, use
@table @kbd
@kindex C-c '
@item C-c '
+@findex org-edit-special
+(@code{org-edit-special})
Visit the include file at point.
@end table
@@ -8979,6 +9201,8 @@ typeset expressions:
@table @kbd
@kindex C-c C-x C-l
@item C-c C-x C-l
+@findex org-preview-latex-fragment
+(@code{org-preview-latex-fragment})
Produce a preview image of the La@TeX{} fragment at point and overlay it
over the source code. If there is no fragment at point, process all
fragments in the current entry (between two headlines). When called
@@ -8987,6 +9211,8 @@ two prefix arguments, or when the cursor is before the first headline,
process the entire buffer.
@kindex C-c C-c
@item C-c C-c
+@findex org-ctrl-c-ctrl-c
+(@code{org-ctrl-c-ctrl-c})
Remove the overlay preview images.
@end table
@@ -9253,6 +9479,8 @@ the subtrees are exported.
@table @kbd
@kindex C-c C-e
@item C-c C-e
+@findex org-export
+(@code{org-export})
@vindex org-export-run-in-background
Dispatcher for export and publishing commands. Displays a help-window
listing the additional key(s) needed to launch an export or publishing
@@ -9971,6 +10199,8 @@ support with
@table @kbd
@kindex C-c C-b
@item C-c C-b
+@findex org-backward-same-level
+(@code{org-backward-same-level})
In @code{org-beamer-mode}, this key offers fast selection of a beamer
environment or the @code{BEAMER_col} property.
@end table
@@ -13026,10 +13256,14 @@ these tables directly in the buffer. Instead, you need to use the command
@table @kbd
@kindex C-c '
@item C-c '
+@findex org-edit-special
+(@code{org-edit-special})
Edit a @file{table.el} table. Works when the cursor is in a table.el table.
@c
@kindex C-c ~
@item C-c ~
+@findex org-table-create-with-table.el
+(@code{org-table-create-with-table.el})
Insert a @file{table.el} table. If there is already a table at point, this
command converts it between the @file{table.el} format and the Org-mode
format. See the documentation string of the command
@@ -13669,6 +13903,8 @@ Dynamic blocks are updated with the following commands
@table @kbd
@kindex C-c C-x C-u
@item C-c C-x C-u
+@findex org-dblock-update
+(@code{org-dblock-update})
Update dynamic block at point.
@kindex C-u C-c C-x C-u
@item C-u C-c C-x C-u
[-- Attachment #3: Type: text/plain, Size: 201 bytes --]
_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply related [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-07-29 13:47 ` Andreas Röhler
2010-07-29 15:19 ` Andreas Röhler
@ 2010-07-31 8:53 ` Bastien
2010-07-31 17:53 ` Andreas Röhler
1 sibling, 1 reply; 44+ messages in thread
From: Bastien @ 2010-07-31 8:53 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
Hi Andreas,
Andreas Röhler <andreas.roehler@easy-emacs.de> writes:
> Please not I signed the FSF-disclaimer but not the paper transferring
> copyright under US-law.
Are you willing to sign those paper?
That would help, because the patch is more than 10 lines...
Thanks for your help,
--
Bastien
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-07-31 8:53 ` Bastien
@ 2010-07-31 17:53 ` Andreas Röhler
2010-07-31 19:02 ` Thomas S. Dye
2010-08-01 9:42 ` Bastien
0 siblings, 2 replies; 44+ messages in thread
From: Andreas Röhler @ 2010-07-31 17:53 UTC (permalink / raw)
To: emacs-orgmode
Am 31.07.2010 10:53, schrieb Bastien:
> Hi Andreas,
>
> Andreas Röhler<andreas.roehler@easy-emacs.de> writes:
>
>> Please not I signed the FSF-disclaimer but not the paper transferring
>> copyright under US-law.
>
> Are you willing to sign those paper?
>
> That would help, because the patch is more than 10 lines...
>
Hi Bastien,
please permit pointing at the silliness of such approaches, which state
a creative work starts upward from 10 lines.
No single haiku will ever have a change to be protected by that famous
US-copyright law.
I'm against spreading stupidity over the world and see with sorrow
people abiding to it.
It's quite the opposite of freedoms GPL promises BTW.
Beside: Writing a programs name at the side of it's key will remain a
trivial change even if this triviality is repeated.
So don't be afraid, if I refuse to sign which I think it's wrong from
bottom up.
It remains a trivial change, sure.
Andreas
> Thanks for your help,
>
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-07-31 17:53 ` Andreas Röhler
@ 2010-07-31 19:02 ` Thomas S. Dye
2010-08-01 9:42 ` Bastien
1 sibling, 0 replies; 44+ messages in thread
From: Thomas S. Dye @ 2010-07-31 19:02 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
Aloha Andreas,
I agree with you about the stupidity of the 10 line rule, and I
begrudge every bit of attention I have to squander on US copyright
law. However, if that law keeps like-minded individuals from working
together on a free project that requires a corporate entity to
complete long-term goals, then I think it will have achieved one of
its core goals. I'd hate to see that happen.
All the best,
Tom
On Jul 31, 2010, at 7:53 AM, Andreas Röhler wrote:
> Am 31.07.2010 10:53, schrieb Bastien:
>> Hi Andreas,
>>
>> Andreas Röhler<andreas.roehler@easy-emacs.de> writes:
>>
>>> Please not I signed the FSF-disclaimer but not the paper
>>> transferring
>>> copyright under US-law.
>>
>> Are you willing to sign those paper?
>>
>> That would help, because the patch is more than 10 lines...
>>
>
> Hi Bastien,
>
> please permit pointing at the silliness of such approaches, which
> state a creative work starts upward from 10 lines.
>
> No single haiku will ever have a change to be protected by that
> famous US-copyright law.
>
> I'm against spreading stupidity over the world and see with sorrow
> people abiding to it.
>
> It's quite the opposite of freedoms GPL promises BTW.
>
> Beside: Writing a programs name at the side of it's key will remain
> a trivial change even if this triviality is repeated.
>
> So don't be afraid, if I refuse to sign which I think it's wrong
> from bottom up.
> It remains a trivial change, sure.
>
>
> Andreas
>
>
>
>> Thanks for your help,
>>
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-07-31 17:53 ` Andreas Röhler
2010-07-31 19:02 ` Thomas S. Dye
@ 2010-08-01 9:42 ` Bastien
2010-08-01 16:40 ` Andreas Röhler
1 sibling, 1 reply; 44+ messages in thread
From: Bastien @ 2010-08-01 9:42 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
Hi Andreas,
Andreas Röhler <andreas.roehler@easy-emacs.de> writes:
> please permit pointing at the silliness of such approaches, which state
> a creative work starts upward from 10 lines.
>
> No single haiku will ever have a change to be protected by that famous
> US-copyright law.
>
> I'm against spreading stupidity over the world and see with sorrow
> people abiding to it.
I'm not following the US copyright law here, but Emacs contribution
policies:
,----[ etc/CONTRIBUTE ]
| * Copyright Assignment
|
| We can accept small changes (roughly, fewer than 15 lines) without
| legal papers. Anything more substantial requires a copyright
| disclaimer or assignment (the latter is preferred, especially for
| larger changes). Both of these involved filling out a short form and
| filing it with the FSF. The process is straightforward -- contact us
| at emacs-devel@gnu.org to obtain the relevant forms.
`----
It's not a matter of the change being trivial or not -- but of course,
it's even more frustrating not being able to apply your patch if it's
trivial :)
--
Bastien
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-01 9:42 ` Bastien
@ 2010-08-01 16:40 ` Andreas Röhler
0 siblings, 0 replies; 44+ messages in thread
From: Andreas Röhler @ 2010-08-01 16:40 UTC (permalink / raw)
To: emacs-orgmode
Am 01.08.2010 11:42, schrieb Bastien:
> Hi Andreas,
>
> Andreas Röhler<andreas.roehler@easy-emacs.de> writes:
>
>> please permit pointing at the silliness of such approaches, which state
>> a creative work starts upward from 10 lines.
>>
>> No single haiku will ever have a change to be protected by that famous
>> US-copyright law.
>>
>> I'm against spreading stupidity over the world and see with sorrow
>> people abiding to it.
>
> I'm not following the US copyright law here, but Emacs contribution
> policies:
>
> ,----[ etc/CONTRIBUTE ]
> | * Copyright Assignment
> |
> | We can accept small changes (roughly, fewer than 15 lines) without
> | legal papers. Anything more substantial requires a copyright
> | disclaimer or assignment (the latter is preferred, especially for
> | larger changes). Both of these involved filling out a short form and
> | filing it with the FSF. The process is straightforward -- contact us
> | at emacs-devel@gnu.org to obtain the relevant forms.
> `----
>
> It's not a matter of the change being trivial or not -- but of course,
> it's even more frustrating not being able to apply your patch if it's
> trivial :)
>
Hi Bastien,
the disclaimer mentioned above was signed long ago and FSF received it.
Does this solve the problem for now?
Andreas
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-07-28 19:36 keys and command name info Andreas Röhler
2010-07-29 6:45 ` Tassilo Horn
@ 2010-08-02 6:32 ` Carsten Dominik
2010-08-08 22:26 ` Gregor Zattler
2010-08-20 11:20 ` keys and command name info Carsten Dominik
2 siblings, 1 reply; 44+ messages in thread
From: Carsten Dominik @ 2010-08-02 6:32 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
Hi everyone,
just a quick note from an internet cafe:
I am not sure I would like such a change because I think it
makes the manual harder and less fluid to read and considerably longer.
Let's please hold off this change until I can take part in the
discussion
next week.
- Carsten
On Jul 28, 2010, at 9:36 PM, Andreas Röhler wrote:
>
> Hi,
>
> what about delivering mnemonic command names alongside
> with its keys in org-info?
>
> For example
>
> 8.1. Agenda files
>
> [ ... ]
> `C-c ['
> Add current file to the list of agenda files. The file is added
> to
> the front of the list. If it was already in the list, it is moved
> to the front. With prefix arg, file is added/moved to the end.
>
> might be provided as
>
> 8.1. Agenda files
>
> [ ... ]
> `C-c [', org-agenda-file-to-front
> Add current file to the list of agenda files. The file is added
> to
> the front of the list. If it was already in the list, it is moved
> to the front. With prefix arg, file is added/moved to the end.
>
>
> IMHO it's useful for emacs-beginners, but for hackers
> too, as remembering function names may precede
> remembering keys - which are to change individually
> anyway.
>
> Should you be interested, I'll consider to take action
> with texi-files.
>
>
> Andreas
>
> --
> https://code.launchpad.net/~a-roehler/python-mode
> https://code.launchpad.net/s-x-emacs-werkstatt/
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-07-30 9:40 ` Andreas Röhler
@ 2010-08-07 19:39 ` Carsten Dominik
2010-08-08 13:57 ` Andreas Röhler
0 siblings, 1 reply; 44+ messages in thread
From: Carsten Dominik @ 2010-08-07 19:39 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
On Jul 30, 2010, at 11:40 AM, Andreas Röhler wrote:
> Am 29.07.2010 20:08, schrieb Tassilo Horn:
>> Andreas Röhler<andreas.roehler@easy-emacs.de> writes:
>>
>>> attached another patch replacing the former, due to a bug at texi
>>
>> Please also add @findex{} entries.
>>
>> Bye,
>> Tassilo
>>
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>
> Done. Patch attached.
>
> Seems the functions index node remains to write.
>
> Looking into, I see a strange thing at line 14746:
>
> @node Variable Index, , Key Index, Top
What is wrong with this line?
I remember having some problems with the document structure
around the index - but somehow I am blind to see what is wrong.
Apparently you see something - what is it?
- Carsten
>
>
> Cheers
>
>
> Andreas
>
> --
> https://code.launchpad.net/~a-roehler/python-mode
> https://code.launchpad.net/s-x-emacs-werkstatt/
>
>
>
>
>
> <org-texi.patch>_______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-07 19:39 ` Carsten Dominik
@ 2010-08-08 13:57 ` Andreas Röhler
0 siblings, 0 replies; 44+ messages in thread
From: Andreas Röhler @ 2010-08-08 13:57 UTC (permalink / raw)
To: Carsten Dominik; +Cc: Tassilo Horn, emacs-orgmode
Am 07.08.2010 21:39, schrieb Carsten Dominik:
>
> On Jul 30, 2010, at 11:40 AM, Andreas Röhler wrote:
>
>> Am 29.07.2010 20:08, schrieb Tassilo Horn:
>>> Andreas Röhler<andreas.roehler@easy-emacs.de> writes:
>>>
>>>> attached another patch replacing the former, due to a bug at texi
>>>
>>> Please also add @findex{} entries.
>>>
>>> Bye,
>>> Tassilo
>>>
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>>
>>
>> Done. Patch attached.
>>
>> Seems the functions index node remains to write.
>>
>> Looking into, I see a strange thing at line 14746:
>>
>> @node Variable Index, , Key Index, Top
>
> What is wrong with this line?
> I remember having some problems with the document structure
> around the index - but somehow I am blind to see what is wrong.
> Apparently you see something - what is it?
>
> - Carsten
>
Hi Carsten,
empty space with colon followed by empty space looks strange for me.
Didn't mean wrong, just strange.
Just a question.
BTW, what's with the patch?
Do you want it?
If yes, I'll insert the index entry near this place still.
Andreas
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-08-02 6:32 ` Carsten Dominik
@ 2010-08-08 22:26 ` Gregor Zattler
2010-08-09 6:43 ` Carsten Dominik
0 siblings, 1 reply; 44+ messages in thread
From: Gregor Zattler @ 2010-08-08 22:26 UTC (permalink / raw)
To: emacs-orgmode
Hi Carsten, org-mode developers,
* Carsten Dominik <carsten.dominik@gmail.com> [02. Aug. 2010]:
> I am not sure I would like such a change because I think it
> makes the manual harder and less fluid to read and considerably longer.
It makes the manual longer as in bytes/bandwidth but not as in
lines which IMHO corresponds with the amount of time one needs to
read the manual.
If it's consistent within the manual it's IMHO not confusing or
harder to read because it's easy to skip.
To me actually this hints look like headings. They would support
me in skimming a section of commands in order to find the right
one. Those paragraphs with key sequences at the beginning are
hard to skim because all the info which stands out is not
relevant if one searches for a specific action.
Seeing how the command is named in the context of usage
information might help lisp novices in getting an idea why some
solutions work the way they do.
Just my 2¢, Gregor
> On Jul 28, 2010, at 9:36 PM, Andreas Röhler wrote:
>>what about delivering mnemonic command names alongside
>>with its keys in org-info?
>>
>>For example
>>
>>8.1. Agenda files
>>
>>[ ... ]
>>`C-c ['
>> Add current file to the list of agenda files. The file is added to
>> the front of the list. If it was already in the list, it is moved
>> to the front. With prefix arg, file is added/moved to the end.
>>
>>might be provided as
>>
>>8.1. Agenda files
>>
>>[ ... ]
>>`C-c [', org-agenda-file-to-front
>> Add current file to the list of agenda files. The file is added to
>> the front of the list. If it was already in the list, it is moved
>> to the front. With prefix arg, file is added/moved to the end.
>>
>>
>>IMHO it's useful for emacs-beginners, but for hackers
>>too, as remembering function names may precede
>>remembering keys - which are to change individually
>>anyway.
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-08 22:26 ` Gregor Zattler
@ 2010-08-09 6:43 ` Carsten Dominik
2010-08-09 9:37 ` Andreas Burtzlaff
` (2 more replies)
0 siblings, 3 replies; 44+ messages in thread
From: Carsten Dominik @ 2010-08-09 6:43 UTC (permalink / raw)
To: Gregor Zattler; +Cc: emacs-orgmode
On Aug 9, 2010, at 12:26 AM, Gregor Zattler wrote:
> Hi Carsten, org-mode developers,
> * Carsten Dominik <carsten.dominik@gmail.com> [02. Aug. 2010]:
>> I am not sure I would like such a change because I think it
>> makes the manual harder and less fluid to read and considerably
>> longer.
>
> It makes the manual longer as in bytes/bandwidth but not as in
> lines which IMHO corresponds with the amount of time one needs to
> read the manual.
>
> If it's consistent within the manual it's IMHO not confusing or
> harder to read because it's easy to skip.
>
> To me actually this hints look like headings. They would support
> me in skimming a section of commands in order to find the right
> one. Those paragraphs with key sequences at the beginning are
> hard to skim because all the info which stands out is not
> relevant if one searches for a specific action.
>
> Seeing how the command is named in the context of usage
> information might help lisp novices in getting an idea why some
> solutions work the way they do.
Hi Gregor, thanks for chiming in and summarizing your arguments.
And that you say it makes it easier to find the right command
may be a good argument to insert the command names.
Some of the original arguments, that these names would stick
more easily and that it would make it easy for a hacker to
find the command name for rebinding, these do not fly, I think.
I don't think anyone calls Org commands with M-x, and if a
hacker needs to find a command name, `C-h b' and in particular
`C-h k' are the perfect ways to get to the names.
I have put a version of the manual as modified by Andreas here:
http://orgmode.org/org-manual-with-command-names.pdf
Not all the command names are in there, but quite a few are.
I'd like to hear from more people
- if they would like to have the names there (i.e. if it would
help them finding a command)
- if the position (first thing in the command description)
is right, or if it would be better to have it
- last thing in the description
- or after the first sentence, this is how the GNUS manual
does it.
Thanks to Andreas for his work so far, and please, let me
hear more opinions.
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-08-09 6:43 ` Carsten Dominik
@ 2010-08-09 9:37 ` Andreas Burtzlaff
2010-08-09 10:19 ` Gregor Zattler
2010-08-09 14:23 ` Nick Dokos
2010-08-10 7:48 ` OT: smex.el (was Re: keys and command name info) Austin Frank
2 siblings, 1 reply; 44+ messages in thread
From: Andreas Burtzlaff @ 2010-08-09 9:37 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
Carsten Dominik <carsten.dominik@gmail.com> writes:
> On Aug 9, 2010, at 12:26 AM, Gregor Zattler wrote:
>
>> Hi Carsten, org-mode developers,
>> * Carsten Dominik <carsten.dominik@gmail.com> [02. Aug. 2010]:
>>> I am not sure I would like such a change because I think it
>>> makes the manual harder and less fluid to read and considerably
>>> longer.
>>
>> It makes the manual longer as in bytes/bandwidth but not as in
>> lines which IMHO corresponds with the amount of time one needs to
>> read the manual.
>>
>> If it's consistent within the manual it's IMHO not confusing or
>> harder to read because it's easy to skip.
>>
>> To me actually this hints look like headings. They would support
>> me in skimming a section of commands in order to find the right
>> one. Those paragraphs with key sequences at the beginning are
>> hard to skim because all the info which stands out is not
>> relevant if one searches for a specific action.
>>
>> Seeing how the command is named in the context of usage
>> information might help lisp novices in getting an idea why some
>> solutions work the way they do.
>
> Hi Gregor, thanks for chiming in and summarizing your arguments.
> And that you say it makes it easier to find the right command
> may be a good argument to insert the command names.
>
> Some of the original arguments, that these names would stick
> more easily and that it would make it easy for a hacker to
> find the command name for rebinding, these do not fly, I think.
> I don't think anyone calls Org commands with M-x, and if a
> hacker needs to find a command name, `C-h b' and in particular
> `C-h k' are the perfect ways to get to the names.
>
> I have put a version of the manual as modified by Andreas here:
>
> http://orgmode.org/org-manual-with-command-names.pdf
>
> Not all the command names are in there, but quite a few are.
> I'd like to hear from more people
>
> - if they would like to have the names there (i.e. if it would
> help them finding a command)
> - if the position (first thing in the command description)
> is right, or if it would be better to have it
> - last thing in the description
> - or after the first sentence, this is how the GNUS manual
> does it.
Having the function names in the manual at all makes it look a bit
overloaded and might lose us a couple of newbies, I think. Personally, I
would not have use for it.
If the names are included in the manual I strongly object to them being
at the beginning of the first sentence. The fixed starting column of the
sentences becomes variable and that makes it hard to skim through for
those who don't want to read the function names.
What about having them in the same line as the keybinding but aligned to
the right?
`C-c [' org-agenda-file-to-front
Add current file to the list of agenda files. The file is added to
the front of the list. If it was already in the list, it is moved
to the front. With prefix arg, file is added/moved to the end.
It would make the manual longer, but at least it looks clean.
It is easy to neglect the function names if one wants, and just as easy
to skim through them.
Andreas
>
> Thanks to Andreas for his work so far, and please, let me
> hear more opinions.
>
> - Carsten
>
>
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-08-09 9:37 ` Andreas Burtzlaff
@ 2010-08-09 10:19 ` Gregor Zattler
2010-08-09 10:31 ` Carsten Dominik
2010-08-09 18:32 ` Dan Davison
0 siblings, 2 replies; 44+ messages in thread
From: Gregor Zattler @ 2010-08-09 10:19 UTC (permalink / raw)
To: emacs-orgmode
Hi Andreas, org-mode developers,
* Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
> Carsten Dominik <carsten.dominik@gmail.com> writes:
>> I have put a version of the manual as modified by Andreas here:
>>
>> http://orgmode.org/org-manual-with-command-names.pdf
>>
>> Not all the command names are in there, but quite a few are.
>> I'd like to hear from more people
>>
>> - if they would like to have the names there (i.e. if it would
>> help them finding a command)
>> - if the position (first thing in the command description)
>> is right, or if it would be better to have it
>> - last thing in the description
>> - or after the first sentence, this is how the GNUS manual
>> does it.
>
> Having the function names in the manual at all makes it look a bit
> overloaded and might lose us a couple of newbies, I think. Personally, I
> would not have use for it.
>
> If the names are included in the manual I strongly object to them being
> at the beginning of the first sentence. The fixed starting column of the
> sentences becomes variable and that makes it hard to skim through for
> those who don't want to read the function names.
+1 for the same reasons.
This is especially true for paragraphs like those:
C-c C-n (outline-next-visible-heading) Next heading.
C-c C-p (outline-previous-visible-heading) Previous heading.
C-c C-f (org-forward-same-level) Next heading same level.
C-c C-b (org-backward-same-level) Previous heading same level.
C-c C-u (outline-up-heading) Backward to higher level heading.
C-c C-j (org-goto) Jump to a different place without changing the current outline
visibility. Shows the document structure in a temporary buffer, where you can
use the following keys to find your destination:
> What about having them in the same line as the keybinding but aligned to
> the right?
>
> `C-c [' org-agenda-file-to-front
> Add current file to the list of agenda files. The file is added to
> the front of the list. If it was already in the list, it is moved
> to the front. With prefix arg, file is added/moved to the end.
>
> It would make the manual longer, but at least it looks clean.
> It is easy to neglect the function names if one wants, and just as easy
> to skim through them.
+1 for the same reasons.
But Andreas Röhlers original variant is IMHO even better:
>| [ ... ]
>| `C-c [', org-agenda-file-to-front
>| Add current file to the list of agenda files. The file is added to
>| the front of the list. If it was already in the list, it is moved
>| to the front. With prefix Argument, file is added/moved to the end.
Here the command name serves as a kind of a heading, it's easy
to search these locations while at the same time it's easy to
skim over the pages and not bother with the command names.
My preference:
1. as in Andreas Röhlers original ASCII rendering
2. as in Andreas Burtzlaffs ASCII rendering
3. not at all
4. as in the test manual
Just me 2¢. Either way, org-mode is great. Gregor
P.S.: Some of the command names don't help that much:
C-c C-c (org-ctrl-c-ctrl-c) If there is a checkbox (see Section 5.6 [Checkboxes],
page 46) in the item line, toggle the state of the checkbox. If not, this command
makes sure that all the items on this list level use the same bullet. Furthermore,
if this is an ordered list, make sure the numbering is OK.
C-c - (org-ctrl-c-minus) Cycle the entire list level through the different item-
ize/enumerate bullets (`-', `+', `*', `1.', `1)'). With a numeric prefix argument
N, select the Nth bullet from this list. If there is an active region when calling
this, all lines will be converted to list items. If the first line already was a list
item, any item markers will be removed from the list. Finally, even without an
active region, a normal line will be converted into a list item.
C-c * (org-ctrl-c-star) Turn a plain list item into a headline (so that it becomes
a subheading at its location). See Section 2.5 [Structure editing], page 7, for a
detailed explanation.
But even this gives a clue in how it all works.
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-09 10:19 ` Gregor Zattler
@ 2010-08-09 10:31 ` Carsten Dominik
2010-08-09 18:32 ` Dan Davison
1 sibling, 0 replies; 44+ messages in thread
From: Carsten Dominik @ 2010-08-09 10:31 UTC (permalink / raw)
To: Gregor Zattler; +Cc: emacs-orgmode
On Aug 9, 2010, at 12:19 PM, Gregor Zattler wrote:
> Hi Andreas, org-mode developers,
> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>> I have put a version of the manual as modified by Andreas here:
>>>
>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>
>>> Not all the command names are in there, but quite a few are.
>>> I'd like to hear from more people
>>>
>>> - if they would like to have the names there (i.e. if it would
>>> help them finding a command)
>>> - if the position (first thing in the command description)
>>> is right, or if it would be better to have it
>>> - last thing in the description
>>> - or after the first sentence, this is how the GNUS manual
>>> does it.
>>
>> Having the function names in the manual at all makes it look a bit
>> overloaded and might lose us a couple of newbies, I think.
>> Personally, I
>> would not have use for it.
>>
>> If the names are included in the manual I strongly object to them
>> being
>> at the beginning of the first sentence. The fixed starting column
>> of the
>> sentences becomes variable and that makes it hard to skim through for
>> those who don't want to read the function names.
>
> +1 for the same reasons.
>
> This is especially true for paragraphs like those:
>
> C-c C-n (outline-next-visible-heading) Next heading.
> C-c C-p (outline-previous-visible-heading) Previous heading.
> C-c C-f (org-forward-same-level) Next heading same level.
> C-c C-b (org-backward-same-level) Previous heading same level.
> C-c C-u (outline-up-heading) Backward to higher level heading.
> C-c C-j (org-goto) Jump to a different place without changing the
> current outline
> visibility. Shows the document structure in a temporary
> buffer, where you can
> use the following keys to find your destination:
>
>
>> What about having them in the same line as the keybinding but
>> aligned to
>> the right?
>>
>> `C-c [' org-agenda-file-to-
>> front
>> Add current file to the list of agenda files. The file is
>> added to
>> the front of the list. If it was already in the list, it is
>> moved
>> to the front. With prefix arg, file is added/moved to the end.
>>
>> It would make the manual longer, but at least it looks clean.
>> It is easy to neglect the function names if one wants, and just as
>> easy
>> to skim through them.
>
> +1 for the same reasons.
> But Andreas Röhlers original variant is IMHO even better:
>
>> | [ ... ]
>> | `C-c [', org-agenda-file-to-front
>> | Add current file to the list of agenda files. The file is
>> added to
>> | the front of the list. If it was already in the list, it is
>> moved
>> | to the front. With prefix Argument, file is added/moved to
>> the end.
>
> Here the command name serves as a kind of a heading, it's easy
> to search these locations while at the same time it's easy to
> skim over the pages and not bother with the command names.
>
>
>
> My preference:
>
> 1. as in Andreas Röhlers original ASCII rendering
> 2. as in Andreas Burtzlaffs ASCII rendering
> 3. not at all
> 4. as in the test manual
>
>
>
> Just me 2¢. Either way, org-mode is great. Gregor
>
>
> P.S.: Some of the command names don't help that much:
>
> C-c C-c (org-ctrl-c-ctrl-c) If there is a checkbox (see Section 5.6
> [Checkboxes],
> page 46) in the item line, toggle the state of the checkbox.
> If not, this command
> makes sure that all the items on this list level use the same
> bullet. Furthermore,
> if this is an ordered list, make sure the numbering is OK.
> C-c - (org-ctrl-c-minus) Cycle the entire list level through the
> different item-
> ize/enumerate bullets (`-', `+', `*', `1.', `1)'). With a
> numeric prefix argument
> N, select the Nth bullet from this list. If there is an
> active region when calling
> this, all lines will be converted to list items. If the first
> line already was a list
> item, any item markers will be removed from the list.
> Finally, even without an
> active region, a normal line will be converted into a list
> item.
> C-c * (org-ctrl-c-star) Turn a plain list item into a headline (so
> that it becomes
> a subheading at its location). See Section 2.5 [Structure
> editing], page 7, for a
> detailed explanation.
For these cases the dispatcher command could be replaced with the
specific command that will be
called by the dispatcher when in this context......
- Carsten
>
> But even this gives a clue in how it all works.
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-09 6:43 ` Carsten Dominik
2010-08-09 9:37 ` Andreas Burtzlaff
@ 2010-08-09 14:23 ` Nick Dokos
2010-08-10 7:48 ` OT: smex.el (was Re: keys and command name info) Austin Frank
2 siblings, 0 replies; 44+ messages in thread
From: Nick Dokos @ 2010-08-09 14:23 UTC (permalink / raw)
To: Carsten Dominik; +Cc: nicholas.dokos, emacs-orgmode
Carsten Dominik <carsten.dominik@gmail.com> wrote:
> Some of the original arguments, that these names would stick
> more easily and that it would make it easy for a hacker to
> find the command name for rebinding, these do not fly, I think.
> I don't think anyone calls Org commands with M-x, and if a
> hacker needs to find a command name, `C-h b' and in particular
> `C-h k' are the perfect ways to get to the names.
>
> I have put a version of the manual as modified by Andreas here:
>
> http://orgmode.org/org-manual-with-command-names.pdf
>
> Not all the command names are in there, but quite a few are.
> I'd like to hear from more people
>
> - if they would like to have the names there (i.e. if it would
> help them finding a command)
> - if the position (first thing in the command description)
> is right, or if it would be better to have it
> - last thing in the description
> - or after the first sentence, this is how the GNUS manual
> does it.
>
> Thanks to Andreas for his work so far, and please, let me
> hear more opinions.
>
I have wished for the command names to be in the manual before but
as you say, C-h k works (although sometimes after the C-h k, I find myself
saying "Oh, that one...", whereas I could have said that with a couple
of keystrokes less if the name were in the manual :) )
As for the position, spot-checking the emacs manual shows the command
name at the end of the first sentence in the key description and right
after the key sequence in running text. Here's an example of both
instances:
,----
| `C-d'
| `<DELETE>'
| Delete next character (`delete-char'). If your keyboard has a
| <DELETE> function key (usually located in the edit keypad), Emacs
| binds it to `delete-char' as well.
|
| `<DEL>'
| `<BS>'
| Delete previous character (`delete-backward-char').
|
| `M-\'
| Delete spaces and tabs around point (`delete-horizontal-space').
|
| `M-<SPC>'
| Delete spaces and tabs around point, leaving one space
| (`just-one-space').
|
| `C-x C-o'
| Delete blank lines around the current line (`delete-blank-lines').
|
| `M-^'
| Join two lines by deleting the intervening newline, along with any
| indentation following it (`delete-indentation').
|
| The most basic delete commands are `C-d' (`delete-char') and <DEL>
| (`delete-backward-char'). `C-d' deletes the character after point, the
| ...
`----
I would vote for consistency above all.
I also think (in contrast to Andreas Burtzlaff) that this helps
newbies : I remember finding it very helpful when I first started
writing elisp. And I also remember the (momentary) annoyance I felt when
I was first reading the Org manual: I was used to the emacs manual
conventions and habits die hard!
My 2 cents,
Nick
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-08-09 10:19 ` Gregor Zattler
2010-08-09 10:31 ` Carsten Dominik
@ 2010-08-09 18:32 ` Dan Davison
2010-08-09 19:28 ` Dan Davison
2010-08-10 1:28 ` Memnon Anon
1 sibling, 2 replies; 44+ messages in thread
From: Dan Davison @ 2010-08-09 18:32 UTC (permalink / raw)
To: emacs-orgmode
Gregor Zattler <telegraph@gmx.net> writes:
> Hi Andreas, org-mode developers,
> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>> I have put a version of the manual as modified by Andreas here:
>>>
>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>
>>> Not all the command names are in there, but quite a few are.
>>> I'd like to hear from more people
>>>
>>> - if they would like to have the names there (i.e. if it would
>>> help them finding a command)
I would like the command names in the manual.
- Emacs-lisp has a lovely tradition of naming functions *very*
descriptively and not being afraid to use long names in the interests
of accuracy. It's a shame to lose all that by displaying only key
sequences. It's a linguistic world of its own and I like being exposed
to it.
- While one can do C-h k, that's not the same as the way one learns the
function names by skimming the manual
>>> - if the position (first thing in the command description)
>>> is right, or if it would be better to have it
>>> - last thing in the description
>>> - or after the first sentence, this is how the GNUS manual
>>> does it.
I definitely would want them out on a line of their own with the key
sequence. I liked the right-aligned model.
Or if not right-aligned, is it possible not to have the comma? Maybe a
different font?
Dan
>>
>> Having the function names in the manual at all makes it look a bit
>> overloaded and might lose us a couple of newbies, I think. Personally, I
>> would not have use for it.
>>
>> If the names are included in the manual I strongly object to them being
>> at the beginning of the first sentence. The fixed starting column of the
>> sentences becomes variable and that makes it hard to skim through for
>> those who don't want to read the function names.
>
> +1 for the same reasons.
>
> This is especially true for paragraphs like those:
>
> C-c C-n (outline-next-visible-heading) Next heading.
> C-c C-p (outline-previous-visible-heading) Previous heading.
> C-c C-f (org-forward-same-level) Next heading same level.
> C-c C-b (org-backward-same-level) Previous heading same level.
> C-c C-u (outline-up-heading) Backward to higher level heading.
> C-c C-j (org-goto) Jump to a different place without changing the current outline
> visibility. Shows the document structure in a temporary buffer, where you can
> use the following keys to find your destination:
>
>
>> What about having them in the same line as the keybinding but aligned to
>> the right?
>>
>> `C-c [' org-agenda-file-to-front
>> Add current file to the list of agenda files. The file is added to
>> the front of the list. If it was already in the list, it is moved
>> to the front. With prefix arg, file is added/moved to the end.
>>
>> It would make the manual longer, but at least it looks clean.
>> It is easy to neglect the function names if one wants, and just as easy
>> to skim through them.
>
> +1 for the same reasons.
> But Andreas Röhlers original variant is IMHO even better:
>
>>| [ ... ]
>>| `C-c [', org-agenda-file-to-front
>>| Add current file to the list of agenda files. The file is added to
>>| the front of the list. If it was already in the list, it is moved
>>| to the front. With prefix Argument, file is added/moved to the end.
Yes, but let's lose the extra comma.
`C-c [' org-agenda-file-to-front
>
> Here the command name serves as a kind of a heading, it's easy
> to search these locations while at the same time it's easy to
> skim over the pages and not bother with the command names.
>
>
>
> My preference:
>
> 1. as in Andreas Röhlers original ASCII rendering
> 2. as in Andreas Burtzlaffs ASCII rendering
> 3. not at all
> 4. as in the test manual
>
>
>
> Just me 2¢. Either way, org-mode is great. Gregor
>
>
> P.S.: Some of the command names don't help that much:
>
> C-c C-c (org-ctrl-c-ctrl-c) If there is a checkbox (see Section 5.6 [Checkboxes],
> page 46) in the item line, toggle the state of the checkbox. If not, this command
> makes sure that all the items on this list level use the same bullet. Furthermore,
> if this is an ordered list, make sure the numbering is OK.
> C-c - (org-ctrl-c-minus) Cycle the entire list level through the different item-
> ize/enumerate bullets (`-', `+', `*', `1.', `1)'). With a numeric prefix argument
> N, select the Nth bullet from this list. If there is an active region when calling
> this, all lines will be converted to list items. If the first line already was a list
> item, any item markers will be removed from the list. Finally, even without an
> active region, a normal line will be converted into a list item.
> C-c * (org-ctrl-c-star) Turn a plain list item into a headline (so that it becomes
> a subheading at its location). See Section 2.5 [Structure editing], page 7, for a
> detailed explanation.
>
> But even this gives a clue in how it all works.
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-08-09 18:32 ` Dan Davison
@ 2010-08-09 19:28 ` Dan Davison
2010-08-11 10:05 ` Carsten Dominik
2010-08-10 1:28 ` Memnon Anon
1 sibling, 1 reply; 44+ messages in thread
From: Dan Davison @ 2010-08-09 19:28 UTC (permalink / raw)
To: emacs-orgmode
Dan Davison <davison@stats.ox.ac.uk> writes:
> Gregor Zattler <telegraph@gmx.net> writes:
>
>> Hi Andreas, org-mode developers,
>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>> I have put a version of the manual as modified by Andreas here:
>>>>
>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>
>>>> Not all the command names are in there, but quite a few are.
>>>> I'd like to hear from more people
>>>>
>>>> - if they would like to have the names there (i.e. if it would
>>>> help them finding a command)
>
> I would like the command names in the manual.
>
> - Emacs-lisp has a lovely tradition of naming functions *very*
> descriptively and not being afraid to use long names in the interests
> of accuracy. It's a shame to lose all that by displaying only key
> sequences. It's a linguistic world of its own and I like being exposed
> to it.
> - While one can do C-h k, that's not the same as the way one learns the
> function names by skimming the manual
Also, it does not add length to the HTML version of the manual, because
the key sequences are already on a line of their own. And the same is
true for a certain proportion of the pdf entries (when the key sequence
is long, then it seems to go on its own line).
>
>>>> - if the position (first thing in the command description)
>>>> is right, or if it would be better to have it
>>>> - last thing in the description
>>>> - or after the first sentence, this is how the GNUS manual
>>>> does it.
>
> I definitely would want them out on a line of their own with the key
> sequence. I liked the right-aligned model.
>
> Or if not right-aligned, is it possible not to have the comma? Maybe a
> different font?
>
> Dan
>
>>>
>>> Having the function names in the manual at all makes it look a bit
>>> overloaded and might lose us a couple of newbies, I think. Personally, I
>>> would not have use for it.
>>>
>>> If the names are included in the manual I strongly object to them being
>>> at the beginning of the first sentence. The fixed starting column of the
>>> sentences becomes variable and that makes it hard to skim through for
>>> those who don't want to read the function names.
>>
>> +1 for the same reasons.
>>
>> This is especially true for paragraphs like those:
>>
>> C-c C-n (outline-next-visible-heading) Next heading.
>> C-c C-p (outline-previous-visible-heading) Previous heading.
>> C-c C-f (org-forward-same-level) Next heading same level.
>> C-c C-b (org-backward-same-level) Previous heading same level.
>> C-c C-u (outline-up-heading) Backward to higher level heading.
>> C-c C-j (org-goto) Jump to a different place without changing the current outline
>> visibility. Shows the document structure in a temporary buffer, where you can
>> use the following keys to find your destination:
>>
>>
>>> What about having them in the same line as the keybinding but aligned to
>>> the right?
>>>
>>> `C-c [' org-agenda-file-to-front
>>> Add current file to the list of agenda files. The file is added to
>>> the front of the list. If it was already in the list, it is moved
>>> to the front. With prefix arg, file is added/moved to the end.
>>>
>>> It would make the manual longer, but at least it looks clean.
>>> It is easy to neglect the function names if one wants, and just as easy
>>> to skim through them.
>>
>> +1 for the same reasons.
>> But Andreas Röhlers original variant is IMHO even better:
>>
>>>| [ ... ]
>>>| `C-c [', org-agenda-file-to-front
>>>| Add current file to the list of agenda files. The file is added to
>>>| the front of the list. If it was already in the list, it is moved
>>>| to the front. With prefix Argument, file is added/moved to the end.
>
> Yes, but let's lose the extra comma.
>
> `C-c [' org-agenda-file-to-front
>
>
>
>
>
>>
>> Here the command name serves as a kind of a heading, it's easy
>> to search these locations while at the same time it's easy to
>> skim over the pages and not bother with the command names.
>>
>>
>>
>> My preference:
>>
>> 1. as in Andreas Röhlers original ASCII rendering
>> 2. as in Andreas Burtzlaffs ASCII rendering
>> 3. not at all
>> 4. as in the test manual
>>
>>
>>
>> Just me 2¢. Either way, org-mode is great. Gregor
>>
>>
>> P.S.: Some of the command names don't help that much:
>>
>> C-c C-c (org-ctrl-c-ctrl-c) If there is a checkbox (see Section 5.6 [Checkboxes],
>> page 46) in the item line, toggle the state of the checkbox. If not, this command
>> makes sure that all the items on this list level use the same bullet. Furthermore,
>> if this is an ordered list, make sure the numbering is OK.
>> C-c - (org-ctrl-c-minus) Cycle the entire list level through the different item-
>> ize/enumerate bullets (`-', `+', `*', `1.', `1)'). With a numeric prefix argument
>> N, select the Nth bullet from this list. If there is an active region when calling
>> this, all lines will be converted to list items. If the first line already was a list
>> item, any item markers will be removed from the list. Finally, even without an
>> active region, a normal line will be converted into a list item.
>> C-c * (org-ctrl-c-star) Turn a plain list item into a headline (so that it becomes
>> a subheading at its location). See Section 2.5 [Structure editing], page 7, for a
>> detailed explanation.
>>
>> But even this gives a clue in how it all works.
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-08-09 18:32 ` Dan Davison
2010-08-09 19:28 ` Dan Davison
@ 2010-08-10 1:28 ` Memnon Anon
1 sibling, 0 replies; 44+ messages in thread
From: Memnon Anon @ 2010-08-10 1:28 UTC (permalink / raw)
To: Dan Davison; +Cc: emacs-orgmode
Dan Davison <davison@stats.ox.ac.uk> writes:
> I would like the command names in the manual.
>
> - Emacs-lisp has a lovely tradition of naming functions *very*
> descriptively and not being afraid to use long names in the interests
> of accuracy. It's a shame to lose all that by displaying only key
> sequences. It's a linguistic world of its own and I like being exposed
> to it.
> - While one can do C-h k, that's not the same as the way one learns the
> function names by skimming the manual
I am 'just a user', with next to nothing elisp skills under his belt.
However, I am willing to learn and I try to modify simple bits to the
best of my abilities.
So, I should probably argue against inclusion of the command names...
But I do not.
I got into Emacs because of orgmode, but I did not stop there.
The Info system is just great for discovering lots of possibilities, and
I really got accustomed to seeing the elisp commands associated to the
keybindings. Somehow, from the start right until this thread started, it
feld curious to me that these are not "right there".
Sure, I have less need for them in orgmode than in, say w3m or gnus,
because the defaults are so great I never considered to change them, but
I (as a still fairly recent Emacs user) felt the documentation - as
great as it is! - to be somewhat out of the line in this regard.
I do not see my behaviour will change over the times to come, and right,
`C-h k' is available to everyone, but I still would humbly vote for
following the accustomed style, i.e. including the elisp function
names.
It is, in my case, rather a vote motivated by consistency.
Memnon
^ permalink raw reply [flat|nested] 44+ messages in thread
* OT: smex.el (was Re: keys and command name info)
2010-08-09 6:43 ` Carsten Dominik
2010-08-09 9:37 ` Andreas Burtzlaff
2010-08-09 14:23 ` Nick Dokos
@ 2010-08-10 7:48 ` Austin Frank
2 siblings, 0 replies; 44+ messages in thread
From: Austin Frank @ 2010-08-10 7:48 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
[-- Attachment #1.1: Type: text/plain, Size: 994 bytes --]
On Mon, Aug 09 2010, Carsten Dominik wrote:
> I don't think anyone calls Org commands with M-x, and if a hacker
> needs to find a command name, `C-h b' and in particular `C-h k' are
> the perfect ways to get to the names.
I don't have a horse in this race, but I will note that I call Org
commands with M-x /all the time/. There's just so much functionality
that even when keybindings exist I may not know them. And of course I
don't use the menu because that would require reaching for the mouse ;)
For anyone else in this situation, I can't recommend strongly enough the
package smex.el (I get it from http://github.com/nonsequitur/smex/, but
it's also in the Emacs Lisp Package Archive). It offers ido-like
completion for function names. For me, this makes the entire emacs
environment, but Org especially, much more discoverable via the M-x
interface.
HTH,
/au
--
Austin Frank
http://aufrank.net
GPG Public Key (D7398C2F): http://aufrank.net/personal.asc
[-- Attachment #1.2: Type: application/pgp-signature, Size: 194 bytes --]
[-- Attachment #2: Type: text/plain, Size: 201 bytes --]
_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-09 19:28 ` Dan Davison
@ 2010-08-11 10:05 ` Carsten Dominik
2010-08-11 10:23 ` Andreas Röhler
` (2 more replies)
0 siblings, 3 replies; 44+ messages in thread
From: Carsten Dominik @ 2010-08-11 10:05 UTC (permalink / raw)
To: Dan Davison, Andreas Röhler; +Cc: emacs-orgmode
On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
> Dan Davison <davison@stats.ox.ac.uk> writes:
>
>> Gregor Zattler <telegraph@gmx.net> writes:
>>
>>> Hi Andreas, org-mode developers,
>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>> I have put a version of the manual as modified by Andreas here:
>>>>>
>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>
>>>>> Not all the command names are in there, but quite a few are.
>>>>> I'd like to hear from more people
>>>>>
>>>>> - if they would like to have the names there (i.e. if it would
>>>>> help them finding a command)
>>
>> I would like the command names in the manual.
>>
>> - Emacs-lisp has a lovely tradition of naming functions *very*
>> descriptively and not being afraid to use long names in the
>> interests
>> of accuracy. It's a shame to lose all that by displaying only key
>> sequences. It's a linguistic world of its own and I like being
>> exposed
>> to it.
>> - While one can do C-h k, that's not the same as the way one learns
>> the
>> function names by skimming the manual
>
> Also, it does not add length to the HTML version of the manual,
> because
> the key sequences are already on a line of their own. And the same is
> true for a certain proportion of the pdf entries (when the key
> sequence
> is long, then it seems to go on its own line).
>
>
>>
>>>>> - if the position (first thing in the command description)
>>>>> is right, or if it would be better to have it
>>>>> - last thing in the description
>>>>> - or after the first sentence, this is how the GNUS manual
>>>>> does it.
>>
>> I definitely would want them out on a line of their own with the key
>> sequence. I liked the right-aligned model.
>>
>> Or if not right-aligned, is it possible not to have the comma?
>> Maybe a
>> different font?
I also like the position on the key line best. So if there is a more-
or-less
general agreement that we should get the names in, this would be my
preferred
location as well. I knot that this is different from what the emacs
and gnus manuals do - but I still think that a solution like this would
be better.
Andreas, can you be bothered to rework the patch?
Unfortunately I have no idea if/how the right-aligned model could be
made to
work. So I think the safest way to do this would be to introduce the
macro,
and we can then work on the macro to get the formatting right, and
also to do the
key and function index stuff fully automatically.
Here is my proposal for now:
@macro orgcmd{key,command}
@kindex \key\
@findex \command\
@item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
@end macro
And then define keys/commands like this:
@table @kbd
.....
@orgcmd{@key{TAB}, org-cycle}
Here follows the description of the command
....
@end table
- Carsten
>>
>> Dan
>>
>>>>
>>>> Having the function names in the manual at all makes it look a bit
>>>> overloaded and might lose us a couple of newbies, I think.
>>>> Personally, I
>>>> would not have use for it.
>>>>
>>>> If the names are included in the manual I strongly object to them
>>>> being
>>>> at the beginning of the first sentence. The fixed starting column
>>>> of the
>>>> sentences becomes variable and that makes it hard to skim through
>>>> for
>>>> those who don't want to read the function names.
>>>
>>> +1 for the same reasons.
>>>
>>> This is especially true for paragraphs like those:
>>>
>>> C-c C-n (outline-next-visible-heading) Next heading.
>>> C-c C-p (outline-previous-visible-heading) Previous heading.
>>> C-c C-f (org-forward-same-level) Next heading same level.
>>> C-c C-b (org-backward-same-level) Previous heading same level.
>>> C-c C-u (outline-up-heading) Backward to higher level heading.
>>> C-c C-j (org-goto) Jump to a different place without changing the
>>> current outline
>>> visibility. Shows the document structure in a temporary
>>> buffer, where you can
>>> use the following keys to find your destination:
>>>
>>>
>>>> What about having them in the same line as the keybinding but
>>>> aligned to
>>>> the right?
>>>>
>>>> `C-c [' org-agenda-file-
>>>> to-front
>>>> Add current file to the list of agenda files. The file is
>>>> added to
>>>> the front of the list. If it was already in the list, it is
>>>> moved
>>>> to the front. With prefix arg, file is added/moved to the end.
>>>>
>>>> It would make the manual longer, but at least it looks clean.
>>>> It is easy to neglect the function names if one wants, and just
>>>> as easy
>>>> to skim through them.
>>>
>>> +1 for the same reasons.
>>> But Andreas Röhlers original variant is IMHO even better:
>>>
>>>> | [ ... ]
>>>> | `C-c [', org-agenda-file-to-front
>>>> | Add current file to the list of agenda files. The file is
>>>> added to
>>>> | the front of the list. If it was already in the list, it
>>>> is moved
>>>> | to the front. With prefix Argument, file is added/moved to
>>>> the end.
>>
>> Yes, but let's lose the extra comma.
>>
>> `C-c [' org-agenda-file-to-front
>>
>>
>>
>>
>>
>>>
>>> Here the command name serves as a kind of a heading, it's easy
>>> to search these locations while at the same time it's easy to
>>> skim over the pages and not bother with the command names.
>>>
>>>
>>>
>>> My preference:
>>>
>>> 1. as in Andreas Röhlers original ASCII rendering
>>> 2. as in Andreas Burtzlaffs ASCII rendering
>>> 3. not at all
>>> 4. as in the test manual
>>>
>>>
>>>
>>> Just me 2¢. Either way, org-mode is great. Gregor
>>>
>>>
>>> P.S.: Some of the command names don't help that much:
>>>
>>> C-c C-c (org-ctrl-c-ctrl-c) If there is a checkbox (see Section
>>> 5.6 [Checkboxes],
>>> page 46) in the item line, toggle the state of the
>>> checkbox. If not, this command
>>> makes sure that all the items on this list level use the
>>> same bullet. Furthermore,
>>> if this is an ordered list, make sure the numbering is OK.
>>> C-c - (org-ctrl-c-minus) Cycle the entire list level through the
>>> different item-
>>> ize/enumerate bullets (`-', `+', `*', `1.', `1)'). With a
>>> numeric prefix argument
>>> N, select the Nth bullet from this list. If there is an
>>> active region when calling
>>> this, all lines will be converted to list items. If the
>>> first line already was a list
>>> item, any item markers will be removed from the list.
>>> Finally, even without an
>>> active region, a normal line will be converted into a list
>>> item.
>>> C-c * (org-ctrl-c-star) Turn a plain list item into a headline
>>> (so that it becomes
>>> a subheading at its location). See Section 2.5 [Structure
>>> editing], page 7, for a
>>> detailed explanation.
>>>
>>> But even this gives a clue in how it all works.
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-11 10:05 ` Carsten Dominik
@ 2010-08-11 10:23 ` Andreas Röhler
2010-08-11 10:27 ` Carsten Dominik
2010-08-13 13:45 ` Andreas Röhler
2010-08-13 19:30 ` Andreas Röhler
2 siblings, 1 reply; 44+ messages in thread
From: Andreas Röhler @ 2010-08-11 10:23 UTC (permalink / raw)
To: Carsten Dominik; +Cc: Dan Davison, emacs-orgmode
Am 11.08.2010 12:05, schrieb Carsten Dominik:
>
> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>
>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>
>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>
>>>> Hi Andreas, org-mode developers,
>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>> I have put a version of the manual as modified by Andreas here:
>>>>>>
>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>
>>>>>> Not all the command names are in there, but quite a few are.
>>>>>> I'd like to hear from more people
>>>>>>
>>>>>> - if they would like to have the names there (i.e. if it would
>>>>>> help them finding a command)
>>>
>>> I would like the command names in the manual.
>>>
>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>> descriptively and not being afraid to use long names in the interests
>>> of accuracy. It's a shame to lose all that by displaying only key
>>> sequences. It's a linguistic world of its own and I like being exposed
>>> to it.
>>> - While one can do C-h k, that's not the same as the way one learns the
>>> function names by skimming the manual
>>
>> Also, it does not add length to the HTML version of the manual, because
>> the key sequences are already on a line of their own. And the same is
>> true for a certain proportion of the pdf entries (when the key sequence
>> is long, then it seems to go on its own line).
>>
>>
>>>
>>>>>> - if the position (first thing in the command description)
>>>>>> is right, or if it would be better to have it
>>>>>> - last thing in the description
>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>> does it.
>>>
>>> I definitely would want them out on a line of their own with the key
>>> sequence. I liked the right-aligned model.
>>>
>>> Or if not right-aligned, is it possible not to have the comma? Maybe a
>>> different font?
>
> I also like the position on the key line best. So if there is a
> more-or-less
> general agreement that we should get the names in, this would be my
> preferred
> location as well. I knot that this is different from what the emacs
> and gnus manuals do - but I still think that a solution like this would
> be better.
>
> Andreas, can you be bothered to rework the patch?
>
> Unfortunately I have no idea if/how the right-aligned model could be
> made to
> work. So I think the safest way to do this would be to introduce the macro,
> and we can then work on the macro to get the formatting right, and also
> to do the
> key and function index stuff fully automatically.
>
> Here is my proposal for now:
>
> @macro orgcmd{key,command}
> @kindex \key\
> @findex \command\
> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
> @end macro
>
> And then define keys/commands like this:
>
> @table @kbd
> .....
> @orgcmd{@key{TAB}, org-cycle}
> Here follows the description of the command
> ....
> @end table
>
> - Carsten
OK, I'm on it next days.
Cheers
Andreas
>
>
>
>
>>>
>>> Dan
>>>
>>>>>
>>>>> Having the function names in the manual at all makes it look a bit
>>>>> overloaded and might lose us a couple of newbies, I think.
>>>>> Personally, I
>>>>> would not have use for it.
>>>>>
>>>>> If the names are included in the manual I strongly object to them
>>>>> being
>>>>> at the beginning of the first sentence. The fixed starting column
>>>>> of the
>>>>> sentences becomes variable and that makes it hard to skim through for
>>>>> those who don't want to read the function names.
>>>>
>>>> +1 for the same reasons.
>>>>
>>>> This is especially true for paragraphs like those:
>>>>
>>>> C-c C-n (outline-next-visible-heading) Next heading.
>>>> C-c C-p (outline-previous-visible-heading) Previous heading.
>>>> C-c C-f (org-forward-same-level) Next heading same level.
>>>> C-c C-b (org-backward-same-level) Previous heading same level.
>>>> C-c C-u (outline-up-heading) Backward to higher level heading.
>>>> C-c C-j (org-goto) Jump to a different place without changing the
>>>> current outline
>>>> visibility. Shows the document structure in a temporary buffer,
>>>> where you can
>>>> use the following keys to find your destination:
>>>>
>>>>
>>>>> What about having them in the same line as the keybinding but
>>>>> aligned to
>>>>> the right?
>>>>>
>>>>> `C-c [' org-agenda-file-to-front
>>>>> Add current file to the list of agenda files. The file is added to
>>>>> the front of the list. If it was already in the list, it is moved
>>>>> to the front. With prefix arg, file is added/moved to the end.
>>>>>
>>>>> It would make the manual longer, but at least it looks clean.
>>>>> It is easy to neglect the function names if one wants, and just as
>>>>> easy
>>>>> to skim through them.
>>>>
>>>> +1 for the same reasons.
>>>> But Andreas Röhlers original variant is IMHO even better:
>>>>
>>>>> | [ ... ]
>>>>> | `C-c [', org-agenda-file-to-front
>>>>> | Add current file to the list of agenda files. The file is added to
>>>>> | the front of the list. If it was already in the list, it is moved
>>>>> | to the front. With prefix Argument, file is added/moved to the end.
>>>
>>> Yes, but let's lose the extra comma.
>>>
>>> `C-c [' org-agenda-file-to-front
>>>
>>>
>>>
>>>
>>>
>>>>
>>>> Here the command name serves as a kind of a heading, it's easy
>>>> to search these locations while at the same time it's easy to
>>>> skim over the pages and not bother with the command names.
>>>>
>>>>
>>>>
>>>> My preference:
>>>>
>>>> 1. as in Andreas Röhlers original ASCII rendering
>>>> 2. as in Andreas Burtzlaffs ASCII rendering
>>>> 3. not at all
>>>> 4. as in the test manual
>>>>
>>>>
>>>>
>>>> Just me 2¢. Either way, org-mode is great. Gregor
>>>>
>>>>
>>>> P.S.: Some of the command names don't help that much:
>>>>
>>>> C-c C-c (org-ctrl-c-ctrl-c) If there is a checkbox (see Section 5.6
>>>> [Checkboxes],
>>>> page 46) in the item line, toggle the state of the checkbox. If not,
>>>> this command
>>>> makes sure that all the items on this list level use the same
>>>> bullet. Furthermore,
>>>> if this is an ordered list, make sure the numbering is OK.
>>>> C-c - (org-ctrl-c-minus) Cycle the entire list level through the
>>>> different item-
>>>> ize/enumerate bullets (`-', `+', `*', `1.', `1)'). With a numeric
>>>> prefix argument
>>>> N, select the Nth bullet from this list. If there is an active
>>>> region when calling
>>>> this, all lines will be converted to list items. If the first line
>>>> already was a list
>>>> item, any item markers will be removed from the list. Finally, even
>>>> without an
>>>> active region, a normal line will be converted into a list item.
>>>> C-c * (org-ctrl-c-star) Turn a plain list item into a headline (so
>>>> that it becomes
>>>> a subheading at its location). See Section 2.5 [Structure editing],
>>>> page 7, for a
>>>> detailed explanation.
>>>>
>>>> But even this gives a clue in how it all works.
>>>>
>
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-11 10:23 ` Andreas Röhler
@ 2010-08-11 10:27 ` Carsten Dominik
0 siblings, 0 replies; 44+ messages in thread
From: Carsten Dominik @ 2010-08-11 10:27 UTC (permalink / raw)
To: Andreas Röhler; +Cc: Dan Davison, emacs-orgmode
On Aug 11, 2010, at 12:23 PM, Andreas Röhler wrote:
> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>
>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>
>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>
>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>
>>>>> Hi Andreas, org-mode developers,
>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>> I have put a version of the manual as modified by Andreas here:
>>>>>>>
>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>
>>>>>>> Not all the command names are in there, but quite a few are.
>>>>>>> I'd like to hear from more people
>>>>>>>
>>>>>>> - if they would like to have the names there (i.e. if it would
>>>>>>> help them finding a command)
>>>>
>>>> I would like the command names in the manual.
>>>>
>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>> descriptively and not being afraid to use long names in the
>>>> interests
>>>> of accuracy. It's a shame to lose all that by displaying only key
>>>> sequences. It's a linguistic world of its own and I like being
>>>> exposed
>>>> to it.
>>>> - While one can do C-h k, that's not the same as the way one
>>>> learns the
>>>> function names by skimming the manual
>>>
>>> Also, it does not add length to the HTML version of the manual,
>>> because
>>> the key sequences are already on a line of their own. And the same
>>> is
>>> true for a certain proportion of the pdf entries (when the key
>>> sequence
>>> is long, then it seems to go on its own line).
>>>
>>>
>>>>
>>>>>>> - if the position (first thing in the command description)
>>>>>>> is right, or if it would be better to have it
>>>>>>> - last thing in the description
>>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>>> does it.
>>>>
>>>> I definitely would want them out on a line of their own with the
>>>> key
>>>> sequence. I liked the right-aligned model.
>>>>
>>>> Or if not right-aligned, is it possible not to have the comma?
>>>> Maybe a
>>>> different font?
>>
>> I also like the position on the key line best. So if there is a
>> more-or-less
>> general agreement that we should get the names in, this would be my
>> preferred
>> location as well. I knot that this is different from what the emacs
>> and gnus manuals do - but I still think that a solution like this
>> would
>> be better.
>>
>> Andreas, can you be bothered to rework the patch?
>>
>> Unfortunately I have no idea if/how the right-aligned model could be
>> made to
>> work. So I think the safest way to do this would be to introduce
>> the macro,
>> and we can then work on the macro to get the formatting right, and
>> also
>> to do the
>> key and function index stuff fully automatically.
>>
>> Here is my proposal for now:
>>
>> @macro orgcmd{key,command}
>> @kindex \key\
>> @findex \command\
>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>> @end macro
>>
>> And then define keys/commands like this:
>>
>> @table @kbd
>> .....
>> @orgcmd{@key{TAB}, org-cycle}
>> Here follows the description of the command
>> ....
>> @end table
>>
>> - Carsten
>
>
> OK, I'm on it next days.
Great.
I am not yet sure how to handle @itemx, so maybe just leave alone
entries which have an @itemx ....
Cheers
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-11 10:05 ` Carsten Dominik
2010-08-11 10:23 ` Andreas Röhler
@ 2010-08-13 13:45 ` Andreas Röhler
2010-08-13 14:20 ` Dan Davison
2010-08-13 19:30 ` Andreas Röhler
2 siblings, 1 reply; 44+ messages in thread
From: Andreas Röhler @ 2010-08-13 13:45 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
Am 11.08.2010 12:05, schrieb Carsten Dominik:
>
> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>
>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>
>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>
>>>> Hi Andreas, org-mode developers,
>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>> I have put a version of the manual as modified by Andreas here:
>>>>>>
>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>
>>>>>> Not all the command names are in there, but quite a few are.
>>>>>> I'd like to hear from more people
>>>>>>
>>>>>> - if they would like to have the names there (i.e. if it would
>>>>>> help them finding a command)
>>>
>>> I would like the command names in the manual.
>>>
>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>> descriptively and not being afraid to use long names in the interests
>>> of accuracy. It's a shame to lose all that by displaying only key
>>> sequences. It's a linguistic world of its own and I like being exposed
>>> to it.
>>> - While one can do C-h k, that's not the same as the way one learns the
>>> function names by skimming the manual
>>
>> Also, it does not add length to the HTML version of the manual, because
>> the key sequences are already on a line of their own. And the same is
>> true for a certain proportion of the pdf entries (when the key sequence
>> is long, then it seems to go on its own line).
>>
>>
>>>
>>>>>> - if the position (first thing in the command description)
>>>>>> is right, or if it would be better to have it
>>>>>> - last thing in the description
>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>> does it.
>>>
>>> I definitely would want them out on a line of their own with the key
>>> sequence. I liked the right-aligned model.
>>>
>>> Or if not right-aligned, is it possible not to have the comma? Maybe a
>>> different font?
>
> I also like the position on the key line best. So if there is a
> more-or-less
> general agreement that we should get the names in, this would be my
> preferred
> location as well. I knot that this is different from what the emacs
> and gnus manuals do - but I still think that a solution like this would
> be better.
>
Hi Carsten, Hi all,
please permit some reflection again at this point, to get it out of my head:
Agree right-aligned is the more pretty from the graphical point.
But is it the most suitable from ergonomics?
Doubt that.
When reading the key, eyes are at the left corner (at least in
english... :)
If looking left, text on the right sight is not in focus.
Would require an eye-move.
If the command is placed next or below, what I prefer meanwhile, as
separating commata is nasty somehow, it should safe some energy.
Andreas
> Andreas, can you be bothered to rework the patch?
>
> Unfortunately I have no idea if/how the right-aligned model could be
> made to
> work. So I think the safest way to do this would be to introduce the macro,
> and we can then work on the macro to get the formatting right, and also
> to do the
> key and function index stuff fully automatically.
>
> Here is my proposal for now:
>
> @macro orgcmd{key,command}
> @kindex \key\
> @findex \command\
> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
> @end macro
>
> And then define keys/commands like this:
>
> @table @kbd
> .....
> @orgcmd{@key{TAB}, org-cycle}
> Here follows the description of the command
> ....
> @end table
>
> - Carsten
>
>
>
>
>>>
>>> Dan
>>>
>>>>>
>>>>> Having the function names in the manual at all makes it look a bit
>>>>> overloaded and might lose us a couple of newbies, I think.
>>>>> Personally, I
>>>>> would not have use for it.
>>>>>
>>>>> If the names are included in the manual I strongly object to them
>>>>> being
>>>>> at the beginning of the first sentence. The fixed starting column
>>>>> of the
>>>>> sentences becomes variable and that makes it hard to skim through for
>>>>> those who don't want to read the function names.
>>>>
>>>> +1 for the same reasons.
>>>>
>>>> This is especially true for paragraphs like those:
>>>>
>>>> C-c C-n (outline-next-visible-heading) Next heading.
>>>> C-c C-p (outline-previous-visible-heading) Previous heading.
>>>> C-c C-f (org-forward-same-level) Next heading same level.
>>>> C-c C-b (org-backward-same-level) Previous heading same level.
>>>> C-c C-u (outline-up-heading) Backward to higher level heading.
>>>> C-c C-j (org-goto) Jump to a different place without changing the
>>>> current outline
>>>> visibility. Shows the document structure in a temporary buffer,
>>>> where you can
>>>> use the following keys to find your destination:
>>>>
>>>>
>>>>> What about having them in the same line as the keybinding but
>>>>> aligned to
>>>>> the right?
>>>>>
>>>>> `C-c [' org-agenda-file-to-front
>>>>> Add current file to the list of agenda files. The file is added to
>>>>> the front of the list. If it was already in the list, it is moved
>>>>> to the front. With prefix arg, file is added/moved to the end.
>>>>>
>>>>> It would make the manual longer, but at least it looks clean.
>>>>> It is easy to neglect the function names if one wants, and just as
>>>>> easy
>>>>> to skim through them.
>>>>
>>>> +1 for the same reasons.
>>>> But Andreas Röhlers original variant is IMHO even better:
>>>>
>>>>> | [ ... ]
>>>>> | `C-c [', org-agenda-file-to-front
>>>>> | Add current file to the list of agenda files. The file is added to
>>>>> | the front of the list. If it was already in the list, it is moved
>>>>> | to the front. With prefix Argument, file is added/moved to the end.
>>>
>>> Yes, but let's lose the extra comma.
>>>
>>> `C-c [' org-agenda-file-to-front
>>>
>>>
>>>
>>>
>>>
>>>>
>>>> Here the command name serves as a kind of a heading, it's easy
>>>> to search these locations while at the same time it's easy to
>>>> skim over the pages and not bother with the command names.
>>>>
>>>>
>>>>
>>>> My preference:
>>>>
>>>> 1. as in Andreas Röhlers original ASCII rendering
>>>> 2. as in Andreas Burtzlaffs ASCII rendering
>>>> 3. not at all
>>>> 4. as in the test manual
>>>>
>>>>
>>>>
>>>> Just me 2¢. Either way, org-mode is great. Gregor
>>>>
>>>>
>>>> P.S.: Some of the command names don't help that much:
>>>>
>>>> C-c C-c (org-ctrl-c-ctrl-c) If there is a checkbox (see Section 5.6
>>>> [Checkboxes],
>>>> page 46) in the item line, toggle the state of the checkbox. If not,
>>>> this command
>>>> makes sure that all the items on this list level use the same
>>>> bullet. Furthermore,
>>>> if this is an ordered list, make sure the numbering is OK.
>>>> C-c - (org-ctrl-c-minus) Cycle the entire list level through the
>>>> different item-
>>>> ize/enumerate bullets (`-', `+', `*', `1.', `1)'). With a numeric
>>>> prefix argument
>>>> N, select the Nth bullet from this list. If there is an active
>>>> region when calling
>>>> this, all lines will be converted to list items. If the first line
>>>> already was a list
>>>> item, any item markers will be removed from the list. Finally, even
>>>> without an
>>>> active region, a normal line will be converted into a list item.
>>>> C-c * (org-ctrl-c-star) Turn a plain list item into a headline (so
>>>> that it becomes
>>>> a subheading at its location). See Section 2.5 [Structure editing],
>>>> page 7, for a
>>>> detailed explanation.
>>>>
>>>> But even this gives a clue in how it all works.
>>>>
>>>> _______________________________________________
>>>> Emacs-orgmode mailing list
>>>> Please use `Reply All' to send replies to the list.
>>>> Emacs-orgmode@gnu.org
>>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>
>
>
>
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-08-13 13:45 ` Andreas Röhler
@ 2010-08-13 14:20 ` Dan Davison
0 siblings, 0 replies; 44+ messages in thread
From: Dan Davison @ 2010-08-13 14:20 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode, Carsten Dominik
Andreas Röhler <andreas.roehler@easy-emacs.de> writes:
> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>
>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>
>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>
>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>
>>>>> Hi Andreas, org-mode developers,
>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>> I have put a version of the manual as modified by Andreas here:
>>>>>>>
>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>
>>>>>>> Not all the command names are in there, but quite a few are.
>>>>>>> I'd like to hear from more people
>>>>>>>
>>>>>>> - if they would like to have the names there (i.e. if it would
>>>>>>> help them finding a command)
>>>>
>>>> I would like the command names in the manual.
>>>>
>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>> descriptively and not being afraid to use long names in the interests
>>>> of accuracy. It's a shame to lose all that by displaying only key
>>>> sequences. It's a linguistic world of its own and I like being exposed
>>>> to it.
>>>> - While one can do C-h k, that's not the same as the way one learns the
>>>> function names by skimming the manual
>>>
>>> Also, it does not add length to the HTML version of the manual, because
>>> the key sequences are already on a line of their own. And the same is
>>> true for a certain proportion of the pdf entries (when the key sequence
>>> is long, then it seems to go on its own line).
>>>
>>>
>>>>
>>>>>>> - if the position (first thing in the command description)
>>>>>>> is right, or if it would be better to have it
>>>>>>> - last thing in the description
>>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>>> does it.
>>>>
>>>> I definitely would want them out on a line of their own with the key
>>>> sequence. I liked the right-aligned model.
>>>>
>>>> Or if not right-aligned, is it possible not to have the comma? Maybe a
>>>> different font?
>>
>> I also like the position on the key line best. So if there is a
>> more-or-less
>> general agreement that we should get the names in, this would be my
>> preferred
>> location as well. I knot that this is different from what the emacs
>> and gnus manuals do - but I still think that a solution like this would
>> be better.
>>
>
> Hi Carsten, Hi all,
>
> please permit some reflection again at this point, to get it out of my head:
>
> Agree right-aligned is the more pretty from the graphical point.
> But is it the most suitable from ergonomics?
>
> Doubt that.
> When reading the key, eyes are at the left corner (at least in
> english... :)
> If looking left, text on the right sight is not in focus.
> Would require an eye-move.
Which could be argued to be an advantage, because Carsten's original
ideas was that new non-programmer users would not want to know function
names. If those of us that do want to learn function names are prepared
to pay the cost in muscular contractions, then right-aligned could be a
good compromise.
> If the command is placed next or below, what I prefer meanwhile, as
> separating commata is nasty somehow,
When you say below, do you mean on its own line or as the first words of
the text? I believe there was a majority vote against the latter.
Dan
> it should safe some energy.
>
> Andreas
>
>
>
>
>
>
>
>
>> Andreas, can you be bothered to rework the patch?
>>
>> Unfortunately I have no idea if/how the right-aligned model could be
>> made to
>> work. So I think the safest way to do this would be to introduce the macro,
>> and we can then work on the macro to get the formatting right, and also
>> to do the
>> key and function index stuff fully automatically.
>>
>> Here is my proposal for now:
>>
>> @macro orgcmd{key,command}
>> @kindex \key\
>> @findex \command\
>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>> @end macro
>>
>> And then define keys/commands like this:
>>
>> @table @kbd
>> .....
>> @orgcmd{@key{TAB}, org-cycle}
>> Here follows the description of the command
>> ....
>> @end table
>>
>> - Carsten
>>
>>
>>
>>
>>>>
>>>> Dan
>>>>
>>>>>>
>>>>>> Having the function names in the manual at all makes it look a bit
>>>>>> overloaded and might lose us a couple of newbies, I think.
>>>>>> Personally, I
>>>>>> would not have use for it.
>>>>>>
>>>>>> If the names are included in the manual I strongly object to them
>>>>>> being
>>>>>> at the beginning of the first sentence. The fixed starting column
>>>>>> of the
>>>>>> sentences becomes variable and that makes it hard to skim through for
>>>>>> those who don't want to read the function names.
>>>>>
>>>>> +1 for the same reasons.
>>>>>
>>>>> This is especially true for paragraphs like those:
>>>>>
>>>>> C-c C-n (outline-next-visible-heading) Next heading.
>>>>> C-c C-p (outline-previous-visible-heading) Previous heading.
>>>>> C-c C-f (org-forward-same-level) Next heading same level.
>>>>> C-c C-b (org-backward-same-level) Previous heading same level.
>>>>> C-c C-u (outline-up-heading) Backward to higher level heading.
>>>>> C-c C-j (org-goto) Jump to a different place without changing the
>>>>> current outline
>>>>> visibility. Shows the document structure in a temporary buffer,
>>>>> where you can
>>>>> use the following keys to find your destination:
>>>>>
>>>>>
>>>>>> What about having them in the same line as the keybinding but
>>>>>> aligned to
>>>>>> the right?
>>>>>>
>>>>>> `C-c [' org-agenda-file-to-front
>>>>>> Add current file to the list of agenda files. The file is added to
>>>>>> the front of the list. If it was already in the list, it is moved
>>>>>> to the front. With prefix arg, file is added/moved to the end.
>>>>>>
>>>>>> It would make the manual longer, but at least it looks clean.
>>>>>> It is easy to neglect the function names if one wants, and just as
>>>>>> easy
>>>>>> to skim through them.
>>>>>
>>>>> +1 for the same reasons.
>>>>> But Andreas Röhlers original variant is IMHO even better:
>>>>>
>>>>>> | [ ... ]
>>>>>> | `C-c [', org-agenda-file-to-front
>>>>>> | Add current file to the list of agenda files. The file is added to
>>>>>> | the front of the list. If it was already in the list, it is moved
>>>>>> | to the front. With prefix Argument, file is added/moved to the end.
>>>>
>>>> Yes, but let's lose the extra comma.
>>>>
>>>> `C-c [' org-agenda-file-to-front
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>>
>>>>> Here the command name serves as a kind of a heading, it's easy
>>>>> to search these locations while at the same time it's easy to
>>>>> skim over the pages and not bother with the command names.
>>>>>
>>>>>
>>>>>
>>>>> My preference:
>>>>>
>>>>> 1. as in Andreas Röhlers original ASCII rendering
>>>>> 2. as in Andreas Burtzlaffs ASCII rendering
>>>>> 3. not at all
>>>>> 4. as in the test manual
>>>>>
>>>>>
>>>>>
>>>>> Just me 2¢. Either way, org-mode is great. Gregor
>>>>>
>>>>>
>>>>> P.S.: Some of the command names don't help that much:
>>>>>
>>>>> C-c C-c (org-ctrl-c-ctrl-c) If there is a checkbox (see Section 5.6
>>>>> [Checkboxes],
>>>>> page 46) in the item line, toggle the state of the checkbox. If not,
>>>>> this command
>>>>> makes sure that all the items on this list level use the same
>>>>> bullet. Furthermore,
>>>>> if this is an ordered list, make sure the numbering is OK.
>>>>> C-c - (org-ctrl-c-minus) Cycle the entire list level through the
>>>>> different item-
>>>>> ize/enumerate bullets (`-', `+', `*', `1.', `1)'). With a numeric
>>>>> prefix argument
>>>>> N, select the Nth bullet from this list. If there is an active
>>>>> region when calling
>>>>> this, all lines will be converted to list items. If the first line
>>>>> already was a list
>>>>> item, any item markers will be removed from the list. Finally, even
>>>>> without an
>>>>> active region, a normal line will be converted into a list item.
>>>>> C-c * (org-ctrl-c-star) Turn a plain list item into a headline (so
>>>>> that it becomes
>>>>> a subheading at its location). See Section 2.5 [Structure editing],
>>>>> page 7, for a
>>>>> detailed explanation.
>>>>>
>>>>> But even this gives a clue in how it all works.
>>>>>
>>>>> _______________________________________________
>>>>> Emacs-orgmode mailing list
>>>>> Please use `Reply All' to send replies to the list.
>>>>> Emacs-orgmode@gnu.org
>>>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>>>
>>>> _______________________________________________
>>>> Emacs-orgmode mailing list
>>>> Please use `Reply All' to send replies to the list.
>>>> Emacs-orgmode@gnu.org
>>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> - Carsten
>>
>>
>>
>>
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-11 10:05 ` Carsten Dominik
2010-08-11 10:23 ` Andreas Röhler
2010-08-13 13:45 ` Andreas Röhler
@ 2010-08-13 19:30 ` Andreas Röhler
2010-08-15 7:37 ` Carsten Dominik
2 siblings, 1 reply; 44+ messages in thread
From: Andreas Röhler @ 2010-08-13 19:30 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 3158 bytes --]
Am 11.08.2010 12:05, schrieb Carsten Dominik:
>
> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>
>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>
>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>
>>>> Hi Andreas, org-mode developers,
>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>> I have put a version of the manual as modified by Andreas here:
>>>>>>
>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>
>>>>>> Not all the command names are in there, but quite a few are.
>>>>>> I'd like to hear from more people
>>>>>>
>>>>>> - if they would like to have the names there (i.e. if it would
>>>>>> help them finding a command)
>>>
>>> I would like the command names in the manual.
>>>
>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>> descriptively and not being afraid to use long names in the interests
>>> of accuracy. It's a shame to lose all that by displaying only key
>>> sequences. It's a linguistic world of its own and I like being exposed
>>> to it.
>>> - While one can do C-h k, that's not the same as the way one learns the
>>> function names by skimming the manual
>>
>> Also, it does not add length to the HTML version of the manual, because
>> the key sequences are already on a line of their own. And the same is
>> true for a certain proportion of the pdf entries (when the key sequence
>> is long, then it seems to go on its own line).
>>
>>
>>>
>>>>>> - if the position (first thing in the command description)
>>>>>> is right, or if it would be better to have it
>>>>>> - last thing in the description
>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>> does it.
>>>
>>> I definitely would want them out on a line of their own with the key
>>> sequence. I liked the right-aligned model.
>>>
>>> Or if not right-aligned, is it possible not to have the comma? Maybe a
>>> different font?
>
> I also like the position on the key line best. So if there is a
> more-or-less
> general agreement that we should get the names in, this would be my
> preferred
> location as well. I knot that this is different from what the emacs
> and gnus manuals do - but I still think that a solution like this would
> be better.
>
> Andreas, can you be bothered to rework the patch?
>
> Unfortunately I have no idea if/how the right-aligned model could be
> made to
> work. So I think the safest way to do this would be to introduce the macro,
> and we can then work on the macro to get the formatting right, and also
> to do the
> key and function index stuff fully automatically.
>
> Here is my proposal for now:
>
> @macro orgcmd{key,command}
> @kindex \key\
> @findex \command\
> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
> @end macro
>
> And then define keys/commands like this:
>
> @table @kbd
> .....
> @orgcmd{@key{TAB}, org-cycle}
> Here follows the description of the command
> ....
> @end table
>
> - Carsten
>
>
[ ... ]
Hi Carsten,
attached a sreenshot, how it comes out for C-c C-b.
Doesn't look ok for me, as back-tick and quote are uncommon that way.
Also diff for the code applied.
Andreas
[-- Attachment #2: texi.diff --]
[-- Type: text/x-patch, Size: 653 bytes --]
diff --git a/doc/org.texi b/doc/org.texi
index ac52c70..05ef8eb 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -22,6 +22,11 @@
@finalout
@c Macro definitions
+@macro orgcmd{key,command}
+@kindex \key\
+@findex \command\
+@item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
+@end macro
@iftex
@c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
@end iftex
@@ -1006,8 +1011,9 @@ Previous heading.
@kindex C-c C-f
@item C-c C-f
Next heading same level.
-@kindex C-c C-b
-@item C-c C-b
+@orgcmd{C-c C-b, org-backward-same-level}
+@c @kindex C-c C-b
+@c @item C-c C-b
Previous heading same level.
@kindex C-c C-u
@item C-c C-u
[-- Attachment #3: org-texi.png --]
[-- Type: image/png, Size: 67164 bytes --]
[-- Attachment #4: Type: text/plain, Size: 201 bytes --]
_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply related [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-13 19:30 ` Andreas Röhler
@ 2010-08-15 7:37 ` Carsten Dominik
2010-08-15 7:39 ` Carsten Dominik
0 siblings, 1 reply; 44+ messages in thread
From: Carsten Dominik @ 2010-08-15 7:37 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>
>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>
>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>
>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>
>>>>> Hi Andreas, org-mode developers,
>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>> I have put a version of the manual as modified by Andreas here:
>>>>>>>
>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>
>>>>>>> Not all the command names are in there, but quite a few are.
>>>>>>> I'd like to hear from more people
>>>>>>>
>>>>>>> - if they would like to have the names there (i.e. if it would
>>>>>>> help them finding a command)
>>>>
>>>> I would like the command names in the manual.
>>>>
>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>> descriptively and not being afraid to use long names in the
>>>> interests
>>>> of accuracy. It's a shame to lose all that by displaying only key
>>>> sequences. It's a linguistic world of its own and I like being
>>>> exposed
>>>> to it.
>>>> - While one can do C-h k, that's not the same as the way one
>>>> learns the
>>>> function names by skimming the manual
>>>
>>> Also, it does not add length to the HTML version of the manual,
>>> because
>>> the key sequences are already on a line of their own. And the same
>>> is
>>> true for a certain proportion of the pdf entries (when the key
>>> sequence
>>> is long, then it seems to go on its own line).
>>>
>>>
>>>>
>>>>>>> - if the position (first thing in the command description)
>>>>>>> is right, or if it would be better to have it
>>>>>>> - last thing in the description
>>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>>> does it.
>>>>
>>>> I definitely would want them out on a line of their own with the
>>>> key
>>>> sequence. I liked the right-aligned model.
>>>>
>>>> Or if not right-aligned, is it possible not to have the comma?
>>>> Maybe a
>>>> different font?
>>
>> I also like the position on the key line best. So if there is a
>> more-or-less
>> general agreement that we should get the names in, this would be my
>> preferred
>> location as well. I knot that this is different from what the emacs
>> and gnus manuals do - but I still think that a solution like this
>> would
>> be better.
>>
>> Andreas, can you be bothered to rework the patch?
>>
>> Unfortunately I have no idea if/how the right-aligned model could be
>> made to
>> work. So I think the safest way to do this would be to introduce
>> the macro,
>> and we can then work on the macro to get the formatting right, and
>> also
>> to do the
>> key and function index stuff fully automatically.
>>
>> Here is my proposal for now:
>>
>> @macro orgcmd{key,command}
>> @kindex \key\
>> @findex \command\
>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>> @end macro
>>
>> And then define keys/commands like this:
>>
>> @table @kbd
>> .....
>> @orgcmd{@key{TAB}, org-cycle}
>> Here follows the description of the command
>> ....
>> @end table
>>
>> - Carsten
>>
>>
> [ ... ]
>
> Hi Carsten,
>
> attached a sreenshot, how it comes out for C-c C-b.
> Doesn't look ok for me, as back-tick and quote are uncommon that way.
Hi Andreas, you are correct, this does not look right.
Seems like we will have to make the table ins @asis and
then have the macro apply the formatting. Sigh... :)
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-15 7:37 ` Carsten Dominik
@ 2010-08-15 7:39 ` Carsten Dominik
2010-08-15 19:07 ` Andreas Röhler
0 siblings, 1 reply; 44+ messages in thread
From: Carsten Dominik @ 2010-08-15 7:39 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
On Aug 15, 2010, at 9:37 AM, Carsten Dominik wrote:
>
> On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
>
>> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>>
>>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>>
>>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>>
>>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>>
>>>>>> Hi Andreas, org-mode developers,
>>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>>> I have put a version of the manual as modified by Andreas here:
>>>>>>>>
>>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>>
>>>>>>>> Not all the command names are in there, but quite a few are.
>>>>>>>> I'd like to hear from more people
>>>>>>>>
>>>>>>>> - if they would like to have the names there (i.e. if it would
>>>>>>>> help them finding a command)
>>>>>
>>>>> I would like the command names in the manual.
>>>>>
>>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>>> descriptively and not being afraid to use long names in the
>>>>> interests
>>>>> of accuracy. It's a shame to lose all that by displaying only key
>>>>> sequences. It's a linguistic world of its own and I like being
>>>>> exposed
>>>>> to it.
>>>>> - While one can do C-h k, that's not the same as the way one
>>>>> learns the
>>>>> function names by skimming the manual
>>>>
>>>> Also, it does not add length to the HTML version of the manual,
>>>> because
>>>> the key sequences are already on a line of their own. And the
>>>> same is
>>>> true for a certain proportion of the pdf entries (when the key
>>>> sequence
>>>> is long, then it seems to go on its own line).
>>>>
>>>>
>>>>>
>>>>>>>> - if the position (first thing in the command description)
>>>>>>>> is right, or if it would be better to have it
>>>>>>>> - last thing in the description
>>>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>>>> does it.
>>>>>
>>>>> I definitely would want them out on a line of their own with the
>>>>> key
>>>>> sequence. I liked the right-aligned model.
>>>>>
>>>>> Or if not right-aligned, is it possible not to have the comma?
>>>>> Maybe a
>>>>> different font?
>>>
>>> I also like the position on the key line best. So if there is a
>>> more-or-less
>>> general agreement that we should get the names in, this would be my
>>> preferred
>>> location as well. I knot that this is different from what the emacs
>>> and gnus manuals do - but I still think that a solution like this
>>> would
>>> be better.
>>>
>>> Andreas, can you be bothered to rework the patch?
>>>
>>> Unfortunately I have no idea if/how the right-aligned model could be
>>> made to
>>> work. So I think the safest way to do this would be to introduce
>>> the macro,
>>> and we can then work on the macro to get the formatting right, and
>>> also
>>> to do the
>>> key and function index stuff fully automatically.
>>>
>>> Here is my proposal for now:
>>>
>>> @macro orgcmd{key,command}
>>> @kindex \key\
>>> @findex \command\
>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>> @end macro
>>>
>>> And then define keys/commands like this:
>>>
>>> @table @kbd
>>> .....
>>> @orgcmd{@key{TAB}, org-cycle}
>>> Here follows the description of the command
>>> ....
>>> @end table
>>>
>>> - Carsten
>>>
>>>
>> [ ... ]
>>
>> Hi Carsten,
>>
>> attached a sreenshot, how it comes out for C-c C-b.
>> Doesn't look ok for me, as back-tick and quote are uncommon that way.
>
> Hi Andreas, you are correct, this does not look right.
> Seems like we will have to make the table ins @asis and
> then have the macro apply the formatting. Sigh... :)
If you do insert all the macro calls with the command names, I will
take care of the formatting.
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-15 7:39 ` Carsten Dominik
@ 2010-08-15 19:07 ` Andreas Röhler
2010-08-16 8:57 ` Carsten Dominik
0 siblings, 1 reply; 44+ messages in thread
From: Andreas Röhler @ 2010-08-15 19:07 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode, Carsten Dominik
Am 15.08.2010 09:39, schrieb Carsten Dominik:
>
> On Aug 15, 2010, at 9:37 AM, Carsten Dominik wrote:
>
>>
>> On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
>>
>>> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>>>
>>>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>>>
>>>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>>>
>>>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>>>
>>>>>>> Hi Andreas, org-mode developers,
>>>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>>>> I have put a version of the manual as modified by Andreas here:
>>>>>>>>>
>>>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>>>
>>>>>>>>> Not all the command names are in there, but quite a few are.
>>>>>>>>> I'd like to hear from more people
>>>>>>>>>
>>>>>>>>> - if they would like to have the names there (i.e. if it would
>>>>>>>>> help them finding a command)
>>>>>>
>>>>>> I would like the command names in the manual.
>>>>>>
>>>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>>>> descriptively and not being afraid to use long names in the interests
>>>>>> of accuracy. It's a shame to lose all that by displaying only key
>>>>>> sequences. It's a linguistic world of its own and I like being
>>>>>> exposed
>>>>>> to it.
>>>>>> - While one can do C-h k, that's not the same as the way one
>>>>>> learns the
>>>>>> function names by skimming the manual
>>>>>
>>>>> Also, it does not add length to the HTML version of the manual,
>>>>> because
>>>>> the key sequences are already on a line of their own. And the same is
>>>>> true for a certain proportion of the pdf entries (when the key
>>>>> sequence
>>>>> is long, then it seems to go on its own line).
>>>>>
>>>>>
>>>>>>
>>>>>>>>> - if the position (first thing in the command description)
>>>>>>>>> is right, or if it would be better to have it
>>>>>>>>> - last thing in the description
>>>>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>>>>> does it.
>>>>>>
>>>>>> I definitely would want them out on a line of their own with the key
>>>>>> sequence. I liked the right-aligned model.
>>>>>>
>>>>>> Or if not right-aligned, is it possible not to have the comma?
>>>>>> Maybe a
>>>>>> different font?
>>>>
>>>> I also like the position on the key line best. So if there is a
>>>> more-or-less
>>>> general agreement that we should get the names in, this would be my
>>>> preferred
>>>> location as well. I knot that this is different from what the emacs
>>>> and gnus manuals do - but I still think that a solution like this would
>>>> be better.
>>>>
>>>> Andreas, can you be bothered to rework the patch?
>>>>
>>>> Unfortunately I have no idea if/how the right-aligned model could be
>>>> made to
>>>> work. So I think the safest way to do this would be to introduce the
>>>> macro,
>>>> and we can then work on the macro to get the formatting right, and also
>>>> to do the
>>>> key and function index stuff fully automatically.
>>>>
>>>> Here is my proposal for now:
>>>>
>>>> @macro orgcmd{key,command}
>>>> @kindex \key\
>>>> @findex \command\
>>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>>> @end macro
>>>>
>>>> And then define keys/commands like this:
>>>>
>>>> @table @kbd
>>>> .....
>>>> @orgcmd{@key{TAB}, org-cycle}
>>>> Here follows the description of the command
>>>> ....
>>>> @end table
>>>>
>>>> - Carsten
>>>>
>>>>
>>> [ ... ]
>>>
>>> Hi Carsten,
>>>
>>> attached a sreenshot, how it comes out for C-c C-b.
>>> Doesn't look ok for me, as back-tick and quote are uncommon that way.
>>
>> Hi Andreas, you are correct, this does not look right.
>> Seems like we will have to make the table ins @asis and
>> then have the macro apply the formatting. Sigh... :)
>
> If you do insert all the macro calls with the command names, I will take
> care of the formatting.
>
> - Carsten
>
Hi,
will do that.
Let us check nonetheless a working example first.
While trying to put @asis at the right place, I get error messages and
it refuses to compile.
Could you re-write the example for me?
Sorry being that stupid :-)
Andreas
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-15 19:07 ` Andreas Röhler
@ 2010-08-16 8:57 ` Carsten Dominik
2010-08-17 12:43 ` Andreas Röhler
2010-08-17 15:44 ` Andreas Röhler
0 siblings, 2 replies; 44+ messages in thread
From: Carsten Dominik @ 2010-08-16 8:57 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
On Aug 15, 2010, at 9:07 PM, Andreas Röhler wrote:
> Am 15.08.2010 09:39, schrieb Carsten Dominik:
>>
>> On Aug 15, 2010, at 9:37 AM, Carsten Dominik wrote:
>>
>>>
>>> On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
>>>
>>>> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>>>>
>>>>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>>>>
>>>>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>>>>
>>>>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>>>>
>>>>>>>> Hi Andreas, org-mode developers,
>>>>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>>>>> I have put a version of the manual as modified by Andreas
>>>>>>>>>> here:
>>>>>>>>>>
>>>>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>>>>
>>>>>>>>>> Not all the command names are in there, but quite a few are.
>>>>>>>>>> I'd like to hear from more people
>>>>>>>>>>
>>>>>>>>>> - if they would like to have the names there (i.e. if it
>>>>>>>>>> would
>>>>>>>>>> help them finding a command)
>>>>>>>
>>>>>>> I would like the command names in the manual.
>>>>>>>
>>>>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>>>>> descriptively and not being afraid to use long names in the
>>>>>>> interests
>>>>>>> of accuracy. It's a shame to lose all that by displaying only
>>>>>>> key
>>>>>>> sequences. It's a linguistic world of its own and I like being
>>>>>>> exposed
>>>>>>> to it.
>>>>>>> - While one can do C-h k, that's not the same as the way one
>>>>>>> learns the
>>>>>>> function names by skimming the manual
>>>>>>
>>>>>> Also, it does not add length to the HTML version of the manual,
>>>>>> because
>>>>>> the key sequences are already on a line of their own. And the
>>>>>> same is
>>>>>> true for a certain proportion of the pdf entries (when the key
>>>>>> sequence
>>>>>> is long, then it seems to go on its own line).
>>>>>>
>>>>>>
>>>>>>>
>>>>>>>>>> - if the position (first thing in the command description)
>>>>>>>>>> is right, or if it would be better to have it
>>>>>>>>>> - last thing in the description
>>>>>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>>>>>> does it.
>>>>>>>
>>>>>>> I definitely would want them out on a line of their own with
>>>>>>> the key
>>>>>>> sequence. I liked the right-aligned model.
>>>>>>>
>>>>>>> Or if not right-aligned, is it possible not to have the comma?
>>>>>>> Maybe a
>>>>>>> different font?
>>>>>
>>>>> I also like the position on the key line best. So if there is a
>>>>> more-or-less
>>>>> general agreement that we should get the names in, this would be
>>>>> my
>>>>> preferred
>>>>> location as well. I knot that this is different from what the
>>>>> emacs
>>>>> and gnus manuals do - but I still think that a solution like
>>>>> this would
>>>>> be better.
>>>>>
>>>>> Andreas, can you be bothered to rework the patch?
>>>>>
>>>>> Unfortunately I have no idea if/how the right-aligned model
>>>>> could be
>>>>> made to
>>>>> work. So I think the safest way to do this would be to introduce
>>>>> the
>>>>> macro,
>>>>> and we can then work on the macro to get the formatting right,
>>>>> and also
>>>>> to do the
>>>>> key and function index stuff fully automatically.
>>>>>
>>>>> Here is my proposal for now:
>>>>>
>>>>> @macro orgcmd{key,command}
>>>>> @kindex \key\
>>>>> @findex \command\
>>>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>>>> @end macro
>>>>>
>>>>> And then define keys/commands like this:
>>>>>
>>>>> @table @kbd
>>>>> .....
>>>>> @orgcmd{@key{TAB}, org-cycle}
>>>>> Here follows the description of the command
>>>>> ....
>>>>> @end table
>>>>>
>>>>> - Carsten
>>>>>
>>>>>
>>>> [ ... ]
>>>>
>>>> Hi Carsten,
>>>>
>>>> attached a sreenshot, how it comes out for C-c C-b.
>>>> Doesn't look ok for me, as back-tick and quote are uncommon that
>>>> way.
>>>
>>> Hi Andreas, you are correct, this does not look right.
>>> Seems like we will have to make the table ins @asis and
>>> then have the macro apply the formatting. Sigh... :)
>>
>> If you do insert all the macro calls with the command names, I will
>> take
>> care of the formatting.
>>
>> - Carsten
>>
>
> Hi,
>
> will do that.
>
> Let us check nonetheless a working example first.
>
> While trying to put @asis at the right place, I get error messages
> and it refuses to compile.
>
> Could you re-write the example for me?
>
> Sorry being that stupid :-)
>
> Andreas
I mean it like this:
@macro orgcmd{key,command}
@kindex \key\
@findex \command\
@item @kbd{\key\} @ @ @ @ @ @ @ @ @ @ (@code{\command}\)
@end macro
And then define keys/commands like this:
@table @asis
.....
@orgcmd{C-c C-x @key{TAB}, org-cycle}
Here follows the description of the command
....
@end table
Does this work?
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-16 8:57 ` Carsten Dominik
@ 2010-08-17 12:43 ` Andreas Röhler
2010-08-18 8:38 ` Carsten Dominik
2010-08-17 15:44 ` Andreas Röhler
1 sibling, 1 reply; 44+ messages in thread
From: Andreas Röhler @ 2010-08-17 12:43 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 5100 bytes --]
Am 16.08.2010 10:57, schrieb Carsten Dominik:
>
> On Aug 15, 2010, at 9:07 PM, Andreas Röhler wrote:
>
>> Am 15.08.2010 09:39, schrieb Carsten Dominik:
>>>
>>> On Aug 15, 2010, at 9:37 AM, Carsten Dominik wrote:
>>>
>>>>
>>>> On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
>>>>
>>>>> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>>>>>
>>>>>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>>>>>
>>>>>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>>>>>
>>>>>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>>>>>
>>>>>>>>> Hi Andreas, org-mode developers,
>>>>>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>>>>>> I have put a version of the manual as modified by Andreas here:
>>>>>>>>>>>
>>>>>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>>>>>
>>>>>>>>>>> Not all the command names are in there, but quite a few are.
>>>>>>>>>>> I'd like to hear from more people
>>>>>>>>>>>
>>>>>>>>>>> - if they would like to have the names there (i.e. if it would
>>>>>>>>>>> help them finding a command)
>>>>>>>>
>>>>>>>> I would like the command names in the manual.
>>>>>>>>
>>>>>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>>>>>> descriptively and not being afraid to use long names in the
>>>>>>>> interests
>>>>>>>> of accuracy. It's a shame to lose all that by displaying only key
>>>>>>>> sequences. It's a linguistic world of its own and I like being
>>>>>>>> exposed
>>>>>>>> to it.
>>>>>>>> - While one can do C-h k, that's not the same as the way one
>>>>>>>> learns the
>>>>>>>> function names by skimming the manual
>>>>>>>
>>>>>>> Also, it does not add length to the HTML version of the manual,
>>>>>>> because
>>>>>>> the key sequences are already on a line of their own. And the
>>>>>>> same is
>>>>>>> true for a certain proportion of the pdf entries (when the key
>>>>>>> sequence
>>>>>>> is long, then it seems to go on its own line).
>>>>>>>
>>>>>>>
>>>>>>>>
>>>>>>>>>>> - if the position (first thing in the command description)
>>>>>>>>>>> is right, or if it would be better to have it
>>>>>>>>>>> - last thing in the description
>>>>>>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>>>>>>> does it.
>>>>>>>>
>>>>>>>> I definitely would want them out on a line of their own with the
>>>>>>>> key
>>>>>>>> sequence. I liked the right-aligned model.
>>>>>>>>
>>>>>>>> Or if not right-aligned, is it possible not to have the comma?
>>>>>>>> Maybe a
>>>>>>>> different font?
>>>>>>
>>>>>> I also like the position on the key line best. So if there is a
>>>>>> more-or-less
>>>>>> general agreement that we should get the names in, this would be my
>>>>>> preferred
>>>>>> location as well. I knot that this is different from what the emacs
>>>>>> and gnus manuals do - but I still think that a solution like this
>>>>>> would
>>>>>> be better.
>>>>>>
>>>>>> Andreas, can you be bothered to rework the patch?
>>>>>>
>>>>>> Unfortunately I have no idea if/how the right-aligned model could be
>>>>>> made to
>>>>>> work. So I think the safest way to do this would be to introduce the
>>>>>> macro,
>>>>>> and we can then work on the macro to get the formatting right, and
>>>>>> also
>>>>>> to do the
>>>>>> key and function index stuff fully automatically.
>>>>>>
>>>>>> Here is my proposal for now:
>>>>>>
>>>>>> @macro orgcmd{key,command}
>>>>>> @kindex \key\
>>>>>> @findex \command\
>>>>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>>>>> @end macro
>>>>>>
>>>>>> And then define keys/commands like this:
>>>>>>
>>>>>> @table @kbd
>>>>>> .....
>>>>>> @orgcmd{@key{TAB}, org-cycle}
>>>>>> Here follows the description of the command
>>>>>> ....
>>>>>> @end table
>>>>>>
>>>>>> - Carsten
>>>>>>
>>>>>>
>>>>> [ ... ]
>>>>>
>>>>> Hi Carsten,
>>>>>
>>>>> attached a sreenshot, how it comes out for C-c C-b.
>>>>> Doesn't look ok for me, as back-tick and quote are uncommon that way.
>>>>
>>>> Hi Andreas, you are correct, this does not look right.
>>>> Seems like we will have to make the table ins @asis and
>>>> then have the macro apply the formatting. Sigh... :)
>>>
>>> If you do insert all the macro calls with the command names, I will take
>>> care of the formatting.
>>>
>>> - Carsten
>>>
>>
>> Hi,
>>
>> will do that.
>>
>> Let us check nonetheless a working example first.
>>
>> While trying to put @asis at the right place, I get error messages and
>> it refuses to compile.
>>
>> Could you re-write the example for me?
>>
>> Sorry being that stupid :-)
>>
>> Andreas
>
> I mean it like this:
>
> @macro orgcmd{key,command}
> @kindex \key\
> @findex \command\
> @item @kbd{\key\} @ @ @ @ @ @ @ @ @ @ (@code{\command}\)
> @end macro
>
> And then define keys/commands like this:
>
> @table @asis
> .....
> @orgcmd{C-c C-x @key{TAB}, org-cycle}
> Here follows the description of the command
> ....
> @end table
>
>
> Does this work?
>
> - Carsten
Think so, thanks.
Patch relying upon attached.
Please have a look at lines 1097 and 1379.
Looks like an erronius replacements.
As its done by a script, ...
Andreas
[-- Attachment #2: texi.patch --]
[-- Type: text/x-patch, Size: 8865 bytes --]
diff --git a/doc/org.texi b/doc/org.texi
index 1624111..5cb1878 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -22,6 +22,11 @@
@finalout
@c Macro definitions
+@macro orgcmd{key,command}
+@kindex \key\
+@findex \command\
+@item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
+@end macro
@iftex
@c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
@end iftex
@@ -898,9 +903,8 @@ Org uses just two commands, bound to @key{TAB} and
@cindex folded, subtree visibility state
@cindex children, subtree visibility state
@cindex subtree, subtree visibility state
-@table @kbd
-@kindex @key{TAB}
-@item @key{TAB}
+@table @asis
+@orgcmd{@key{TAB}, org-cycle}
@emph{Subtree cycling}: Rotate current subtree among the states
@example
@@ -940,19 +944,16 @@ tables, @kbd{S-@key{TAB}} jumps to the previous field.
@kindex C-u C-u C-u @key{TAB}
@item C-u C-u C-u @key{TAB}
Show all, including drawers.
-@kindex C-c C-r
-@item C-c C-r
+@orgcmd{C-c C-r, org-reveal}
Reveal context around point, showing the current entry, the following heading
and the hierarchy above. Useful for working near a location that has been
exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
(@pxref{Agenda commands}). With a prefix argument show, on each
level, all sibling headings. With double prefix arg, also show the entire
subtree of the parent.
-@kindex C-c C-k
-@item C-c C-k
+@orgcmd{C-c C-k, org-kill-note-or-show-branches}
Expose all the headings of the subtree, CONTENT view for just one subtree.
-@kindex C-c C-x b
-@item C-c C-x b
+@orgcmd{C-c C-x b, org-tree-to-indirect-buffer}
Show the current subtree in an indirect buffer@footnote{The indirect
buffer
@ifinfo
@@ -1009,24 +1010,18 @@ entries.
@cindex headline navigation
The following commands jump to other headlines in the buffer.
-@table @kbd
-@kindex C-c C-n
-@item C-c C-n
+@table @asis
+@orgcmd{C-c C-n, outline-next-visible-heading}
Next heading.
-@kindex C-c C-p
-@item C-c C-p
+@orgcmd{C-c C-p, outline-previous-visible-heading}
Previous heading.
-@kindex C-c C-f
-@item C-c C-f
+@orgcmd{C-c C-f, org-forward-same-level}
Next heading same level.
-@kindex C-c C-b
-@item C-c C-b
+@orgcmd{C-c C-b, org-backward-same-level}
Previous heading same level.
-@kindex C-c C-u
-@item C-c C-u
+@orgcmd{C-c C-u, outline-up-heading}
Backward to higher level heading.
-@kindex C-c C-j
-@item C-c C-j
+@orgcmd{C-c C-j, org-goto}
Jump to a different place without changing the current outline
visibility. Shows the document structure in a temporary buffer, where
you can use the following keys to find your destination:
@@ -1061,9 +1056,8 @@ See also the variable @code{org-goto-interface}.
@cindex sorting, of subtrees
@cindex subtrees, cut and paste
-@table @kbd
-@kindex M-@key{RET}
-@item M-@key{RET}
+@table @asis
+@orgcmd{M-@key{RET}, org-insert-heading}
@vindex org-M-RET-may-split-line
Insert new heading with same level as current. If the cursor is in a
plain list item, a new item is created (@pxref{Plain lists}). To force
@@ -1093,47 +1087,36 @@ variable @code{org-treat-insert-todo-heading-as-state-change}.
Insert new TODO entry with same level as current heading. Like
@kbd{C-@key{RET}}, the new headline will be inserted after the current
subtree.
-@kindex @key{TAB}
-@item @key{TAB} @r{in new, empty entry}
+@orgcmd{@key{TAB}, org-cycle}
In a new entry with no text yet, the first @key{TAB} demotes the entry to
become a child of the previous one. The next @key{TAB} makes it a parent,
and so on, all the way to top level. Yet another @key{TAB}, and you are back
to the initial level.
-@kindex M-@key{left}
-@item M-@key{left}
+@orgcmd{M-@key{left}, org-metaleft}
Promote current heading by one level.
-@kindex M-@key{right}
-@item M-@key{right}
+@orgcmd{M-@key{right}, org-metaright}
Demote current heading by one level.
-@kindex M-S-@key{left}
-@item M-S-@key{left}
+@orgcmd{M-S-@key{left}, org-shiftmetaleft}
Promote the current subtree by one level.
-@kindex M-S-@key{right}
-@item M-S-@key{right}
+@orgcmd{M-S-@key{right}, org-shiftmetaright}
Demote the current subtree by one level.
-@kindex M-S-@key{up}
-@item M-S-@key{up}
+@orgcmd{M-S-@key{up}, org-shiftmetaup}
Move subtree up (swap with previous subtree of same
level).
-@kindex M-S-@key{down}
-@item M-S-@key{down}
+@orgcmd{M-S-@key{down}, org-shiftmetadown}
Move subtree down (swap with next subtree of same level).
-@kindex C-c C-x C-w
-@item C-c C-x C-w
+@orgcmd{C-c C-x C-w, org-cut-special}
Kill subtree, i.e. remove it from buffer but save in kill ring.
With a numeric prefix argument N, kill N sequential subtrees.
-@kindex C-c C-x M-w
-@item C-c C-x M-w
+@orgcmd{C-c C-x M-w, org-copy-special}
Copy subtree to kill ring. With a numeric prefix argument N, copy the N
sequential subtrees.
-@kindex C-c C-x C-y
-@item C-c C-x C-y
+@orgcmd{C-c C-x C-y, org-paste-special}
Yank subtree from kill ring. This does modify the level of the subtree to
make sure the tree fits in nicely at the yank position. The yank level can
also be specified with a numeric prefix argument, or by yanking after a
headline marker like @samp{****}.
-@kindex C-y
-@item C-y
+@orgcmd{C-y, org-yank}
@vindex org-yank-adjusted-subtrees
@vindex org-yank-folded-subtrees
Depending on the variables @code{org-yank-adjusted-subtrees} and
@@ -1146,19 +1129,16 @@ previously visible. Any prefix argument to this command will force a normal
force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
yank, it will yank previous kill items plainly, without adjustment and
folding.
-@kindex C-c C-x c
-@item C-c C-x c
+@orgcmd{C-c C-x c, org-clone-subtree-with-time-shift}
Clone a subtree by making a number of sibling copies of it. You will be
prompted for the number of copies to make, and you can also specify if any
timestamps in the entry should be shifted. This can be useful, for example,
to create a number of tasks related to a series of lectures to prepare. For
more details, see the docstring of the command
@code{org-clone-subtree-with-time-shift}.
-@kindex C-c C-w
-@item C-c C-w
+@orgcmd{C-c C-w, org-refile}
Refile entry or region to a different location. @xref{Refiling notes}.
-@kindex C-c ^
-@item C-c ^
+@orgcmd{C-c ^, org-sort}
Sort same-level entries. When there is an active region, all entries in the
region will be sorted. Otherwise the children of the current headline are
sorted. The command prompts for the sorting method, which can be
@@ -1175,8 +1155,7 @@ Narrow buffer to current subtree.
@kindex C-x n w
@item C-x n w
Widen buffer to remove narrowing.
-@kindex C-c *
-@item C-c *
+@orgcmd{C-c *, org-ctrl-c-ctrl-c}
Turn a normal line or plain list item into a headline (so that it becomes a
subheading at its location). Also turn a headline into a normal line by
removing the stars. If there is an active region, turn all lines in the
@@ -1220,9 +1199,8 @@ and you will see immediately how it works.
Org-mode contains several commands creating such trees, all these
commands can be accessed through a dispatcher:
-@table @kbd
-@kindex C-c /
-@item C-c /
+@table @asis
+@orgcmd{C-c /, org-sparse-tree}
This prompts for an extra key to select a sparse-tree creating command.
@kindex C-c / r
@item C-c / r
@@ -1347,9 +1325,8 @@ the current list-level) improves readability, customize the variable
The following commands act on items when the cursor is in the first line
of an item (the line with the bullet or number).
-@table @kbd
-@kindex @key{TAB}
-@item @key{TAB}
+@table @asis
+@orgcmd{@key{TAB}, org-cycle}
@vindex org-cycle-include-plain-lists
Items can be folded just like headline levels. Normally this works only if
the cursor is on a plain list item. For more details, see the variable
@@ -1360,8 +1337,7 @@ headlines, however; the hierarchies remain completely separated.
If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
fixes the indentation of the current line in a heuristic way.
-@kindex M-@key{RET}
-@item M-@key{RET}
+@orgcmd{M-@key{RET}, org-insert-heading}
@vindex org-M-RET-may-split-line
Insert new item at current level. With a prefix argument, force a new
heading (@pxref{Structure editing}). If this command is used in the middle
@@ -1375,13 +1351,11 @@ bullet, a bullet is added to the current line.
@kindex M-S-@key{RET}
@item M-S-@key{RET}
Insert a new item with a checkbox (@pxref{Checkboxes}).
-@kindex @key{TAB}
-@item @key{TAB} @r{in new, empty item}
+@orgcmd{@key{TAB}, org-cycle}
In a new item with no text yet, the first @key{TAB} demotes the item to
become a child of the previous one. The next @key{TAB} makes it a parent,
and so on, all the way to the left margin. Yet another @key{TAB}, and you
are back to the initial level.
-@kindex S-@key{up}
@kindex S-@key{down}
@item S-@key{up}
@itemx S-@key{down}
[-- Attachment #3: Type: text/plain, Size: 201 bytes --]
_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply related [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-16 8:57 ` Carsten Dominik
2010-08-17 12:43 ` Andreas Röhler
@ 2010-08-17 15:44 ` Andreas Röhler
1 sibling, 0 replies; 44+ messages in thread
From: Andreas Röhler @ 2010-08-17 15:44 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
>>>>>> Here is my proposal for now:
>>>>>>
>>>>>> @macro orgcmd{key,command}
>>>>>> @kindex \key\
>>>>>> @findex \command\
>>>>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>>>>> @end macro
>>>>>>
>>>>>> And then define keys/commands like this:
>>>>>>
>>>>>> @table @kbd
>>>>>> .....
>>>>>> @orgcmd{@key{TAB}, org-cycle}
>>>>>> Here follows the description of the command
>>>>>> ....
>>>>>> @end table
>>>>>>
>>>>>> - Carsten
>>>>>>
>>>>>>
>>>>> [ ... ]
>>>>>
>>>>> Hi Carsten,
>>>>>
>>>>> attached a sreenshot, how it comes out for C-c C-b.
>>>>> Doesn't look ok for me, as back-tick and quote are uncommon that way.
>>>>
>>>> Hi Andreas, you are correct, this does not look right.
>>>> Seems like we will have to make the table ins @asis and
>>>> then have the macro apply the formatting. Sigh... :)
>>>
>>> If you do insert all the macro calls with the command names, I will take
>>> care of the formatting.
>>>
>>> - Carsten
>>>
>>
>> Hi,
>>
>> will do that.
>>
>> Let us check nonetheless a working example first.
>>
>> While trying to put @asis at the right place, I get error messages
>> and it refuses to compile.
>>
>> Could you re-write the example for me?
>>
>> Sorry being that stupid :-)
>>
>> Andreas
>
> I mean it like this:
>
> @macro orgcmd{key,command}
> @kindex \key\
> @findex \command\
> @item @kbd{\key\} @ @ @ @ @ @ @ @ @ @ (@code{\command}\)
> @end macro
>
> And then define keys/commands like this:
>
> @table @asis
> .....
> @orgcmd{C-c C-x @key{TAB}, org-cycle}
> Here follows the description of the command
> ....
> @end table
>
BTW used macro form from first proposal, @asis entry from second.
Second macro form was not visible (maybe due typo backslash "}\)" ?)
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-17 12:43 ` Andreas Röhler
@ 2010-08-18 8:38 ` Carsten Dominik
2010-08-20 6:27 ` Andreas Röhler
0 siblings, 1 reply; 44+ messages in thread
From: Carsten Dominik @ 2010-08-18 8:38 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
Hi Andreas,
this already goes in the right direction.
I have a better definition for the macro, which does now
push the command name all the way to the right (in PDF output).
I hated the look of the command name separated by a fixed
number of spaces - this is a lot better.
Does anyone know how to do this for HTML and info?
@macro orgcmd{key,command}
@iftex
@kindex \key\
@findex \command\
@item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
@end iftex
@ifnottex
@kindex \key\
@findex \command\
@item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
@end ifnottex
@end macro
Also, since the table is now an @asis table, lines which do not
have a command name like
@item C-u C-u C-u @key{TAB}
will need an explicit formatting command, like this:
@item @kbd{C-u C-u C-u @key{TAB}}
Alternatively, we could have another macro
@macro orgkey{key}
@item @kbd{\key\}
@end macro
so that we could write keys for which we have no command name
like this:
@orgkey{C-u C-u C-u @key{TAB}}
Hope this gets you on your way with a tideous task....
One more thing: I do frequently small changes in the manual,
so please make sure to update your patch to the most recent
version of Org.
> Please have a look at lines 1097 and 1379.
> Looks like an erronius replacements.
> As its done by a script, ...
Well, hand checking will absolutely be necessary with this patch.
Hope you can do as much as possible of that as well, maybe with
comments in the text to get my attention to certain places.
- Carsten
On Aug 17, 2010, at 2:43 PM, Andreas Röhler wrote:
> Am 16.08.2010 10:57, schrieb Carsten Dominik:
>>
>> On Aug 15, 2010, at 9:07 PM, Andreas Röhler wrote:
>>
>>> Am 15.08.2010 09:39, schrieb Carsten Dominik:
>>>>
>>>> On Aug 15, 2010, at 9:37 AM, Carsten Dominik wrote:
>>>>
>>>>>
>>>>> On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
>>>>>
>>>>>> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>>>>>>
>>>>>>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>>>>>>
>>>>>>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>>>>>>
>>>>>>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>>>>>>
>>>>>>>>>> Hi Andreas, org-mode developers,
>>>>>>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>>>>>>> I have put a version of the manual as modified by Andreas
>>>>>>>>>>>> here:
>>>>>>>>>>>>
>>>>>>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>>>>>>
>>>>>>>>>>>> Not all the command names are in there, but quite a few
>>>>>>>>>>>> are.
>>>>>>>>>>>> I'd like to hear from more people
>>>>>>>>>>>>
>>>>>>>>>>>> - if they would like to have the names there (i.e. if it
>>>>>>>>>>>> would
>>>>>>>>>>>> help them finding a command)
>>>>>>>>>
>>>>>>>>> I would like the command names in the manual.
>>>>>>>>>
>>>>>>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>>>>>>> descriptively and not being afraid to use long names in the
>>>>>>>>> interests
>>>>>>>>> of accuracy. It's a shame to lose all that by displaying
>>>>>>>>> only key
>>>>>>>>> sequences. It's a linguistic world of its own and I like being
>>>>>>>>> exposed
>>>>>>>>> to it.
>>>>>>>>> - While one can do C-h k, that's not the same as the way one
>>>>>>>>> learns the
>>>>>>>>> function names by skimming the manual
>>>>>>>>
>>>>>>>> Also, it does not add length to the HTML version of the manual,
>>>>>>>> because
>>>>>>>> the key sequences are already on a line of their own. And the
>>>>>>>> same is
>>>>>>>> true for a certain proportion of the pdf entries (when the key
>>>>>>>> sequence
>>>>>>>> is long, then it seems to go on its own line).
>>>>>>>>
>>>>>>>>
>>>>>>>>>
>>>>>>>>>>>> - if the position (first thing in the command description)
>>>>>>>>>>>> is right, or if it would be better to have it
>>>>>>>>>>>> - last thing in the description
>>>>>>>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>>>>>>>> does it.
>>>>>>>>>
>>>>>>>>> I definitely would want them out on a line of their own with
>>>>>>>>> the
>>>>>>>>> key
>>>>>>>>> sequence. I liked the right-aligned model.
>>>>>>>>>
>>>>>>>>> Or if not right-aligned, is it possible not to have the comma?
>>>>>>>>> Maybe a
>>>>>>>>> different font?
>>>>>>>
>>>>>>> I also like the position on the key line best. So if there is a
>>>>>>> more-or-less
>>>>>>> general agreement that we should get the names in, this would
>>>>>>> be my
>>>>>>> preferred
>>>>>>> location as well. I knot that this is different from what the
>>>>>>> emacs
>>>>>>> and gnus manuals do - but I still think that a solution like
>>>>>>> this
>>>>>>> would
>>>>>>> be better.
>>>>>>>
>>>>>>> Andreas, can you be bothered to rework the patch?
>>>>>>>
>>>>>>> Unfortunately I have no idea if/how the right-aligned model
>>>>>>> could be
>>>>>>> made to
>>>>>>> work. So I think the safest way to do this would be to
>>>>>>> introduce the
>>>>>>> macro,
>>>>>>> and we can then work on the macro to get the formatting right,
>>>>>>> and
>>>>>>> also
>>>>>>> to do the
>>>>>>> key and function index stuff fully automatically.
>>>>>>>
>>>>>>> Here is my proposal for now:
>>>>>>>
>>>>>>> @macro orgcmd{key,command}
>>>>>>> @kindex \key\
>>>>>>> @findex \command\
>>>>>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>>>>>> @end macro
>>>>>>>
>>>>>>> And then define keys/commands like this:
>>>>>>>
>>>>>>> @table @kbd
>>>>>>> .....
>>>>>>> @orgcmd{@key{TAB}, org-cycle}
>>>>>>> Here follows the description of the command
>>>>>>> ....
>>>>>>> @end table
>>>>>>>
>>>>>>> - Carsten
>>>>>>>
>>>>>>>
>>>>>> [ ... ]
>>>>>>
>>>>>> Hi Carsten,
>>>>>>
>>>>>> attached a sreenshot, how it comes out for C-c C-b.
>>>>>> Doesn't look ok for me, as back-tick and quote are uncommon
>>>>>> that way.
>>>>>
>>>>> Hi Andreas, you are correct, this does not look right.
>>>>> Seems like we will have to make the table ins @asis and
>>>>> then have the macro apply the formatting. Sigh... :)
>>>>
>>>> If you do insert all the macro calls with the command names, I
>>>> will take
>>>> care of the formatting.
>>>>
>>>> - Carsten
>>>>
>>>
>>> Hi,
>>>
>>> will do that.
>>>
>>> Let us check nonetheless a working example first.
>>>
>>> While trying to put @asis at the right place, I get error messages
>>> and
>>> it refuses to compile.
>>>
>>> Could you re-write the example for me?
>>>
>>> Sorry being that stupid :-)
>>>
>>> Andreas
>>
>> I mean it like this:
>>
>> @macro orgcmd{key,command}
>> @kindex \key\
>> @findex \command\
>> @item @kbd{\key\} @ @ @ @ @ @ @ @ @ @ (@code{\command}\)
>> @end macro
>>
>> And then define keys/commands like this:
>>
>> @table @asis
>> .....
>> @orgcmd{C-c C-x @key{TAB}, org-cycle}
>> Here follows the description of the command
>> ....
>> @end table
>>
>>
>> Does this work?
>>
>> - Carsten
>
>
> Think so, thanks.
> Patch relying upon attached.
>
>
>
> Andreas
> <texi.patch>_______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-18 8:38 ` Carsten Dominik
@ 2010-08-20 6:27 ` Andreas Röhler
2010-08-20 7:31 ` Carsten Dominik
2010-08-20 7:44 ` Carsten Dominik
0 siblings, 2 replies; 44+ messages in thread
From: Andreas Röhler @ 2010-08-20 6:27 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
Am 18.08.2010 10:38, schrieb Carsten Dominik:
> Hi Andreas,
>
> this already goes in the right direction.
>
> I have a better definition for the macro, which does now
> push the command name all the way to the right (in PDF output).
> I hated the look of the command name separated by a fixed
> number of spaces - this is a lot better.
> Does anyone know how to do this for HTML and info?
>
> @macro orgcmd{key,command}
> @iftex
> @kindex \key\
> @findex \command\
> @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
> @end iftex
> @ifnottex
> @kindex \key\
> @findex \command\
> @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
> @end ifnottex
> @end macro
>
> Also, since the table is now an @asis table, lines which do not
> have a command name like
>
> @item C-u C-u C-u @key{TAB}
>
> will need an explicit formatting command, like this:
>
> @item @kbd{C-u C-u C-u @key{TAB}}
>
> Alternatively, we could have another macro
>
> @macro orgkey{key}
> @item @kbd{\key\}
> @end macro
>
> so that we could write keys for which we have no command name
> like this:
>
> @orgkey{C-u C-u C-u @key{TAB}}
>
> Hope this gets you on your way with a tideous task....
Hmm,
I'm afraid this starts walking the desert.
May be it helps keeping things apart for the beginning.
1) Introducing the command names
2) Completing the formatting
As views are different concerning the latter, thats a rather hard task
for me, as I can't see the progress...
For me it's important seeing command names somewhere near its keys.
If beneath or at the right, doesn't matter that much IMHO.
>
> One more thing: I do frequently small changes in the manual,
> so please make sure to update your patch to the most recent
> version of Org.
>
>
>> Please have a look at lines 1097 and 1379.
>> Looks like an erronius replacements.
>> As its done by a script, ...
>
> Well, hand checking will absolutely be necessary with this patch.
Did that. Cancelled the warning already. Seems you didn't get the mail.
What about checkin in the patch as it's done so far?
Andreas
> Hope you can do as much as possible of that as well, maybe with
> comments in the text to get my attention to certain places.
>
> - Carsten
>
> On Aug 17, 2010, at 2:43 PM, Andreas Röhler wrote:
>
>> Am 16.08.2010 10:57, schrieb Carsten Dominik:
>>>
>>> On Aug 15, 2010, at 9:07 PM, Andreas Röhler wrote:
>>>
>>>> Am 15.08.2010 09:39, schrieb Carsten Dominik:
>>>>>
>>>>> On Aug 15, 2010, at 9:37 AM, Carsten Dominik wrote:
>>>>>
>>>>>>
>>>>>> On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
>>>>>>
>>>>>>> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>>>>>>>
>>>>>>>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>>>>>>>
>>>>>>>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>>>>>>>
>>>>>>>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>>>>>>>
>>>>>>>>>>> Hi Andreas, org-mode developers,
>>>>>>>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>>>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>>>>>>>> I have put a version of the manual as modified by Andreas
>>>>>>>>>>>>> here:
>>>>>>>>>>>>>
>>>>>>>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>>>>>>>
>>>>>>>>>>>>> Not all the command names are in there, but quite a few are.
>>>>>>>>>>>>> I'd like to hear from more people
>>>>>>>>>>>>>
>>>>>>>>>>>>> - if they would like to have the names there (i.e. if it would
>>>>>>>>>>>>> help them finding a command)
>>>>>>>>>>
>>>>>>>>>> I would like the command names in the manual.
>>>>>>>>>>
>>>>>>>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>>>>>>>> descriptively and not being afraid to use long names in the
>>>>>>>>>> interests
>>>>>>>>>> of accuracy. It's a shame to lose all that by displaying only key
>>>>>>>>>> sequences. It's a linguistic world of its own and I like being
>>>>>>>>>> exposed
>>>>>>>>>> to it.
>>>>>>>>>> - While one can do C-h k, that's not the same as the way one
>>>>>>>>>> learns the
>>>>>>>>>> function names by skimming the manual
>>>>>>>>>
>>>>>>>>> Also, it does not add length to the HTML version of the manual,
>>>>>>>>> because
>>>>>>>>> the key sequences are already on a line of their own. And the
>>>>>>>>> same is
>>>>>>>>> true for a certain proportion of the pdf entries (when the key
>>>>>>>>> sequence
>>>>>>>>> is long, then it seems to go on its own line).
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>>>> - if the position (first thing in the command description)
>>>>>>>>>>>>> is right, or if it would be better to have it
>>>>>>>>>>>>> - last thing in the description
>>>>>>>>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>>>>>>>>> does it.
>>>>>>>>>>
>>>>>>>>>> I definitely would want them out on a line of their own with the
>>>>>>>>>> key
>>>>>>>>>> sequence. I liked the right-aligned model.
>>>>>>>>>>
>>>>>>>>>> Or if not right-aligned, is it possible not to have the comma?
>>>>>>>>>> Maybe a
>>>>>>>>>> different font?
>>>>>>>>
>>>>>>>> I also like the position on the key line best. So if there is a
>>>>>>>> more-or-less
>>>>>>>> general agreement that we should get the names in, this would be my
>>>>>>>> preferred
>>>>>>>> location as well. I knot that this is different from what the emacs
>>>>>>>> and gnus manuals do - but I still think that a solution like this
>>>>>>>> would
>>>>>>>> be better.
>>>>>>>>
>>>>>>>> Andreas, can you be bothered to rework the patch?
>>>>>>>>
>>>>>>>> Unfortunately I have no idea if/how the right-aligned model
>>>>>>>> could be
>>>>>>>> made to
>>>>>>>> work. So I think the safest way to do this would be to introduce
>>>>>>>> the
>>>>>>>> macro,
>>>>>>>> and we can then work on the macro to get the formatting right, and
>>>>>>>> also
>>>>>>>> to do the
>>>>>>>> key and function index stuff fully automatically.
>>>>>>>>
>>>>>>>> Here is my proposal for now:
>>>>>>>>
>>>>>>>> @macro orgcmd{key,command}
>>>>>>>> @kindex \key\
>>>>>>>> @findex \command\
>>>>>>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>>>>>>> @end macro
>>>>>>>>
>>>>>>>> And then define keys/commands like this:
>>>>>>>>
>>>>>>>> @table @kbd
>>>>>>>> .....
>>>>>>>> @orgcmd{@key{TAB}, org-cycle}
>>>>>>>> Here follows the description of the command
>>>>>>>> ....
>>>>>>>> @end table
>>>>>>>>
>>>>>>>> - Carsten
>>>>>>>>
>>>>>>>>
>>>>>>> [ ... ]
>>>>>>>
>>>>>>> Hi Carsten,
>>>>>>>
>>>>>>> attached a sreenshot, how it comes out for C-c C-b.
>>>>>>> Doesn't look ok for me, as back-tick and quote are uncommon that
>>>>>>> way.
>>>>>>
>>>>>> Hi Andreas, you are correct, this does not look right.
>>>>>> Seems like we will have to make the table ins @asis and
>>>>>> then have the macro apply the formatting. Sigh... :)
>>>>>
>>>>> If you do insert all the macro calls with the command names, I will
>>>>> take
>>>>> care of the formatting.
>>>>>
>>>>> - Carsten
>>>>>
>>>>
>>>> Hi,
>>>>
>>>> will do that.
>>>>
>>>> Let us check nonetheless a working example first.
>>>>
>>>> While trying to put @asis at the right place, I get error messages and
>>>> it refuses to compile.
>>>>
>>>> Could you re-write the example for me?
>>>>
>>>> Sorry being that stupid :-)
>>>>
>>>> Andreas
>>>
>>> I mean it like this:
>>>
>>> @macro orgcmd{key,command}
>>> @kindex \key\
>>> @findex \command\
>>> @item @kbd{\key\} @ @ @ @ @ @ @ @ @ @ (@code{\command}\)
>>> @end macro
>>>
>>> And then define keys/commands like this:
>>>
>>> @table @asis
>>> .....
>>> @orgcmd{C-c C-x @key{TAB}, org-cycle}
>>> Here follows the description of the command
>>> ....
>>> @end table
>>>
>>>
>>> Does this work?
>>>
>>> - Carsten
>>
>>
>> Think so, thanks.
>> Patch relying upon attached.
>>
>>
>>
>> Andreas
>> <texi.patch>_______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
>
>
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-20 6:27 ` Andreas Röhler
@ 2010-08-20 7:31 ` Carsten Dominik
2010-08-20 8:13 ` Andreas Röhler
2010-08-20 7:44 ` Carsten Dominik
1 sibling, 1 reply; 44+ messages in thread
From: Carsten Dominik @ 2010-08-20 7:31 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
Hi Andreas,
On Aug 20, 2010, at 8:27 AM, Andreas Röhler wrote:
> Am 18.08.2010 10:38, schrieb Carsten Dominik:
>> Hi Andreas,
>>
>> this already goes in the right direction.
>>
>> I have a better definition for the macro, which does now
>> push the command name all the way to the right (in PDF output).
>> I hated the look of the command name separated by a fixed
>> number of spaces - this is a lot better.
>> Does anyone know how to do this for HTML and info?
>>
>> @macro orgcmd{key,command}
>> @iftex
>> @kindex \key\
>> @findex \command\
>> @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
>> @end iftex
>> @ifnottex
>> @kindex \key\
>> @findex \command\
>> @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
>> @end ifnottex
>> @end macro
>>
>> Also, since the table is now an @asis table, lines which do not
>> have a command name like
>>
>> @item C-u C-u C-u @key{TAB}
>>
>> will need an explicit formatting command, like this:
>>
>> @item @kbd{C-u C-u C-u @key{TAB}}
>>
>> Alternatively, we could have another macro
>>
>> @macro orgkey{key}
>> @item @kbd{\key\}
>> @end macro
>>
>> so that we could write keys for which we have no command name
>> like this:
>>
>> @orgkey{C-u C-u C-u @key{TAB}}
>>
>> Hope this gets you on your way with a tideous task....
>
> Hmm,
>
> I'm afraid this starts walking the desert.
> May be it helps keeping things apart for the beginning.
>
> 1) Introducing the command names
> 2) Completing the formatting
>
> As views are different concerning the latter, thats a rather hard
> task for me, as I can't see the progress...
>
> For me it's important seeing command names somewhere near its keys.
> If beneath or at the right, doesn't matter that much IMHO.
I am not sure what the problem is.
For keys where you have a command name, you continue as you have been
doing.
For keys where you do not have the command names, just enclose the key
after the @item into @kbd{...}
This should get you very far.
I am not sure if I have the most recent patch - can you
please send it again, so that I can check it?
Thanks.
- Carsten
>
>
>
>>
>> One more thing: I do frequently small changes in the manual,
>> so please make sure to update your patch to the most recent
>> version of Org.
>>
>>
>>> Please have a look at lines 1097 and 1379.
>>> Looks like an erronius replacements.
>>> As its done by a script, ...
>>
>> Well, hand checking will absolutely be necessary with this patch.
>
> Did that. Cancelled the warning already. Seems you didn't get the
> mail.
>
> What about checkin in the patch as it's done so far?
>
> Andreas
>
>
>> Hope you can do as much as possible of that as well, maybe with
>> comments in the text to get my attention to certain places.
>>
>> - Carsten
>>
>> On Aug 17, 2010, at 2:43 PM, Andreas Röhler wrote:
>>
>>> Am 16.08.2010 10:57, schrieb Carsten Dominik:
>>>>
>>>> On Aug 15, 2010, at 9:07 PM, Andreas Röhler wrote:
>>>>
>>>>> Am 15.08.2010 09:39, schrieb Carsten Dominik:
>>>>>>
>>>>>> On Aug 15, 2010, at 9:37 AM, Carsten Dominik wrote:
>>>>>>
>>>>>>>
>>>>>>> On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
>>>>>>>
>>>>>>>> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>>>>>>>>
>>>>>>>>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>>>>>>>>
>>>>>>>>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>>>>>>>>
>>>>>>>>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>>>>>>>>
>>>>>>>>>>>> Hi Andreas, org-mode developers,
>>>>>>>>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>>>>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>>>>>>>>> I have put a version of the manual as modified by Andreas
>>>>>>>>>>>>>> here:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Not all the command names are in there, but quite a few
>>>>>>>>>>>>>> are.
>>>>>>>>>>>>>> I'd like to hear from more people
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> - if they would like to have the names there (i.e. if
>>>>>>>>>>>>>> it would
>>>>>>>>>>>>>> help them finding a command)
>>>>>>>>>>>
>>>>>>>>>>> I would like the command names in the manual.
>>>>>>>>>>>
>>>>>>>>>>> - Emacs-lisp has a lovely tradition of naming functions
>>>>>>>>>>> *very*
>>>>>>>>>>> descriptively and not being afraid to use long names in the
>>>>>>>>>>> interests
>>>>>>>>>>> of accuracy. It's a shame to lose all that by displaying
>>>>>>>>>>> only key
>>>>>>>>>>> sequences. It's a linguistic world of its own and I like
>>>>>>>>>>> being
>>>>>>>>>>> exposed
>>>>>>>>>>> to it.
>>>>>>>>>>> - While one can do C-h k, that's not the same as the way one
>>>>>>>>>>> learns the
>>>>>>>>>>> function names by skimming the manual
>>>>>>>>>>
>>>>>>>>>> Also, it does not add length to the HTML version of the
>>>>>>>>>> manual,
>>>>>>>>>> because
>>>>>>>>>> the key sequences are already on a line of their own. And the
>>>>>>>>>> same is
>>>>>>>>>> true for a certain proportion of the pdf entries (when the
>>>>>>>>>> key
>>>>>>>>>> sequence
>>>>>>>>>> is long, then it seems to go on its own line).
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>>>> - if the position (first thing in the command
>>>>>>>>>>>>>> description)
>>>>>>>>>>>>>> is right, or if it would be better to have it
>>>>>>>>>>>>>> - last thing in the description
>>>>>>>>>>>>>> - or after the first sentence, this is how the GNUS
>>>>>>>>>>>>>> manual
>>>>>>>>>>>>>> does it.
>>>>>>>>>>>
>>>>>>>>>>> I definitely would want them out on a line of their own
>>>>>>>>>>> with the
>>>>>>>>>>> key
>>>>>>>>>>> sequence. I liked the right-aligned model.
>>>>>>>>>>>
>>>>>>>>>>> Or if not right-aligned, is it possible not to have the
>>>>>>>>>>> comma?
>>>>>>>>>>> Maybe a
>>>>>>>>>>> different font?
>>>>>>>>>
>>>>>>>>> I also like the position on the key line best. So if there
>>>>>>>>> is a
>>>>>>>>> more-or-less
>>>>>>>>> general agreement that we should get the names in, this
>>>>>>>>> would be my
>>>>>>>>> preferred
>>>>>>>>> location as well. I knot that this is different from what
>>>>>>>>> the emacs
>>>>>>>>> and gnus manuals do - but I still think that a solution like
>>>>>>>>> this
>>>>>>>>> would
>>>>>>>>> be better.
>>>>>>>>>
>>>>>>>>> Andreas, can you be bothered to rework the patch?
>>>>>>>>>
>>>>>>>>> Unfortunately I have no idea if/how the right-aligned model
>>>>>>>>> could be
>>>>>>>>> made to
>>>>>>>>> work. So I think the safest way to do this would be to
>>>>>>>>> introduce
>>>>>>>>> the
>>>>>>>>> macro,
>>>>>>>>> and we can then work on the macro to get the formatting
>>>>>>>>> right, and
>>>>>>>>> also
>>>>>>>>> to do the
>>>>>>>>> key and function index stuff fully automatically.
>>>>>>>>>
>>>>>>>>> Here is my proposal for now:
>>>>>>>>>
>>>>>>>>> @macro orgcmd{key,command}
>>>>>>>>> @kindex \key\
>>>>>>>>> @findex \command\
>>>>>>>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>>>>>>>> @end macro
>>>>>>>>>
>>>>>>>>> And then define keys/commands like this:
>>>>>>>>>
>>>>>>>>> @table @kbd
>>>>>>>>> .....
>>>>>>>>> @orgcmd{@key{TAB}, org-cycle}
>>>>>>>>> Here follows the description of the command
>>>>>>>>> ....
>>>>>>>>> @end table
>>>>>>>>>
>>>>>>>>> - Carsten
>>>>>>>>>
>>>>>>>>>
>>>>>>>> [ ... ]
>>>>>>>>
>>>>>>>> Hi Carsten,
>>>>>>>>
>>>>>>>> attached a sreenshot, how it comes out for C-c C-b.
>>>>>>>> Doesn't look ok for me, as back-tick and quote are uncommon
>>>>>>>> that
>>>>>>>> way.
>>>>>>>
>>>>>>> Hi Andreas, you are correct, this does not look right.
>>>>>>> Seems like we will have to make the table ins @asis and
>>>>>>> then have the macro apply the formatting. Sigh... :)
>>>>>>
>>>>>> If you do insert all the macro calls with the command names, I
>>>>>> will
>>>>>> take
>>>>>> care of the formatting.
>>>>>>
>>>>>> - Carsten
>>>>>>
>>>>>
>>>>> Hi,
>>>>>
>>>>> will do that.
>>>>>
>>>>> Let us check nonetheless a working example first.
>>>>>
>>>>> While trying to put @asis at the right place, I get error
>>>>> messages and
>>>>> it refuses to compile.
>>>>>
>>>>> Could you re-write the example for me?
>>>>>
>>>>> Sorry being that stupid :-)
>>>>>
>>>>> Andreas
>>>>
>>>> I mean it like this:
>>>>
>>>> @macro orgcmd{key,command}
>>>> @kindex \key\
>>>> @findex \command\
>>>> @item @kbd{\key\} @ @ @ @ @ @ @ @ @ @ (@code{\command}\)
>>>> @end macro
>>>>
>>>> And then define keys/commands like this:
>>>>
>>>> @table @asis
>>>> .....
>>>> @orgcmd{C-c C-x @key{TAB}, org-cycle}
>>>> Here follows the description of the command
>>>> ....
>>>> @end table
>>>>
>>>>
>>>> Does this work?
>>>>
>>>> - Carsten
>>>
>>>
>>> Think so, thanks.
>>> Patch relying upon attached.
>>>
>>>
>>>
>>> Andreas
>>> <texi.patch>_______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>>
>>
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-20 6:27 ` Andreas Röhler
2010-08-20 7:31 ` Carsten Dominik
@ 2010-08-20 7:44 ` Carsten Dominik
1 sibling, 0 replies; 44+ messages in thread
From: Carsten Dominik @ 2010-08-20 7:44 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
On Aug 20, 2010, at 8:27 AM, Andreas Röhler wrote:
>
> Did that. Cancelled the warning already. Seems you didn't get the
> mail.
Sorry about that. I get bout 50 email per day relating to org-mode,
and I often work off line, so it is possible that I reply to one email
while another one is waiting in a queue - or it is also entirely
possible that I overlook a part of an email.
I did get that message.
- Carsten
>
> What about checkin in the patch as it's done so far?
>
> Andreas
>
>
>> Hope you can do as much as possible of that as well, maybe with
>> comments in the text to get my attention to certain places.
>>
>> - Carsten
>>
>> On Aug 17, 2010, at 2:43 PM, Andreas Röhler wrote:
>>
>>> Am 16.08.2010 10:57, schrieb Carsten Dominik:
>>>>
>>>> On Aug 15, 2010, at 9:07 PM, Andreas Röhler wrote:
>>>>
>>>>> Am 15.08.2010 09:39, schrieb Carsten Dominik:
>>>>>>
>>>>>> On Aug 15, 2010, at 9:37 AM, Carsten Dominik wrote:
>>>>>>
>>>>>>>
>>>>>>> On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
>>>>>>>
>>>>>>>> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>>>>>>>>
>>>>>>>>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>>>>>>>>
>>>>>>>>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>>>>>>>>
>>>>>>>>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>>>>>>>>
>>>>>>>>>>>> Hi Andreas, org-mode developers,
>>>>>>>>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>>>>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>>>>>>>>> I have put a version of the manual as modified by Andreas
>>>>>>>>>>>>>> here:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Not all the command names are in there, but quite a few
>>>>>>>>>>>>>> are.
>>>>>>>>>>>>>> I'd like to hear from more people
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> - if they would like to have the names there (i.e. if
>>>>>>>>>>>>>> it would
>>>>>>>>>>>>>> help them finding a command)
>>>>>>>>>>>
>>>>>>>>>>> I would like the command names in the manual.
>>>>>>>>>>>
>>>>>>>>>>> - Emacs-lisp has a lovely tradition of naming functions
>>>>>>>>>>> *very*
>>>>>>>>>>> descriptively and not being afraid to use long names in the
>>>>>>>>>>> interests
>>>>>>>>>>> of accuracy. It's a shame to lose all that by displaying
>>>>>>>>>>> only key
>>>>>>>>>>> sequences. It's a linguistic world of its own and I like
>>>>>>>>>>> being
>>>>>>>>>>> exposed
>>>>>>>>>>> to it.
>>>>>>>>>>> - While one can do C-h k, that's not the same as the way one
>>>>>>>>>>> learns the
>>>>>>>>>>> function names by skimming the manual
>>>>>>>>>>
>>>>>>>>>> Also, it does not add length to the HTML version of the
>>>>>>>>>> manual,
>>>>>>>>>> because
>>>>>>>>>> the key sequences are already on a line of their own. And the
>>>>>>>>>> same is
>>>>>>>>>> true for a certain proportion of the pdf entries (when the
>>>>>>>>>> key
>>>>>>>>>> sequence
>>>>>>>>>> is long, then it seems to go on its own line).
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>>>> - if the position (first thing in the command
>>>>>>>>>>>>>> description)
>>>>>>>>>>>>>> is right, or if it would be better to have it
>>>>>>>>>>>>>> - last thing in the description
>>>>>>>>>>>>>> - or after the first sentence, this is how the GNUS
>>>>>>>>>>>>>> manual
>>>>>>>>>>>>>> does it.
>>>>>>>>>>>
>>>>>>>>>>> I definitely would want them out on a line of their own
>>>>>>>>>>> with the
>>>>>>>>>>> key
>>>>>>>>>>> sequence. I liked the right-aligned model.
>>>>>>>>>>>
>>>>>>>>>>> Or if not right-aligned, is it possible not to have the
>>>>>>>>>>> comma?
>>>>>>>>>>> Maybe a
>>>>>>>>>>> different font?
>>>>>>>>>
>>>>>>>>> I also like the position on the key line best. So if there
>>>>>>>>> is a
>>>>>>>>> more-or-less
>>>>>>>>> general agreement that we should get the names in, this
>>>>>>>>> would be my
>>>>>>>>> preferred
>>>>>>>>> location as well. I knot that this is different from what
>>>>>>>>> the emacs
>>>>>>>>> and gnus manuals do - but I still think that a solution like
>>>>>>>>> this
>>>>>>>>> would
>>>>>>>>> be better.
>>>>>>>>>
>>>>>>>>> Andreas, can you be bothered to rework the patch?
>>>>>>>>>
>>>>>>>>> Unfortunately I have no idea if/how the right-aligned model
>>>>>>>>> could be
>>>>>>>>> made to
>>>>>>>>> work. So I think the safest way to do this would be to
>>>>>>>>> introduce
>>>>>>>>> the
>>>>>>>>> macro,
>>>>>>>>> and we can then work on the macro to get the formatting
>>>>>>>>> right, and
>>>>>>>>> also
>>>>>>>>> to do the
>>>>>>>>> key and function index stuff fully automatically.
>>>>>>>>>
>>>>>>>>> Here is my proposal for now:
>>>>>>>>>
>>>>>>>>> @macro orgcmd{key,command}
>>>>>>>>> @kindex \key\
>>>>>>>>> @findex \command\
>>>>>>>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>>>>>>>> @end macro
>>>>>>>>>
>>>>>>>>> And then define keys/commands like this:
>>>>>>>>>
>>>>>>>>> @table @kbd
>>>>>>>>> .....
>>>>>>>>> @orgcmd{@key{TAB}, org-cycle}
>>>>>>>>> Here follows the description of the command
>>>>>>>>> ....
>>>>>>>>> @end table
>>>>>>>>>
>>>>>>>>> - Carsten
>>>>>>>>>
>>>>>>>>>
>>>>>>>> [ ... ]
>>>>>>>>
>>>>>>>> Hi Carsten,
>>>>>>>>
>>>>>>>> attached a sreenshot, how it comes out for C-c C-b.
>>>>>>>> Doesn't look ok for me, as back-tick and quote are uncommon
>>>>>>>> that
>>>>>>>> way.
>>>>>>>
>>>>>>> Hi Andreas, you are correct, this does not look right.
>>>>>>> Seems like we will have to make the table ins @asis and
>>>>>>> then have the macro apply the formatting. Sigh... :)
>>>>>>
>>>>>> If you do insert all the macro calls with the command names, I
>>>>>> will
>>>>>> take
>>>>>> care of the formatting.
>>>>>>
>>>>>> - Carsten
>>>>>>
>>>>>
>>>>> Hi,
>>>>>
>>>>> will do that.
>>>>>
>>>>> Let us check nonetheless a working example first.
>>>>>
>>>>> While trying to put @asis at the right place, I get error
>>>>> messages and
>>>>> it refuses to compile.
>>>>>
>>>>> Could you re-write the example for me?
>>>>>
>>>>> Sorry being that stupid :-)
>>>>>
>>>>> Andreas
>>>>
>>>> I mean it like this:
>>>>
>>>> @macro orgcmd{key,command}
>>>> @kindex \key\
>>>> @findex \command\
>>>> @item @kbd{\key\} @ @ @ @ @ @ @ @ @ @ (@code{\command}\)
>>>> @end macro
>>>>
>>>> And then define keys/commands like this:
>>>>
>>>> @table @asis
>>>> .....
>>>> @orgcmd{C-c C-x @key{TAB}, org-cycle}
>>>> Here follows the description of the command
>>>> ....
>>>> @end table
>>>>
>>>>
>>>> Does this work?
>>>>
>>>> - Carsten
>>>
>>>
>>> Think so, thanks.
>>> Patch relying upon attached.
>>>
>>>
>>>
>>> Andreas
>>> <texi.patch>_______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>>
>>
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: Re: keys and command name info
2010-08-20 7:31 ` Carsten Dominik
@ 2010-08-20 8:13 ` Andreas Röhler
0 siblings, 0 replies; 44+ messages in thread
From: Andreas Röhler @ 2010-08-20 8:13 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 9338 bytes --]
Am 20.08.2010 09:31, schrieb Carsten Dominik:
> Hi Andreas,
>
> On Aug 20, 2010, at 8:27 AM, Andreas Röhler wrote:
>
>> Am 18.08.2010 10:38, schrieb Carsten Dominik:
>>> Hi Andreas,
>>>
>>> this already goes in the right direction.
>>>
>>> I have a better definition for the macro, which does now
>>> push the command name all the way to the right (in PDF output).
>>> I hated the look of the command name separated by a fixed
>>> number of spaces - this is a lot better.
>>> Does anyone know how to do this for HTML and info?
>>>
>>> @macro orgcmd{key,command}
>>> @iftex
>>> @kindex \key\
>>> @findex \command\
>>> @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
>>> @end iftex
>>> @ifnottex
>>> @kindex \key\
>>> @findex \command\
>>> @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
>>> @end ifnottex
>>> @end macro
>>>
>>> Also, since the table is now an @asis table, lines which do not
>>> have a command name like
>>>
>>> @item C-u C-u C-u @key{TAB}
>>>
>>> will need an explicit formatting command, like this:
>>>
>>> @item @kbd{C-u C-u C-u @key{TAB}}
>>>
>>> Alternatively, we could have another macro
>>>
>>> @macro orgkey{key}
>>> @item @kbd{\key\}
>>> @end macro
>>>
>>> so that we could write keys for which we have no command name
>>> like this:
>>>
>>> @orgkey{C-u C-u C-u @key{TAB}}
>>>
>>> Hope this gets you on your way with a tideous task....
>>
>> Hmm,
>>
>> I'm afraid this starts walking the desert.
>> May be it helps keeping things apart for the beginning.
>>
>> 1) Introducing the command names
>> 2) Completing the formatting
>>
>> As views are different concerning the latter, thats a rather hard task
>> for me, as I can't see the progress...
>>
>> For me it's important seeing command names somewhere near its keys.
>> If beneath or at the right, doesn't matter that much IMHO.
>
> I am not sure what the problem is.
>
> For keys where you have a command name, you continue as you have been
> doing.
> For keys where you do not have the command names, just enclose the key
> after the @item into @kbd{...}
>
> This should get you very far.
>
Hi Carsten,
so let's proceed.
Patch attached.
Andreas
> I am not sure if I have the most recent patch - can you
> please send it again, so that I can check it?
>
> Thanks.
>
> - Carsten
>
>
>>
>>
>>
>>>
>>> One more thing: I do frequently small changes in the manual,
>>> so please make sure to update your patch to the most recent
>>> version of Org.
>>>
>>>
>>>> Please have a look at lines 1097 and 1379.
>>>> Looks like an erronius replacements.
>>>> As its done by a script, ...
>>>
>>> Well, hand checking will absolutely be necessary with this patch.
>>
>> Did that. Cancelled the warning already. Seems you didn't get the mail.
>>
>> What about checkin in the patch as it's done so far?
>>
>> Andreas
>>
>>
>>> Hope you can do as much as possible of that as well, maybe with
>>> comments in the text to get my attention to certain places.
>>>
>>> - Carsten
>>>
>>> On Aug 17, 2010, at 2:43 PM, Andreas Röhler wrote:
>>>
>>>> Am 16.08.2010 10:57, schrieb Carsten Dominik:
>>>>>
>>>>> On Aug 15, 2010, at 9:07 PM, Andreas Röhler wrote:
>>>>>
>>>>>> Am 15.08.2010 09:39, schrieb Carsten Dominik:
>>>>>>>
>>>>>>> On Aug 15, 2010, at 9:37 AM, Carsten Dominik wrote:
>>>>>>>
>>>>>>>>
>>>>>>>> On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
>>>>>>>>
>>>>>>>>> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>>>>>>>>>
>>>>>>>>>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>>>>>>>>>
>>>>>>>>>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>>>>>>>>>
>>>>>>>>>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>>>>>>>>>
>>>>>>>>>>>>> Hi Andreas, org-mode developers,
>>>>>>>>>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>>>>>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>>>>>>>>>> I have put a version of the manual as modified by Andreas
>>>>>>>>>>>>>>> here:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> http://orgmode.org/org-manual-with-command-names.pdf
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Not all the command names are in there, but quite a few are.
>>>>>>>>>>>>>>> I'd like to hear from more people
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> - if they would like to have the names there (i.e. if it
>>>>>>>>>>>>>>> would
>>>>>>>>>>>>>>> help them finding a command)
>>>>>>>>>>>>
>>>>>>>>>>>> I would like the command names in the manual.
>>>>>>>>>>>>
>>>>>>>>>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>>>>>>>>>> descriptively and not being afraid to use long names in the
>>>>>>>>>>>> interests
>>>>>>>>>>>> of accuracy. It's a shame to lose all that by displaying
>>>>>>>>>>>> only key
>>>>>>>>>>>> sequences. It's a linguistic world of its own and I like being
>>>>>>>>>>>> exposed
>>>>>>>>>>>> to it.
>>>>>>>>>>>> - While one can do C-h k, that's not the same as the way one
>>>>>>>>>>>> learns the
>>>>>>>>>>>> function names by skimming the manual
>>>>>>>>>>>
>>>>>>>>>>> Also, it does not add length to the HTML version of the manual,
>>>>>>>>>>> because
>>>>>>>>>>> the key sequences are already on a line of their own. And the
>>>>>>>>>>> same is
>>>>>>>>>>> true for a certain proportion of the pdf entries (when the key
>>>>>>>>>>> sequence
>>>>>>>>>>> is long, then it seems to go on its own line).
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>>>>> - if the position (first thing in the command description)
>>>>>>>>>>>>>>> is right, or if it would be better to have it
>>>>>>>>>>>>>>> - last thing in the description
>>>>>>>>>>>>>>> - or after the first sentence, this is how the GNUS manual
>>>>>>>>>>>>>>> does it.
>>>>>>>>>>>>
>>>>>>>>>>>> I definitely would want them out on a line of their own with
>>>>>>>>>>>> the
>>>>>>>>>>>> key
>>>>>>>>>>>> sequence. I liked the right-aligned model.
>>>>>>>>>>>>
>>>>>>>>>>>> Or if not right-aligned, is it possible not to have the comma?
>>>>>>>>>>>> Maybe a
>>>>>>>>>>>> different font?
>>>>>>>>>>
>>>>>>>>>> I also like the position on the key line best. So if there is a
>>>>>>>>>> more-or-less
>>>>>>>>>> general agreement that we should get the names in, this would
>>>>>>>>>> be my
>>>>>>>>>> preferred
>>>>>>>>>> location as well. I knot that this is different from what the
>>>>>>>>>> emacs
>>>>>>>>>> and gnus manuals do - but I still think that a solution like this
>>>>>>>>>> would
>>>>>>>>>> be better.
>>>>>>>>>>
>>>>>>>>>> Andreas, can you be bothered to rework the patch?
>>>>>>>>>>
>>>>>>>>>> Unfortunately I have no idea if/how the right-aligned model
>>>>>>>>>> could be
>>>>>>>>>> made to
>>>>>>>>>> work. So I think the safest way to do this would be to introduce
>>>>>>>>>> the
>>>>>>>>>> macro,
>>>>>>>>>> and we can then work on the macro to get the formatting right,
>>>>>>>>>> and
>>>>>>>>>> also
>>>>>>>>>> to do the
>>>>>>>>>> key and function index stuff fully automatically.
>>>>>>>>>>
>>>>>>>>>> Here is my proposal for now:
>>>>>>>>>>
>>>>>>>>>> @macro orgcmd{key,command}
>>>>>>>>>> @kindex \key\
>>>>>>>>>> @findex \command\
>>>>>>>>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>>>>>>>>> @end macro
>>>>>>>>>>
>>>>>>>>>> And then define keys/commands like this:
>>>>>>>>>>
>>>>>>>>>> @table @kbd
>>>>>>>>>> .....
>>>>>>>>>> @orgcmd{@key{TAB}, org-cycle}
>>>>>>>>>> Here follows the description of the command
>>>>>>>>>> ....
>>>>>>>>>> @end table
>>>>>>>>>>
>>>>>>>>>> - Carsten
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>> [ ... ]
>>>>>>>>>
>>>>>>>>> Hi Carsten,
>>>>>>>>>
>>>>>>>>> attached a sreenshot, how it comes out for C-c C-b.
>>>>>>>>> Doesn't look ok for me, as back-tick and quote are uncommon that
>>>>>>>>> way.
>>>>>>>>
>>>>>>>> Hi Andreas, you are correct, this does not look right.
>>>>>>>> Seems like we will have to make the table ins @asis and
>>>>>>>> then have the macro apply the formatting. Sigh... :)
>>>>>>>
>>>>>>> If you do insert all the macro calls with the command names, I will
>>>>>>> take
>>>>>>> care of the formatting.
>>>>>>>
>>>>>>> - Carsten
>>>>>>>
>>>>>>
>>>>>> Hi,
>>>>>>
>>>>>> will do that.
>>>>>>
>>>>>> Let us check nonetheless a working example first.
>>>>>>
>>>>>> While trying to put @asis at the right place, I get error messages
>>>>>> and
>>>>>> it refuses to compile.
>>>>>>
>>>>>> Could you re-write the example for me?
>>>>>>
>>>>>> Sorry being that stupid :-)
>>>>>>
>>>>>> Andreas
>>>>>
>>>>> I mean it like this:
>>>>>
>>>>> @macro orgcmd{key,command}
>>>>> @kindex \key\
>>>>> @findex \command\
>>>>> @item @kbd{\key\} @ @ @ @ @ @ @ @ @ @ (@code{\command}\)
>>>>> @end macro
>>>>>
>>>>> And then define keys/commands like this:
>>>>>
>>>>> @table @asis
>>>>> .....
>>>>> @orgcmd{C-c C-x @key{TAB}, org-cycle}
>>>>> Here follows the description of the command
>>>>> ....
>>>>> @end table
>>>>>
>>>>>
>>>>> Does this work?
>>>>>
>>>>> - Carsten
>>>>
>>>>
>>>> Think so, thanks.
>>>> Patch relying upon attached.
>>>>
>>>>
>>>>
>>>> Andreas
>>>> <texi.patch>_______________________________________________
>>>> Emacs-orgmode mailing list
>>>> Please use `Reply All' to send replies to the list.
>>>> Emacs-orgmode@gnu.org
>>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>>
>>>
>>>
>>
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>
>
>
>
[-- Attachment #2: org-texi.patch --]
[-- Type: text/x-patch, Size: 8865 bytes --]
diff --git a/doc/org.texi b/doc/org.texi
index 1624111..5cb1878 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -22,6 +22,11 @@
@finalout
@c Macro definitions
+@macro orgcmd{key,command}
+@kindex \key\
+@findex \command\
+@item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
+@end macro
@iftex
@c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
@end iftex
@@ -898,9 +903,8 @@ Org uses just two commands, bound to @key{TAB} and
@cindex folded, subtree visibility state
@cindex children, subtree visibility state
@cindex subtree, subtree visibility state
-@table @kbd
-@kindex @key{TAB}
-@item @key{TAB}
+@table @asis
+@orgcmd{@key{TAB}, org-cycle}
@emph{Subtree cycling}: Rotate current subtree among the states
@example
@@ -940,19 +944,16 @@ tables, @kbd{S-@key{TAB}} jumps to the previous field.
@kindex C-u C-u C-u @key{TAB}
@item C-u C-u C-u @key{TAB}
Show all, including drawers.
-@kindex C-c C-r
-@item C-c C-r
+@orgcmd{C-c C-r, org-reveal}
Reveal context around point, showing the current entry, the following heading
and the hierarchy above. Useful for working near a location that has been
exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
(@pxref{Agenda commands}). With a prefix argument show, on each
level, all sibling headings. With double prefix arg, also show the entire
subtree of the parent.
-@kindex C-c C-k
-@item C-c C-k
+@orgcmd{C-c C-k, org-kill-note-or-show-branches}
Expose all the headings of the subtree, CONTENT view for just one subtree.
-@kindex C-c C-x b
-@item C-c C-x b
+@orgcmd{C-c C-x b, org-tree-to-indirect-buffer}
Show the current subtree in an indirect buffer@footnote{The indirect
buffer
@ifinfo
@@ -1009,24 +1010,18 @@ entries.
@cindex headline navigation
The following commands jump to other headlines in the buffer.
-@table @kbd
-@kindex C-c C-n
-@item C-c C-n
+@table @asis
+@orgcmd{C-c C-n, outline-next-visible-heading}
Next heading.
-@kindex C-c C-p
-@item C-c C-p
+@orgcmd{C-c C-p, outline-previous-visible-heading}
Previous heading.
-@kindex C-c C-f
-@item C-c C-f
+@orgcmd{C-c C-f, org-forward-same-level}
Next heading same level.
-@kindex C-c C-b
-@item C-c C-b
+@orgcmd{C-c C-b, org-backward-same-level}
Previous heading same level.
-@kindex C-c C-u
-@item C-c C-u
+@orgcmd{C-c C-u, outline-up-heading}
Backward to higher level heading.
-@kindex C-c C-j
-@item C-c C-j
+@orgcmd{C-c C-j, org-goto}
Jump to a different place without changing the current outline
visibility. Shows the document structure in a temporary buffer, where
you can use the following keys to find your destination:
@@ -1061,9 +1056,8 @@ See also the variable @code{org-goto-interface}.
@cindex sorting, of subtrees
@cindex subtrees, cut and paste
-@table @kbd
-@kindex M-@key{RET}
-@item M-@key{RET}
+@table @asis
+@orgcmd{M-@key{RET}, org-insert-heading}
@vindex org-M-RET-may-split-line
Insert new heading with same level as current. If the cursor is in a
plain list item, a new item is created (@pxref{Plain lists}). To force
@@ -1093,47 +1087,36 @@ variable @code{org-treat-insert-todo-heading-as-state-change}.
Insert new TODO entry with same level as current heading. Like
@kbd{C-@key{RET}}, the new headline will be inserted after the current
subtree.
-@kindex @key{TAB}
-@item @key{TAB} @r{in new, empty entry}
+@orgcmd{@key{TAB}, org-cycle}
In a new entry with no text yet, the first @key{TAB} demotes the entry to
become a child of the previous one. The next @key{TAB} makes it a parent,
and so on, all the way to top level. Yet another @key{TAB}, and you are back
to the initial level.
-@kindex M-@key{left}
-@item M-@key{left}
+@orgcmd{M-@key{left}, org-metaleft}
Promote current heading by one level.
-@kindex M-@key{right}
-@item M-@key{right}
+@orgcmd{M-@key{right}, org-metaright}
Demote current heading by one level.
-@kindex M-S-@key{left}
-@item M-S-@key{left}
+@orgcmd{M-S-@key{left}, org-shiftmetaleft}
Promote the current subtree by one level.
-@kindex M-S-@key{right}
-@item M-S-@key{right}
+@orgcmd{M-S-@key{right}, org-shiftmetaright}
Demote the current subtree by one level.
-@kindex M-S-@key{up}
-@item M-S-@key{up}
+@orgcmd{M-S-@key{up}, org-shiftmetaup}
Move subtree up (swap with previous subtree of same
level).
-@kindex M-S-@key{down}
-@item M-S-@key{down}
+@orgcmd{M-S-@key{down}, org-shiftmetadown}
Move subtree down (swap with next subtree of same level).
-@kindex C-c C-x C-w
-@item C-c C-x C-w
+@orgcmd{C-c C-x C-w, org-cut-special}
Kill subtree, i.e. remove it from buffer but save in kill ring.
With a numeric prefix argument N, kill N sequential subtrees.
-@kindex C-c C-x M-w
-@item C-c C-x M-w
+@orgcmd{C-c C-x M-w, org-copy-special}
Copy subtree to kill ring. With a numeric prefix argument N, copy the N
sequential subtrees.
-@kindex C-c C-x C-y
-@item C-c C-x C-y
+@orgcmd{C-c C-x C-y, org-paste-special}
Yank subtree from kill ring. This does modify the level of the subtree to
make sure the tree fits in nicely at the yank position. The yank level can
also be specified with a numeric prefix argument, or by yanking after a
headline marker like @samp{****}.
-@kindex C-y
-@item C-y
+@orgcmd{C-y, org-yank}
@vindex org-yank-adjusted-subtrees
@vindex org-yank-folded-subtrees
Depending on the variables @code{org-yank-adjusted-subtrees} and
@@ -1146,19 +1129,16 @@ previously visible. Any prefix argument to this command will force a normal
force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
yank, it will yank previous kill items plainly, without adjustment and
folding.
-@kindex C-c C-x c
-@item C-c C-x c
+@orgcmd{C-c C-x c, org-clone-subtree-with-time-shift}
Clone a subtree by making a number of sibling copies of it. You will be
prompted for the number of copies to make, and you can also specify if any
timestamps in the entry should be shifted. This can be useful, for example,
to create a number of tasks related to a series of lectures to prepare. For
more details, see the docstring of the command
@code{org-clone-subtree-with-time-shift}.
-@kindex C-c C-w
-@item C-c C-w
+@orgcmd{C-c C-w, org-refile}
Refile entry or region to a different location. @xref{Refiling notes}.
-@kindex C-c ^
-@item C-c ^
+@orgcmd{C-c ^, org-sort}
Sort same-level entries. When there is an active region, all entries in the
region will be sorted. Otherwise the children of the current headline are
sorted. The command prompts for the sorting method, which can be
@@ -1175,8 +1155,7 @@ Narrow buffer to current subtree.
@kindex C-x n w
@item C-x n w
Widen buffer to remove narrowing.
-@kindex C-c *
-@item C-c *
+@orgcmd{C-c *, org-ctrl-c-ctrl-c}
Turn a normal line or plain list item into a headline (so that it becomes a
subheading at its location). Also turn a headline into a normal line by
removing the stars. If there is an active region, turn all lines in the
@@ -1220,9 +1199,8 @@ and you will see immediately how it works.
Org-mode contains several commands creating such trees, all these
commands can be accessed through a dispatcher:
-@table @kbd
-@kindex C-c /
-@item C-c /
+@table @asis
+@orgcmd{C-c /, org-sparse-tree}
This prompts for an extra key to select a sparse-tree creating command.
@kindex C-c / r
@item C-c / r
@@ -1347,9 +1325,8 @@ the current list-level) improves readability, customize the variable
The following commands act on items when the cursor is in the first line
of an item (the line with the bullet or number).
-@table @kbd
-@kindex @key{TAB}
-@item @key{TAB}
+@table @asis
+@orgcmd{@key{TAB}, org-cycle}
@vindex org-cycle-include-plain-lists
Items can be folded just like headline levels. Normally this works only if
the cursor is on a plain list item. For more details, see the variable
@@ -1360,8 +1337,7 @@ headlines, however; the hierarchies remain completely separated.
If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
fixes the indentation of the current line in a heuristic way.
-@kindex M-@key{RET}
-@item M-@key{RET}
+@orgcmd{M-@key{RET}, org-insert-heading}
@vindex org-M-RET-may-split-line
Insert new item at current level. With a prefix argument, force a new
heading (@pxref{Structure editing}). If this command is used in the middle
@@ -1375,13 +1351,11 @@ bullet, a bullet is added to the current line.
@kindex M-S-@key{RET}
@item M-S-@key{RET}
Insert a new item with a checkbox (@pxref{Checkboxes}).
-@kindex @key{TAB}
-@item @key{TAB} @r{in new, empty item}
+@orgcmd{@key{TAB}, org-cycle}
In a new item with no text yet, the first @key{TAB} demotes the item to
become a child of the previous one. The next @key{TAB} makes it a parent,
and so on, all the way to the left margin. Yet another @key{TAB}, and you
are back to the initial level.
-@kindex S-@key{up}
@kindex S-@key{down}
@item S-@key{up}
@itemx S-@key{down}
[-- Attachment #3: Type: text/plain, Size: 201 bytes --]
_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply related [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-07-28 19:36 keys and command name info Andreas Röhler
2010-07-29 6:45 ` Tassilo Horn
2010-08-02 6:32 ` Carsten Dominik
@ 2010-08-20 11:20 ` Carsten Dominik
2010-08-20 11:32 ` Stefan Vollmar
2010-08-20 13:23 ` Bernt Hansen
2 siblings, 2 replies; 44+ messages in thread
From: Carsten Dominik @ 2010-08-20 11:20 UTC (permalink / raw)
To: Andreas Röhler; +Cc: emacs-orgmode
Hi everyone,
we now now a first batch of command names in the manual.
Please take a look if you like the formatting at
http://orgmode.org/org-manual-with-command=names.pdf
- Carsten
On Jul 28, 2010, at 9:36 PM, Andreas Röhler wrote:
>
> Hi,
>
> what about delivering mnemonic command names alongside
> with its keys in org-info?
>
> For example
>
> 8.1. Agenda files
>
> [ ... ]
> `C-c ['
> Add current file to the list of agenda files. The file is added
> to
> the front of the list. If it was already in the list, it is moved
> to the front. With prefix arg, file is added/moved to the end.
>
> might be provided as
>
> 8.1. Agenda files
>
> [ ... ]
> `C-c [', org-agenda-file-to-front
> Add current file to the list of agenda files. The file is added
> to
> the front of the list. If it was already in the list, it is moved
> to the front. With prefix arg, file is added/moved to the end.
>
>
> IMHO it's useful for emacs-beginners, but for hackers
> too, as remembering function names may precede
> remembering keys - which are to change individually
> anyway.
>
> Should you be interested, I'll consider to take action
> with texi-files.
>
>
> Andreas
>
> --
> https://code.launchpad.net/~a-roehler/python-mode
> https://code.launchpad.net/s-x-emacs-werkstatt/
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
- Carsten
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-08-20 11:20 ` keys and command name info Carsten Dominik
@ 2010-08-20 11:32 ` Stefan Vollmar
2010-08-20 13:23 ` Bernt Hansen
1 sibling, 0 replies; 44+ messages in thread
From: Stefan Vollmar @ 2010-08-20 11:32 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode Mailinglist
[-- Attachment #1.1: Type: text/plain, Size: 2520 bytes --]
Dear Carsten,
there was a typo in your last email. It should have been:
http://orgmode.org/org-manual-with-command-names.pdf
I *love* the formatting and really appreciate the effort that went into it, I am sure it was a lot of work!
Warm regards,
Stefan
On 20.08.2010, at 13:20, Carsten Dominik wrote:
> Hi everyone,
>
> we now now a first batch of command names in the manual.
> Please take a look if you like the formatting at
>
> http://orgmode.org/org-manual-with-command=names.pdf
>
> - Carsten
>
>
> On Jul 28, 2010, at 9:36 PM, Andreas Röhler wrote:
>
>>
>> Hi,
>>
>> what about delivering mnemonic command names alongside
>> with its keys in org-info?
>>
>> For example
>>
>> 8.1. Agenda files
>>
>> [ ... ]
>> `C-c ['
>> Add current file to the list of agenda files. The file is added to
>> the front of the list. If it was already in the list, it is moved
>> to the front. With prefix arg, file is added/moved to the end.
>>
>> might be provided as
>>
>> 8.1. Agenda files
>>
>> [ ... ]
>> `C-c [', org-agenda-file-to-front
>> Add current file to the list of agenda files. The file is added to
>> the front of the list. If it was already in the list, it is moved
>> to the front. With prefix arg, file is added/moved to the end.
>>
>>
>> IMHO it's useful for emacs-beginners, but for hackers
>> too, as remembering function names may precede
>> remembering keys - which are to change individually
>> anyway.
>>
>> Should you be interested, I'll consider to take action
>> with texi-files.
>>
>>
>> Andreas
>>
>> --
>> https://code.launchpad.net/~a-roehler/python-mode
>> https://code.launchpad.net/s-x-emacs-werkstatt/
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>
>
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
--
Dr. Stefan Vollmar, Dipl.-Phys.
Head of IT group
Max-Planck-Institut für neurologische Forschung
Gleuelerstr. 50, 50931 Köln, Germany
Tel.: +49-221-4726-213 FAX +49-221-4726-298
Tel.: +49-221-478-5713 Mobile: 0160-93874279
Email: vollmar@nf.mpg.de http://www.nf.mpg.de
[-- Attachment #1.2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 4409 bytes --]
[-- Attachment #2: Type: text/plain, Size: 201 bytes --]
_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply [flat|nested] 44+ messages in thread
* Re: keys and command name info
2010-08-20 11:20 ` keys and command name info Carsten Dominik
2010-08-20 11:32 ` Stefan Vollmar
@ 2010-08-20 13:23 ` Bernt Hansen
1 sibling, 0 replies; 44+ messages in thread
From: Bernt Hansen @ 2010-08-20 13:23 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi everyone,
>
> we now now a first batch of command names in the manual.
> Please take a look if you like the formatting at
>
> http://orgmode.org/org-manual-with-command=names.pdf
>
> - Carsten
http://orgmode.org/org-manual-with-command-names.pdf
That looks good to me! Great job!
Regards,
Bernt
^ permalink raw reply [flat|nested] 44+ messages in thread
end of thread, other threads:[~2010-08-20 13:23 UTC | newest]
Thread overview: 44+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-07-28 19:36 keys and command name info Andreas Röhler
2010-07-29 6:45 ` Tassilo Horn
2010-07-29 13:47 ` Andreas Röhler
2010-07-29 15:19 ` Andreas Röhler
2010-07-29 18:08 ` Tassilo Horn
2010-07-30 9:40 ` Andreas Röhler
2010-08-07 19:39 ` Carsten Dominik
2010-08-08 13:57 ` Andreas Röhler
2010-07-31 8:53 ` Bastien
2010-07-31 17:53 ` Andreas Röhler
2010-07-31 19:02 ` Thomas S. Dye
2010-08-01 9:42 ` Bastien
2010-08-01 16:40 ` Andreas Röhler
2010-08-02 6:32 ` Carsten Dominik
2010-08-08 22:26 ` Gregor Zattler
2010-08-09 6:43 ` Carsten Dominik
2010-08-09 9:37 ` Andreas Burtzlaff
2010-08-09 10:19 ` Gregor Zattler
2010-08-09 10:31 ` Carsten Dominik
2010-08-09 18:32 ` Dan Davison
2010-08-09 19:28 ` Dan Davison
2010-08-11 10:05 ` Carsten Dominik
2010-08-11 10:23 ` Andreas Röhler
2010-08-11 10:27 ` Carsten Dominik
2010-08-13 13:45 ` Andreas Röhler
2010-08-13 14:20 ` Dan Davison
2010-08-13 19:30 ` Andreas Röhler
2010-08-15 7:37 ` Carsten Dominik
2010-08-15 7:39 ` Carsten Dominik
2010-08-15 19:07 ` Andreas Röhler
2010-08-16 8:57 ` Carsten Dominik
2010-08-17 12:43 ` Andreas Röhler
2010-08-18 8:38 ` Carsten Dominik
2010-08-20 6:27 ` Andreas Röhler
2010-08-20 7:31 ` Carsten Dominik
2010-08-20 8:13 ` Andreas Röhler
2010-08-20 7:44 ` Carsten Dominik
2010-08-17 15:44 ` Andreas Röhler
2010-08-10 1:28 ` Memnon Anon
2010-08-09 14:23 ` Nick Dokos
2010-08-10 7:48 ` OT: smex.el (was Re: keys and command name info) Austin Frank
2010-08-20 11:20 ` keys and command name info Carsten Dominik
2010-08-20 11:32 ` Stefan Vollmar
2010-08-20 13:23 ` Bernt Hansen
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).