Copying over the scripts for downloading the reference; updating the reference.

build/create_reference.pl

@@ -0,0 +1,141 @@
+#!/usr/bin/env perl
+#
+#  Grab the Arduino reference documentation from the web site and
+#  modify the pages to create an offline reference.
+#
+# Author: Tom Pollard <tomp at earthlink dot net>
+# Written: Jan 12, 2008
+#
+use strict;
+use warnings;
+
+my $verbose = 1;
+my $CURL_OPTIONS = '--silent --show-error';
+
+my $ARDUINO = 'http://arduino.cc/en'; # base url for arduino site
+
+my %downloaded = ();  # keep track of the pages we download
+
+my $guide = create_page('Guide_index.html', "$ARDUINO/Guide/HomePage");
+
+my $faq = create_page('FAQ.html', "$ARDUINO/Main/FAQ");
+my $env = create_page('environment.html', "$ARDUINO/Main/Environment");
+my $css = create_page('arduino.css', "$ARDUINO/pub/skins/arduino/arduino.css");
+my $eeprom = create_page('EEPROM.html', "$ARDUINO/Reference/EEPROM");
+my $stepper = create_page('Stepper.html', "$ARDUINO/Reference/Stepper");
+my $softser = create_page('SoftwareSerial.html', "$ARDUINO/Reference/SoftwareSerial");
+my $wire = create_page('Wire.html', "$ARDUINO/Reference/Wire");
+my $servo = create_page('Servo.html', "$ARDUINO/Reference/Servo");
+my $lcd = create_page('LiquidCrystal.html', "$ARDUINO/Reference/LiquidCrystal");
+my $ethernet = create_page('Ethernet.html', "$ARDUINO/Reference/Ethernet");
+my $serial = create_page('Serial.html', "$ARDUINO/Reference/Serial");
+
+create_linked_pages($guide,   qr!$ARDUINO/Guide/(\w+)!,             'Guide_%%.html');
+create_linked_pages($softser, qr!$ARDUINO/Reference/(SoftwareSerial\w+)!, '%%.html');
+create_linked_pages($eeprom,  qr!$ARDUINO/Reference/(EEPROM\w+)!,         '%%.html');
+create_linked_pages($stepper, qr!$ARDUINO/Reference/(Stepper\w+)!,        '%%.html');
+create_linked_pages($wire, qr!$ARDUINO/Reference/(Wire\w+)!,        '%%.html');
+create_linked_pages($servo, qr!$ARDUINO/Reference/(Servo\w+)!,        '%%.html');
+create_linked_pages($lcd, qr!$ARDUINO/Reference/(LiquidCrystal\w+)!,        '%%.html');
+create_linked_pages($ethernet, qr!$ARDUINO/Reference/(Ethernet\w+)!,        '%%.html');
+create_linked_pages($ethernet, qr!$ARDUINO/Reference/(Server\w+)!,        '%%.html');
+create_linked_pages($ethernet, qr!$ARDUINO/Reference/(Client\w+)!,        '%%.html');
+create_linked_pages($serial, qr!$ARDUINO/Serial/(\w+)!,    'Serial_%%.html');
+
+my $index = create_page('index.html', "$ARDUINO/Reference/HomePage");
+
+create_linked_pages($index, qr!$ARDUINO/Reference/(\w+)!,        '%%.html');
+
+my $ext = create_page('Extended.html', "$ARDUINO/Reference/Extended");
+
+create_linked_pages($ext, qr!$ARDUINO/Reference/(\w+)!, '%%.html');
+
+exit 0;
+
+#------------------------- end of main code ----------------------------
+
+########################################################################
+#  $original_text = create_page($filename, $url)
+#
+#    Download the web page at the given URL, change links to point to
+#    the offline pages, and save it locally under the given filename. 
+#    The original (unmodified) text of the downloaded page is returned.
+#
+sub create_page {
+  my $page = shift;
+  my $url = shift;
+
+  print "$page\n" if $verbose;
+  my $original_text = `curl $CURL_OPTIONS $url`;
+  die "** Unable to download $url **\n" if $? or ! $original_text;
+  $downloaded{$url} = $page;  # remember that we downloaded this page
+
+  my $localized_text = localize_page($original_text);
+  open(my $PAGE, "> $page") 
+    or die "** Unable to open $page for writing. **\n";
+  print $PAGE $localized_text;
+  close $PAGE;
+
+  return $original_text;
+}
+
+########################################################################
+#  $localized_text = localize_page($text)
+#
+#    Rewrite links in the given text to point to the offline pages.
+#
+sub localize_page {
+  my $text = shift;
+
+  # replace links to unknown pages with links to '#'
+  $text =~ s!$ARDUINO/Reference/[^?"']*\?[^'"]*!#!xg;
+
+  # replace links to remote guide with links to local guide
+  $text =~ s!$ARDUINO/Guide/([^']+)!Guide_$1.html!xg;
+
+  # replace links to remote reference with links to local reference
+  $text =~ s!$ARDUINO/Reference/([^']*)!$1.html!xg;
+
+  # replace links to remove serial reference with links to local serial reference
+  $text =~ s!$ARDUINO/Serial/([^']*)!Serial_$1.html!xg;
+
+  # direct pages to the local style file
+  $text =~ s!$ARDUINO/pub/skins/arduino/arduino.css!arduino.css!xg;
+
+  # change links to Main/FAQ to go to FAQ.html 
+  $text =~ s!$ARDUINO/Main/FAQ!FAQ.html!xg;
+
+  # change links to the reference HomePage to go to index.html 
+  $text =~ s!HomePage.html!index.html!xg;
+
+  # change links to the root directory to go to the Arduino home page
+  $text =~ s!href="/"!href="http://www.arduino.cc"/!xg;
+
+  return $text;
+}
+
+########################################################################
+#  create_linked_pages($text, $link_pattern, $page_name)
+#
+#    Scan the given text for links matching the $link_pattern and
+#    create local files for the linked pages.  
+#
+#    The link_pattern is a regexp with one parenthesized subexpression -
+#    the text matching the subexpression will replace the
+#    special pattern '%%' in the $page_name to generate the name of
+#    the local file.  
+#
+sub create_linked_pages {
+  my $text = shift;
+  my $link_pattern = shift;
+  my $new_name = shift;
+
+  while ($text =~ m!$link_pattern!g) {
+    my ($url, $name) = ($&, $1);
+    (my $page = $new_name) =~ s!%%!$name!;
+    next if $name =~ /\?/ || $downloaded{$url};
+    create_page($page, $url);
+  }
+}
+
+#---------------------------- end of code ------------------------------

build/fetch.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+# fetch.sh
+# David A. Mellis and Tom Pollard
+# Script to download reference pages from Arduino website and change links
+# to point to local copies of the pages. 
+
+die () { echo ERROR: $*; exit 1; }
+
+mkdir reference  || die 'unable to create reference directory'
+
+cd reference
+perl ../create_reference.pl || die 'unable to create local reference pages'
+
+cd ..
+zip -r shared/reference.zip reference || die 'unable to create reference.zip archive'
+
+rm -rf reference

todo.txt

@@ -5,9 +5,9 @@ PROCESSING 5503 SYNC
 
 Add library keyword highlighting.
 
-Test the FTDI drivers in the arduino.dmg.
+Fix the settings in the Info.plist file in the Arduino.app.
 
-Update reference.
+Test the FTDI drivers in the arduino.dmg.
 
 Test bootloader burning w/ an AVRISP and a parallel programmer.