EMBOSS: Project Meeting (Jun 7th 2000)
Peter will review the "octanol" documentation. Alan has been asked to review the profile programs' documentation.
The FAQ list needs revision. Peter made some changes for the new make install directories, but has not thoroughly checked all the topics.
Peter suggested making a list of applications by author, and asking them each to review the documentation once the revisions have been completed.
Peter will build a CVSLOG file from the Sanger CVS commit comments, and update this later with HGMP comments.
The demo applications need reviewing to check for completeness. The original intention was to add boolean command line options to generate typical errors, for example adding strings to a list or table and then reallocating the original string which then overwrites the copy in the table.
The melting functions are confusing. Peter wrote the original versions and will review them.
An application to display program documentation would be useful. For example "appdoc appname" to print the web page sources as plain text. Possibly could be written as a perl script.
"See also" documentation could be automated by following the group classifications for all programs, with an automated one-line description from the ACD files. Other comments could be added as a leading paragraph, in a similar way to the documentation for data files.
Special include files are needed for exit status (usually only zero) and for function (1 line generated from the ACD file).
Peter has a script to parse the web pages and generate a version that can be committed and maintained in the CVS source tree, with a script to make a copy for other sites to install. The FTP server can keep a tar.gz file of this processed documentation. This will take time to modify the files to remove Sanger-specific web page features.
Next meeting on Monday 11th June, 11:00am, usual place.