On Tue, Aug 19, 2008 at 2:59 AM, Martin Albrecht
<[EMAIL PROTECTED]> wrote:
>
> On Tuesday 19 August 2008, John H Palmieri wrote:
>> It says:
>> "You might also write additional documentation in \Latex, which is not
>> to
>> be part of any source code file. The examples in this documentation
>> should be contained in verbatim environments. The examples should be
>> tested using \code{sage-testtex}, which you run on the \Latex file."
>>
>> Are there examples of this sort of additional documentation in the
>> Sage library? And what is sage-testtex?
One should now just do
sage -t foo.tex
on the tex file to test it. This is done at the beginning of "make check"
on the reference manual, constructions guide, and tutorial.
>
> I have never heard of it, maybe
>
> http://www.ctan.org/tex-archive/macros/latex/contrib/sagetex/
>
> by Dan Drake could/should be used here. I'm BCCing him :-)
>
>> In the Interfaces chapter it says:
>> "You can create \SAGE pseudo-tty interfaces that allow \SAGE to
>> work with an almost completely arbitrary command line program,
>> and don't require any modification or extensions to the
>> command line program."
>>
>> Are there examples (maybe in sage/interfaces) which are good
>> illustrations of this?
>
> Strictly speaking all sage.interfaces are such examples. A quite short one is
> gfan.py. However, I strongly suggest someone looks through whatever example
> we choose and makes it very very nice. I learned the hard way that examples
> tend to be templated/copied and every nastiness in those will be copied over.
> Even comments like: "This is a short-cut, the proper way can be seen in" are
> often futile.
I think a few paragraphs that guide one through an existing interface
in SAGE_ROOT/devel/sage/sage/interfaces is much much better
than some templated interface thing we make up. The issue is
something in SAGE_ROOT/devel/sage/sage/interfaces works, is
tested, and will hence always work in the future. In constrast, something
made up for the documentation could easily get out of date.
William
--~--~---------~--~----~------------~-------~--~----~
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---
