A start on the User Manual



--- Tuukka Toivonen <tuukkat@ees2.oulu.fi> wrote:
> On Wed, 17 Oct 2001, Oscar Lopez wrote:
> 
> >I use lyx and everyone agrees in the excellent documentation that
> >accompanies this nice piece of software. They have structured the
> help
> >documentation in several documents. A maxima replicant outline could
> be:
> 
> Yes, and when I'm looking for something, I may have to look from all
> *three*
> manuals which is very cumbersome. I would rather prefer just one
> longer
> manual. And besides, the LyX documentation is *very* long. Before the
> Maxima documentation gets to the same length, I don't think we should
> even talk about splitting it into multiple documents.
> Of course, this is just my personal opinion...

I agree, but since there seem to be differing opinions why not have our
cake and eat it too?  In my last response to Richard I outlined a way I
thought we might be able to work it - have each chapter unit contained
in a different file, and include different units in different
documents.  That way, Tuukka and I can get our huge all in one manual,
and other people could get just the basics.  That way, only one install
document has to be maintained, i.e. the installchapter.tex file, and it
can be used either in a stand-alone Install.tex or in BigManual.tex.

There will probably be some specific components which would only work
in one document - i.e., tutorial components might not work in a Manual
where the information is already covered in more depth, but I think
there would be enough overlap to make it worthwhile.

If this sounds OK to everyone, I can start adapting the current Lyx
file into LaTeX and breaking it up into multiple files, and maybe we
can make this the first upload into sourceforge CVS?  I know the main
Maxima effort is still wavering about where to host the project, but I
think the documentation team could benefit from the resources there.

__________________________________________________
Do You Yahoo!?
Make a great connection at Yahoo! Personals.
http://personals.yahoo.com