www_help $SMEI/ucsd/gen/python/www_help.cgi
[Previous] [Next]
 NAME:
	www_help
 PURPOSE:
	Python cgi script used to retrieve code from original
	source code files in on-line www_help system
 INPUTS:
	The www_help systems provide 3 arguments to this cgi script:
	- A file name in the form $TOP/sub1/.../file_name.code
	- A procedure name (the entry following the NAME sections in the
	  source code header
	- Number of spaces per tab
 RESTRICTIONS:
	Requires a valid file www_list.lst containing definitions of
	top directories in the form
		$TOP=full_directory name
 SEE ALSO:
	www_help
 PROCEDURE:
 >	See the IDL www_help package for more information.

 >	The start of the file name ($HAT in the example) refers to a
	top directory defined in the file www_list.lst.
 >	www_list.lst should contain at least one entry
		$HAT=dir_where_headings
	specifying the directory where the files with the section
	headings are stored (in SSW this should be
		~/ssw/smei/gen/idl/gen).

 >	Requires a web server with python installed.
	The script has only been run on a Linux box so far.

 >	Problems could arise when lines read from a source code file
	contain special html characters (like <,>,&).
	This is avoided by using the cgi.escape function. This is done
	immediately after reading a new line of code, i.e. prior to
	any further processing (this processing involves adding html
	tags; these would get lost if the processed line of code is
	run through cgi.escape.

	There is a problem with IDL here: special html characters
	are replaced by character combinations like &gt;
	i.e. and ampersand at the start and a semicolon at the end.
	Care must be taken that the semi-colon is not interpreted as
	the start of and IDL comment. This is done by looking for
	an ampersand preceeding with at least 1 at most 3 intermediate
	characters.
 MODIFICATION HISTORY:
	DEC-2001, Paul Hick (UCSD/CASS), v0.0
	JAN-2002, Paul Hick (UCSD/CASS)
		Introduced www_help.lst to store definitions for
		environment variables.
	JUL-2002, Paul Hick (UCSD/CASS)
		Added option to omit lines from being displayed.
	JAN-2004, Paul Hick (UCSD/CASS), v1.0
		Added checks for parameters and include statements for
		Fortran code.
	JUL-2005, Paul Hick (UCSD/CASS), v2.0
		Added 'auto_calls' section. IDL is now used to find all
		routines called by IDL and Fortran code by calling
		www_help_get_info.pro.
	JUL-2005, Paul Hick (UCSD/CASS), v2.1
		Removed dependence on string module.
	JUL-2006, Paul Hick (UCSD/CASS)
		Fixed bug in detecting function declaration lines.
	DEC-2006, Paul Hick (UCSD/CASS; pphick@ucsd.edu)
		The call to the IDL procedure www_help_get_info suddenly
		returns a leading new line (since IDL version 6.3???)
		leading to an empty 'auto_calls' list.


www_help_dep [1] $SMEI/ucsd/gen/python/www_help_dep.cgi
[Previous] [Next]
 NAME:
	www_help_dep
 PURPOSE: 
	Provides dependence tree information for
	software in the SMEI tree
 CALLING SEQUENCE:
	www_help_dep <module> -db=<db.txt> -dest=<dest> -show
 INPUTS:
	module		name of program, function or procedure
					(default: ipsdt)
	db.txt		name of data base file containing the
					dependency information.
					(default: for.txt)
					(this is created as part of the
					www_help system).
	<dest>		name of an empty, existing directory
					if specified, this is where copies
					of all files are written.
					If omitted information is written
					to screen only.
	-show		displays a list of file names on the screen
	-html		displays html file
 LIMITATIONS:
	Works for Fortran and IDL code only
 PROCEDURE:
 MODIFICATION HISTORY:
       SEP-2007, Paul Hick (UCSD/CASS)


www_help_dep [2] $SMEI/ucsd/gen/python/www_help_dep.py
[Previous] [Next]
 NAME:
	www_help_dep
 PURPOSE: 
	Provides dependence tree information for
	software in the SMEI tree
 CALLING SEQUENCE:
	www_help_dep <module> -db=<db.txt> -dest=<dest> -show
 INPUTS:
	module		name of program, function or procedure
					(default: ipsdt)
	db.txt		name of data base file containing the
					dependency information.
					(default: for.txt)
					(this is created as part of the
					www_help system).
	<dest>		name of an empty, existing directory
					if specified, this is where copies
					of all files are written.
					If omitted information is written
					to screen only.
	-show		displays a list of file names on the screen
	-html		displays html file
 LIMITATIONS:
	Works for Fortran and IDL code only
 PROCEDURE:
 MODIFICATION HISTORY:
       SEP-2007, Paul Hick (UCSD/CASS)


www_help_sync $SMEI/ucsd/gen/python/www_help_sync.py
[Previous]
 NAME:
	www_help_sync
 PROCEDURE:
	Compare ascii files
 CALLING SEQUENCE:
	www_help_sync.py ext=ext new_dir old_dir
 INPUTS:
	new_dir		directory containing new help files
	old_dir		directory containing old help files
 CALLS:
	tiny.args, tiny.start
 PROCEDURE:
	HTML files in directory 'new_dir' are compared with files
	in directory 'old_dir' with the same base name
	(file name, plus extension).
	HTML files in old_dir not present in new_dir are deleted.
	HTML files in new_dir not present or different from the
	corresponding file in old_dir is moved to new_dir.
	The remaining HTML files in new_dir are deleted.
 MODIFICATION HISTORY:
	FEB-2003, Paul Hick (UCSD/CASS; pphick@ucsd.edu)