GNU bug report logs - #16750
add images to manuals

Previous Next

Package: emacs;

Reported by: Gokul Kannan <gokul_ps <at> yahoo.com>

Date: Fri, 14 Feb 2014 07:38:02 UTC

Severity: wishlist

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Fri, 14 Feb 2014 07:38:04 GMT) Full text and rfc822 format available.

Acknowledgement sent to Gokul Kannan <gokul_ps <at> yahoo.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Fri, 14 Feb 2014 07:38:06 GMT) Full text and rfc822 format available.

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

From: Gokul Kannan <gokul_ps <at> yahoo.com>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: Feedback on the manual
Date: Thu, 13 Feb 2014 23:00:51 -0800 (PST)
[Message part 1 (text/plain, inline)]

One of the best tools and worst manual I ever came across.
 
Appreciating your effort on building such a tool.. But you have missed something in the manual part.. 


It's not at all helping.. At least, for me..


There is no point in go on redirecting users to further
pages, when they’re not done with the initial pages. It’s everywhere – The Hyperlink
to further pages.. Googling for some other manual now.. 



Thanks,
Gokul
+919738847153
[Message part 2 (text/html, inline)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Fri, 14 Feb 2014 07:43:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Gokul Kannan <gokul_ps <at> yahoo.com>
Cc: 16750 <at> debbugs.gnu.org
Subject: Re: bug#16750: Feedback on the manual
Date: Fri, 14 Feb 2014 09:42:04 +0200
> Date: Thu, 13 Feb 2014 23:00:51 -0800 (PST)
> From: Gokul Kannan <gokul_ps <at> yahoo.com>
> 
> One of the best tools and worst manual I ever came across.
>  
> Appreciating your effort on building such a tool.. But you have missed something in the manual part.. 
> 
> 
> It's not at all helping.. At least, for me..
> 
> 
> There is no point in go on redirecting users to further
> pages, when they’re not done with the initial pages. It’s everywhere – The Hyperlink
> to further pages.. Googling for some other manual now.. 

It would help if you could provide some specific criticism of specific
parts in the manual that made it hard for you to read it, and
explained why.  That would allow us to improve the manual.

Thanks.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Fri, 14 Feb 2014 14:15:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Gokul Kannan <gokul_ps <at> yahoo.com>
Cc: 16750 <at> debbugs.gnu.org
Subject: Re: bug#16750: Feedback on the manual
Date: Fri, 14 Feb 2014 16:14:13 +0200
> Date: Fri, 14 Feb 2014 03:59:57 -0800 (PST)
> From: Gokul Kannan <gokul_ps <at> yahoo.com>
> Cc: "16750 <at> debbugs.gnu.org" <16750 <at> debbugs.gnu.org>
> 
> One quick thing anyone could notice is.. You guys have tried to explain the various components of emac without a pic.. A big fail.. 

Yes, I guess pictures will be worth about a thousand words.
Volunteers are welcome.

> And the other thing i already pointed.. wasn't that specific.?  Endless hyperlinks pointing to further pages makes the guide clumsy and spoils the reading experience.

Did you try not to follow them?  They are only there for those who
want the details.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Fri, 14 Feb 2014 16:43:04 GMT) Full text and rfc822 format available.

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

From: Gokul Kannan <gokul_ps <at> yahoo.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: "16750 <at> debbugs.gnu.org" <16750 <at> debbugs.gnu.org>
Subject: Re: bug#16750: Feedback on the manual
Date: Fri, 14 Feb 2014 03:59:57 -0800 (PST)
[Message part 1 (text/plain, inline)]
Thanks for taking time to write back...

One quick thing anyone could notice is.. You guys have tried to explain the various components of emac without a pic.. A big fail.. 

The intro part, I mean.. This is buffer, the last line is this, top there is a tool bar.. and so and so.. Users could easily get confused since all they could read is alphabets.. Even if they have emacs opened, it would be little misleading when you say last line.. below line.. and these sort of terms..

And the other thing i already pointed.. wasn't that specific.?  Endless hyperlinks pointing to further pages makes the guide clumsy and spoils the reading experience.

Thanks,
Gokul
+919738847153



________________________________
 From: Eli Zaretskii <eliz <at> gnu.org>
To: Gokul Kannan <gokul_ps <at> yahoo.com> 
Cc: 16750 <at> debbugs.gnu.org 
Sent: Friday, 14 February 2014 1:12 PM
Subject: Re: bug#16750: Feedback on the manual
 

> Date: Thu, 13 Feb 2014 23:00:51 -0800 (PST)
> From: Gokul Kannan <gokul_ps <at> yahoo.com>
> 
> One of the best tools and worst manual I ever came across.
>  
> Appreciating your effort on building such a tool.. But you have missed something in the manual part.. 
> 
> 
> It's not at all helping.. At least, for me..
> 
> 
> There is no point in go on redirecting users to further
> pages, when they’re not done with the initial pages. It’s everywhere – The Hyperlink
> to further pages.. Googling for some other manual now.. 

