Hello,
I'm happy to announce the acceptance of a new publication for TUG 2019
(the TeX users group conference) to be held in Palo Alto, CA, USA, next
August. See below for the title and abstract:
Quickref: a Stress Test for Texinfo
Quickref is a global documentation project for the Common Lisp ecosystem. It
creates reference manuals automatically by introspecting libraries and
generating a corresponding documentation in Texinfo format. The Texinfo files
may subsequently be converted into PDF or HTML. Quickref is non-intrusive:
software developers do not have anything to do to get their libraries
documented by the system.
Quickref may be used to create a local website documenting your current,
partial, working environment, but it is also able to document the whole Common
Lisp ecosystem at once. The result is a website containing almost two thousand
reference manuals. Quickref provides a Docker image for an easy recreation of
this website, but a public version is also available and kept up to date on
quickref.common-lisp.net.
Quickref constitutes an enormous (and successful) stress test for Texinfo, and
not only because of the number of files generated and processed. The Texinfo
file sizes range from 7K to 15M (make it double for the generated HTML ones).
The number of lines of Texinfo code in those files extend from 364 to 285,020,
the indexes may contain between 14 and 44500 entries, and the processing times
vary from .3s to 1m 38s per file.
In this paper, we give an overview of the design and architecture of the
system, describe the challenges and difficulties in generating valid Texinfo
code automatically, and put some emphasis on the currently remaining problems
and deficiencies.
--
Resistance is futile. You will be jazzimilated.
Lisp, Jazz, Aïkido:
http://www.didierverna.info