On 11/4/24 22:18, Grégory Vanuxem wrote:
In fact, as of now, my primary concern is formatting examples in a "not"
ugly way. Furthermore, I am not at a stage where \example{}s are clickable
and executed in an Xterm like HyperDoc do, just api.spad does not seem to
handle them.
Exactly. I was already wondering, but now grep'ed for \example. In fact,
\example does not appear inside ++ docstrings. So why should api.spad
handle that?
I also do not know how HyperTex processes their commands, and
even more, when I wrote multiline examples I wrote several \example{}
lines. HyperDoc handles this, this why I do this that way. Maybe I can test
other ways.
Let me first clarify the concepts.
"HyperTex" is a format. It probably comes from HyperText an invention at
a time where HTML was not yet there. And since TeX was well known the
authors modeled a HyperText format in a TeX-like fashion.
"HyperDoc" is the program that presents HyperTeX documents to the user.
In modern terms HyperTex ist HTML and HyperDoc is a browser.
You find a lot of *.ht files in the sources. That is HyperTex format.
The .htex files are a mixture of LaTeX and HyperTex. Before they can be
shown in HyperDoc, they are translated into .ht files. This is done by
src/doc/ht.awk.
How ++ docstrings are handled for HyperDoc, I have not looked at since I
was only interested in translating them into what we now have at
fricas.github.io/api. I basically tried to translate the ++ docstrings
into an .rst format and let sphinx-doc do the rest.
By the way, improving how FriCAS handles ++ documentation is a must do for
me.
What exactly do you want? Do you insist on using HyperDoc or do you
prefer a web version (HTML)?
Ralf
--
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 view this discussion visit
https://groups.google.com/d/msgid/fricas-devel/89b7fd8f-0ebc-411d-8df9-02d1659f1f67%40hemmecke.org.
