Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 22 Mar 2003 14:46:41 -0800
From:      "Bruce A. Mah" <bmah@FreeBSD.org>
To:        Giorgos Keramidas <keramida@FreeBSD.org>
Cc:        freebsd-doc@FreeBSD.org, re@FreeBSD.org
Subject:   Re: ulink elements and URL duplication in the docs
Message-ID:  <20030322224641.GA71175@intruder.bmah.org>
In-Reply-To: <20030322215305.GB57850@gothmog.gr>

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

[-- Attachment #1 --]
If memory serves me right, Giorgos Keramidas wrote:
> The <ulink> element in SGML doesn't need to have any content apart
> from a URL="" attribute.  There are currently many places where lines
> look awful because a long URL is include twice(!) in the running text
> of a document, i.e.
> 
> 	<para>See <ulink
> 	  URL="http://www.foobar.net/some/long/path/here/">http://www.foobar.net/some/long/path/here/</ulink>;
> 
> This is equivalent to:
> 
> 	<para>See <ulink
> 	  URL="http://www.foobar.net/some/long/path/here/"></ulink>;
> 
> which contains the URL only once, saving some (precious most of the
> time) horizontal space and reducing the potential for mistakes when
> someone edits the URL in one of those places and forgets the other, or
> makes a mistake while editing the same text twice.

IMHO, the second reason is more important than the first.

> There's a relatively large diff I tested a few moments ago through a
> full build of doc/ at:
> 
> 	http://www.FreeBSD.org/~keramida/diff/_03.ulink.patch
> 
> Do you all think it's ok to make the changes of that diff?

Hmmm.  I only perused the diff, but this looks pretty good to me.
Could you do a quick check to see if our print stylesheets generate
sane output as well?  (I think they do, but just to be sure...)

> If yes, is it ok to do it now, or should I just wait for a date after
> 4.8-RELEASE to avoid making large changes at this point in time?

I tagged the doc/ tree a couple days ago...I think at this point it'd
probably be better to wait.  It'll probably just be a few more days.

Thanks!

Bruce.



[-- Attachment #2 --]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (FreeBSD)

iD8DBQE+fOfR2MoxcVugUsMRAprGAJ4wPZwvFLTMpvSO6D4d9Flvx+SIRACg+OaD
A8IHqQiRQ6vj0chrUOSRX7I=
=ocgg
-----END PGP SIGNATURE-----
help

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