View of /trunk/webwork-modperl/doc/TODO

    1 ################################################################################
    2 # WeBWorK mod_perl (c) 2000-2002 WeBWorK Project
    3 # $Id: TODO,v 1.17 2002-10-30 22:09:53 sh002i Exp $
    4 ################################################################################
    5 
    6 Son of WeBWorK - TODO list
    7 
    8 OK	write template file from what we drew on the board
    9 OK	normalize files:
   10 		- (c) header on all files
   11 		- standard order of preamble lines:
   12 			1. (c) header
   13 			
   14 			2. package PACKAGENAME;
   15 			
   16 			3. short summary of the package (pod's NAME section)
   17 			
   18 			4. use - pragmatic modules
   19 			5. use - standard perl modules
   20 			6. use - CPAN modules
   21 			7. use - webwork modules
   22 		- ALWAYS use strict and use warnings
   23 		- use "use base" rather than "our @ISA"
   24 		- no warnings or errors!
   25 		- (later on) POD documentation for all files
   26 OK	fix templating code in ContentGenerator, add new escape functions
   27 OK	implement the new template
   28 OK	finish ProblemSets and ProblemSet
   29 	
   30 --------------------------------------------------------------------------------
   31 
   32 DONE	New interface to PG.pm
   33 	DONE	- instead of it accessing the database directly, accept $user,
   34 		  $set, and $problem as arguments (instead of $setName, etc.)
   35 	DONE	- UPDATE PG.pm'S DOCS!!!!!!!!!!!!!
   36 	DONE	- Fix Problem.pm and Hardcopy.pm to work with the new interface
   37 	
   38 	Hardcopy generation
   39 	DONE	- ad-hoc version of &latex2png in Hardcopy.pm (move later)
   40 	DONE	- fix code (heh heh)
   41 	DONE	- fix hardcopySetHeader
   42 	
   43 	Integration of dvipng method of image generation
   44 	N/A	- choice between writing to a temporary TeX file from within
   45 		  dangerousMacros, or queueing the equations up in RAM and
   46 		  passing them out to the caller (via PG_flags?) who will then
   47 		  call &latex2png
   48 	DONE	- write tempfile from dangerousMacros
   49 			- PRO: gets it out of RAM
   50 			- PRO: no dependancies between equations
   51 			- CON: have to coordinate between latex2png and
   52 			       dangerous macros for tempfile locations
   53 	FORGET	- queue equations in RAM
   54 			- PRO: all file access and external calls happen
   55 			       outside of the safe compartment.
   56 			- PRO: latex2png gets to decide where to put files
   57 			- CON: stuff sits in RAM
   58 			- CON: uses a package array to queue equations :p
   59 	
   60 --------------------------------------------------------------------------------
   61 
   62 DONE	display of screen set header in ProblemSet.pm (easy)
   63 DONE	add <!--#if can="blah" warning="1" error="1"-->
   64 DONE	fix alignment of displaymath images
   65 DONE	print $pg->{header_text} in head of Problem.pm
   66 DONE	remove "set" and "prob" from URL generation, remove s/^(set|prob)//;
   67 DONE	remove webwork-dvipng-xxxxx temp directories when finished with them
   68 DONE	make "enter" on the problem form trigger "submit answer", not "redisplay"
   69 DONE	handling of PG warnings (?!?!?!?!)
   70 DONE	time logging
   71 DONE	test transaction logging
   72 DONE	make static images work
   73 DONE	make GD-generated images work
   74 DONE	make HTML links work
   75 DONE	make images in PDFs work
   76 	remove dependancies on Global:: from IO functions
   77 	handle PG errors (and warnings) in Hardcopy
   78 	fix TTH mode character encodings (check on mac and windows)
   79 	have logout button invalidate key
   80 	answer preview button
   81 	Pretty die messages (from outside of the translator)
   82 	Feedback - need nice modular way of sending email
   83 	Options - email address and password
   84 	grep for "***" in source, address all issues
   85 
   86 --------------------------------------------------------------------------------
   87 
   88 change notes
   89 
   90 --------------------------------------------------------------------------------
   91 
   92 IO functions (dependancies on other IO functions are not listed)
   93 
   94 all variables in the global namespace should be replaced with items in the
   95 %envir hash. all functions that access the envir hash need to be evaluated
   96 from within the safe compartment (i.e. &unrestricted_eval'd).
   97 
   98 includePGtext
   99 	$envir{probFileName}
  100 send_mail_to
  101 	$REMOTE_HOST
  102 	$REMOTE_ADDR
  103 	$Global::smtpServer
  104 	$Global::webmaster
  105 	&Global::wwerror
  106 read_whole_problem_file
  107 read_whole_file
  108 convertPath				stub
  109 getDirDelim				stub
  110 getCourseTempDirectory
  111 	$envir{tempDirectory}
  112 surePathToTmpFile
  113 	#$Global::tmp_directory_permission
  114 	#$Global::numericalGroupID
  115 	&Global::wwerror
  116 fileFromPath
  117 directoryFromPath
  118 createFile
  119 createDirectory
  120 getImageDimmensions
  121 
  122 --------------------------------------------------------------------------------
  123 
  124 	Calling LaTeX/dvipng and PDFLaTeX in a nice way
  125 		- create LaTeX.pm (?)
  126 		- &latex2pdf
  127 			- create secure tempdir
  128 			- write hardcopy to tex file
  129 			- call pdflatex
  130 			- move resulting pdf file to tmp/hardcopy/whatever.pdf
  131 			- remove tempdir
  132 		- &latex2png (dvipng method)
  133 			- create secure tempdir
  134 			- write equations to tex file
  135 			- call latex
  136 			- run dvipng (as per ImageGenerator) on dvi file
  137 			- move resulting images to tmp/dvipng/whatever.png
  138 			- remove tempdir