From: Eli Zaretskii <eliz@gnu.org>
To: Summer Emacs <summeremacs@summerstar.me>
Cc: emacs-devel@gnu.org
Subject: Re: Emacs Newbie Info Pages
Date: Fri, 13 Sep 2024 09:35:03 +0300 [thread overview]
Message-ID: <86v7z0jc2w.fsf@gnu.org> (raw)
In-Reply-To: <EE7D2B70-4778-42B5-B265-8C87995411E6@summerstar.me> (message from Summer Emacs on Thu, 12 Sep 2024 19:30:57 +0200)
> From: Summer Emacs <summeremacs@summerstar.me>
> Date: Thu, 12 Sep 2024 19:30:57 +0200
>
> Hi everyone,
Thank you for your interest in Emacs.
First, about terminology: please don't use the phrase "Info pages".
Unlike man pages, an Info manual is not a collection of
loosely-coupled pages, it is a coherent book with sensible structure
of chapters, sections, and subsections, and with menus and
cross-references between them as appropriate.
> I posted a question in Reddit this morning about having an Emacs newbie info pages on the front of the default Emacs page for complete newbies and first-timers. I know that the splash page already has information links, which are very appreciated, but I think that first time users would be overwhelmed with the information and how to use it. The goal of this project would be the following:
>
> 1) A very visible (easy to see, and hard to miss) link at the top which says something like “New to Emacs? Click here!”
> 2) A simple “one page” info page with some general information about Emacs and suggested setups. This would include:
>
> a) The link to the Emacs movement/editing tutorial (vital) and why it is necessary to go through it.
> b) A quick overview for non-coders/devs on how Emacs is special and can be made to look like anything they want it to look like.
> c) An explanation of how to configure Emacs in a basic way with a few links to some suggested configs to get started “out of the box” (I know this is contentious, please don’t bite my head off)
> d) How they can download themes right away with some examples of some basic themes and links to some popular theme packages.
> e) An explanation of some bigger packages which they might be interested in as non-coders (mostly writers or other office jobs) such as: Org-Mode, EWS, Denote, Org-Roam, Fontaine, etc…a quick explanation of what each one does, a link to the page where the information can be found.
> f) How to use the configuration panels if they choose to go that route with a few quick examples for them to try out.
I think something like this will be most useful, if done right. The
challenge, as always, is to do it right. And the most challenging
aspect of the above job is to select what to describe and what not to
describe, since Emacs is so large, and since each class of users has
different parts of Emacs that are important enough to be in that
"newbie stuff".
The next challenge is how to have this "newbie stuff" in the face of a
newbie, without annoying newbies and veteran users alike.
> Now, a few things:
> 1) I’m not a dev. This is just my take from a non-dev perspective.
> 2) I’ve heard there was work on a wizard setup a while back but that it never went anywhere. My suggestion is to use the info pages instead of a wizard, but to make a newbie “home base” for new users which won’t overwhelm them. I’ve already written about 3 pages but it is very rough and needs a lot of work, links put in, and a lot of editing because my tone is very different from the tone of the manuals. I’ve never written a tutorial before, so I’m going to need some volunteers to help me with some of this stuff.
> 3) I don’t know what it takes to include such a thing into Emacs proper. I don’t know how to patch things, or know what the specifics are for submitting things in a proper way. Please don’t hold that against me - I’m willing to learn.
>
> I wanted to write this email to put something concrete down rather than just say “Emacs needs to be better for newbs” and not do anything about it. Somebody suggest that I actually do, so I’m going to try.
If we are talking about an Info manual or a tutorial, then just
writing the text to be included there would go a long way towards the
goal. Someone else can then add markup and install the result in the
Emacs sources, but that is mostly a technical job that has few if any
challenges.
So if you want to propose a text to the above effect, please do, and
TIA.
prev parent reply other threads:[~2024-09-13 6:35 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-09-12 17:30 Emacs Newbie Info Pages Summer Emacs
2024-09-12 18:26 ` Philip Kaludercic
2024-09-12 18:45 ` Summer Emacs
2024-09-12 19:17 ` Philip Kaludercic
2024-09-13 6:40 ` Eli Zaretskii
2024-09-13 7:36 ` Philip Kaludercic
2024-09-13 7:39 ` Summer Emacs
2024-09-13 14:46 ` Juergen Fenn
2024-09-13 12:28 ` Thanos Apollo
2024-09-12 18:29 ` Corwin Brust
2024-09-12 19:00 ` Summer Emacs
2024-09-13 2:24 ` Suhail Singh
2024-09-17 3:47 ` Richard Stallman
2024-09-17 10:58 ` Summer Emacs
2024-09-17 13:31 ` Eli Zaretskii
2024-09-17 14:12 ` Summer Emacs
2024-09-17 14:48 ` Emanuel Berg
2024-09-17 16:45 ` Summer Emacs
2024-09-18 1:09 ` Emanuel Berg
2024-09-17 15:44 ` Eli Zaretskii
2024-09-17 16:49 ` Summer Emacs
2024-09-17 17:53 ` Eli Zaretskii
2024-09-19 3:51 ` Richard Stallman
2024-09-19 9:45 ` Summer Emacs
2024-09-13 6:38 ` Eli Zaretskii
2024-09-13 7:45 ` Summer Emacs
2024-09-13 10:46 ` Eli Zaretskii
2024-09-13 11:20 ` Summer Emacs
2024-09-13 11:57 ` Eli Zaretskii
2024-09-13 12:09 ` Summer Emacs
2024-09-13 13:31 ` Eli Zaretskii
2024-09-18 8:13 ` Emanuel Berg
2024-09-18 20:02 ` Juergen Fenn
2024-09-20 2:39 ` Emanuel Berg
2024-09-22 12:37 ` Peter Oliver
2024-09-22 14:31 ` Eli Zaretskii
2024-09-13 6:35 ` Eli Zaretskii [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86v7z0jc2w.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=summeremacs@summerstar.me \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.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).