It would help if you could provide some specific criticism of specific
parts in the manual that made it hard for you to read it, and
explained why.  That would allow us to improve the manual.


Thanks.
[Message part 2 (text/html, inline)]

Changed bug title to 'add images to manuals' from 'Feedback on the manual' Request was from Glenn Morris <rgm <at> gnu.org> to control <at> debbugs.gnu.org. (Sun, 16 Feb 2014 03:24:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Sun, 16 Feb 2014 19:13:01 GMT) Full text and rfc822 format available.

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

From: Gokul Kannan <gokul_ps <at> yahoo.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: "16750 <at> debbugs.gnu.org" <16750 <at> debbugs.gnu.org>
Subject: Re: bug#16750: Feedback on the manual
Date: Sat, 15 Feb 2014 23:38:20 -0800 (PST)
[Message part 1 (text/plain, inline)]
Did you try not to follow them?  They are only there for those who
want the details. 


//I tried not to follow the endless hyperlinks, but it just spoils the reading experience.

Who would want to jump to advanced, when you have not even explained the basics yet..

Majority of people wouldn't be interested to read like this.. read page number 10 -- then jump to 200.. then come back to 11.. go till 20.. then jump to 989.. 


If you feel the details at 989 is very much needed to what you have explained at 20, then it should be page number 21 and not 989..

Finally, I would like to get my hands on emacs.. But couldn't find a proper guide yet.. Guide me with some hyperlinks/articles on emacs for beginners that you're aware of..


Thanks,
Gokul



________________________________
 From: Eli Zaretskii <eliz <at> gnu.org>
To: Gokul Kannan <gokul_ps <at> yahoo.com> 
Cc: 16750 <at> debbugs.gnu.org 
Sent: Friday, 14 February 2014 7:44 PM
Subject: Re: bug#16750: Feedback on the manual
 

> Date: Fri, 14 Feb 2014 03:59:57 -0800 (PST)
> From: Gokul Kannan <gokul_ps <at> yahoo.com>
> Cc: "16750 <at> debbugs.gnu.org" <16750 <at> debbugs.gnu.org>
> 
> One quick thing anyone could notice is.. You guys have tried to explain the various components of emac without a pic.. A big fail.. 

Yes, I guess pictures will be worth about a thousand words.
Volunteers are welcome.


> And the other thing i already pointed.. wasn't that specific.?  Endless hyperlinks pointing to further pages makes the guide clumsy and spoils the reading experience.

Did you try not to follow them?  They are only there for those who
want the details.
[Message part 2 (text/html, inline)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Sun, 16 Feb 2014 19:46:02 GMT) Full text and rfc822 format available.

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

From: Bastien <bzg <at> altern.org>
To: Gokul Kannan <gokul_ps <at> yahoo.com>
Cc: "16750 <at> debbugs.gnu.org" <16750 <at> debbugs.gnu.org>,
 Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#16750: Feedback on the manual
Date: Sun, 16 Feb 2014 20:45:44 +0100
Gokul Kannan <gokul_ps <at> yahoo.com> writes:

> Finally, I would like to get my hands on emacs.. But couldn't find a
> proper guide yet.. Guide me with some hyperlinks/articles on emacs
> for beginners that you're aware of..

