#!/usr/bin/perl # # Copyright 2004 World Wide Web Consortium, # (Massachusetts Institute of Technology, ERCIM, # 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. # # modified 20040325 Dean Jackson: removed tables so we can use CSS # for layout, remove all the code for HTML - UTF-8 XHTML strict only here! # changed default styles (now better CSS - although results are ugly) # # Based on Id: w3cburst.pl,v 1.21 2001/10/17 01:15:16 plehegar Exp # # $Id: w3cburst.pl,v 1.2 2004/04/11 16:51:14 danbri 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 ## $doctype = ''; $xmlns = ' xmlns="http://www.w3.org/1999/xhtml" '; ## 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'; ## header of the presentation $header = 'World Wide Web Consortium'; ## 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 = 'corepoorate/corepoorate.css,stripes/stripes.css,oldskool/oldskool.css,idunno/idunno.css,stripier/stripier.css,pasthell/pasthell.css,queereye/queereye.css'; # TODO - fix this up #if (! -d '') { # ## 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 = 'utf-8'; ## 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"; ## set an XML declaration for XHTML $xmldecl = "\n"; ## adjust language information $langattr = " xml:lang=\"$baselang\" lang=\"$baselang\""; # charset $meta_charset = "\n"; ############################################################################## ## read the raw (X)HTML presentation ## ## copy file in memory my $sep = $/; $/ = undef; if (!open(ALL, $all)) { print "Error: Cannot open file: $all\n"; exit 0; } my $buf = ; 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"; } local($lastslide); $lastslide = $nbCssStandard-1; print FOO < $meta_charset$talkTitle - Slide list $stylelink

END print FOO <$talkTitle by $author

END close(FOO); } ## ## the toc has been completed and saved ############################################################################## ############################################################################## ## add an item in the toc sub addTitle { $_[0] =~ s/\r//ig; # remove the windows CR+LF $_[0] =~ s/<[^>]+>//g; if (length $_[0] == 0) { return 1; } # add accesskey for first 9 slides (`1' - `9'), and tabindex for all slides if ($_[1] < 10) { print FOO <$_[0] END } else { print FOO <$_[0] END } } ## ############################################################################## ############################################################################## ## generate the current slide sub createSlide { # parameters are respectively the slide title, its content, # its number, the next slide title and the previous slide title if (length $_[0] == 0) { return 1; } # work the slide title, the previous and next titles $_[0] =~ s/\r//ig; # remove the windows CR+LF $_[3] =~ s/\r//ig; $_[4] =~ s/\r//ig; $title = $_[0]; # Remove any tags from the prev & next titles $_[3] =~ s/<[^>]+>//g; $_[4] =~ s/<[^>]+>//g; $title =~ s/<[^>]+>//g; # Replace double quotes # $_[0] =~ s/"/"/g; $_[3] =~ s/"/"/g; $_[4] =~ s/"/"/g; # work the slide content $_[1] =~ s/<\/body>//i; # remove if any $_[1] =~ s/<\/html>//i; # remove if any $status = sprintf "Slide %2d: %s\n", $_[2], $_[0]; $status =~ s#<[^>]+>##g; print STDOUT $status; &verify_html($_[1]); # check the (X)HTML ## we create as many slides as there are css files ## Pierre note: it'd be much nicer to have only one slide ## which could dynamically load the css file, but ... my $cNumber = 0; for ($i=0;$i<$nbCssStandard;$i++) { $cNumber = $i+1; $cNumber = 0 if ($i == $nbCssStandard-1); ## write to the slide open(SLIDE, ">slide$_[2]-$i$htmlsuffix"); local($navBar); local($miniNavBar); local($toclink); local($firstlink); local($lastlink); local($prevlink); local($nextlink); ## navigation to previous slide, toc and next slide $navBar = ""; $miniNavBar = "$author $_[2] of $total\n"; ## the toc link needs to match the slide index ## so that the style sheets match between the slides and the toc $toclink = "\n". ""; $firstlink = ""; $lastlink = ""; ## initialization of the navigation links $nextlink = ""; $prevlink = ""; if ($_[2]>1) { $prevlink = ""; $navBar .= "\n"; } else { ## add a link back to the toc for the first slide --CMN 19991102 if ($i == 0) { $prevlink = ""; $navBar .= "\n"; } else { $prevlink = ""; $navBar .= "\n"; } } if ($i == 0) { ## we're using the first css file, so no need to number the toc # @@ huh? $navBar .= "\n"; #$navBar = $navBar." $\"$ "; } else { ## change $toclink $toclink = "\n". ""; ## we're using another css, the toc needs to match # @@ huh? $navBar .= "\n"; #$navBar = $navBar." $\"$ "; } ## add style change before the "next" button --CMN 19991102 # @@ todo - style change $navBar .= "\n"; if ($_[2] != $total) { $nextlink = ""; $navBar .= "\n"; } $stylelink = ""; # here is the standard style sheet $stylelink .= ""; # we overload with the user css if it exists if ($cssUser[$i]) { $stylelink .= "\n"; } print SLIDE < $meta_charset$talkTitle - slide "$title" $firstlink $lastlink $nextlink $prevlink $toclink $stylelink

$_[0]

$_[1]

END close(SLIDE); } return 0; } ############################################################################## ## generate all the toc of contents needed for each css choosen by the user ## the default toc is not numbered so it can be served by a request to '/' ## (ie it remains Overview$htmlsuffix whereas the other toc are called Overview_#$htmlsuffix) sub generateTOC { ## read the general toc open(FOO, "<$overview$htmlsuffix"); @TOC = ; close(FOO); $toc = "@TOC"; local($lastslide); $lastslide = $nbCssStandard - 1; ## for each user CSS file ## starting after the default css for ($css=1;$css<$nbCssStandard;$css++) { ## create new TOC $newTOC = $toc; ## replace the navigation link elements $newTOC =~ s###ig; $newTOC =~ s###ig; $newTOC =~ s###ig; ## replace the style link with a new one ## ## we eventually choose the user css file if any $newTOC =~ s###ig; if ($cssUser[$css]) { $newTOC =~ s###ig; } ## the links on the toc need also to be modified ## to link to the correct slides $newTOC =~ s///ig; $newTOC =~ s///ig; ## write to new TOC $outfile = $overview."-".$css."$htmlsuffix"; open(OUT, ">$outfile"); print OUT $newTOC; close(OUT) } } ############################################################################## # check that the (X)HTML of the slide # is correct (alt attributes, ...) # This procedure produces only warning sub verify_html { if ($_[0] =~ /]*)>/im) { if (!($1 =~ /alt=/im)) { print STDOUT "WARNING: without alt\n"; print STDOUT " \n" ; } } } ############################################################################## # clean the html of the slide # remove all

blabla

sub clean_html { $_[0] =~ s/]|\"comment\").*?<\/div>//igs; return $_[0]; }

Table of contents

$_[0]