oldk1331 wrote:
>
> Another question related with the help system:
>
> How to generate DOM/CAT/PKG help files under
> $AXIOM/share/spadhelp/ ?
>
> They are not generated in a fresh build from trunk,
> and seems to be bundled in release tarballs without
> change for a long time.
>
> I search "spadhelp" in mail archives, seems that
> because of possible duplication, the spadhelp/
> dir is not included in FriCAS source tree. But also
> we still don't have a way to generate them.
> Am I summing it up correctly?
>
> What's the status of spadhelp, and what's the right
> thing to do with it?
Currently help files for system commands are generated
from .htex file describing system command. Algebra
help files were created mostly manually by Tim Daly.
Currently algebra help files are essentially unmaintained:
trying to maintain them would mean duplicating work
done on .htex files. There is source tarball
IIRC present in 1.0.8 version.
Let me add that it is important that there is one
"authoritative" version of documentation -- currently
it is contained in .htex files (plus ++ docstrings
and a few .ht files). Other formats should be
generated from this one.
Concerning what to do: I consider spadhelp files as
extra nicety, but not essential. Namely, main
source of information is HyperDoc and in principle
we can generate nice .pdf file from HyperDoc.
In other words, users can find information
in other places and spadhelp files add little
value.
Spadhelp files are pure ASCII which limits what
can be expressed. HyperDoc format is also
deliberatly limited, so in principle translating most
of HyperDoc to ASCII is possible (there are problems
caused by images and interactive features).
But to the moment nobody set up process to
genrate them.
--
Waldek Hebisch
--
You received this message because you are subscribed to the Google Groups
"FriCAS - computer algebra system" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/fricas-devel.
For more options, visit https://groups.google.com/d/optout.
