unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Alan Mackenzie <acm@muc.de>
To: xah lee <xah@xahlee.org>
Cc: emacs-pretest-bug@gnu.org
Subject: Re: elisp documentation links to emacs doc
Date: Sat, 12 Jan 2008 11:50:39 +0000	[thread overview]
Message-ID: <20080112115039.GD2581@muc.de> (raw)
In-Reply-To: <D984D7C2-D7C8-4E5B-9964-F48BD59B2F13@xahlee.org>

Hi, Xah!

On Fri, Jan 11, 2008 at 07:06:25PM -0800, xah lee wrote:

> In the official HTML version of the elisp doc, there are many links  to
> the emacs doc nodes. (i counted, 101 of them.)

[ .... ]

> My problem is that for those who only install one doc, then the links
> are dead.

> Are people suppose do always install these 2 docs together? If not,  
> is there some mechanism, either when writing the doc or generating  
> the doc, to not result in links to other docs?

I had this problem in cc-mode.sourceforge.net: my solution was to fix the
html files, redirecting all {links to the non-existent directories
../emacs and ../elisp} to
http://www.gnu.org/software/emacs/manual/html_node/e{macs,lisp}/

Here is the script I use, called "2www.gnu.org.sh" - (it also deletes a
reference to the non-existent GNU Indent manual).  Feel free to adapt it
to your needs.

#########################################################################


#!/bin/sh
# Fix all http links to the Emacs or Elisp manual.
#
# These are redirected from, e.g., "../emacs" to the existing page at
# www.gnu.org.  The link to the indent manual is deleted, because there is no
# online copy of this.
#
# This script takes exactly 1 parameter, the directory to run in.
# e.g. % 2www.gnu.org.sh ~/cc-mode/html

CURDIR=`pwd`
cd $1
for f in *.html
do mv $f asdf.html
    sed 's%href="../emacs/%href="http://www.gnu.org/software/emacs/manual/html_node/emacs/%g
s%href="../elisp/%href="http://www.gnu.org/software/emacs/manual/html_node/elisp/%g' \
    asdf.html > $f
done

mv Limitations-and-Known-Bugs.html asdf.html
sed "s%<[^<>]*>GNU indent ([^()]*)</a>%GNU indent%" \
asdf.html > Limitations-and-Known-Bugs.html

rm asdf.html
cd $CURDIR

#########################################################################

> Thanks.

>   Xah

-- 
Alan Mackenzie (Nuremberg, Germany)

  parent reply	other threads:[~2008-01-12 11:50 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-01-12  3:06 elisp documentation links to emacs doc xah lee
2008-01-12 11:11 ` Richard Stallman
2008-01-12 11:50 ` Alan Mackenzie [this message]
2008-01-21 21:09   ` Kevin Ryde
2008-01-12 12:32 ` Eli Zaretskii

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=20080112115039.GD2581@muc.de \
    --to=acm@muc.de \
    --cc=emacs-pretest-bug@gnu.org \
    --cc=xah@xahlee.org \
    /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).