[Aldor-l] Ann: ALLPROSE / Suggestions

[Martin Rubey]

Ralf Hemmecke <ralf at hemmecke.de> writes:

> I have no idea how to make Section 6 shorter. The only way would be to write
> a script that does most of these setup things automatically. But a library
> writer has to replace most of the code anyway so a script makes not much
> sense. Are there other opinions?

I'm not sure. Maybe a script would help. But very likely I would have to read
Section 6 more carefully to provide *constructive* critisism.

If you have some spare time (hohoho...), maybe you could transform one (or,
even better: all) .pamphlet files of Axiom into ALLPROSE documents. Although:
there are no libraries in Axiom.

> > Furthermore, it should be separate from the big document.
> 
> I am somehow against this. If I understand you correctly, you would like a
> kind of reference card for the "How to start a new project" and "aldordoc
> user interface". Maybe I provide such documents on my website, but I don't
> see a real advantage.

I'd hope that you'd get more users more quickly. But again, for me personally
the most important point is to replace the HyperTeX sources by ALLPROSE
sources. When this is achieved, you probably should shorten the name to
ALPROSE, by the way...

> Anyway, I don't want to invest much time in that. The reasons is that my
> preferred way of producing an API description is the following.
> 
> - Install a set of libraries (.al and .a) on your computer.
> - Call a program that extracts the +++ comments that are compiled into
>    the  .ao files of the .al libraries together with some further
>    information on the code (see the output of "aldor -fasy FILE.ao").
> - Transform this information into a LaTeX document.
> - Transform into HTML ...

HyperDoc nearly does this, in fact. Just, it is not really LaTeX and cannot be
transformed in HTML automatically yet. So I'm afraid, you'll have to do this
too.

> That would lead to an API description of the libraries you have actually
> installed on your system. And even more than ALLPROSE could provide: the
> references would work even between libraries since there would be generated
> ONE big LaTeX file.

I hope you tried HyperDoc already? By the way, it might well be that HyperDoc
works with Aldor code just as well...

Martin