GNU bug report logs - #14087
[PATCH] Some fixes for refcard.tex

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 14087 in the body.
You can then email your comments to 14087 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Xue Fuqiao <xfq.free <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Some fixes for refcard.tex
Date: Fri, 29 Mar 2013 17:02:27 +0800

The following patch refines some entries in etc/refcards/refcard.tex:

diff -cp trunk/etc/refcards/refcard.tex.orig trunk/etc/refcards/refcard.tex
*** trunk/etc/refcards/refcard.tex.orig	2013-03-10 06:42:26.000000000 +0800
--- trunk/etc/refcards/refcard.tex	2013-03-29 16:54:48.000000000 +0800
*************** If Emacs is still searching, \kbd{C-g} c
*** 355,360 ****
--- 355,361 ----
  \key{scroll current line to center, top, bottom}{C-l}
  
  \key{goto line}{M-g g}
+ \key{goto char}{M-g c}
  \key{back to indentation}{M-m}
  
  \section{Killing and Deleting}
*************** minibuffer.  Type \kbd{F10} to activate
*** 504,509 ****
--- 505,511 ----
  \key{check spelling of current word}{M-\$}
  \metax{check spelling of all words in region}{M-x ispell-region}
  \metax{check spelling of entire buffer}{M-x ispell-buffer}
+ \metax{toggle on-the-fly spell checking}{M-x flyspell-mode}
  
  \section{Tags}
  
*************** minibuffer.  Type \kbd{F10} to activate
*** 512,523 ****
  \metax{specify a new tags file}{M-x visit-tags-table}
  
  \metax{regexp search on all files in tags table}{M-x tags-search}
! \metax{run query-replace on all the files}{M-x tags-query-replace}
  \key{continue last tags search or query-replace}{M-,}
  
  \section{Shells}
  
  \key{execute a shell command}{M-!}
  \key{run a shell command on the region}{M-|}
  \key{filter region through a shell command}{C-u M-|}
  \key{start a shell in window \kbd{*shell*}}{M-x shell}
--- 514,526 ----
  \metax{specify a new tags file}{M-x visit-tags-table}
  
  \metax{regexp search on all files in tags table}{M-x tags-search}
! \metax{run {\bf query-replace-regexp} on all files listed in tags table}{M-x tags-query-replace}
  \key{continue last tags search or query-replace}{M-,}
  
  \section{Shells}
  
  \key{execute a shell command}{M-!}
+ \key{execute a shell command asynchronously}{M-&}
  \key{run a shell command on the region}{M-|}
  \key{filter region through a shell command}{C-u M-|}
  \key{start a shell in window \kbd{*shell*}}{M-x shell}
*************** minibuffer.  Type \kbd{F10} to activate
*** 554,562 ****
--- 557,568 ----
  \key{zero or more repeats}{*}
  \key{one or more repeats}{+}
  \key{zero or one repeat}{?}
+ \key{quote special characters}{\\}
  \key{quote regular expression special character {\it c\/}}{\\{\it c}}
  \key{alternative (``or'')}{\\|}
  \key{grouping}{\\( {\rm$\ldots$} \\)}
+ \key{shy grouping}{\\(:? {\rm$\ldots$} \\)}
+ \key{explicit numbered grouping}{\\(:NUM {\rm$\ldots$} \\)}
  \key{same text as {\it n\/}th group}{\\{\it n}}
  \key{at word break}{\\b}
  \key{not at word break}{\\B}
*************** minibuffer.  Type \kbd{F10} to activate
*** 565,576 ****
--- 571,585 ----
  \threecol{{\bf entity}}{{\bf match start}}{{\bf match end}}
  \threecol{line}{^}{\$}
  \threecol{word}{\\<}{\\>}
+ \threecol{symbol}{\\_<}{\\_>}
  \threecol{buffer}{\\`}{\\'}
+ %% FIXME: "`" and "'" isn't displayed correctly in the output PDF file
  
  \threecol{{\bf class of characters}}{{\bf match these}}{{\bf match others}}
  \threecol{explicit set}{[ {\rm$\ldots$} ]}{[^ {\rm$\ldots$} ]}
  \threecol{word-syntax character}{\\w}{\\W}
  \threecol{character with syntax {\it c}}{\\s{\it c}}{\\S{\it c}}
+ \threecol{character with category {\it c}}{\\c{\it c}}{\\C{\it c}}
  }
  
  \section{International Character Sets}
*************** Moving within a node:
*** 592,598 ****
  
  \key{scroll forward}{SPC}
  \key{scroll reverse}{DEL}
! \key{beginning of node}{. {\rm (dot)}}
  
  Moving between nodes:
  
--- 601,607 ----
  
  \key{scroll forward}{SPC}
  \key{scroll reverse}{DEL}
