From: Jesse W <jessw@netwood.net>
To: zsh-workers@sunsite.dk
Subject: Vastly better HTML docs
Date: Tue, 14 Apr 2009 02:19:54 -0700 [thread overview]
Message-ID: <a6d48fcde22cea44b9ed94a38225abc3@netwood.net> (raw)
I've (finally) figured out how to generate a HTML version of the zsh
docs with sane and helpful file and anchor names. And it's really
easy.
The HTML version of the zsh docs are generated from the texinfo version
by a program called texi2html. The version that is currently being
used to generate the online copy of the docs is 1.64, which was
released in 2000 (!) and whose maintainer hasn't released a new version
since. However, the project has been taken up by another maintainer,
who has put out more recent releases, (available from
http://www.nongnu.org/texi2html/ ), with some extremely nice features.
If you generate the zsh docs with the current version (1.82), and use
the --node-files option, it will make html files with *actual*
*descriptive* *names* (like "Shell-Grammar.html", or
"Editor-Functions-Index.html").
**EVEN BETTER**, the index anchors, which in the current version are
opaque, unguessable numerical codes, are now self-evident, easily
guess-able links like "#index-compadd" or
"#index-background-jobs_002c-notification" (_002c is a comma -- maybe
not totally obvious, but understandable once seen).
Combining these, you get the very automatable, human-readable URLs
like: "Options.html#index-EQUALS" for the EQUALS option, etc.
And the whole things is very customizable, so if we want to change it
(maybe making underscores, which currently show up as "_005f",
something simpler), we can do so easily...
It would be great to get these improved URLs live on the various zsh
doc mirrors, so we can start linking to them from the wiki, and other
places.
Let me know how else I can help with this,
Jesse Weinstein
next reply other threads:[~2009-04-14 9:18 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-04-14 9:19 Jesse W [this message]
2009-04-16 10:11 ` Peter Stephenson
2009-04-16 18:33 ` Jesse W
2009-04-17 13:20 ` Peter Stephenson
2009-04-17 13:55 ` Richard Hartmann
2009-04-18 18:23 ` Jesse W
2009-04-18 18:49 ` Peter Stephenson
2009-04-21 10:09 ` Richard Hartmann
2009-05-27 16:39 ` Richard Hartmann
2009-05-27 23:59 ` Jesse W
2009-05-28 19:07 ` Peter Stephenson
2009-05-28 20:03 ` Oliver Kiddle
2009-05-29 5:23 ` Jesse W
2009-04-17 11:28 ` Richard Hartmann
2009-04-17 12:05 ` Peter Stephenson
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=a6d48fcde22cea44b9ed94a38225abc3@netwood.net \
--to=jessw@netwood.net \
--cc=zsh-workers@sunsite.dk \
/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.vuxu.org/mirror/zsh/
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 NNTP newsgroup(s).