Generating API pages

3 views
Skip to first unread message

Waldek Hebisch

unread,
Jan 12, 2026, 3:30:11 PM (2 days ago) Jan 12
to fricas...@googlegroups.com
You may recall that more than year ago I posted code which
generated HTML pages with API information, without using
Sphinx. I have not put updated version of this code at:

http://wiki.fricas.org/public/api2n.spad

Main change is that it uses BrowserInformation. If you want to
try this, first generate 'abbrev-lines.list' (you can take it
from documentation build), then compile 'api2n.spad' and at
FriCAS prompt issue

documentAll("abbrev-lines.list")

Note: you need current FriCAS trunk as this package uses
recently commited BrowserInformation and TeX parser.

If you want you can compare with older version of 'api2.spad'
which is still at

http://wiki.fricas.org/public/api2.spad

This version takes API information from Ralf's 'api.spad' so
before compiling 'api2.spad' you need to compile 'api.spad'
(which is in src/doc).

Comparing output you can see some differences due to sorting,
also 'api2n.spad' puts conditions on categories. But main
difference is due to different information coming from 'api.spad'
and from BrowserInformation.

Anyway, as I already mentiond data produced by BrowserInformation
needs improvement. Also, currently pages generated by 'api2.spad'
lacks search box. I think that I know what needs to be done to
add good search box, that is we need a chunk of Javascipt and
together with API pages we need to generate approriate index
(as a Javascript code).

ATM it is still a preview, usable, but having less functionality
than output of 'api.spad'. I intend now to work on differnt things,
so I will come back to this probably in the summer.

--
Waldek Hebisch
Reply all
Reply to author
Forward
0 new messages