`C-h t' may help.

-- 
 Bastien




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Sun, 16 Feb 2014 21:15:02 GMT) Full text and rfc822 format available.

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

From: Jay Belanger <jay.p.belanger <at> gmail.com>
To: Gokul Kannan <gokul_ps <at> yahoo.com>
Cc: "16750 <at> debbugs.gnu.org" <16750 <at> debbugs.gnu.org>, jay.p.belanger <at> gmail.com,
 Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#16750: Feedback on the manual
Date: Sun, 16 Feb 2014 15:14:24 -0600
> //I tried not to follow the endless hyperlinks, but it just spoils the
> reading experience.
>
> Who would want to jump to advanced, when you have not even explained
> the basics yet..

I might, in some situations.  Others might not.  It's good to offer the
choice.

> Majority of people wouldn't be interested to read like this.. read
> page number 10 -- then jump to 200.. then come back to 11.. go till
> 20.. then jump to 989.. 

The majority of people wouldn't need to.  The links are for those that
want the extra information.  The choices seem to be:
  * Put all of the information up front.
    This could be offputting for those that don't want the advanced 
    information right away.
  * Don't let the users know where to get more advanced information.
    Why keep it a secret?
  * Provide the basic information, and link to more information for
    those who want it.
    It seems like a good choice to me, but you can't please everyone. 

> If you feel the details at 989 is very much needed to what you have
> explained at 20, then it should be page number 21 and not 989..

And if you think that the details at 989 aren't very much needed, but
want to let people who might be interested know where to get it right
away, a link sounds like a good idea.

> Finally, I would like to get my hands on emacs.. But couldn't find a
> proper guide yet.. Guide me with some hyperlinks/articles on emacs for
> beginners that you're aware of..

When you start Emacs, you are given a message:
   "For information about GNU Emacs and the GNU system, type C-h C-a."
Typing C-hC-a leads you to hyperlinks/articles on using Emacs (and other
information, too).  It's possible that someone doesn't know what
"C-hC-a" means (it's explained in the tutorial), but there is a Help
menu, whose first menu item is the Emacs tutorial.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Mon, 17 Feb 2014 02:15:03 GMT) Full text and rfc822 format available.

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

From: Personal <gokul_ps <at> yahoo.com>
To: jay.p.belanger <at> gmail.com
Cc: 16750 <at> debbugs.gnu.org, jay.p.belanger <at> gmail.com,
 Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#16750: Feedback on the manual
Date: Mon, 17 Feb 2014 07:24:20 +0530
[Message part 1 (text/html, inline)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Mon, 17 Feb 2014 02:59:02 GMT) Full text and rfc822 format available.

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

From: Jay Belanger <jay.p.belanger <at> gmail.com>
To: Personal <gokul_ps <at> yahoo.com>
Cc: 16750 <at> debbugs.gnu.org, jay.p.belanger <at> gmail.com,
 Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#16750: Feedback on the manual
Date: Sun, 16 Feb 2014 20:58:26 -0600
> I still can't think of a scenario where one would want to keep
> jumping.

...

> And yes, you can't satisfy everyone. You need not, as well.. But still
> there should be people who might feel the same way as me..

People like you don't need to jump; nobody is forced to.

> and as long as you care.. one quick suggestion would be to release a
> short user guide (different from manual) with enough pictures and no
> hyperlinks which will help people quickly to begin with, and later
> proceed with the manual in place..

Eli pointed out that pictures is a good idea.  Does the tutorial count
as a short user guide?  What about the guided tour?  Actually, the
guided tour has a lot of pictures included in it.
Since nobody is forced to use hyperlinks, there is no reason for them to
be omitted.  People who don't want them can ignore them, people who want
them can follow them.

> Regarding the 'C-h t' part.. yes the YouTube video taught me where and
> how I need to issue that command..

The Emacs Help menu also takes you to the tutorial, which tells you what
the commands do.

> I don't want this to be an argument on who's right.. but as long as
> you're ready to lend ears to some suggestions, I would once again like
> to quote the picture thing.. window, buffer or whatever terminology
> you try to explain there with alphanumeric, try with a picture
> instead. That will serve the purpose..

More pictures might be useful; currently, the Guided tour is heavily
illustrated. 

> Once again.. I really really appreciate your efforts.. though I have
> some concerns, you have did a great job there and I appreciate it..
> regarding volunteering, not sure how long it takes for me to master
> emacs, but when I do.. I would definitely contribute in ways I can..

You don't need to master Emacs to contribute; in fact, if you are trying
to help with the beginning information, suggestions from someone not
familiar with Emacs might be the most helpful.  

When Emacs starts up (unless the splash screen is turned off), there is
a list of resources for learning Emacs.  Is there anything else you
think should be there?  I would think the tutorial would be where new
users would start off.  I take it you think the tutorial should contain
images; any other suggestions?





Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Mon, 17 Feb 2014 03:15:02 GMT) Full text and rfc822 format available.

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

From: Personal <gokul_ps <at> yahoo.com>
To: jay.p.belanger <at> gmail.com
Cc: 16750 <at> debbugs.gnu.org, jay.p.belanger <at> gmail.com,
 Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#16750: Feedback on the manual
Date: Mon, 17 Feb 2014 08:41:35 +0530
[Message part 1 (text/html, inline)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#16750; Package emacs. (Thu, 26 Sep 2019 17:07:01 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Personal <gokul_ps <at> yahoo.com>
Cc: 16750 <at> debbugs.gnu.org, jay.p.belanger <at> gmail.com,
 Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#16750: Feedback on the manual
Date: Thu, 26 Sep 2019 19:06:13 +0200
I agree that it might be nice to add more images to the Emacs manuals in
general, but I don't think there's anything to act on in this bug report
in a concrete manner, so I'm closing this bug report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no





bug closed, send any further explanations to 16750 <at> debbugs.gnu.org and Gokul Kannan <gokul_ps <at> yahoo.com> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Thu, 26 Sep 2019 17:07:03 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Fri, 25 Oct 2019 11:24:07 GMT) Full text and rfc822 format available.

This bug report was last modified 4 years and 156 days ago.

Previous Next


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