Date: Wed, 26 Sep 2001 14:36:54 -0700 From: Murray Stokely <murray@FreeBSD.org> To: Giorgos Keramidas <charon@labs.gr> Cc: doc@freebsd.org Subject: Re: RFC: <filename> tags and use of class="directory" attribute Message-ID: <20010926143654.K1338@windriver.com> In-Reply-To: <20010926121908.A23272@hades.hell.gr>; from charon@labs.gr on Wed, Sep 26, 2001 at 12:19:08PM %2B0300 References: <20010926121908.A23272@hades.hell.gr>
next in thread | previous in thread | raw e-mail | index | archive | help
[-- Attachment #1 --]
I agree with Nik here that if you want to send in a patch we'll
certainly commit it, but it's not likely to make much of an impact on
our user's experience with FreeBSD Documentation. There are plenty of
other things that need to be done though :
* Write more content for our books.
* Write more tutorials
* Improve the sometimes horrible abuse of the English language
in our documentation.
* Translate our English documentation into other languages.
* Make screenshots or diagrams to replace ASCII text if it
provides a large benefit for the clarity of the text.
The doc project task list is available online at
http://www.freebsd.org/docproj/current.html. The above is just a
sample of some of my own todo items.
- Murray
On Wed, Sep 26, 2001 at 12:19:08PM +0300, Giorgos Keramidas wrote:
> [ 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 '<div class=
> ./books/developers-handbook/x86/chapter.sgml: db 'cellspacing="0"
> ./books/developers-handbook/x86/chapter.sgml: db '<td class="n
> ./books/developers-handbook/x86/chapter.sgml: db '<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
>
[-- Attachment #2 --]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (SunOS)
Comment: For info see http://www.gnupg.org
iD8DBQE7skp2tNcQog5FH30RAk+QAKDNj5Nx7CoARFIL8t72U5q0oBMe9gCdG48C
pj+uaKvXVokqx9RJc26/eyM=
=zKi7
-----END PGP SIGNATURE-----
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010926143654.K1338>