Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 26 Nov 2001 13:17:28 +0000
From:      Nik Clayton <nik@freebsd.org>
To:        Michael Lucas <mwlucas@blackhelicopters.org>
Cc:        Pete Fritchman <petef@databits.net>, doc@FreeBSD.ORG
Subject:   Re: man page/link on handbook page error
Message-ID:  <20011126131728.B34313@clan.nothing-going-on.org>
In-Reply-To: <20011120155301.A15092@blackhelicopters.org>; from mwlucas@blackhelicopters.org on Tue, Nov 20, 2001 at 03:53:01PM -0500
References:  <000801c172c8$8b4dc540$1600a8c0@test2> <20011120154504.A14999@blackhelicopters.org> <20011120154913.C10974@databits.net> <20011120155301.A15092@blackhelicopters.org>

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

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

On Tue, Nov 20, 2001 at 03:53:01PM -0500, Michael Lucas wrote:
> On Tue, Nov 20, 2001 at 03:49:13PM -0500, Pete Fritchman wrote:
> > ++ 20/11/01 15:45 -0500 - Michael Lucas:
> > | Well, -doc team, this one looks somewhat interesting.
> > |=20
> > | The entity for devfs(5) points to the releng_4 man pages.  The
> > | reference in the page specifically discusses devfs(5) from -current.
> > |=20
> > | What's the proper way to handle this?
> >=20
> > How about:
> >=20
> > http://www.freebsd.org/cgi/man.cgi?query=3Ddevfs&sektion=3D5&manpath=3D=
FreeBSD+5.0-current
> >=20
> > You can see the different options availabe by just going to
> > http://www.freebsd.org/cgi/man.cgi.
>=20
> True, but that kind of violates the "use entities everywhere" rule we
> have going.
>=20
> Is there a precedent for how this should be done?  Surely somewhere in
> the docs there's something similar...

No, but this has come up before.

Here's a replacement for the create-refentry-xref-link function in=20
doc/en_US.ISO8859-1/share/sgml/freebsd.dsl.  This uses the vendor
attribute to extend the URL.

        <!-- Specify how to generate the man page link HREF -->
        (define ($create-refentry-xref-link$ #!optional (n (current-node)))
          (let* ((r (select-elements (children n) (normalize "refentrytitle=
")))
                 (m (select-elements (children n) (normalize "manvolnum")))
                 (v (attribute-string (normalize "vendor") n))
                 (u (string-append "http://www.FreeBSD.org/cgi/man.cgi?quer=
y=3D"
                         (data r) "&" "sektion=3D" (data m))))
            (case v
              (("xfree86") (string-append u "&" "manpath=3DXFree86+4.0.2"))
              (("netbsd")  (string-append u "&" "manpath=3DNetBSD+1.5"))
              (else u))))

This really ought to be committed, with a case for "freebsd-5.0.0" or
similar that adds the appropriate manpath to the URL.  Then you could
write

  <citerefentry vendor=3D"freebsd-5.0.0"><refentrytitle>devfs</refentrytitl=
e>
    <manvolnum>5</manvolnum></citerefentry>

or similar, create entities for it, and so forth.

Thoughts?

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

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

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

iEYEARECAAYFAjwCQOcACgkQk6gHZCw343XaUACfSF0DiHMmyme3sLYbiLYj8yPu
5uoAmwbSiusT+uU+NejW8K81NUcaYqbN
=pq40
-----END PGP SIGNATURE-----

--hQiwHBbRI9kgIhsi--

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?20011126131728.B34313>