scsh-users
[Top] [All Lists]

Re: documentation

To: scsh@martigny.ai.mit.edu
Subject: Re: documentation
From: bothner@cygnus.com (Per Bothner)
Date: 16 Apr 1996 18:00:02 -0700
Organization: Cygnus Support, Mountain View, CA
In article <qiju3yjlr9s.fsf@lambda.ai.mit.edu>,
Olin Shivers <shivers@ai.mit.edu> wrote:
>If someone out there understands what the right thing is, I'd appreciate
>an update.

I think texinfo or linuxdoc-sgml are the best options right now.

Texinfo is widely used, relatively simple and straight-forward,
and can be translated to dvi, ps, ?roff, html, the info format.

I think texinfo needs to be replaced by something sgml-based,
but for now texinfo is sufficient.  Designing a successor to
texinfo is not something that the scsh project should get involved
with.  If and when there is a successor, there will also be
translators to the successor.

An alternative is linuxdoc-sgml.  I have not used it mayself,
but it is used by the Linux documentation project.  It can
be translated into a number of other formats, including texinfo
and html.  One problem is that it is not widely used outside the
Linux documentation project, and the DTD used is similarly
non-standard.  I suspect this is a more powerful format than texinfo.
Using sgml is Good, and even if the linux-doc DTD becomes
replaced by some other standard, there will be tools to
translate it - after all that is what sgml is all about.

Using the docbook DTD for sgml might be reasonable, but I don't
know of a good set of free tools that work with it.  (Perhaps someone
more knowledgeable can comment.)
-- 
        --Per Bothner
Cygnus Support     bothner@cygnus.com

<Prev in Thread] Current Thread [Next in Thread>