$talkTitle - Slide list

#!/usr/bin/perl # # Copyright 1997-2003 World Wide Web Consortium, # (Massachusetts Institute of Technology, European # Research Consortium for Informatics and Mathematics, # Keio University). All Rights Reserved. # This program is distributed under the W3C's # Intellectual Property License. This program is # distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied # warranty of MERCHANTABILITY or FITNESS FOR A # PARTICULAR PURPOSE. See W3C License # http://www.w3.org/Consortium/Legal/ for more details. # ############################################################################## # # slidemaker tool # split an all.htm into slides # # Stephan Montigaud - stephan@w3.org # created 970601 # modified by Pierre Fillault # check the documentation at http://www.w3.org/Talks/YYMMsub/ # # modified 19990505 Bert Bos: ALT text of prev/next arrows is now # "prev"/"next" rather than the title of the prev/next slide; looks better # in lynx. # # modified 20011014 Philippe Le Hegaret: improved the link elements for a # better use fo the mozilla link toolbar (added first, last and top). Fixed # the style sheet links in all Overview-*.html (only cssUser was taken into # account). # # modified 20020504 Masayasu Ishikawa: added XHTML support. # # Based on Id: w3cburst.pl,v 1.21 2001/10/17 01:15:16 plehegar Exp # # $Id: w3cburstx.pl,v 1.7 2003-11-11 14:43:36 mimasa Exp $ # # NOTE: all the anchors in this tool contain the extension # indeed this package has to work outside the environment of a web server # Users need to be able to display their presentation using file:\\ # which requires link to 'real' files use Getopt::Std; getopts('h'); $htmlsuffix = defined $opt_h ? '.htm' : '.html'; ############################################################################## ## default values of variables ## ## $version sets the version of (X)HTML for slides ## version = ## ( html4 | xhtml1 | xhtml11 | xhtml-math | xhtml-math-svg | xhtml-family ) $version = "html4"; ## default DOCTYPE added on the slides $html4_doctype = ''; $xhtml1_doctype = ''; $xhtml11_doctype = ''; $xhtml_math_doctype = ''; $xhtml_math_svg_doctype = ''; $xhtml_family_doctype = ''; ## table of content built from all.htm - also first page of the presentation ## this is only the basename as we need to generate one toc for each style sheets ## the main toc will not bear any more so the server can understand a request for '/' ## the next ones will bear a number corresponding to the slide index $overview = 'Overview'; ## name of the file containing the parameters of the presentation $infos = 'infos.txt'; ## link to the logo printed on all the slides $logoLink = 'http://www.w3.org/'; ## default location of the logo - works when slidemaker is used as a package $logoFile = '../Icons/w3c_home.png'; ## if slidemaker is used online, then the location of the logo is likely to be different ## than the default if (! -f $logoFile) { # if the logo is not found, then we're likely to find it # at /Talks/Icons/ for W3C users $logoFile = '/Talks/Icons/w3c_home'; } ## alternate representation of the logo $logoAlt = 'W3C '; ## default values set to none $logoLink2 = ''; # link to a potential second reference $logoFile2 = ''; # location of a second logo $logoAlt2 = ''; # alternate representation of the second logo ## navigation icons used in the slides $left = '../Icons/left.png'; $right = '../Icons/right.png'; $top = '../Icons/up.png'; $toc = '../Icons/toc.png'; $bar = '../Icons/bar.png'; $barl = '../Icons/barl.png'; $change = '../Icons/change.png'; ## for online use on the W3C site if (! -d '../Icons') { ## the icons will be present at this default location $left = '/Talks/Icons/left'; $right = '/Talks/Icons/right'; $top = '/Talks/Icons/up'; $toc = '/Talks/Icons/toc'; $bar = '/Talks/Icons/bar'; $barl = '/Talks/Icons/barl'; $change = '/Talks/Icons/change'; } ## default accesskeys for navigation icons used in the slides $prevKey = 'P'; # accesskey for previous slide $nextKey = 'N'; # accesskey for next slide $tocKey = 'C'; # accesskey for table of contents $styleKey = 'S'; # accesskey for changing style sheets ## default author name $author = 'W3C Staff'; ## default presentation title $talkTitle = 'W3C Talk'; ## standard style sheets $cssStandardFiles = '../Tools/slide-640.css,../Tools/slide-800.css,../Tools/slide-1024.css'; if (! -d '../Tools') { ## online location for W3C use $cssStandardFiles = '/Talks/Tools/slide-640.css,/Talks/Tools/slide-800.css,/Talks/Tools/slide-1024.css'; } ## default charset for use in meta http-equiv or XML declaration $charset = 'ISO-8859-1'; ## default language setting is US English $baselang = 'en-US'; ## end of default values for the presentation ############################################################################## ############################################################################## ## reading user input from $infos ## @PARAM = @ARGV; # we keep this for backward compatibility with an old version # of the slidemaker tool #when the parameters were in Makefile or make.bat # read parameters from infos.txt and put them in @PARAM if (open(INFOS, $infos)) { print STDOUT "--- Reading parameters file $infos ---\n"; local(@file,$counter); $counter = 0; @file = ; @PARAM = (); do { if ($file[0] =~ /^[^#\n\r]/) { $file[0] =~ s/\n//; # remove UNIX \n $file[0] =~ s/\r//; # remove WINDOWS \r $file[0] =~ s/ *= */=/; $PARAM[$counter++] = $file[0]; print "$file[0]\n"; } } while (shift(@file)); } ## @PARAM is now a table with the user preferences for his presentation ## process arguments ## each preset variable is now re-attributed using the user preferences foreach (@PARAM) { @_ = split(/ *= */); $cmd="\$$_[0] = \'$_[1]\';"; if (length $_[1] != 0) { eval($cmd); } } ## save the style sheet file locations into tables @cssStandard = split(',',$cssStandardFiles); $nbCssStandard = $#{@cssStandard} +1; @cssUser = split(',',$cssUserFiles); $nbCssUser = $#{@cssUser} +1; ## build an (X)HTML fragment for the author variable ## containing the presentation author name linked to ## a location of his choice if ($authorUrl) { $author = "$author"; } ## same string is built if there is a second author for the presentation if ($author2 && $author2Url) { $author2 = "$author2"; } ## put both authors together if ($author2) { $author = $author." & ".$author2; } ## name of raw (X)HTML file containing the slides $all = "all$htmlsuffix"; #$all = "all.htm"; ## set an XML declaration for XHTML if ($version =~ /^xhtml/){ $xmldecl = "\n"; } else { $xmldecl = ""; } ## set an XML namespace declaration for XHTML if ($version =~ /^xhtml/){ $xmlns = ' xmlns="http://www.w3.org/1999/xhtml"'; } else { $xmlns = ''; } ## set an appropriate DOCTYPE if ($version eq "xhtml11"){ $doctype = $xhtml11_doctype; } elsif ($version eq "xhtml-math"){ $doctype = $xhtml_math_doctype; } elsif ($version eq "xhtml-math-svg"){ $doctype = $xhtml_math_svg_doctype; } elsif ($version eq "xhtml-family"){ $doctype = $xhtml_family_doctype; } elsif ($version eq "xhtml1"){ $doctype = $xhtml1_doctype; } elsif ($version eq "html4"){ $doctype = $html4_doctype; } ## adjust language information depending on the version of (X)HTML if ($version eq "xhtml1"){ $langattr = " xml:lang=\"$baselang\" lang=\"$baselang\""; } elsif ($version =~ /^xhtml/){ $langattr = " xml:lang=\"$baselang\""; } else { $langattr = " lang=\"$baselang\""; } ## adjust empty element syntax if ($version =~ /^xhtml/){ $empty = " />"; } else { $empty = ">"; } ## meta charset will be only added in HTML 4 and XHTML 1.0 if ($version eq "html4" || $version eq "xhtml1"){ $meta_charset = "; close(ALL); $/ = $sep; ## Remove comments from the raw presentation ## they do not need to show up on the slides $buf =~ s///sgo; ## the slidemaker tool assumes that each slide is self contained between ## 2 sets of h1 elements ## if not it will generate a rather weird output ## split using and as separator (ignores attributes!) @table = split(/<\/?[hH]1[^>]*>/, $buf); ## compute the total number of slides $total = $#table / 2; if ($#table % 2 != 0) { $total = ($#table +1)/2; } ## ## raw presentation has been read successfully ############################################################################## ############################################################################## ## processing the slides print STDOUT "\n--- Processing $total slides ---\n"; ## generate the header table of content of the presentation ## which is also the first page of the talk &openOverview($overview); ## start the slide count so we can number them $slideCount = 1; ## @table is the array containing each slide with its title ## for each slide to be generated ## we delete each slide and its title when generated ## so that the current slide and its title are always at $table[0] (for the title) ## and $table[1] (for the slide content) do { ## get rid of the first element contained by the raw presentation array shift(@table); ## then $table[0] is the title of the slide to be generated $table[0] =~ s/\n+/ /g; ## replace return character by a white space $table[0] =~ s/ +/ /g; ## concatenate several white spaces to only one $table[0] =~ s/^ //; ## remove all the starting white spaces in the title $table[0] =~ s/ $//; ## remove all trailing white spaces in the title ## $slideTitle preserves link(s) in the title $slideTitle = $table[0]; ## need to check if the title contains any anchor ## if so it needs to be removed ## because the title is being used in the table of content to link to the corresponding slide $table[0] =~ s/(.*)]*>(.*)<\/a>(.*)/$1$2$3/; ## grab next slide title $table[2] (if there's a next slide) ## to be able to use in the 'next' navigation button ## keep in mind that $table[1] contains the slide corresponding to the title $table[0] $next_slide_title = $table[2] if $table[2]; ## remove any anchor from the next slide title $next_slide_title =~ s/(.*)]*>(.*)<\/a>(.*)/$1$2$3/; ## add the title of the current slide to the table of content &addTitle("$table[0]",$slideCount); ## the current slide content is stored $table[1] ## there is an attempt to make sure it's clean (X)HTML ## Pierre Fillault's note: use same piece of as used in http://www.w3.org/Web/Tools/CvsCommitScripting ## to make use of the validation service $slideContent = &clean_html($table[1]) ; ## generate the current slide ## parameters are: ## title of the slide, its content, the slide number, the title of the previous slide and the title of the next slide &createSlide("$slideTitle",$slideContent ,$slideCount++,$previous_slide_title,$next_slide_title); ## save the title of the previous slide to be displayed in the 'previous' navigation button $previous_slide_title="$table[0]"; } ## process the next slide while (shift(@table)); ## close the table of content &closeOverview; ## generate more toc with the all the style sheets ## as there's no way of loading a style sheet ## except dynamically, but that would be slow ## and would not work on all platforms (ie would fail on Joe's laptop) &generateTOC; print STDOUT "--- Finished ---\n"; exit 0; ## ## end of the slidemaker main program ############################################################################## ############################################################################## ## generate the header of the table of content sub openOverview { ## open the file to write to open(FOO, ">$_[0]$htmlsuffix"); ## the style sheet used in the table of content is $stylelink = ""; $stylePI = ""; ## here is the standard style sheet $stylelink .= ""; } ## we overload with the user css if it exists if ($cssUser[$0]) { $stylelink .= "\n\n"; } } local($lastslide); $lastslide = $nbCssStandard-1; print FOO < $meta_charset$talkTitle - Slide list END ## if there's only one logo to put on the toc if (length $logoFile2 == 0) { print FOO <

Table of contents

$_[0]