! \key{beginning of node}{b}
  
  Moving between nodes:
  
*************** Other:
*** 630,646 ****
  \key{{\bf start} defining a keyboard macro}{C-x (}
  \key{{\bf end} keyboard macro definition}{C-x )}
  \key{{\bf execute} last-defined keyboard macro}{C-x e}
! \key{append to last keyboard macro}{C-u C-x (}
  \metax{name last keyboard macro}{M-x name-last-kbd-macro}
  \metax{insert Lisp definition in buffer}{M-x insert-kbd-macro}
  
  \section{Commands Dealing with Emacs Lisp}
  
! \key{eval {\bf sexp} before point}{C-x C-e}
  \key{eval current {\bf defun}}{C-M-x}
  \metax{eval {\bf region}}{M-x eval-region}
  \key{read and eval minibuffer}{M-:}
! \metax{load from standard system directory}{M-x load-library}
  
  \section{Simple Customization}
  
--- 639,655 ----
  \key{{\bf start} defining a keyboard macro}{C-x (}
  \key{{\bf end} keyboard macro definition}{C-x )}
  \key{{\bf execute} last-defined keyboard macro}{C-x e}
! \key{record subsequent keyboard input, then append to last keyboard macro}{C-u C-x (}
  \metax{name last keyboard macro}{M-x name-last-kbd-macro}
  \metax{insert Lisp definition in buffer}{M-x insert-kbd-macro}
  
  \section{Commands Dealing with Emacs Lisp}
  
! \key{eval {\bf sexp} before point}{C-x C-e} % sexp?  form?  expression?  S-expression?
  \key{eval current {\bf defun}}{C-M-x}
  \metax{eval {\bf region}}{M-x eval-region}
  \key{read and eval minibuffer}{M-:}
! \metax{load a Lisp library from {\bf load-path}}{M-x load-library}
  
  \section{Simple Customization}
  
*************** An example:
*** 669,675 ****
  \beginexample%
  (defun this-line-to-top-of-window (line)
    "Reposition current line to top of window.
! With ARG, put point on line ARG."
    (interactive "P")
    (recenter (if (null line)
                  0
--- 678,684 ----
  \beginexample%
  (defun this-line-to-top-of-window (line)
    "Reposition current line to top of window.
! With prefix argument LINE, put point on LINE."
    (interactive "P")
    (recenter (if (null line)
                  0
*************** With ARG, put point on line ARG."
*** 677,683 ****
  \endexample
  
  The \kbd{interactive} spec says how to read arguments interactively.
! Type \kbd{C-h f interactive} for more details.
  
  \copyrightnotice
  
--- 686,692 ----
  \endexample
  
  The \kbd{interactive} spec says how to read arguments interactively.
! Type \kbd{C-h f interactive RET} for more details.
  
  \copyrightnotice
  

diff -cp trunk/etc/ChangeLog.orig trunk/etc/ChangeLog
*** trunk/etc/ChangeLog.orig	2013-03-23 18:14:12.000000000 +0800
--- trunk/etc/ChangeLog	2013-03-29 17:00:51.000000000 +0800
***************
*** 1,3 ****
--- 1,7 ----
+ 2013-03-29  Xue Fuqiao  <xfq.free <at> gmail.com>
+ 
+ 	* refcards/refcard.tex: Refine some entries.
+ 
  2013-03-21  Eric Ludlam  <zappo <at> gnu.org>
  
  	* srecode/ede-autoconf.srt: Change Copyright to FSF.

-- 
Xue Fuqiao
http://www.gnu.org/software/emacs/

Message #8 received at 14087 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Xue Fuqiao <xfq.free <at> gmail.com>
Cc: 14087 <at> debbugs.gnu.org
Subject: Re: bug#14087: [PATCH] Some fixes for refcard.tex
Date: Wed, 08 May 2013 13:18:20 -0400

Xue Fuqiao wrote:

> ! \metax{run {\bf query-replace-regexp} on all files listed in tags table}{M-x tags-query-replace}

Way too long. Looks terrible in generated pdf.

> + \key{execute a shell command asynchronously}{M-&}

Fails to LaTeX. Use '\&'.

> ! \key{record subsequent keyboard input, then append to last keyboard macro}{C-u C-x (}

Too long.

> ! \key{eval {\bf sexp} before point}{C-x C-e} % sexp?  form?  expression?  S-expression?

sexp seems fine for a quick reference card.

Message #11 received at 14087 <at> debbugs.gnu.org (full text, mbox):

From: Xue Fuqiao <xfq.free <at> gmail.com>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 14087 <at> debbugs.gnu.org
Subject: Re: bug#14087: [PATCH] Some fixes for refcard.tex
Date: Thu, 9 May 2013 12:59:46 +0800

On Thu, May 9, 2013 at 1:18 AM, Glenn Morris <rgm <at> gnu.org> wrote:

(Sorry, but I cannot configure my email client to use `X-Debbugs-CC'.)

> Xue Fuqiao wrote:
>
>> ! \metax{run {\bf query-replace-regexp} on all files listed in tags table}{M-x tags-query-replace}
>
> Way too long. Looks terrible in generated pdf.

OK, I'll remove this change.

>> + \key{execute a shell command asynchronously}{M-&}
>
> Fails to LaTeX. Use '\&'.

I'll change it.

>> ! \key{record subsequent keyboard input, then append to last keyboard macro}{C-u C-x (}
>
> Too long.

I'll remove this change.

>> ! \key{eval {\bf sexp} before point}{C-x C-e} % sexp?  form?  expression?  S-expression?
>
> sexp seems fine for a quick reference card.

In (info "(elisp) Intro Eval"):

    A Lisp object that is intended for evaluation is called a "form" or
  "expression".
[...]
    It is sometimes also referred to as an "S-expression" or "sexp",
  but we generally do not use this terminology in this manual.

IMO we can use "form" here since it is consistent with the manual and
not too long.

--
Best regards, Xue Fuqiao.
http://www.gnu.org/software/emacs/

Message #14 received at 14087 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Xue Fuqiao <xfq.free <at> gmail.com>
Cc: 14087 <at> debbugs.gnu.org
Subject: Re: bug#14087: [PATCH] Some fixes for refcard.tex
Date: Thu, 09 May 2013 02:21:26 -0400

Xue Fuqiao wrote:

> (Sorry, but I cannot configure my email client to use `X-Debbugs-CC'.)

i) That option only affects new reports, not replies to existing
reports, so I don't see the relevance.

ii) I guess your mail client doesn't let you add X- headers.
Well, you can put it in the first line of the body instead.
No, it probably isn't in the documentation.

>>> ! \key{eval {\bf sexp} before point}{C-x C-e} % sexp?  form?  expression?  S-expression?
>>
>> sexp seems fine for a quick reference card.
>
> In (info "(elisp) Intro Eval"):
>
>     A Lisp object that is intended for evaluation is called a "form" or
>   "expression".
> [...]
>     It is sometimes also referred to as an "S-expression" or "sexp",
>   but we generally do not use this terminology in this manual.
>
> IMO we can use "form" here since it is consistent with the manual and
> not too long.

A reference card is not a manual.
The command is "eval-last-sexp"; "Evaluate sexp before point".
Using the word "sexp" will therefore be confusing to literally no-one,
and has added mnemonic value wrt the command-name.
There is no need to change it.

Message #17 received at 14087 <at> debbugs.gnu.org (full text, mbox):

From: Xue Fuqiao <xfq.free <at> gmail.com>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 14087 <at> debbugs.gnu.org
Subject: Re: bug#14087: [PATCH] Some fixes for refcard.tex
Date: Thu, 9 May 2013 16:06:34 +0800

On Thu, May 9, 2013 at 2:21 PM, Glenn Morris <rgm <at> gnu.org> wrote:
> Xue Fuqiao wrote:
>
>> (Sorry, but I cannot configure my email client to use `X-Debbugs-CC'.)
>
> i) That option only affects new reports, not replies to existing
> reports, so I don't see the relevance.
>
> ii) I guess your mail client doesn't let you add X- headers.
> Well, you can put it in the first line of the body instead.
> No, it probably isn't in the documentation.

Ah, I see.  Thank you.

>>>> ! \key{eval {\bf sexp} before point}{C-x C-e} % sexp?  form?  expression?  S-expression?
>>>
>>> sexp seems fine for a quick reference card.
>>
>> In (info "(elisp) Intro Eval"):
>>
>>     A Lisp object that is intended for evaluation is called a "form" or
>>   "expression".
>> [...]
>>     It is sometimes also referred to as an "S-expression" or "sexp",
>>   but we generally do not use this terminology in this manual.
>>
>> IMO we can use "form" here since it is consistent with the manual and
>> not too long.
>
> A reference card is not a manual.
> The command is "eval-last-sexp"; "Evaluate sexp before point".
> Using the word "sexp" will therefore be confusing to literally no-one,
> and has added mnemonic value wrt the command-name.
> There is no need to change it.

OK, you convinced me.

--
Best regards, Xue Fuqiao.
http://www.gnu.org/software/emacs/

Message #22 received at 14087-done <at> debbugs.gnu.org (full text, mbox):

From: Xue Fuqiao <xfq.free <at> gmail.com>
To: 14087-done <at> debbugs.gnu.org
Subject: Re: [PATCH] Some fixes for refcard.tex
Date: Sat, 25 May 2013 10:18:53 +0800

Fixed and installed, thanks.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.