From marc@blackend.org  Mon Jun  3 03:50:45 2002
Return-Path: <marc@blackend.org>
Received: from abigail.blackend.org (blackend.org [212.11.50.35])
	by hub.freebsd.org (Postfix) with ESMTP id CCD7037B403
	for <FreeBSD-gnats-submit@freebsd.org>; Mon,  3 Jun 2002 03:50:43 -0700 (PDT)
Received: from abigail.blackend.org (localhost [127.0.0.1])
	by abigail.blackend.org (8.12.3/8.12.3/ - 15/04/02) with ESMTP id g53AoXe3095339
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 3 Jun 2002 12:50:33 +0200 (CEST)
	(envelope-from marc@abigail.blackend.org)
Received: (from marc@localhost)
	by abigail.blackend.org (8.12.3/8.12.3/Submit) id g53AoX2d095338;
	Mon, 3 Jun 2002 12:50:33 +0200 (CEST)
	(envelope-from marc)
Message-Id: <200206031050.g53AoX2d095338@abigail.blackend.org>
Date: Mon, 3 Jun 2002 12:50:33 +0200 (CEST)
From: Marc Fonvieille <marc@blackend.org>
Reply-To: Marc Fonvieille <marc@blackend.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Some keycap tags addition and minor changes in section 3.8 of the Handbook
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         38851
>Category:       docs
>Synopsis:       Some keycap tags addition and minor changes in section 3.8 of the Handbook
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    keramida
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Jun 03 04:00:11 PDT 2002
>Closed-Date:    Tue Jun 04 17:49:28 PDT 2002
>Last-Modified:  Tue Jun 04 17:49:28 PDT 2002
>Originator:     Marc Fonvieille
>Release:        FreeBSD 4.6-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD abigail.blackend.org 4.6-PRERELEASE FreeBSD 4.6-PRERELEASE #5: Sun May 12 00:30:43 CEST 2002 marc@abigail.blackend.org:/usr/src/sys/compile/ABIGAIL i386


	
>Description:
Some keycap tags addition and minor changes in section 3.8 of the
Handbook. Read the patch below for more details.
	
>How-To-Repeat:
	
>Fix:
Apply the patch to handbook/basics/chapter.sgml
	

--- chapter.sgml.diff begins here ---
--- chapter.sgml.org	Mon Jun  3 12:38:09 2002
+++ chapter.sgml	Mon Jun  3 12:46:40 2002
@@ -1256,9 +1256,9 @@
       <command>ee</command>, all of the
       commands for manipulating the editor's functions are listed at the
       top of the display. The caret <literal>^</literal> character means
-      the control key on the keyboard, so ^e expands to pressing the
-      control key plus the letter <literal>e</literal>.  To leave
-      <application>ee</application>, hit the escape key, then choose leave
+      the <keycap>Ctrl</keycap> key on the keyboard, so <literal>^e</literal> expands to the key combination
+      <keycombo action="simul"><keycap>Ctrl</keycap><keycap>e</keycap></keycombo>.  To leave
+      <application>ee</application>, hit the <keycap>Esc</keycap> key, then choose leave
       editor.  The editor will prompt you to save any changes if the file
       has been modified.</para>
 
@@ -1277,7 +1277,7 @@
       <secondary><command>emacs</command></secondary>
     </indexterm>
     <para>FreeBSD also comes with more powerful text editors such as
-      <command>vi</command> as part of the base system, and
+      <command>vi</command> as part of the base system, 
       <command>emacs</command> and <command>vim</command>
       as part of the FreeBSD Ports Collection.  These editors offer much
       more functionality and power at the expense of being a little more
--- chapter.sgml.diff ends here ---


>Release-Note:
>Audit-Trail:

From: Giorgos Keramidas <keramida@FreeBSD.org>
To: Marc Fonvieille <marc@blackend.org>
Cc: bug-followup@FreeBSD.org
Subject: Re: docs/38851: Some keycap tags addition and minor changes in section 3.8 of the Handbook
Date: Tue, 4 Jun 2002 21:03:54 +0300

 On 2002-06-03 12:50 +0200, Marc Fonvieille wrote:
 > @@ -1256,9 +1256,9 @@
 
 [Snippetry of patch part that looks nice.]
 
 > @@ -1277,7 +1277,7 @@
 >        <secondary><command>emacs</command></secondary>
 >      </indexterm>
 >      <para>FreeBSD also comes with more powerful text editors such as
 > -      <command>vi</command> as part of the base system, and
 > +      <command>vi</command> as part of the base system, 
 >        <command>emacs</command> and <command>vim</command>
 >        as part of the FreeBSD Ports Collection.  These editors offer much
 >        more functionality and power at the expense of being a little more
 > --- chapter.sgml.diff ends here ---
 
 The new line that is added has whitespace at EOL.  This is not really
 important though.  What is more important is that we'll probably have to
 rewrite parts of the sentence anyways.  What about something like this?
 
 %%%
 @@ -1277,9 +1277,9 @@
        <secondary><command>emacs</command></secondary>
      </indexterm>
      <para>FreeBSD also comes with more powerful text editors such as
 -      <command>vi</command> as part of the base system, and
 -      <command>emacs</command> and <command>vim</command>
 -      as part of the FreeBSD Ports Collection.  These editors offer much
 +      <command>vi</command> as part of the base system, while other editors, like
 +      <command>emacs</command> and <command>vim</command>,
 +      are part of the FreeBSD Ports Collection.  These editors offer much
        more functionality and power at the expense of being a little more
        complicated to learn.  However if you plan on doing a lot of text
        editing, learning a more powerful editor such as
 %%%
 
 - Giorgos
 

From: Marc Fonvieille <marc@blackend.org>
To: Giorgos Keramidas <keramida@FreeBSD.org>
Cc:  
Subject: Re: docs/38851: Some keycap tags addition and minor changes in section 3.8 of the Handbook
Date: Tue, 4 Jun 2002 20:46:31 +0200

 On Tue, Jun 04, 2002 at 09:03:54PM +0300, Giorgos Keramidas wrote:
 > The new line that is added has whitespace at EOL.  This is not really
 > important though.
 
 Oh i missed it :(
 
 > What is more important is that we'll probably have to
 > rewrite parts of the sentence anyways.  What about something like this?
 > 
 > %%%
 > @@ -1277,9 +1277,9 @@
 >        <secondary><command>emacs</command></secondary>
 >      </indexterm>
 >      <para>FreeBSD also comes with more powerful text editors such as
 > -      <command>vi</command> as part of the base system, and
 > -      <command>emacs</command> and <command>vim</command>
 > -      as part of the FreeBSD Ports Collection.  These editors offer much
 > +      <command>vi</command> as part of the base system, while other editors, like
 > +      <command>emacs</command> and <command>vim</command>,
 > +      are part of the FreeBSD Ports Collection.  These editors offer much
 >        more functionality and power at the expense of being a little more
 >        complicated to learn.  However if you plan on doing a lot of text
 >        editing, learning a more powerful editor such as
 > %%%
 > 
 
 It's perfect, far better than my *quick* fix.
 
 Marc
State-Changed-From-To: open->closed 
State-Changed-By: keramida 
State-Changed-When: Tue Jun 4 17:47:44 PDT 2002 
State-Changed-Why:  
The changes have been committed.  I merged the changes mentioned in 
the audit trail of the PR, so this should be fine now. 

Thanks for the work in this part of the documentation ;) 


Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Tue Jun 4 17:47:44 PDT 2002 
Responsible-Changed-Why:  

http://www.freebsd.org/cgi/query-pr.cgi?pr=38851 
>Unformatted:
