Skip site navigation (1)Skip section navigation (2)
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>

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

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




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