On 06/30/2016 03:44 PM, oldk1331 wrote: > I didn't dig the help system much, so I'll just ask: > is there duplication between ++ docstrings and > .htex files? The ++ docstrings are meant to > generate .htex files, right?
No. That's a bit more difficult. In fact, I don't know, how the ++ docstrings get into hyperdoc, but they definitely undergo some massage, i.e. in ++ docstrings you can use certain LaTeX-like looking commands like \spadtype, \spad, \spadfun, etc. When I generate the http://fricas.github.io/api site, I get the docstrings via api.spad. So you find the LaTeX commands here. https://github.com/hemmecke/fricas/blob/mathjax/src/doc/api.spad#L1015 In fact that .htex Format is more or less pure LaTeX (the special commands are handled by fricas.sty). That way .htex can be used to generate the pdf form of the book. For HyperDoc, the .htex files are translated into .ht files. The .ht Format is what some program (I don't know which) needs to generate the internal HyperDoc objects that can be shown. Additionally, there are original .ht file that are not generated from .htex (see https://github.com/hemmecke/fricas/tree/mathjax/src/doc/ht). Basically, I haven't touched them, because I think that HyperDoc should die. The only interesting things in HyperDoc that are interesting for me are: 1) Finding out which domain implements a certain function 2) The ++ docstrings of user compiled domain/category/package show up immediately in HyperDoc browse after ")compile SomeDomain". I also did not care to generate the helpfiles (ASCII) from the .htex sources (although this could probably be done), but with the availability of http://fricas.github.io/api (which one can even have generated to work on localhost) makes the ascii help of (except for the system commands) superfluous for my taste. Everyone has an html-browser nowadays. And one can read the API side with Lynx, i.e. in ASCII. 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 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.
