unofficial mirror of bug-guile@gnu.org 
 help / color / mirror / Atom feed
From: Mark Harig <idirectscm@aim.com>
To: wingo@pobox.com, neil@ossau.uklinux.net
Cc: bug-guile@gnu.org
Subject: Re: More missing options for guile/doc/guile.1
Date: Thu, 27 Jan 2011 14:25:35 -0500	[thread overview]
Message-ID: <8CD8C6F1AF294F7-1AF8-149B8@Webmail-d115.sysops.aol.com> (raw)
In-Reply-To: <m3pqrjeagh.fsf@unquote.localdomain>

Here are some other language interpreters that have manual pages:

    awk, bash, bc, clisp, dc, emacs, make

"emacs" and "make" follow the terse approach, while the others do not.
These can be examined to help decide whether you would prefer for those
programs to have a terse manual page or not.

Although my preferred documentation format is "info," requiring new
users to learn info or emacs before learning guile is another barrier
to adoption, it seems to me.  If the terse approach is adopted, the
manual page should at least include a reference to the on-line manual.
(kept scrupulously up to date for each release, for example
 version 1.9.14 is *not* available here
http://www.gnu.org/software/guile/docs/master/guile.html/index.html).

Speaking of on-line manuals, I would like to point to Org-mode's manual,
which has melded info and HTML together so that info keyboard
commands can be used to move through the manual (that is, some
commands, such as 'n', 'p', 'u', 't', '1', '2', but not all), while 
still allowing
mouse users to click on links.

http://orgmode.org/guide/index.html

This is something I would like to see all GNU online manuals that
are derived from texinfo files aspire to.  Can a guile version of
http://orgmode.org/org-keys.js be written?

---



  parent reply	other threads:[~2011-01-27 19:25 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-01-13 23:13 More missing options for guile/doc/guile.1 Mark Harig
2011-01-15 21:15 ` Neil Jerram
2011-01-17 22:25   ` Ludovic Courtès
2011-01-26 19:22   ` Andy Wingo
2011-01-26 21:49     ` Neil Jerram
2011-01-27 17:06     ` Ludovic Courtès
2011-01-27 19:25     ` Mark Harig [this message]
2011-01-27 22:35       ` Andy Wingo
     [not found]     ` <8CD8C7DAC060621-190C-94B30@Webmail-d109.sysops.aol.com>
2011-01-27 22:52       ` Andy Wingo

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/guile/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=8CD8C6F1AF294F7-1AF8-149B8@Webmail-d115.sysops.aol.com \
    --to=idirectscm@aim.com \
    --cc=bug-guile@gnu.org \
    --cc=neil@ossau.uklinux.net \
    --cc=wingo@pobox.com \
    /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.
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).