Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 24 May 2001 13:20:51 +0200
From:      Udo Erdelhoff <ue@nathan.ruhr.de>
To:        freebsd-doc@freebsd.org
Subject:   Problems with the automatic links
Message-ID:  <20010524132051.A25181@nathan.ruhr.de>

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

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

Hi,
I've found two sets of problems while working on yet another round of FAQ
markup improvements[1].

The first problem is a case of "well, don't do that":
Using &man.foo.bar; inside <question> has intresting side effects for the
TOCs: It ends the link to the question, inserts a link to the manapge and
continues with normal text. Check question 20 in the networking chapter
for a drastic example. Courtesy URL:
http://www.freebsd.org/doc/en_US.ISO_8859-1/books/faq/networking.html

Solution: Like I said earler: Well, don't do that. The neccessary patches
are already in my version of the FAQ and will be committed "soon".

The second problem is somewhat tricky: We have several entities for
programs found in the ports collection. Using them results in a link of
this form:

http://www.freebsd.org/cgi/man.cgi?query=3Dimwheel&sektion=3D1

Unfortunately, using this links gives "Sorry, no data found for...".  The
same problem applies to the entities for X programs.  The solution is a
link of the form

http://www.freebsd.org/cgi/man.cgi?\
query=3Dimwheel&sektion=3D1&manpath=3DFreeBSD+Ports

Unfortunately, I'm not a stylesheet guru and have absolutely no idea how
to change the stylesheets to add "&manpath=3DFreeBSD+Ports" to some entitie=
s.
As far as I can see, the current code simply forces every refentry into
a link to man.cgi. So far, I had two possible ideas:

a) Go back in time and use the old "1x" notation. The names of the entities
would be &man.foo.1x;, resulting in

<citerefentry><refentrytitle>foo</refentrytitle><manvolnum>1x</manvolnum></=
citerefentry>=20

The code in the stylesheets would have to use the second char to add the
right link to HTML version. In the other formats, the stylesheets would
have to remove the second letter.

b) Use &man.foo.1x; to generate an entity of the form:
<citerefentry><refentrytitle>foo</refentrytitle><manvolnum class=3D"xfree">=
1</manvolnum></citerefentry>=20

And use the class parameter in the HTML version to create the correct link.

I think b) is the better approach but I'd like to hear the opinions of
our resident stylesheet gurus on that matter.

/s/Udo
[1] To answer the obvious question: Yes, I could have created one mega-patch
containing all the various fixes. I'm using seperate patches to make the
changes more transparent and to ease the work for the translation teams.
Doing the change A twenty times and then change B twenty times is faster
than doing fourty mixed changes.

--=20
Schnell und schluepfrig wie geoeltes Ferkel auf Crack

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

iQCVAwUBOwzuk0Poh1XnT6hxAQFbXAP/RgxKNUor4lFkuggwyfXqgk+eTMk+cJbp
P1lFx4nU7gYG3jstMzEpJhig0uENBWBOdBbDOBSZ1V46QrgpfzX3bzVS5oGTWOIw
c+A6UUaO4D3hSdWqqm0TN8r84cVO4OI3LHrJUL9TZk4fxsrZGYzgNH16nTmZLSPl
scxvSDZ+NuU=
=byxG
-----END PGP SIGNATURE-----

--dDRMvlgZJXvWKvBx--

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?20010524132051.A25181>