>Steve, do you think this is a good plan? Should we as package
>maintainers write sections along these lines? Since the amount of
>text would be small we could presumably complete this quite quickly
>(today).
A perfect plan.
Steve.
-----Original Message-----
From: Mark Taylor [mailto:[log in to unmask]]
Sent: 06 June 2003 10:19
To: [log in to unmask]
Subject: Re: StarJava
On Fri, 6 Jun 2003, Rankin, SE (Stephen) wrote:
> All that I was asking was if I need to move the current SUN documents for
> splat and treeview to the docs package. If there is online documentation
in
OK well the short answer is 'no' for the treeview one, because it
does not match the current state of the application. I don't know
about SPLAT.
> the application itself, then we only need to say this in the two page
> document that I suggested. We only need something simple this time to let
> people know what there is in the java stuff, and what commands to run. But
How about this: one SUN on the starjava system itself, briefly
explaining the filesystem structure, with a short section for
some of the packages, at least the application ones.
These sections can be as short as a couple of paragraphs (though
could be longer) and should at least say:
- what the application is for
- how to invoke it
- and how to get additional help if any is available
I suppose a representative screenshot might be a good idea too.
In this way 'findme frog' etc will come up with something rather
than nothing. As you say this is not an ideal solution and we need
to come up with something better for subsequent releases.
Those of us responsible for packages could come up with a \section
(or \subsection?) each and Steve could collate them into a new SUN
with an additional overview section.
Steve, do you think this is a good plan? Should we as package
maintainers write sections along these lines? Since the amount of
text would be small we could presumably complete this quite quickly
(today).
Mark
--
Mark Taylor Starlink Programmer Physics, Bristol University, UK
[log in to unmask] 0117 928 8776 http://www.star.bris.ac.uk/~mbt/
|