Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 4 Apr 2001 10:27:00 +0100
From:      Nik Clayton <nik@freebsd.org>
To:        Dima Dorfman <dima@unixfreak.org>
Cc:        doc@freebsd.org, nik@freebsd.org
Subject:   Re: Proper way to make relative links to other docs
Message-ID:  <20010404102700.A45781@canyon.nothing-going-on.org>
In-Reply-To: <20010404012554.11C423E09@bazooka.unixfreak.org>; from dima@unixfreak.org on Tue, Apr 03, 2001 at 06:25:53PM -0700
References:  <20010404012554.11C423E09@bazooka.unixfreak.org>

next in thread | previous in thread | raw e-mail | index | archive | help

--h31gzZEtNLTqOjlF
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Tue, Apr 03, 2001 at 06:25:53PM -0700, Dima Dorfman wrote:
> What's the proper way to link from one document to another? =20

Very good question.

> The FAQ
> and Handbook generally refer to each other using "../".  This works
> both ways, and for all kinds of directory structures/layouts.  What's
> the correct way to link from, say, the PPP primer to the Handbook,
> though?  With the "/docs/en/books/whatever" layout, "../" still works;
> that layout doesn't seem to be used, though (it's still on
> www.freebsd.org, but the current Makefile in www/en doesn't update
> it).  It doesn't work for the case where the ppp-primer is
> tutorials/ppp, though; using "../../" seems evil, since that will
> break for just about any other layout.
>=20
> Suggestions?

This is one reason why I'd like the docs on the web site to install in
to a fixed hierarchy.  It makes this issue relatively easy to solve for
90% of the cases.

The way you're supposed to do it is to use the OLink element (c.f.,
ULink, and XRef in DocBook).  The available documentation on OLink is
relatively sparse;

    http://www.docbook.org/tdg/html/olink.html
    http://www.nwalsh.com/docbook/dsssl/doc/olinksemantics.html

and we haven't done anything with it (I seem to recall that Neil (nbm)
looked at this a while ago).

N
--=20
FreeBSD: The Power to Serve             http://www.freebsd.org/
FreeBSD Documentation Project           http://www.freebsd.org/docproj/

          --- 15B8 3FFC DDB4 34B0 AA5F  94B7 93A8 0764 2C37 E375 ---

--h31gzZEtNLTqOjlF
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.4 (FreeBSD)
Comment: For info see http://www.gnupg.org

iEYEARECAAYFAjrK6OMACgkQk6gHZCw343X4dgCcCD24xKnjCGgDcV9mDzuZSbRL
FSkAn3y0iMrxhZDlDcGYhfR2JAd59jdo
=yCKw
-----END PGP SIGNATURE-----

--h31gzZEtNLTqOjlF--

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010404102700.A45781>