Elibgen

• ELIBGEN
  • FUNCTION
  • DESCRIPTION
  • AUTHOR
  • EXAMPLE
  • OUTPUT
  • RELATED PROGRAMS
  • RESTRICTIONS
  • CONSIDERATIONS
  • ARCHITECTURE
  • COMMAND-LINE SUMMARY
  • LOCAL DATA FILES
  • OPTIONAL PARAMETERS

ELIBGEN

FUNCTION

ELibGen creates formatted versions of EGCG documentation for the on-line help facilities egenhelp and egenmanual.

DESCRIPTION

ELibGen is a system utility that produces an ASCII-formatted file from the source code for an entry in the EGCG Program Manual. The output file contains Level 1, Level 2 and Level 3 help keys suitable for VAX/VMS help libraries or BuildHelpLib libraries such as EGCG's EGenHelp and EGenManual libraries. The input file(s) (the first parameter on the command line) is one or more source files suitable for input to GCG's Red. Most of the files in EGenDocSource:*.red are suitable for input to ELibGen

If you run ELibGen with a second parameter set to banner, it will make up a formatted file with a Level 1 help key at the top with the file name as the topic. No other help keys are inserted. We use ELibGen with banner to make up the Level 1 banners at the top of each section in our on-line help. The input files for this are EGenDocBanner:*.Txt.

ELibGen examines the symbol IsUnixDoc and processes a file of filenames accordingly. If IsUnixDoc is true and a filename in a set of filenames has the comment "! vms", the file will be skipped. If IsUnixDoc is false the comment "! unix" will cause ELibGen to skip the file. The symbol IsUnixDoc also controls the appearance of bold type in the output file. If IsUnixDoc is true, bold text is not converted to uppercase.

ELibGen is very similar to GCG's utility LibGen, but was modified to correct some problems so that EGCG documentation could be produced. We may drop the program in future if LibGen is able to process our documentation without problems.

AUTHOR

This GCG program was modified by Peter Rice (E-mail: pmr@sanger.ac.uk Post: Informatics Division, The Sanger Centre, Hinxton Hall, Cambridge, CB10 1RQ, UK).

All EGCG programs are supported by the EGCG Support Team, who can be contacted by E-mail (egcg@embnet.org).

EXAMPLE

Here is the session with ELibGen that we used to make up the on-line entry for Antigenic.

  
  % elibgen antigenic -monitor
  
  ELIBGEN creates formatted versions of EGCG documentation for the
  on-line help facilities EGENHELP and EGENMANUAL
  
Creating EGenDocEntry:antigenic.help ...
Creating EGenDocEntry:antigenic.manual ...
  
  %
  

OUTPUT

Each entry is formatted to look like an entry in the EGCG Program Manual. In front of the program name there is a level 2 help key (a '2' in column one). In front of each topic there is a level 3 help key (a '3' in column one). The formatted entry is always written into Temp.Txt and this file is copied into GenDocEntry:EntryName.Entry. Words that were bold in the original document are set to all upper case. Here is the output from the example:

  
  
  2 ANTIGENIC
  
  
  Antigenic looks for potential antigenic  regions using the method  of
  Kolaskar.
  
  3 DESCRIPTION
  
  Antigenic   predicts  potentially  antigenic  regions  of  a  protein
  sequence, using the method  of Kolaskar and  Tongaonkar (1990);  FEBS
  Letters  276:172-174  "A  semi-empirical  method  for  prediction  of
  antigenic determinants on protein antigens."
  
  3 AUTHOR
  
  This program was  written  by  Peter  Rice  (E-mail: pmr@sanger.ac.uk
  Post:   Informatics   Division,  The Sanger   Centre,   Hinxton Hall,
  Cambridge, CB10 1RQ, UK), who should be contacted for support.
  
  3 EXAMPLE
  
  Here is a sample session with Antigenic.
  
  /////////////////////////////////////////////////////////////////////
  

RELATED PROGRAMS

LibGen creates formatted versions of GCG documentation for the on-line help facilities GenHelp and GenManual. Red is a text formatter that creates publication-quality documents on a PostScript laser printer such as the Apple LaserWriter. You can use 13 different fonts, scaling each font to any size. You can also include figures and graphics from any GCG graphics program within the text of the document. Most GCG documentation, correspondence, and publication is done with Red.

RESTRICTIONS

You must have the GCG documentation tree (GenDocDisk:gcgdoc/...) mounted to manipulate EGCG documentation. ELibGen has no other than purpose than to make the EGCG Program Manual entries ready for BuildHelpLib.

CONSIDERATIONS

We use the files of filenames in EGenDocBinder as input to ELibGen ELibGen will conditionally process files in a file of filenames according to the comments "! vms" and ! unix". We can also use the -DIRectory qualifier to specify EGenDocEntry as the output directory.

ARCHITECTURE

ELibGen first filters the input file to change its header, reset the margings and size the pages appropriately, and outputs the filtered file to a temporary file temp.red. ElibGen then runs the program Red on temp.red to create a file called temp.format, which is a formatted ASCII file that includes all of the included ("required") files specified in the original document. Next, temp.format is read by GCG's LibGen two more times. The first time, LibGen inserts level 2 and 3 help keys and writes the resulting file to a new temporary file called infile.manual. The second time, LibGen inserts level 1 and 2 help keys into it and writes the final file, infile.help. The temporary files are deleted from the default directory after being read.

COMMAND-LINE SUMMARY

All parameters for this program may be put on the command line. Use the option -CHEck to see the summary below and to have a chance to add things to the command line before the program executes. In the summary below, the capitalized letters in the qualifier names are the letters that you must type in order to use the parameter. Square brackets ([ and ]) enclose qualifiers or parameter values that are optional. For more information, see "Using Program Parameters" in Chapter 3, Basic Concepts: Using Programs in the GCG User's Guide.

  
  
  Minimal Syntax: % elibgen [-INfile=]@EGenDocBinder:mapping.red -Default
  
  Other Prompted Parameters: None
  
  Local Data Files: None
  
  Optional Parameters:
  
  -BANner[=Token]         create a .module file from a banner file
                     using "Token" as the Level 1 key or the
                     filename if "Token" is omitted.
  -DIRectory=EGenDocEntry  write output file(s) to this directory
  -NODELete                don't delete temporary files
  -MONitor                 monitor program progress
  

LOCAL DATA FILES

None.

OPTIONAL PARAMETERS

None.

Printed: April 22, 1996 15:52 (1162)