Date: Mon, 14 Aug 2000 23:48:53 +0100 From: Mark Ovens <marko@freebsd.org> To: Nik Clayton <nik@freebsd.org> Cc: Jim Mock <jim@freebsd.org>, "David O'Brien" <obrien@freebsd.org>, doc@freebsd.org Subject: Re: Porters handbook missing for docs webpage Message-ID: <20000814234853.C254@parish> In-Reply-To: <20000814081211.A706@kilt.nothing-going-on.org>; from nik@freebsd.org on Mon, Aug 14, 2000 at 08:12:11AM %2B0000 References: <20000809035116.A986@dragon.nuxi.com> <20000809123016.A251@parish> <20000813211222.D4052@kilt.nothing-going-on.org> <20000813163111.B516@luna.osd.bsdi.com> <20000814081211.A706@kilt.nothing-going-on.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On Mon, Aug 14, 2000 at 08:12:11AM +0000, Nik Clayton wrote:
> On Sun, Aug 13, 2000 at 04:31:11PM -0700, Jim Mock wrote:
> > > My preferred approach to this is to set up docs.freebsd.org, probably
> > > modeled along very similar lines to docs.sun.com. We can then set up
> > > the links within docs.freebsd.org along much more logical and simple
> > > lines than the mess of links, redirects, and Makefile kludges that
> > > sit in the current web site.
> >
> > Woo hoo! :-)
> >
> > > This is probably simpler than trying to iteratively improve the
> > > situation in www/.
> > >
> > > Volunteers wanted.
> >
> > What do you have in mind?
>
> Didn't we go through this at Usenix :-)
>
> Ideally, the site should present the user with the documentation organised
> in a number of different ways.
>
OK, I'm volunteering to do some (all?) of the work (writing the SGML)
once it's been decided what is wanted.
One thing Nik mentioned in some previous discussions was that he would
like to have a grid/matrix/table showing the languages the various
docs are available in:
I also wouldn't mind seeing a translation table that listed
all the docs, and an indication of whether or not they've
been translated. . .
en es fr ja ru zh
Handbook x x x
FAQ x x x x x x
FDP Primer x
Porter's Handbook x x
[...]
> The first, and easiest way is to show the man/article/book distinction, and
> let the user find what they want that way. That should be rev 1.0.
>
> What I'd also like to do is create several virtual categories, and place
> some of the documentation in to those categories. So, a hypothetical
> "Using Samba on FreeBSD" document might go in to the "File sharing",
> "Windows", and "Printing" categories (assuming it talked about Samba
> printing).
>
> Internally we would arrange this with a CATEGORIES variable in the
> Makefile (or similar) that created a bunch of symlinks. As far as
> *we*, the infrastructure people, are concerned, we still only
> distinguish between man pages, books, and articles. But the end user
> can browse through different categories as necessary. This is rev
> 2.0.
>
> In my really ideal world, the website is built from some template pages and
> a script that works its way through the installed documentation. So the
> canonical docs.freebsd.org would be produced from a fully installed
> documentation set. However, end users should be able to use the same script
> to produce an HTML tree on their local machine which accurately reflects the
> documentation they have installed.
>
> N
> --
> Internet connection, $19.95 a month. Computer, $799.95. Modem, $149.95.
> Telephone line, $24.95 a month. Software, free. USENET transmission,
> hundreds if not thousands of dollars. Thinking before posting, priceless.
> Somethings in life you can't buy. For everything else, there's MasterCard.
> -- Graham Reed, in the Scary Devil Monastery
>
>
> To Unsubscribe: send mail to majordomo@FreeBSD.org
> with "unsubscribe freebsd-doc" in the body of the message
--
4.4 - The number of the Beastie
________________________________________________________________
51.44°N FreeBSD - The Power To Serve http://www.freebsd.org
2.057°W My Webpage http://ukug.uk.freebsd.org/~mark
mailto:marko@freebsd.org http://www.radan.com
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?20000814234853.C254>