html/README

   1 To manage this website:
   2
   3 **** Static information ****
   4
   5 This information should only need to be setup at the beginning of the
   6 course.
   7
   8 ** Introductory Blurbs **
   9
  10 You should change the introductory patter in all the *.shtml files
  11 as necessary to suit your course.
  12
  13 ** Contact Information **
  14
  15 Add appropriate entries to the profs.xml, TAs.xml, and webmaster.xml
  16 files in the xml directory.
  17
  18 The prof and TA files are formatted into XHTML by people.php, and the
  19 output is included in contact.shtml.  The webmaster xml file is
  20 formatted by webmaster.php.  Because the formatting occurs at
  21 run-time, the served page will always reflect the current xml data.
  22
  23 ** Course Information **
  24
  25 Add appropriate entries to the course.xml file in the xml directory.
  26 The course xml file is read by course.php.  See the title of
  27 index.shtml for an example of how to use this information dynamically
  28 in your HTML.
  29
  30
  31 **** Dynamic information ****
  32
  33 ** Assignments / Section documents **
  34
  35 This material gets added and updated as the course progresses.
  36 Basically, it consists of a lab, rectitation, exam, etc. files
  37 (e.g. problems, solutions, procedures, etc.).  The contents of the
  38 directories in doc (e.g. labs) are scanned by section_docs.php to
  39 create a list of all the files in the directory (e.g. 'doc/lab/'
  40 beginning with a certain prefix (e.g. lab[0-9], starts with 'lab').
  41 So simply dumping the appropriate files into the appropriate directory
  42 should get them displayed on the website.
  43
  44 If you want to add a comment to a section document section (e.g. to
  45 point out the due date for hwk3, or the date/time/room of exam1), just
  46 add the a relevant XHTML snippet to the *_comment file.  For example:
  47 <snip doc/lab/lab1_comment>
  48 <p>The Interference lab starts on <b>Wed., April 08, 2009</b>.</p>
  49 <p>
  50 Wednesday, April 8, Thursday, April 9 and Friday, April 10, 2009:
  51 EVEN number sections 060, 062, 064, and 66.
  52 </p>
  53 <p>
  54 Wednesday, April 15, Thursday, April 16, and Friday, April 17, 2009:
  55 ODD number sections 063, 065, 071, and 073.
  56 </p>
  57 </snip>
  58
  59 If you have something that you want to put up later (e.g. solutions)
  60 you can chmod it 640 (so that it's not world-readable), and the php
  61 parser will ignore the file.  After you have collected the
  62 homework/exam/etc., you chan chmod 644 the file (so that it is world
  63 readable) and it will show up on the website.
  64
  65 ** Announcements / Atom feed **
  66
  67 Course announcements should be formatted in an atom feed
  68   http://en.wikipedia.org/wiki/Atom_(standard)
  69 Atom feeds may be generated with a number of tools, but a simple
  70 command-line generator for linux is
  71   http://www.physics.drexel.edu/~wking/code#atomgen
  72 Once you've generated the atom.xml file, copy it into the xml
  73 directory so atom.php can find it, and the announcements page will be
  74 filled in automatically.  Another benefit of this approach is that a
  75 feed monitor such as rss2email can be used to monitor the feed and
  76 send classwide emails out whenever a new announcement is posted
  77 (http://rss2email.infogami.com/).