Home Online Manual
Top
Back: Libraries
Forward: Version string
FastBack: Procedures
FastForward: Debugging tools
Up: Libraries
Top: Singular Manual
Contents: Table of Contents
Index: Index
About: About this document

3.8.1 Libraries in the SINGULAR Documentation

  • The typesetting language in which the SINGULAR documentation is written is texinfo. The info string of a library included in the SINGULAR distribution will be parsed and automatically translated to the texinfo format. The same applies to the help string of each procedure listed in the PROCEDURE: section of the info string.
  • Based on various tools, info, dvi, p, and html versions of the texinfo documentation are generated.
  • For texinfo markup elements and other information facilitating optimal typesetting, see Typesetting of help and info strings.
  • For the convenience of users checking directly the source code, the texinfo tools should be used economically. That is, the info and help texts should be well readable verbatim.
  • The example of each procedure listed in the PROCEDURE: section of the info string is computed and its output is included in the documentation.