From fnaumann@mail.cs.uni-magdeburg.de Mon Jul 26 08:56:06 2004 Message-ID: <41043712.4010901@inf.tu-dresden.de> Date: Mon, 26 Jul 2004 00:41:22 +0200 From: Norman Feske User-Agent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.7.1) Gecko/20040715 Debian/1.7.1-1 X-Accept-Language: en MIME-Version: 1.0 To: mint@fishpool.com Subject: Re: [MiNT] FreeMiNT documentation References: <001701c47223$3b66a120$0100a8c0@dalamar> <006301c47250$f3f36020$390f63d9@blaszak> In-Reply-To: <006301c47250$f3f36020$390f63d9@blaszak> Content-Type: text/plain; charset=us-ascii; format=flowed Content-Transfer-Encoding: 7bit X-Virus-Scanned: by amavisd-new at inf.tu-dresden.de X-Virus-Scanned: by amavisd-new-20030616-p10 (Debian) at fishpool.fi Delivered-To: mint@fishpool.com Delivered-To: mint@lists.fishpool.fi X-ecartis-version: Ecartis v1.0.0 Sender: mint-bounce@lists.fishpool.fi Errors-to: mint-bounce@lists.fishpool.fi X-original-sender: nf2@inf.tu-dresden.de Precedence: bulk List-help: List-unsubscribe: List-ID: X-List-ID: X-Milter: ClamAV 0.70/0.70kjel X-Milter: milter-regex 1.5jel X-Milter: ClamAV 0.70/0.70kjel X-Milter: milter-regex 1.5jel Dear MiNT developers, > before all "invent some sane format for the documentation". Then, when > invented, we can revise all the existing documentation, because it will have > to be converted anyways. "Revise" means re-use and update, not simply dump > and write from scratch. Once, I had the same problem. So I developed a tool, which I use now for all my text-related work. It is called GOSH. It is a tcl-script, which takes a plain ASCII text in usenet-style and generates either Latex (and thus, ps or pdf), html, xml or man-pages. It supports multiple section levels, nested items, nested enumerations, detection of hex numbers, accentuations such as _this_ or *that*, tables, cross-references, links, description-items, verbatim sections (for source code) etc. For example, I wrote my ACP-article about my MiNT-work using this tool. You can take a look at the source code: http://os.inf.tu-dresden.de/~nf2/svn/trunk/acp/doc/mcf5407eval.txt Simple, isnt it? As a result, you get something like: http://acp.atari.org/files/articles/mcf5407eval.pdf or http://acp.atari.org/articles/mcf5407eval/mcf5407eval.html or even http://os.inf.tu-dresden.de/~nf2/tudos/html/goshtest.html It is very extensible - a new backend can be added easily (the html-backend took me an hour or so). ST-Guide, UDO? Its biggest advantage is, that the source code is a readable ASCII text. There is no markup-stuff or such. As I said, I use this tool for everything: documentation, websites, papers etc. Maybe it could be also of use for the MiNT documentation work? If so - I would release it as GPL. Greetings, Norman