Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 16 May 2001 17:28:19 +0100
From:      Nik Clayton <nik@freebsd.org>
To:        Brooks Davis <brooks@one-eyed-alien.net>
Cc:        doc@freebsd.org, Sue Blake <sue@welearn.com.au>, Nik Clayton <nik@FreeBSD.ORG>, "Bruce A. Mah" <bmah@FreeBSD.ORG>, Randy Pratt <rpratt@ezwv.com>, freebsd-docs@FreeBSD.ORG, Doug Young <dougy@gargoyle.apana.org.au>, Murray Stokely <murray@osd.bsdi.com>, Jim Mock <jim@FreeBSD.ORG>
Subject:   Re: Install Preview (was Re: (was) I'm leaving, now something like "anti official docs rant" :) )
Message-ID:  <20010516172819.C41723@catkin.nothing-going-on.org>
In-Reply-To: <20010516074946.A20858@Odin.AC.HMC.Edu>; from brooks@one-eyed-alien.net on Wed, May 16, 2001 at 07:49:46AM -0700
References:  <01051513051703.00373@k6-2.weeble.com> <200105151727.f4FHRos64816@bmah-freebsd-0.cisco.com> <01051515135804.00373@k6-2.weeble.com> <20010516093113.G26123@welearn.com.au> <200105160129.f4G1TtF13540@bmah-freebsd-0.cisco.com> <20010516104048.G72224@catkin.nothing-going-on.org> <20010517003901.K26132@welearn.com.au> <20010516074946.A20858@Odin.AC.HMC.Edu>

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

--tqI+Z3u+9OQ7kwn0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

I'm cc'ing this back to -doc.

On Wed, May 16, 2001 at 07:49:46AM -0700, Brooks Davis wrote:
> On Thu, May 17, 2001 at 12:39:02AM +1000, Sue Blake wrote:
> > Is there some reason why our finished HTML itself can't be made useful
> > to all, as HTML was intended?
>=20
> Because the designers of HTML compleatly screwed up the IMG tag. :-(

Specifically, Marc Andreesen.  However, that's a rant for a whole other
time.

> There are some things that work fine as ASCII art, but you can't do HTML
> which uses ASCII art when images are off because you can't control the
> formatting of text in the ALT argument of the IMG tag. =20

True.

> DocBook handles
> this correctly in that you can have multiple options for any given media
> object including video, pictures, text, and ASCII art.  Unfortunatly,
> there are some things that are just going to be too painful for most
> people to describe comprehensivly in the alt text so that's not really a
> fully functional option either (take the TCP state diagram as an example.)

Which is why images in the Doc. Proj. should have at least two
<textobject> elements.  One of them contains a <phrase> which becomes
the contents of the alt attribute, the other should contain a
<literallayout> block to contain the necessary ASCII art.

It *is* possible to then generate HTML that has ASCII art in it instead
of pictures.  For example, if you've got a checked out copy of the doc/
tree, do

    cd doc/en_US.ISO_8859-1/articles/vm-design
    make article.html-text

and then load the generated article.html-text file in to your browser
(you may need to rename it to article.html before your browser will
realise it's HTML).

Again, these are available from the FTP site -- they're not currently
turned on by default in the web site build.

I've put a copy of what one of these looks like in

    http://people.freebsd.org/~nik/article.html-text

Compare and contrast with

    http://www.freebsd.org/doc/en_US.ISO_8859-1/articles/vm-design/article.=
html

The big problem we'll have getting these coexisting is that filenames
for different output formats will probably clash.  We may now be getting
to the point where we need to put each output format in its own
subdirectory at build and install time, which is another headache.

N
--=20
FreeBSD: The Power to Serve             http://www.freebsd.org/
FreeBSD Documentation Project           http://www.freebsd.org/docproj/

          --- 15B8 3FFC DDB4 34B0 AA5F  94B7 93A8 0764 2C37 E375 ---

--tqI+Z3u+9OQ7kwn0
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.5 (FreeBSD)
Comment: For info see http://www.gnupg.org

iEYEARECAAYFAjsCqqIACgkQk6gHZCw343XlggCeMwciMcAoarR98x1gZYsi7bqc
WnIAn3Ow87ghRgI/+cNpH62NYq3S9zvY
=Dv7x
-----END PGP SIGNATURE-----

--tqI+Z3u+9OQ7kwn0--

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?20010516172819.C41723>