From owner-freebsd-doc  Wed Sep 26  4:16:48 2001
Delivered-To: freebsd-doc@freebsd.org
Received: from mailsrv.otenet.gr (mailsrv.otenet.gr [195.170.0.5])
	by hub.freebsd.org (Postfix) with ESMTP id D7E8037B431
	for <doc@freebsd.org>; Wed, 26 Sep 2001 04:16:43 -0700 (PDT)
Received: from hades.hell.gr (patr530-a219.otenet.gr [212.205.215.219])
	by mailsrv.otenet.gr (8.11.5/8.11.5) with ESMTP id f8QBGdY20033
	for <doc@freebsd.org>; Wed, 26 Sep 2001 14:16:40 +0300 (EEST)
Received: (from charon@localhost)
	by hades.hell.gr (8.11.6/8.11.6) id f8Q9J9K23373
	for doc@freebsd.org; Wed, 26 Sep 2001 12:19:09 +0300 (EEST)
	(envelope-from charon@labs.gr)
Date: Wed, 26 Sep 2001 12:19:08 +0300
From: Giorgos Keramidas <charon@labs.gr>
To: doc@freebsd.org
Subject: RFC: <filename> tags and use of class="directory" attribute
Message-ID: <20010926121908.A23272@hades.hell.gr>
Mime-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
	protocol="application/pgp-signature"; boundary="VbJkn9YxBvnuCH5J"
Content-Disposition: inline
User-Agent: Mutt/1.3.22.1i
X-GPG-Fingerprint: C1EB 0653 DB8B A557 3829  00F9 D60F 941A 3186 03B6
X-URL: http://labs.gr/~charon/
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-doc.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-doc>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-doc>
X-Loop: FreeBSD.org


--VbJkn9YxBvnuCH5J
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

[ A few bits of DocBook anal-retentiveness. ]

I noticed that there are places (very few, this is true) in the english
documentation that use the <filename> tag with it's class="" attribute.
A little search in the DocBook DTD's showed that <filename> supports the
following classes: headerfile, devicefile, directory, libraryfile, symlink and
path.

The en_US.ISO8859-1 docs use class="" in very few places though (lines wrapped
for readability):

    # lines `cut' at 78 characters, to avoid messy output on narrow terminals
    $ cd ~/freebsd/doc/en_US.ISO8859-1
    $ find . -type f -name \*.sgml |\
    > xargs grep 'class="' /dev/null |\
    > grep -v 'literallayout' |\
    > grep -v '<tr'
    ./articles/dialup-firewall/article.sgml:      class="directory">/etc/fire
    ./books/developers-handbook/introduction/chapter.sgml:      <filename cl
    ./books/developers-handbook/x86/chapter.sgml:   db      '&lt;div class=
    ./books/developers-handbook/x86/chapter.sgml:   db      'cellspacing="0"
    ./books/developers-handbook/x86/chapter.sgml:   db      '&lt;td class="n
    ./books/developers-handbook/x86/chapter.sgml:   db      '&lt;td class="v

Is this done because it's preferred to avoid cluttering the SGML source with
too much markup (or some other equally important reason)? (in which case, those
few places that *do* use class="" are better removed)  If not, should I go
through the docs and add proper class attributes to those <filename> tags that
do not have them?

-giorgos


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

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (FreeBSD)

iD8DBQE7sZ2M1g+UGjGGA7YRAn/TAKC6ewv2/44G1+hH9qycoN45uRaNvwCcCdCd
Hi/n+ZcW2Mib+TfBRadi34g=
=lHnE
-----END PGP SIGNATURE-----

--VbJkn9YxBvnuCH5J--

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