[system] / trunk / webwork-modperl / doc / TODO Repository:
ViewVC logotype

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 742 - (download) (annotate)
Sat Feb 22 01:32:35 2003 UTC (10 years, 3 months ago) by sh002i
File size: 6733 byte(s)
added some notes to doc/
-sam

    1 ################################################################################
    2 # WeBWorK mod_perl (c) 2000-2002 WeBWorK Project
    3 # $Id: TODO,v 1.39 2003-02-22 01:32:35 sh002i Exp $
    4 ################################################################################
    5 
    6 Son of WeBWorK - TODO list
    7 
    8 DONE	write template file from what we drew on the board
    9 DONE	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 DONE	fix templating code in ContentGenerator, add new escape functions
   27 DONE	implement the new template
   28 DONE	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 DONE	display of screen set header in ProblemSet.pm (easy)
   61 DONE	add <!--#if can="blah" warning="1" error="1"-->
   62 DONE	fix alignment of displaymath images
   63 DONE	print $pg->{header_text} in head of Problem.pm
   64 DONE	remove "set" and "prob" from URL generation, remove s/^(set|prob)//;
   65 DONE	remove webwork-dvipng-xxxxx temp directories when finished with them
   66 DONE	make "enter" on the problem form trigger "submit answer", not "redisplay"
   67 DONE	handling of PG warnings (?!?!?!?!)
   68 DONE	time logging
   69 DONE	test transaction logging
   70 DONE	make static images work
   71 DONE	make GD-generated images work
   72 DONE	make HTML links work
   73 DONE	make images in PDFs work
   74 DONE	remove dependancies on Global:: from send_mail_to
   75 DONE	preview button in Problem
   76 DONE	handle PG errors (and warnings) in Hardcopy
   77 DONE	have logout button invalidate key
   78 DONE	Options - email address and password
   79 
   80 --------------------------------------------------------------------------------
   81 
   82 >>>>> FOR JANUARY PREVIEW RELEASE <<<<<
   83 
   84 DONE	Feedback - need nice modular way of sending email
   85 DONE		customize reciever, make object dumps prettier, link to context
   86 DONE	Professor - redirect to the old system
   87 	pretty die messages (from outside of the translator)
   88 DONE	make sure students can't look at not-yet-open problem sets
   89 DONE	make answer previews use $displayMode
   90 DONE	make preview-on-submit optional
   91 	Increase border size on images by a couple pixels
   92 DONE	effectiveUser for at least Problem.pm
   93 DONE	add a "check answers" button if the user has the apropriate permissions
   94 DONE	write a template escape for printing $user, $effectiveUser, &c. nicely 
   95 	calling logout requires valid key -- doesn't make sense.
   96 DONE	hardcopy - allow hardcopy with correct answers (BRANCH)
   97 DONE	sort problems by due date
   98 DONE	disable "show hint/solution" when there's no hint/solution
   99 DONE	results table
  100 DONE		part(or blank)/entered/preview/result/messages
  101 DONE		don't show messages unless there are some
  102 DONE	make displayMode sticky (for nav and siblings)
  103 DONE	check TTH mode character encodings on mac
  104 	grep for "***" in source, address all issues (hah!)
  105 
  106 mike wants:
  107 	problem credit indicator (graphical?)
  108 DONE	answers/solutions in hardcopy
  109 DONE	turn off verbose debugging in feedback mail
  110 DONE	URL on feedback from any module
  111 	email address change notification by email
  112 arnie wants:
  113 	parse errors in student answers hilited more strongly
  114 
  115 >>>>> FOR SPRING RELEASE <<<<<
  116 
  117 	write TeXImage module to take care of TeX image caching and generation
  118 	replace direct access of $permissionLevel with calls to Authz
  119 	replace hardcoded URL construction with some other method
  120 		(unify dispatcher URL parsing and module URL generation)
  121 	implement professor pages
  122 		have the prof modules be subclasses of the single Professor
  123 		ContentGenerator module? more structured? less structured?
  124 		THIS WILL TAKE LONGER THAN I THINK IT WILL
  125 	implement better (and more unified) file editor
  126 
  127 >>>>> AFTER SPRING RELEASE <<<<<
  128 
  129 	MySQL and PostgreSQL database backend
  130 	problem library work (?)
  131 	PG language work (?)
  132 	renderer/frontend/database uncoupling (?)
  133 
  134 --------------------------------------------------------------------------------
  135 
  136 change notes
  137 
  138 --------------------------------------------------------------------------------
  139 
  140 IO functions (dependancies on other IO functions are not listed)
  141 
  142 all variables in the global namespace should be replaced with items in the
  143 %envir hash. all functions that access the envir hash need to be evaluated
  144 from within the safe compartment (i.e. &unrestricted_eval'd).
  145 
  146 includePGtext
  147 	$envir{probFileName}
  148 send_mail_to
  149 	$REMOTE_HOST
  150 	$REMOTE_ADDR
  151 	#$Global::smtpServer
  152 	#$Global::webmaster
  153 	(&Global::wwerror)
  154 read_whole_problem_file
  155 read_whole_file
  156 convertPath				stub
  157 getDirDelim				stub
  158 getCourseTempDirectory
  159 	$envir{tempDirectory}
  160 surePathToTmpFile
  161 	#$Global::tmp_directory_permission
  162 	#$Global::numericalGroupID
  163 	(&Global::wwerror)
  164 fileFromPath
  165 directoryFromPath
  166 createFile
  167 createDirectory
  168 getImageDimmensions
  169 
  170 --------------------------------------------------------------------------------
  171 
  172 	Calling LaTeX/dvipng and PDFLaTeX in a nice way
  173 		- create LaTeX.pm (?)
  174 		- &latex2pdf
  175 			- create secure tempdir
  176 			- write hardcopy to tex file
  177 			- call pdflatex
  178 			- move resulting pdf file to tmp/hardcopy/whatever.pdf
  179 			- remove tempdir
  180 		- &latex2png (dvipng method)
  181 			- create secure tempdir
  182 			- write equations to tex file
  183 			- call latex
  184 			- run dvipng (as per ImageGenerator) on dvi file
  185 			- move resulting images to tmp/dvipng/whatever.png
  186 			- remove tempdir

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9