← Back to team overview

teco-users team mailing list archive

teco documentation

 

Hi

This is an update on the aims for this tecoc thing to be dusted off and made available for a current system. Included is a review of the documentation. It appears that the user manual is a paged document that can be read with »tecoc teco -inspect teco.doc« and paged through with »yht$$«. A potential producer of this is the RUNOFF program, or one of its successors, such as troff, nroff, groff and friends. Implications are, that documentation may be created semi-automatically for various formats, like text, pdf, and html. This is now being reviewed; of course this also aims to review the documentation itself in the process. The git branch name, as per current working guidelines/policies/practices points to where this is happening.

Other work is still ongoing, here. The planned milestone that includes a »reasonable« built application, together with introductory instructions, such as the tutorial chapter from within teco.doc, as well as a »reasonable« deployment/configure facility, will be tagged with »release/v0.1.« This milestone will then have, as it has now, a severe warning about risks of its use. For example, when I used the teco tool in the 1980s and 1990s I always worked on a copy of a file, and even then used separate inputs and outputs via the »ERfile-in$« and »EWfile-out$« commands of the teco language, because a single misplaced character can undo all work done so far. This is not meant to deter; just use common sense as always with anything.

Regards,

Gunter
gunter.liszewski@xxxxxxxxx