Hi,
Le lun. 4 nov. 2024 à 22:57, 'Ralf Hemmecke' via FriCAS - computer
algebra system <fricas-devel@googlegroups.com> a écrit :
>
> 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?
Try:
fricas -noht
compile the attached file and via the system command synonym )hd
browse for 'bar', you will see in boldface clickable examples.
I no longer remember how I found this HyperTex command but I found it
interesting since as I said before FriCAS really lacks examples for
numerous routines defined in Spad. I know there is a book, but that's
different and having clickable examples or even more, in HTML, a copy
link like the ones in the upper right corner in a lot of other
projects for their documentation actually, that's really a plus.
>
> > 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.
Ok
>
> 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)?
The two for now, as you suggested previously/ since rst or md files
can be easily converted apparently, but, yes, a format needs to be
chosen or we need to "jungle" between different formats, a waste of
time for me.
Greg
--
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 fricas-devel+unsubscr...@googlegroups.com.
To view this discussion visit
https://groups.google.com/d/msgid/fricas-devel/CAHnU2da2yRJudidMC%3DJ19CpEZg_P_3czb5yoEfFW0rLScy4eOA%40mail.gmail.com.
foo.spad
Description: Binary data
