<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="MS Exchange Server version 5.5.2652.35">
<TITLE>RE: ADMIN: RE: [Javascript] PROPOSAL for An Annotated JavaScript Project</TITLE>
</HEAD>
<BODY>
<P><FONT SIZE=2>I will help when I can. Suggest using a combination of web site and two special lists: One lists for members/annotators to discuss details and one for the panel to use to discuss and vote. </FONT></P>
<P><FONT SIZE=2>Bob Filipiak (Contractor)</FONT>
<BR><FONT SIZE=2>MCP </FONT>
</P>
<P><FONT SIZE=2>-----Original Message-----</FONT>
<BR><FONT SIZE=2>From: David Merchant [<A HREF="mailto:merchant@LATECH.EDU">mailto:merchant@LATECH.EDU</A>]</FONT>
<BR><FONT SIZE=2>Sent: Wednesday, June 06, 2001 4:33 PM</FONT>
<BR><FONT SIZE=2>To: javascript@LaTech.edu</FONT>
<BR><FONT SIZE=2>Subject: ADMIN: RE: [Javascript] PROPOSAL for An Annotated JavaScript</FONT>
<BR><FONT SIZE=2>Project</FONT>
</P>
<BR>
<P><FONT SIZE=2>Thanks for the feedback, glad there is interest in this.</FONT>
</P>
<P><FONT SIZE=2>Now for ironing out some of the details. Those that are interested in </FONT>
<BR><FONT SIZE=2>participating, even if just occasionally or in a small way (I fully </FONT>
<BR><FONT SIZE=2>understand being busy or being spread thin), please give your comments / </FONT>
<BR><FONT SIZE=2>feedback / suggestions on the following items:</FONT>
</P>
<P><FONT SIZE=2>*** There are two ways I see that we can go about this (if there are other </FONT>
<BR><FONT SIZE=2>ways please bring them up for discussion):</FONT>
</P>
<P><FONT SIZE=2>1. Someone annotates every line in some script they wrote or like and </FONT>
<BR><FONT SIZE=2>either A) posts it for comments or B) I put it up on a special list members </FONT>
<BR><FONT SIZE=2>only web page where list members can add their comments to it. Don't have </FONT>
<BR><FONT SIZE=2>to comment on every line, just on whatever line of the script they feel the </FONT>
<BR><FONT SIZE=2>need or have time to comment on.</FONT>
</P>
<P><FONT SIZE=2>2. A script is chosen, and is posted to the list or to the special list </FONT>
<BR><FONT SIZE=2>members only web page, and list members annotate as few or as many of the </FONT>
<BR><FONT SIZE=2>lines of the script as they choose or have time to.</FONT>
</P>
<P><FONT SIZE=2>There are pros and cons to either 1 or 2, and we could easily do both. Do </FONT>
<BR><FONT SIZE=2>we prefer having the scripts and the annotations posted on the list, or by </FONT>
<BR><FONT SIZE=2>using a cgi script on a list members only page where list members can post </FONT>
<BR><FONT SIZE=2>their comments/annotations to parts or all of a script, adding theirs to </FONT>
<BR><FONT SIZE=2>whoever commented before them?</FONT>
</P>
<P><FONT SIZE=2>*** Need a way to end the process for a script (so that commenting and </FONT>
<BR><FONT SIZE=2>discussion and annotation for a particular script doesn't last for years </FONT>
<BR><FONT SIZE=2>:-) !). Have some of us volunteer to be a board or panel that once a </FONT>
<BR><FONT SIZE=2>script becomes annotated and some sufficient time has passed, the </FONT>
<BR><FONT SIZE=2>board/panel votes on letting it be released to the public page that will be </FONT>
<BR><FONT SIZE=2>the repository for all the annotated scripts? Any comments on this?</FONT>
</P>
<P><FONT SIZE=2>*** When the script is finished being peer-reviewed, it is placed on a </FONT>
<BR><FONT SIZE=2>public page for all the world to benefit from.</FONT>
</P>
<P><FONT SIZE=2>*** What scripts to choose? For #2, I would suggest that we probably </FONT>
<BR><FONT SIZE=2>should concentrate at first on the most common basic scripts (image flips, </FONT>
<BR><FONT SIZE=2>etc). For #1 any script a list member decides to annotate themselves and </FONT>
<BR><FONT SIZE=2>wants comments on.</FONT>
</P>
<P><FONT SIZE=2>*** Commenting: Let everyone be reviewers in good faith. That is, be </FONT>
<BR><FONT SIZE=2>polite, professional, and realize that often there are more than one right </FONT>
<BR><FONT SIZE=2>way to do the same thing. It's OK to point out an alternative way of </FONT>
<BR><FONT SIZE=2>scripting a line or two of someone's code, and if there are short-comings </FONT>
<BR><FONT SIZE=2>in a line or so of coding that can be overcome by a different coding, by </FONT>
<BR><FONT SIZE=2>all means point it out (nicely!). If there are short-comings or </FONT>
<BR><FONT SIZE=2>limitations in a script, by all means point that out too, that's part of </FONT>
<BR><FONT SIZE=2>the annotation and part of the learning process for us all. For a "virgin" </FONT>
<BR><FONT SIZE=2>script that has no annotations and is being presented to the group for </FONT>
<BR><FONT SIZE=2>annotation/comments, whenever you comment or add any lines of annotations </FONT>
<BR><FONT SIZE=2>include your name to those annotations or comments so we can keep track of </FONT>
<BR><FONT SIZE=2>whose annotations get into the final version.</FONT>
</P>
<P><FONT SIZE=2>For those that annotate an entire script, after feedback and any changes, </FONT>
<BR><FONT SIZE=2>they of course can have their name as the annotator for that script (makes </FONT>
<BR><FONT SIZE=2>for a nice resume line item, and/or another page in your tenure file, </FONT>
<BR><FONT SIZE=2>etc). For the scripts that are "virgin" and several members of the list </FONT>
<BR><FONT SIZE=2>add annotations, when the final fully annotated version of the script is </FONT>
<BR><FONT SIZE=2>approved by the board / panel, we could consider putting in all the names </FONT>
<BR><FONT SIZE=2>of those whose annotations are in the final version (those who want their </FONT>
<BR><FONT SIZE=2>names used).</FONT>
</P>
<P><FONT SIZE=2>Again, please feel free to comment on any of the above items!</FONT>
</P>
<P><FONT SIZE=2>TTFN,</FONT>
<BR><FONT SIZE=2>David Merchant</FONT>
</P>
<P><FONT SIZE=2>Head, Systems Dept, Louisiana Tech University</FONT>
<BR><FONT SIZE=2>merchant@latech.edu</FONT>
<BR><FONT SIZE=2>JavaScript List Administrator (www.mountaindragon.com/javascript/)</FONT>
<BR><FONT SIZE=2>Webmaster, HTML Encyclopedia (www.mountaindragon.com/html/)</FONT>
<BR><FONT SIZE=2>Webmaster, Memorial Day Page: (www.usmemorialday.org/)</FONT>
</P>
<BR>
<P><FONT SIZE=2>_______________________________________________</FONT>
<BR><FONT SIZE=2>Javascript mailing list</FONT>
<BR><FONT SIZE=2>Javascript@LaTech.edu</FONT>
<BR><FONT SIZE=2><A HREF="http://www.LaTech.edu/mailman/listinfo/javascript" TARGET="_blank">http://www.LaTech.edu/mailman/listinfo/javascript</A></FONT>
</P>
</BODY>
</HTML>