discuss: Linux documentation wiki
Subject:
Re: Linux documentation wiki
From:
David Merrill ####@####.####
Date:
12 Jan 2002 17:53:11 -0000
Message-Id: <20020112184443.GA28479@lupercalia.net>
On Sat, Jan 12, 2002 at 10:45:54AM -0500, Greg Ferguson wrote:
[snip]
> Exactly. We need to be mindful of how the docs are used, being part
> of many distributions. I'd certainly be interested in looking at
> or working on a wiki-to-{sg,x}ml filtering mechanism, but given the
> nature of the wiki, I'm not sure if that would really work for HOWTOs,
> etc. The strength of the wiki is it's dynamic nature.
I think it can be done. Look at Wikipedia and how they handle Wiki
(text) to html. Here's a brief outline of one approach:
--SAMPLE--
Author: David Merrill
AuthorEmail: ####@####.####
Keywords: foo bar baz
=Introduction=
==Copyright==
Text
==License==
Text
=The Details=
Text
*item
*item
*item
#item
#item
#item
=References=
This document is from the [[http://www.linuxdoc.org Linux Documentation Project]].
See also the [[SCSI-HOWTO]] for more information.
--END SAMPLE--
This is similar to the way UseModWiki works.
On save the = tag gets converted to a <sect1> tag, and two carriage
returns gets translated to a <para> construct. * goes to an unordered
list, # to a numbered list.
Automatically convert http: links and ftp: links into <ulink>
constructs. Automatically convert non-http: links to the named
document.
Primitive? Yes. Not full docbook functionality. But the idea could be
expanded, I am sure. I think it's possible and even desirable. We do
need to make writing HOWTOs even easier than it is, but we don't want
to lose the power of DocBook, either.
Basically what we'd be doing is writing a text-to-docbook tool, using
a specifically formatted text. It would be even easier to write in
than Linuxdoc.
--
David C. Merrill http://www.lupercalia.net
Linux Documentation Project ####@####.####
Collection Editor & Coordinator http://www.linuxdoc.org
The only thing wrong with Microsoft is that they have no taste.
--Steve Jobs, Interim Apple Computer CEO
