home *** CD-ROM | disk | FTP | other *** search
/ Solo Programadores 22 / SOLO_22.iso / docs / lovelace / mklesson < prev    next >
Encoding:
Text File  |  1995-11-21  |  24.1 KB  |  720 lines
  1. #!/usr/local/bin/perl -s
  2. # 
  3. # This is mklesson, a `lesson compiler.'
  4. # Mklesson takes a lesson file (.les) as its sole argument, and uses it to
  5. # generate a set of hypertext tutor files in HTML (.html) format.
  6. # The generated files are created in the current directory.
  7. # Status information is sent to standard output (which is usually the screen).
  8. #
  9. # Usage Example:
  10. #     mklesson lesson9.les
  11. #
  12. # $Id: mklesson,v 1.15 1995/08/09 21:07:40 wheeler Exp $
  13. #
  14. # See the user's guide in file userg.html and formatmk.txt.
  15. #
  16. # Input:
  17. #   (argument 1) -- filename of lesson (.les) file.
  18. #   template -- file with templates used for file generation.
  19. #   default  -- if this file exists, it is read to find default settings
  20. #               (its format is identical to a lesson header section).
  21. # 
  22. #
  23. # Output: The program generates files with the following naming patterns:
  24. #    sLESSON-SECTION.html  - text for lesson number LESSON, section SECTION.
  25. #                            If this is the last one, SECTION is "f" (final)
  26. #                            so that the next lesson can always link
  27. #                            backwards correctly (didn't use "l" for last,
  28. #                            because it looks too much like a "1").
  29. #    sLESSON-SECTIONrRESPONSENUMBER.html - text for response RESPONSENUMBER
  30. #    lessonLESSON.html    - lesson outline.
  31. #
  32. #
  33. # This program is written in the programming language perl because it's
  34. # a relatively short program that performs text processing (a perl strength),
  35. # and I wanted it to be VERY portable (perl is widely available).
  36. # Perl has some disadvantages, in particular, please be careful modifying
  37. # this program because the Perl language syntax is so awful that it's
  38. # as though it was designed to maximize error creation.
  39. #
  40. # Copyright (C) 1994 David A. Wheeler.
  41. #
  42. #    This program is free software; you can redistribute it and/or modify
  43. #    it under the terms of the GNU General Public License as published by
  44. #    the Free Software Foundation; either version 2 of the License, or
  45. #    (at your option) any later version.
  46. #
  47. #    This program is distributed in the hope that it will be useful,
  48. #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  49. #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  50. #    GNU General Public License for more details.
  51. #
  52. #    You should have received a copy of the GNU General Public License
  53. #    along with this program; if not, write to the Free Software
  54. #    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  55. #
  56. # Since mklesson is free software, if you modify this program and
  57. # then distribute it (or results generated from it) you ARE REQUIRED
  58. # to distribute & permit anyone to copy the modified version of this program.
  59. #
  60. # You CAN use this program to generate
  61. # proprietary tutorials, just as you can use gcc to generate
  62. # proprietary executables. See the GPL for more information.
  63.  
  64.  
  65. # START OF MAIN PROGRAM
  66.  
  67. if (defined($s)) {
  68.    # a "-s" option uses Short extension names (.htm).
  69.    $html_extension = ".htm";
  70. }
  71. else {
  72.    # without a "-s" option, generate ".html" extensions.
  73.    $html_extension = ".html";
  74. }
  75.  
  76. &initialize_variables;
  77. &read_in_template;  # Load the template file into memory.
  78. &read_in_defaults;  # Load the contents of file "default".
  79.  
  80. # Open & process the lesson file.
  81. $lesson_source=shift;
  82. &open_lesson_file;
  83. &process_input_header;
  84. &process_input_body;
  85. &change_timestamp_file($lesson_source);
  86.  
  87. &move_in_new_files;
  88.  
  89. # END OF MAIN PROGRAM
  90.  
  91.  
  92. # SUBROUTINES:
  93.  
  94. sub process_input_header {
  95.  # Process input file as a lesson header section.
  96.  # Stop processing at end-of-file or a <SECTION> marker.
  97.  # (The input file could be a "lesson" file or "default" file)
  98.  
  99.  while (&read_line) {
  100.   if (m/^ *<TUTOR .*NAME="([^"]*)"/i) {
  101.     if (($tutor_name ne "") && ($tutor_name ne $1) )
  102.        {die "Cannot redefine tutor name"};
  103.     $tutor_name=$1;
  104.     print "Tutor name is $tutor_name\n";
  105.     }
  106.   elsif (m/^ *<LESSON .*NUMBER=([0-9]+)/i) {
  107.    if ($lesson_number != 0) {die "Cannot redefine lesson number"};
  108.    $lesson_number=$1;
  109.    $lesson_outline_URL = "lesson${lesson_number}" . $html_extension;
  110.    print "Lesson number is $lesson_number\n";
  111.    }
  112.   elsif (m/^ *<AUTHOR .*NAME="([^"]*)".*EMAIL="([^"]*)"/i) {
  113.    $author_name=$1;
  114.    $author_email=$2;
  115.    print "Author name is $author_name\n";
  116.    print "Author email (address) is $author_email\n";
  117.    }
  118.   elsif (m/^ *<AUTHOR .*ADDRESS="(.*)">$/i) {
  119.    # Note: this format is slightly different, grabbing the ENTIRE line.
  120.    # This is so that the address can include anchors and such, which
  121.    # require the use of " and > characters.
  122.    $author_address=$1;
  123.    print "Author address is $author_address\n";
  124.    }
  125.   elsif (m/^ *<PREVIOUS_LESSON .*LOCATION="([^"]*)"/i) {
  126.    if ($previous_lesson_location_set != 0)
  127.        {die "Cannot redefine previous lesson location"};
  128.    $previous_lesson_location = $1;
  129.    $previous_lesson_location_set = 1;
  130.    print "Previous lesson location is $previous_lesson_location\n";
  131.    }
  132.   elsif (m/^ *<NEXT_LESSON .*LOCATION="([^"]*)"/i) {
  133.    if ($next_lesson_location_set != 0)
  134.       {die "Cannot redefine next lesson location"};
  135.    $next_lesson_location = $1;
  136.    $next_lesson_location_set = 1;
  137.    print "Next lesson location is $next_lesson_location\n";
  138.    }
  139.   elsif (m/^ *<MASTER_OUTLINE .*HREF="([^"]*)"/i) {
  140.    if ($master_outline_URL_set != 0)
  141.      {die "Cannot redefine master lesson outline URL"};
  142.    $master_outline_URL = $1;
  143.    $master_outline_URL_set = 1;
  144.    print "Master outline URL is $master_outline_URL\n";
  145.    }
  146.   elsif (m/^ *<TUTOR_HOME_PAGE .*HREF="([^"]*)"/i) {
  147.    if ($tutor_home_page_set != 0) {die "Cannot redefine tutor home page URL"};
  148.    $tutor_home_page_URL = $1;
  149.    $tutor_home_page_URL_set = 1;
  150.    print "Tutor home page URL is $tutor_home_page_URL\n";
  151.    }
  152.   elsif (m/^<SECTION /i) {last}
  153.   elsif (m/^ *$/) {} # Do nothing with blank lines.
  154.   else {
  155.     print "WARNING: LINE IN HEADER OF FILE IGNORED, TEXT IS:";
  156.     print $_;
  157.   }
  158.  }
  159.  # We found a SECTION header or end of file. Stop processing lesson header.
  160. }
  161.  
  162. sub process_input_body {
  163.   # Process body of a lesson file (it should have 2 or more sections).
  164.  
  165.   # Errorcheck - we should have gotten TUTOR, LESSON, and AUTHOR.
  166.  
  167.   if ($lesson_number < 1)
  168.      {die "Sorry, no valid lesson number encountered!"};
  169.  
  170.   # Set up constants used in the rest of the program & open outline file.
  171.   # This is the filename for the generated outline.
  172.   $lesson_outline = "lesson${lesson_number}" . $html_extension;
  173.   if (!open(OUTLINE, ">${lesson_outline}.new"))
  174.     {die "Sorry, cannot open output lesson outline file ${lesson_outline}"};
  175.   &substitute_and_append("outline.head", "outline");
  176.  
  177.   # Process body of .les file.
  178.  
  179.   while ($_ ne "") {  # While there's still some text to process.
  180.     if (m/^<SECTION /i) { &process_section; }
  181.     else { print "Warning: text ignored outside of a section: $_" };
  182.     &read_line; # Done processing; read in the next line.
  183.   }
  184.  
  185.   # Done with all sections; close everything up.
  186.   &close_section_if_necessary;
  187.   &substitute_and_append("outline.tail", "outline");
  188.   close(OUTLINE);
  189.   close(IN);
  190. }
  191.  
  192. sub process_section {
  193.  # Process a single section from a lesson file.
  194.  # Precondition: current line should have a SECTION command.
  195.  &close_section_if_necessary; # Close previous section if necessary.
  196.  $section_number++;
  197.  # In the last section, use "f" as the section number in the filename
  198.  # so that the next lesson can link back to it correctly.
  199.  if ($section_number == $number_of_sections)
  200.     {$section_number_file_rep = "f"}
  201.  else
  202.     {$section_number_file_rep = $section_number};
  203.  # The only way to get here is if $_ contains <SECTION ...>; get its name.
  204.  $title= $_;
  205.  $title =~ s/^<SECTION .*NAME="([^"]*)".*$/$1/i;
  206.  chop($title);
  207.  print "Processing Section ${lesson_number}.${section_number}, ";
  208.  print "Name (Title) = $title\n";
  209.  $section_filename="s${lesson_number}-${section_number_file_rep}" .
  210.                    $html_extension;
  211.  if (!open(SECTION, ">${section_filename}.new"))
  212.    {die "Sorry, cannot open section file ${section_filename}"};
  213.  $section_file_open = 1;
  214.  
  215.  &determine_next_section_URL;
  216.  &determine_previous_section_URL;
  217.  $section_question_URL = "s${lesson_number}-" .
  218.                          "${section_number_file_rep}" . $html_extension .
  219.                          "#quiz";
  220.  $section_has_question = 0; # We haven't seen section question yet.
  221.  
  222.  print OUTLINE '<LI><A HREF="', ${section_filename}, '">', ${title}, "</A>\n";
  223.  
  224.  &reset_set_response;
  225.  # Insert the section header.
  226.  &substitute_and_append("section.head", "section");
  227.  
  228.  while (!eof(IN)) {
  229.   &read_line;
  230.  
  231.   # Is this the start of a question?
  232.   if (m/^<QUESTION[ >]/i) {&process_question;};
  233.  
  234.   # Is this the end of the section?
  235.   if (m/^<SECTION /i) {&process_section; last}; # recurse.
  236.   if (m/^<\/SECTION /i) {&close_section_if_necessary; last};
  237.  
  238.   # Normal text, just append it into the section.
  239.   print SECTION $_;
  240.  }
  241. }
  242.  
  243.  
  244. sub close_section_if_necessary {
  245.  if ($section_file_open == 1) {
  246.    if ($section_has_question == 0) {
  247.       # No quiz question - insert the no_question template.
  248.       &substitute_and_append("section.no_question", "section");
  249.    }
  250.    &substitute_and_append("section.tail", "section");
  251.    close(SECTION);
  252.    $section_file_open = 0;
  253.  }
  254. }
  255.  
  256. sub substitute_and_append {
  257.  local($template_chunk, $file_to_append) = @_;
  258.  
  259.  # Append to $file_to_append the contents of $template_chunk
  260.  # after performing appropriate substitutions.
  261.  
  262.  # $template_chunk is a string containing the name of the template chunk
  263.  #              from the template file to read in & perform substitutions on.
  264.  # $file_to_append is a string containing the name of the file handler
  265.  #              to append to. This is a kludge; ideally we would pass in
  266.  #              actual file handle, but perl apparantly can't pass file
  267.  #              handles, so we pass in a string instead.
  268.  
  269.  local($template_text) = $template{ $template_chunk };
  270.  
  271.  # Substitute markers in the template with their current values.
  272.  
  273.  $template_text =~ s/\[TUTOR_NAME\]/${tutor_name}/g;
  274.  $template_text =~
  275.      s/\[FULL_SECTION_NUMBER\]/${lesson_number}.${section_number}/g;
  276.  $template_text =~ s/\[SECTION_TITLE\]/${title}/g;
  277.  $template_text =~ s/\[SECTION_NAME\]/${title}/g; # likely misspelling
  278.  $template_text =~ s/\[AUTHOR_EMAIL\]/${author_email}/g;
  279.  $template_text =~ s/\[AUTHOR_ADDRESS\]/${author_address}/g;
  280.  $template_text =~ s/\[AUTHOR_NAME\]/${author_name}/g;
  281.  $template_text =~ s/\[ANSWER_NUMBER\]/${current_response}/g;
  282.  $template_text =~ s/\[LESSON_NUMBER\]/${lesson_number}/g;
  283.  $template_text =~ s/\[LESSON_OUTLINE_URL\]/${lesson_outline_URL}/g;
  284.  $template_text =~ s/\[TUTOR_HOME_PAGE_URL\]/${tutor_home_page_URL}/g;
  285.  
  286.  $template_text =~ s/\[MASTER_OUTLINE_URL\]/${master_outline_URL}/g;
  287.  $template_text =~ s/\[TODAYS_DATE\]/${todays_date}/g;
  288.  $template_text =~ s/\[TODAYS_YEAR\]/${todays_year}/g;
  289.  
  290.  # These values may change from section to section.
  291.  $template_text =~ s/\[NEXT_SECTION_URL\]/${next_section_URL}/g;
  292.  $template_text =~ s/\[PREVIOUS_SECTION_URL\]/${previous_section_URL}/g;
  293.  $template_text =~
  294.    s/\[THE_PREVIOUS_SECTION_OR_HOME\]/${the_previous_section_or_home}/g;
  295.  $template_text =~
  296.    s/\[CONFIRM_SKIP_SECTION_URL\]/${confirm_skip_section_URL}/g;
  297.  $template_text =~
  298.    s/\[SECTION_QUESTION_URL\]/${section_question_URL}/g;
  299.  
  300.  
  301.  # Determine where to append this line & append it.
  302.  if    ($file_to_append eq "section")  {print SECTION  $template_text;}
  303.  elsif ($file_to_append eq "response") {print RESPONSE $template_text;}
  304.  elsif ($file_to_append eq "outline")  {print OUTLINE  $template_text;}
  305.  else {die "Unexpected append parameter value $file_to_append!"};
  306. }
  307.  
  308. sub process_question {
  309. # Process the question in the section.
  310.  
  311.  $section_has_question = 1;
  312.  &substitute_and_append("section.question.head", "section");
  313.  
  314.  # Eliminate marker. If there's text left on this line, use it.
  315.  s/<QUESTION[^>]*> *//i;
  316.  chop;
  317.  if ($_ ne "") {print SECTION "$_\n"};
  318.  
  319.  # Copy text until there's a <CHOICES> marker.
  320.  while (!eof(IN)) {
  321.   &read_line;
  322.   if (/^<CHOICES/) {last};
  323.   if (/^<SECTION/) {die "Error - previous question had no choices."};
  324.   print SECTION;
  325.  }
  326.  
  327.  # We've sent out the question to its end.
  328.  
  329.  &process_choices;
  330.  &process_optional_responses;
  331.  &generate_default_responses;
  332. }
  333.  
  334.  
  335. sub read_line {
  336. # Read line from file handle <IN>. Sets $_ to its new value, and returns it.
  337. # Discards <COMMENT > lines.
  338.  $_ = $input_line = <IN>;
  339.  if (/^ *<COMMENT /i) {&read_line}; # Don't include COMMENT lines.
  340.  if (/^ *<TEXT /i) {&read_textfile}
  341.  else {$input_line;} # Return the value of the line read in.
  342. }
  343.  
  344. sub read_textfile {
  345. # Read in an entire non-HTML text file.
  346. # Sets $_ to the file contents, and returns $_'s value.
  347. # Performs substitutions so that "special" HTML characters
  348. # come out correctly (&, <, etc.)
  349.   m/^ *<TEXT .*FILE="([^"]*)"/i;
  350.   $text_filename=$1;
  351.   if (m/FONT=PRE/i) {$use_pre=1}
  352.   else              {$use_pre=0};
  353.   $file_contents = "";
  354.   if ($use_pre) {$file_contents .= "<PRE>\n"};
  355.   print "  Incorporating text (non-HTML) file ${text_filename}.\n";
  356.   if (!open(TEXTFILE, "<${text_filename}"))
  357.     {die "Sorry, cannot open text file ${text_filename}"};
  358.   while (<TEXTFILE>) {
  359.     # Substitute special HTML characters.
  360.     s/\&/&/g;   # & becomes &
  361.     s/\</</g;    # < becomes <
  362.     s/\>/>/g;    # > becomes >
  363.     # Do _NOT_ substitute the double-quote character (" into ")
  364.     # Windows NCSA Mosaic version 2.0 alpha 2 doesn't handle it,
  365.     # and all the browsers I can find can display them quite well.
  366.     #  s/\"/"/g;  # " becomes "
  367.     $file_contents .= $_;  # Add the contents.
  368.   }
  369.   close(TEXTFILE);
  370.   if ($use_pre) {$file_contents .= "</PRE>\n"};
  371.   $_ = $file_contents;  # Set the value, and return it.
  372. }
  373.  
  374. sub process_choices {
  375.  # Process the choices portion of a question in a section.
  376.  
  377.  # It must be of the form:
  378.  # <CHOICES>
  379.  # <CHOICE ANS=1>Text_IO
  380.  # </CHOICES>
  381.  # <ANSWER ANS=2>
  382.  # Note: the numbers in the <CHOICE> item are ignored.
  383.  
  384.  die "CHOICES section expected." unless /^<CHOICES/;
  385.  
  386.  print SECTION "<OL>\n";
  387.  $choice_number = 0;
  388.  while (!eof(IN)) {
  389.    &read_line;
  390.    if (/^<\/CHOICES/) {last};
  391.    if (/^<CHOICE/) {
  392.      $choice_number++;
  393.      s/^<CHOICE[^>]*> *//i;
  394.      chop;
  395.      print SECTION '<LI><A HREF="' .
  396.                    "s${lesson_number}-${section_number_file_rep}" .
  397.                    "r${choice_number}${html_extension}\">";
  398.      print SECTION $_;
  399.      print SECTION "</A>\n";
  400.      }
  401.    else {die "Sorry, choice text must be on the same line as <CHOICE>."}
  402.  }
  403.  $number_of_choices = $choice_number;
  404.  
  405.  die "A Choice section must end with </CHOICES>" unless (/^<\/CHOICES>/i);
  406.  &read_line;
  407.  
  408.  if (/^<ANSWER .*ANS=([0-9])+>/i) {
  409.    $correct_answer = $1 + 0;
  410.  } else {
  411.    die "A Choice section must be followed with the answer, " .
  412.        "format: <ANSWER ANS=number>";
  413.  }
  414.  &read_line;  # Get the next line for the callee.
  415.  
  416.  &substitute_and_append("section.question.tail", "section");
  417. }
  418.  
  419. sub process_optional_responses {
  420.  # Process the optional response portion of a section:
  421.  # <RESPONSES>
  422.  # <WHEN ANS=1> ..text..
  423.  # </RESPONSES>
  424.  # A <SECTION> could also follow.
  425.  
  426.  # Skip blank lines, if any.
  427.  while ($_ || !eof(IN)) {
  428.    if (/<RESPONSES>/i) {last};
  429.    if (/<SECTION/i) {last};
  430.    chop;
  431.    if ($_ ne "") {print "Warning: line ignored: $_\n"};
  432.    &read_line;
  433.  }
  434.  
  435.  if (/<RESPONSES>/i) {
  436.    # We have a response section.
  437.    $current_response = 0;
  438.    while (&read_line) {
  439.      if (/<\/RESPONSES>/i) {&read_line; last};
  440.      if (/<WHEN .*>/i) {
  441.        &close_response_if_necessary;
  442.        if (/<WHEN ANS=[0-9]*>/i) {
  443.          $current_response = $_;
  444.          $current_response =~ s/^<WHEN *ANS=([0-9]+)>.*$/$1/i;
  445.          chop($current_response);
  446.        }
  447.        else {
  448.          if (/<WHEN CORRECT>/i) {$current_response = $correct_answer}
  449.          else {die "Invalid WHEN clause"}
  450.         };
  451.        $set_response[$current_response] = 1; # Mark this response as found
  452.        &open_response;
  453.  
  454.        # If there's text on the same line as the WHEN clause, put it
  455.        # in the response file.
  456.        s/^ *<WHEN[^>]*> *//i;
  457.        chop;
  458.        if ($_ ne "") {print RESPONSE "$_\n"};
  459.      } else {
  460.         # We got some text, presumably part of a response.
  461.         if ($current_response == 0) {
  462.            print "Warning: Responses not associated with a specific answer\n";
  463.            print "Text is: $_";
  464.         } else {
  465.            print RESPONSE;
  466.         }
  467.      }
  468.    }
  469.    &close_response_if_necessary;
  470.  }
  471. }
  472.  
  473. sub open_response {
  474.  # Open the response file & set the variable names referring to it.
  475.  $response_filename="s${lesson_number}-${section_number_file_rep}" .
  476.                     "r${current_response}${html_extension}";
  477.  if (!open(RESPONSE, ">${response_filename}.new"))
  478.       {die "Sorry, cannot open response file ${response_filename}.new"};
  479.  print "  Opened response file ${response_filename}\n";
  480.  $response_file_open = 1;
  481.  &substitute_and_append("response.head", "response");
  482. }
  483.  
  484. sub close_response_if_necessary {
  485.  if ($response_file_open == 1) {
  486.    if ($current_response == $correct_answer)
  487.     {&substitute_and_append("response.correct.tail", "response");}
  488.    else
  489.     {&substitute_and_append("response.incorrect.tail", "response");};
  490.    &substitute_and_append("response.tail", "response");
  491.    close(RESPONSE);
  492.    $response_file_open = 0;
  493.  }
  494. }
  495.  
  496. sub generate_default_responses {
  497.  $current_response = 1;
  498.  while ($current_response <= $number_of_choices) {
  499.    if ($set_response[$current_response] == 0) {
  500.       &open_response;
  501.       # insert default text.
  502.       if ($current_response == $correct_answer) {
  503.          &substitute_and_append("response.correct.default", "response");
  504.       } else {
  505.          &substitute_and_append("response.incorrect.default", "response");
  506.       }
  507.       &close_response_if_necessary;
  508.    }
  509.    $current_response++;
  510.  }
  511. }
  512.  
  513. sub determine_next_section_URL {
  514. # Set $next_section_URL, $confirm_skip_to_next_section_URL
  515.  if ($section_number == $number_of_sections) {
  516.     $next_prefix = $next_lesson_location;
  517.     $next_lesson_number = $lesson_number + 1;
  518.     $next_section_file_rep = "1";
  519.  }
  520.  else {
  521.     $next_prefix = "";
  522.     $next_lesson_number = $lesson_number;
  523.     $next_section_file_rep = $section_number + 1;
  524.     if ($next_section_file_rep == $number_of_sections)
  525.       {$next_section_file_rep = "f"};
  526.    }
  527.   $next_section_URL = "${next_prefix}s${next_lesson_number}" .
  528.                      "-${next_section_file_rep}${html_extension}";
  529.  
  530.  # Set $confirm_skip_to_next_section_URL, the URL to go to if
  531.  # the user selects "skip" from a section.
  532.  
  533.  if ($lesson_number == 1 && $section_number == 1) {
  534.    # For lesson 1, section 1, confirm the skipping of the quiz
  535.    # by linking to the special file "skip1-1.html".
  536.    $confirm_skip_section_URL = 'skip1-1' . $html_extension;
  537.  } else {
  538.    $confirm_skip_section_URL = $next_section_URL;
  539.  };
  540. }
  541.  
  542. sub determine_previous_section_URL {
  543.  # Determine & set the value of:
  544.  # $previous_section_URL
  545.  # $the_previous_section_or_home
  546.  
  547.  $the_previous_section_or_home = $template{"the_previous_section_is_not_home"};
  548.  if ( $the_previous_section_or_home == "" ) 
  549.     { $the_previous_section_or_home = "the previous section" };
  550.  local($template_text) = $template{ $template_chunk };
  551.  if ($section_number == 1) {
  552.      $previous_lesson_number = $lesson_number - 1;
  553.      if ($lesson_number == 1) {
  554.         # lesson 1, section 1 - the "previous" section is the home page.
  555.         $previous_section_URL= $tutor_home_page_URL;
  556.         $the_previous_section_or_home =
  557.                     $template{"the_previous_section_is_home"};
  558.         if ( $the_previous_section_or_home == "" ) 
  559.              { $the_previous_section_or_home = "the tutorial home page" };
  560.      } elsif ($previous_lesson_location_set == 1) {
  561.         $previous_section_URL= $previous_lesson_location . '/' .
  562.                       's' . $previous_lesson_number . '-f' . $html_extension;
  563.      } else {
  564.         # No previous location set; must be current directory.
  565.         $previous_section_URL= 's' . $previous_lesson_number . '-f' .
  566.                                $html_extension;
  567.      }
  568.  } else {
  569.      $previous_lesson_number = $lesson_number;
  570.      $previous_section_number = $section_number - 1;
  571.      $previous_section_URL= 's' . $previous_lesson_number . '-' .
  572.                             $previous_section_number . $html_extension;
  573.  }
  574.  
  575. }
  576.  
  577.  
  578. sub move_in_new_files {
  579. # Move in all files with .new extensions to replace original files.
  580. # If desired, this can be modified so it only replaces "changed" files.
  581.  print "\n";
  582.  print "Replacing changed files, if any.\n";
  583.  while (<*.new>) {
  584.    $oldname = $_;
  585.    $newname = $_;
  586.    $newname =~ s/\.new$//;
  587.    if (system("cmp -s $oldname $newname") != 0) {
  588.      # The new file is different, remove the older one.
  589.      print " Replacing $newname (with $oldname)\n";
  590.      rename($newname, "${newname}.BAK"); # Keep older one, just in case.
  591.      rename($oldname, $newname);
  592.    } else {
  593.      unlink($oldname);
  594.    }
  595.  }
  596. }
  597.  
  598. sub change_timestamp_file {
  599. # Change the timestamp file. Parameter 1 is the input filename.
  600. # The timestamp is used so we'll know when this file was last generated.
  601. local($infile_name) = @_;
  602. $timestamp_filename = $infile_name;
  603. $timestamp_filename =~ s/\.les$//;
  604. $timestamp_filename .= ".tim";
  605. if (!open(TIMESTAMP_FILE, ">${timestamp_filename}"))
  606.    {die "Sorry, cannot create timestamp file ${timestamp_filename}"};
  607. print TIMESTAMP_FILE "Lesson Generated.\n";
  608. close(TIMESTAMP_FILE);
  609. }
  610.  
  611. sub read_in_template {
  612. # Read in file "template", putting results in associative array %template
  613. local($current_template_unit);
  614. $current_template_unit = "garbage";
  615. if (!open(TEMPLATE, "<template"))
  616.    {die "Sorry, cannot find a local file named template."};
  617. while (<TEMPLATE>) {
  618.   if (/^===== (\S+) =====/)
  619.     {$current_template_unit = $1;}
  620.   elsif ($current_template_unit eq "comment")
  621.      {} # Do nothing with comments.
  622.   elsif ($current_template_unit eq "garbage")
  623.     {print "WARNING: Garbage line in file template: $_";}
  624.   else { $template{$current_template_unit} .= $_; } # Append to assoc array.
  625. };
  626. close(TEMPLATE);
  627.  
  628. # If debug on, print out the %template contents.
  629. if ($debug_template == 1) {
  630.   print "DEBUG: Printing out template contents as read:\n";
  631.   foreach $i (%template) {
  632.    print "=====\n";
  633.    print $i;
  634.    print "\n";
  635.   }
  636. }
  637. }
  638.  
  639. sub reset_set_response {
  640.  # Reset array "set_response", which stores the list of responses
  641.  # set in this section by the user. This is used to determine
  642.  # which responses should have "default" responses set for them.
  643.  
  644.  # Assume no more than 9 responses.
  645.  @set_response = ( 0, 0, 0, 0, 0, 0, 0, 0, 0 );
  646.  $choice_number = 0;
  647. }
  648.  
  649. sub initialize_variables {
  650. # Note - these are GLOBAL variables.
  651.  $lesson_number = 0;
  652.  $section_number = 0;
  653.  $tutor_name="";
  654.  $author_name="";
  655.  $author_email="";
  656.  $author_address="";
  657.  $section_has_question = 0;  # Does this section have a question? 0=false.
  658.  
  659.  $previous_lesson_location_set = 0;
  660.  $previous_lesson_location ="";
  661.  
  662.  $next_lesson_location_set = 0;
  663.  $next_lesson_location ="";
  664.  
  665.  $master_outline_set = 0;
  666.  $master_outline_URL ="";
  667.  
  668.  $tutor_home_page_set = 0;
  669.  $tutor_home_page_URL = "";
  670.  
  671.  $section_file_open = 0; # 0=false, 1=true.
  672.  $response_file_open = 0;
  673.  $current_response = 0;
  674.  
  675.  # Determine today's date and year.
  676.  ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst) =
  677.                                                           localtime(time);
  678.  $mon++; # Month was returned as 0-11, so we need to fix it.
  679.  # Determine 4-digit year; recode in 2090.
  680.  if ($year < 90) { $year += 2000 } else { $year += 1900 };
  681.  $todays_date =  $year . "." . $mon . "." . $mday . " (YY.MM.DD)";
  682.  $todays_year = $year;
  683.  print "Today's date is ${todays_date}; year is $todays_year\n";
  684. }
  685.  
  686. sub open_lesson_file {
  687.  # Get lesson file name and find out how many sections it has.
  688.  if (!open(IN, "<$lesson_source"))
  689.    {die "Sorry, cannot open input file ${lesson_source}"};
  690.  $number_of_sections=0;
  691.  while (<IN>) {
  692.   if (m/^<SECTION /i) {$number_of_sections++};
  693.   };
  694.  close(IN);
  695.  print "There are $number_of_sections sections in " .
  696.        "lesson file ${lesson_source}.\n";
  697.  if (!open(IN, "<$lesson_source"))
  698.     {die "Cannot re-open input file ${lesson_source}"};
  699. }
  700.  
  701. sub read_in_defaults {
  702.  # If it exists, load in the file "defaults" as a lesson header file.
  703.  # This makes it easier to create 'standard defaults' for a specific
  704.  # tutorial.
  705.  if (open(IN, "<default")) {
  706.    print "Default file found; processing it first.\n";
  707.    &process_input_header;
  708.    close(IN);
  709.  } else {
  710.    print "(No default file found.)\n";
  711.  }
  712. }
  713.  
  714.  
  715. # Potential projects:
  716. # ?? Process <INCLUDE >
  717. # ?? Clean up code (use perl shortcuts, examine for EOF).
  718. # ?? Error check input. For head, warn of unused.
  719. # ?? More error checking in body processing.
  720.