84f83e88f4a01bc489c8fe422c828b3b6c3f1a59
[techtalk-pse.git] / techtalk-pse.pl
1 #!/usr/bin/perl -w
2 # -*- perl -*-
3 # @configure_input@
4 #
5 # Tech Talk PSE
6 # Copyright (C) 2010 Red Hat Inc.
7 #
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 2 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21
22 use warnings;
23 use strict;
24 use utf8;
25
26 use POSIX qw(setsid);
27 use Pod::Usage;
28 use Getopt::Long;
29 use Cwd qw(getcwd abs_path);
30 use Glib qw(TRUE FALSE);
31 use Gtk2 -init;
32 use Gtk2::MozEmbed;
33
34 =encoding utf8
35
36 =head1 NAME
37
38 techtalk-pse - superior technical demonstration software
39
40 =head1 SYNOPSIS
41
42  cd /path/to/talk/; techtalk-pse
43
44  techtalk-pse /path/to/talk/
45
46 =head1 DESCRIPTION
47
48 Tech Talk "Platinum Supreme Edition" (PSE) is Linux Presentation
49 Software designed by technical people to give technical software
50 demonstrations to other technical people.  It is designed to be simple
51 to use (for people who know how to use an editor and the command line)
52 and powerful, so that you can create informative, technically accurate
53 and entertaining talks and demonstrations.
54
55 Tech Talk PSE is good at opening editors at the right place, opening
56 shell prompts with preloaded history, compiling and running things
57 during the demonstration, displaying text, photos, figures and video.
58
59 Tech Talk PSE is I<bad> at slide effects, chart junk and bullet
60 points.
61
62 This manual page covers all the documentation you will need to use
63 Tech Talk PSE.  The next section covers running the tool from the
64 command line.  After that there is a L</TUTORIAL> section to get you
65 started.  Then there is a detailed L</REFERENCE> section.  Finally
66 there is a discussion on L<WHAT MAKES A GOOD TALK>.
67
68 =head1 RUNNING THE TOOL FROM THE COMMAND LINE
69
70 A Tech Talk PSE talk is not a single file, but a directory full of
71 files.  (If you want to start a new talk, see the L</TUTORIAL> section
72 below).  To display or run the talk, change into the directory
73 containing all those files and run the C<techtalk-pse> command:
74
75  cd /path/to/talk/; techtalk-pse
76
77 You can also run C<techtalk-pse> without changing directory, instead
78 specifying the path to the talk:
79
80  techtalk-pse /path/to/talk/
81
82 =head2 OPTIONS
83
84 =over 4
85
86 =cut
87
88 my $help;
89
90 =item B<--help>
91
92 Display brief help and exit.
93
94 =cut
95
96 my $last;
97
98 =item B<--last>
99
100 Start at the last slide.
101
102 You cannot use this with the B<-n> / B<--start> option.
103
104 =cut
105
106 my $start;
107
108 =item B<-n SLIDE> | B<--start SLIDE>
109
110 Start at the named slide.  I<SLIDE> is the shortest unique prefix of
111 the slide name, so to start at a slide named
112 I<00010-introduction.html>, you could use I<-n 00010> or I<-n 00010-intro>,
113 or give the full filename I<-n 00010-introduction.html>.
114
115 The default is to start at the first slide in the talk.
116
117 =cut
118
119 my $splash = 1;
120
121 =item B<--no-splash>
122
123 Don't display the initial "splash" screen which advertises Tech Talk
124 PSE to your audience.  Just go straight into the talk.
125
126 =cut
127
128 my $verbose;
129
130 =item B<--verbose>
131
132 Display verbose messages, useful for debugging or tracing
133 what the program is doing.
134
135 =cut
136
137 my $version;
138
139 =item B<--version>
140
141 Display version number and exit.
142
143 =cut
144
145 my $mozembed;
146 my $mozembed_first;
147 my $mozembed_last;
148
149 GetOptions ("help|?" => \$help,
150             "last" => \$last,
151             "mozembed" => \$mozembed,
152             "mozembed-first" => \$mozembed_first,
153             "mozembed-last" => \$mozembed_last,
154             "n=s" => \$start,
155             "splash!" => \$splash,
156             "start=s" => \$start,
157             "verbose" => \$verbose,
158             "version" => \$version,
159     ) or pod2usage (2);
160
161 =back
162
163 =cut
164
165 pod2usage (1) if $help;
166 if ($version) {
167     print "@PACKAGE@ @VERSION@\n";
168     exit
169 }
170 die "techtalk-pse: cannot use --start and --last options together\n"
171     if defined $last && defined $start;
172
173 # Run with --mozembed: see below.
174 run_mozembed () if $mozembed;
175
176 # Normal run of the program.
177 die "techtalk-pse: too many arguments\n" if @ARGV >= 2;
178
179 # Get the true name of the program.
180 $0 = abs_path ($0);
181
182 # Locate the talk.
183 if (@ARGV > 0) {
184     my $d = $ARGV[0];
185     if (-d $d) {
186         chdir $d or die "techtalk-pse: chdir: $d: $!";
187     } else {
188         # XXX In future allow people to specify an archive and unpack
189         # it for them.
190         die "techtalk-pse: argument is not a directory"
191     }
192 }
193
194 # Get the talk directory and set environment variable $talkdir
195 # which is inherited by all the scripts.
196 my $talkdir = getcwd;
197 $ENV{talkdir} = $talkdir;
198
199 # Get the files.
200 my @files;
201 my %files;
202 sub reread_directory
203 {
204     @files = ();
205
206     my $i = 0;
207     foreach (glob ("*")) {
208         if (/^(\d+)(?:-.*)\.(html|sh)$/) {
209             print STDERR "reading $_\n" if $verbose;
210
211             my $seq = $1;
212             my $ext = $2;
213             warn "techtalk-pse: $_: command file is not executable (+x)\n"
214                 if $ext eq "sh" && ! -x $_;
215
216             my $h = { name => $_, seq => $1, ext => $2, i => $i };
217             push @files, $h;
218             $files{$_} = $h;
219             $i++;
220         } else {
221             print STDERR "ignoring $_\n" if $verbose;
222         }
223     }
224
225     if (@files > 0) {
226         $files[0]->{first} = 1;
227         $files[$#files]->{last} = 1;
228     }
229 }
230 reread_directory ();
231 print STDERR "read ", 0+@files, " files\n" if $verbose;
232 if (@files == 0) {
233     warn "techtalk-pse: no files found, continuing anyway ...\n"
234 }
235
236 # Work out what slide we're starting on.
237 my $current;
238 if (defined $current) {
239     die "start slide not implemented yet XXX"
240 }
241 elsif (@files) {
242     $current = $files[0];
243 }
244 # else $current is undefined
245
246 if ($splash) {
247     my $w = Gtk2::AboutDialog->new;
248     $w->set_authors ("Richard W.M. Jones");
249     $w->set_comments (
250         "Superior technical demonstration software\n"
251         );
252     $w->set_program_name ("Tech Talk Platinum Supreme Edition (PSE)");
253     $w->set_version ("@VERSION@");
254     $w->set_website ("http://people.redhat.com/~rjones");
255     $w->set_license ("GNU General Public License v2 or above");
256     $w->run;
257     print STDERR "calling \$w->destroy on about dialog\n" if $verbose;
258     $w->destroy;
259
260     # The dialog doesn't really get destroyed here.  We have
261     # to add this hack to really destroy it.
262     Glib::Idle->add (sub { Gtk2->main_quit; return FALSE; });
263     Gtk2->main;
264 }
265
266 MAIN: while (1) {
267     if (defined $current) {
268         my $go = show_slide ($current);
269         if (defined $go) {
270             print STDERR "go = $go\n" if $verbose;
271             last MAIN if $go eq "QUIT";
272
273             my $i = $current->{i};
274             print STDERR "i = $i\n" if $verbose;
275             $i-- if $go eq "PREV" && $i > 0;
276             $i++ if $go eq "NEXT" && $i+1 < @files;
277             $current = $files[$i];
278         }
279     } else {
280         print "No slides found.  Press any key to reload directory ...\n";
281         $_ = <STDIN>;
282     }
283
284     # Reread directory between slides.
285     reread_directory ();
286
287     if (defined $current && !exists $files{$current->{name}}) {
288         # Current slide was deleted.
289         undef $current;
290         $current = $files[0] if @files;
291     }
292 }
293
294 sub show_slide
295 {
296     my $slide = shift;
297
298     # Display an HTML page.
299     if ($slide->{ext} eq "html") {
300         # MozEmbed is incredibly crashy, so we run ourself as a
301         # subprocess, so when it segfaults we don't care.
302         my @cmd = ($0, "--mozembed");
303         push @cmd, "--mozembed-first" if exists $slide->{first};
304         push @cmd, "--mozembed-last" if exists $slide->{last};
305         my $url = "file://$talkdir/" . $slide->{name};
306         push @cmd, $url;
307         print STDERR "running subcommand: ", join (" ", @cmd), "\n"
308             if $verbose;
309         system (@cmd);
310         die "failed to execute subcommand: ", join(" ", @cmd), ": $!\n"
311             if $? == -1;
312         if ($? & 127) {
313             # Subcommand probably segfaulted, just continue to next slide.
314             return "NEXT";
315         } else {
316             my $r = $? >> 8;
317             if ($r == 0) {
318                 return "NEXT";
319             } elsif ($r == 1) {
320                 return "PREV";
321             } elsif ($r == 2) {
322                 return "QUIT";
323             }
324         }
325     }
326     # Run a shell command.
327     elsif ($slide->{ext} eq "sh") {
328         my $pid;
329         # http://docstore.mik.ua/orelly/perl/cookbook/ch10_17.htm
330         local *run_process = sub {
331             $pid = fork ();
332             die "fork: $!" unless defined $pid;
333             unless ($pid) {
334                 # Child.
335                 POSIX::setsid ();
336                 exec ("./".$slide->{name});
337                 die "failed to execute command: ", $slide->{name}, ": $!";
338             }
339             # Parent returns.
340         };
341         local *kill_process = sub {
342             print STDERR "sending TERM signal to process group $pid\n"
343                 if $verbose;
344             kill "TERM", -$pid;
345         };
346         run_process ();
347
348         my $r = "NEXT";
349
350         my $w = Gtk2::Window->new ();
351
352         my $s = $w->get_screen;
353         $w->set_default_size ($s->get_width, -1);
354         $w->move (0, 0);
355         $w->set_decorated (0);
356
357         my $bbox = Gtk2::HButtonBox->new ();
358         $bbox->set_layout ('start');
359
360         my $bnext = Gtk2::Button->new ("Next slide");
361         $bnext->signal_connect (clicked => sub { $r = "NEXT"; $w->destroy });
362         $bnext->set_sensitive (!(exists $slide->{last}));
363         $bbox->add ($bnext);
364
365         my $bback = Gtk2::Button->new ("Back");
366         $bback->signal_connect (clicked => sub { $r = "PREV"; $w->destroy });
367         $bback->set_sensitive (!(exists $slide->{first}));
368         $bbox->add ($bback);
369
370         my $brestart = Gtk2::Button->new ("Kill & restart");
371         $brestart->signal_connect (clicked => sub {
372             kill_process ();
373             run_process ();
374         });
375         $bbox->add ($brestart);
376
377         my $bquit = Gtk2::Button->new ("Quit");
378         $bquit->signal_connect (clicked => sub { $r = "QUIT"; $w->destroy });
379         $bbox->add ($bquit);
380         $bbox->set_child_secondary ($bquit, 1);
381
382         $w->add ($bbox);
383
384         $w->signal_connect (destroy => sub {
385             Gtk2->main_quit;
386             return FALSE;
387         });
388         $w->show_all ();
389
390         Gtk2->main;
391
392         kill_process ();
393         print STDERR "returning r=$r\n" if $verbose;
394         return $r;
395     }
396 }
397
398 # If invoked with the --mozembed parameter then we just display a
399 # single page.  This is just to prevent crashes in MozEmbed from
400 # killing the whole program.
401 sub run_mozembed
402 {
403     my $r = 0;
404
405     my $w = Gtk2::Window->new ();
406     my $vbox = Gtk2::VBox->new ();
407     my $moz = Gtk2::MozEmbed->new ();
408
409     my $bbox = Gtk2::HButtonBox->new ();
410     $bbox->set_layout ('start');
411
412     $vbox->pack_start ($bbox, 0, 0, 0);
413     $vbox->add ($moz);
414     $w->fullscreen ();
415     #$w->set_default_size (640, 480);
416     $w->add ($vbox);
417
418     my $bnext = Gtk2::Button->new ("Next slide");
419     $bnext->signal_connect (clicked => sub { $r = 0; $w->destroy });
420     $bnext->set_sensitive (!$mozembed_last);
421     $bbox->add ($bnext);
422
423     my $bback = Gtk2::Button->new ("Back");
424     $bback->signal_connect (clicked => sub { $r = 1; $w->destroy });
425     $bback->set_sensitive (!$mozembed_first);
426     $bbox->add ($bback);
427
428     my $bquit = Gtk2::Button->new ("Quit");
429     $bquit->signal_connect (clicked => sub { $r = 2; $w->destroy });
430     $bbox->add ($bquit);
431     $bbox->set_child_secondary ($bquit, 1);
432
433     $w->signal_connect (destroy => sub {
434         Gtk2->main_quit;
435         return FALSE;
436     });
437     $w->show_all ();
438
439     $moz->load_url ($ARGV[0]);
440     Gtk2->main;
441
442     exit $r;
443 }
444
445 1;
446
447 =head1 TUTORIAL
448
449 =head2 START WRITING A TALK
450
451 [Before you start writing your real talk, I urge you to read
452 L</WHAT MAKES A GOOD TALK> below].
453
454 To start your talk, all you have to do is to make a new directory
455 somewhere:
456
457  mkdir talk
458  cd talk
459
460 A tech talk consists of HTML files ("slides") and shell scripts.  The
461 filenames must start with a number, followed optionally by a
462 description, followed by the extension (C<.html> or C<.sh>).  So to
463 start our talk with two slides:
464
465  echo "This is the introduction" > 0010-introduction.html
466  echo "This is the second slide" > 0020-second.html
467
468 To run it, run the command from within the talk directory:
469
470  techtalk-pse
471
472 Any other file in the directory is ignored, so if you want to add
473 Makefiles, version control files etc, just go ahead.
474
475 =head2 TIPS FOR WRITING HTML
476
477 You may have your own techniques and tools for writing HTML, so
478 this section is just to share my ideas.  I start every
479 HTML file with a standard stylesheet and Javascript header:
480
481  <link rel="stylesheet" href="style.css" type="text/css"/>
482  <script src="code.js" type="text/javascript"></script>
483
484 That just ensures that I can put common styling instructions for all
485 my slides in a single file (C<style.css>), and I have one place where
486 I can add all Javascript, if I need to use any (C<code.js>).
487
488 =head3 BACKGROUNDS, FONTS AND LOGOS
489
490 To add a common background and font size to all slides, put this in
491 C<style.css>:
492
493  body {
494      font-size: 24pt;
495      background: url(background-image.jpg) no-repeat;
496  }
497
498 To add a logo in one corner:
499
500  body {
501      background: url(logo.jpg) top right no-repeat;
502  }
503
504 =head3 SCALING AND CENTERING
505
506 Scaling slide text and images so that they appear at the same
507 proportionate size for any screen resolution can be done using
508 Javascript.  (See
509 L<https://developer.mozilla.org/En/DOM/window.innerHeight>).
510
511 If you want to center text horizontally, use CSS, eg:
512
513  p.center {
514      text-align: center;
515  }
516
517 To center text vertically, CSS3 is supposed to offer a solution some
518 time, but while you're waiting for that try
519 L<http://www.w3.org/Style/Examples/007/center#vertical>.
520
521 =head3 PREVIEWING HTML
522
523 I find it helpful to have Firefox open to display the HTML files and
524 styles as I edit them.  Just start firefox in the talk directory:
525
526  firefox file://$(pwd) &
527
528 When you edit an HTML file, click the Firefox reload button to
529 immediately see your changes.
530
531 Tech Talk PSE uses Mozilla embedding to display HTML, which uses the
532 same Mozilla engine as Firefox, so what you should see in Firefox
533 should be identical to what Tech Talk PSE displays.
534
535 =head2 CREATING FIGURES
536
537 Use your favorite tool to draw the figure, convert it to an image (in
538 any format that the Mozilla engine can display) and include it using
539 an C<E<lt>imgE<gt>> tag, eg:
540
541  <img src="fig1.gif">
542
543 Suitable tools include: XFig, GnuPlot, GraphViz, and many TeX tools
544 such as PicTex and in particular TikZ.
545
546 =head2 EMBEDDING VIDEOS, ANIMATIONS, ETC.
547
548 Using HTML 5, embedding videos in the browser is easy.  See:
549 L<https://developer.mozilla.org/En/Using_audio_and_video_in_Firefox>
550
551 For animations, you could try L<Haxe|http://haxe.org/> which has a
552 Javascript back-end.  There are many other possibilities.
553
554 If you are B<sure> that the venue will have an internet connection,
555 why not embed a YouTube video.
556
557 =head2 DISPLAYING EXISTING WEB PAGES
558
559 Obviously you could just have an HTML file that contains a redirect to
560 the public web page:
561
562  <meta http-equiv="Refresh" content="0; url=http://www.example.com/">
563
564 However if you want your talk to work offline, then it's better to
565 download the web page in advance, eg. using Firefox's "Save Page As
566 -E<gt> Web Page, complete" feature, into the talk directory, then
567 either rename or make a symbolic link to the slide name:
568
569  ln -s "haXe - Welcome to haXe.html" 0010-haxe-homepage.html
570
571 =head2 TIPS FOR WRITING SHELL SCRIPTS
572
573 Make sure each C<*.sh> file you write is executable, otherwise Tech
574 Talk PSE won't be able to run it.  (The program gives a warning if you
575 forget this).
576
577 A good idea is to start each script by sourcing some common functions.
578 All my scripts start with:
579
580  #!/bin/bash -
581  source functions
582
583 where C<functions> is another file (ignored by Tech Talk PSE) which
584 contains common functions for setting shell history and starting a
585 terminal.
586
587 In C<functions>, I have:
588
589  # -*- shell-script -*-
590  export PS1="$ "
591  export HISTFILE=/tmp/history
592  rm -f $HISTFILE
593  
594  add_history ()
595  {
596      echo "$@" >> $HISTFILE
597  }
598  
599  terminal ()
600  {
601      exec \
602          gnome-terminal \
603          --window \
604          --geometry=+100+100 \
605          --hide-menubar \
606          --disable-factory \
607          -e '/bin/bash --norc' \
608          "$@"
609  }
610
611 By initializing the shell history, during your talk you can rapidly
612 recall commands to start parts of the demonstration just by hitting
613 the Up arrow.  A complete shell script from one of my talks would look
614 like this:
615
616  #!/bin/bash -
617  source functions
618  add_history guestfish -i debian.img
619  terminal --title="Examining a Debian guest image in guestfish"
620
621 This is just a starting point for your own scripts.  You may want to
622 use a different terminal, such as xterm, and you may want to adjust
623 terminal fonts.
624
625 =head1 REFERENCE
626
627 =head2 ORDER OF FILES
628
629 Tech Talk PSE displays the slides in the directory in lexicographic
630 order (the same order as C<LANG=C ls -1>).  Only files matching the
631 following regexp are considered:
632
633  ^(\d+)(?:-.*)\.(html|sh)$
634
635 For future compatibility, you should ensure that every slide has a
636 unique numeric part (ie. I<don't> have C<0010-aaa.html> and
637 C<0010-bbb.html>).  This is because in future we want to have the
638 ability to display multiple files side by side.
639
640 Also for future compatibility, I<don't> use file names that have an
641 uppercase letter immediately after the numeric part.  This is because
642 in future we want to allow placement hints using filenames like
643 C<0010L-on-the-left.html> and C<0010R-on-the-right.html>.
644
645 =head2 BASE URL AND CURRENT DIRECTORY
646
647 The base URL is set to the be the directory containing the talk files.
648 Thus you should use relative paths, eg:
649
650  <img src="fig1.gif">
651
652 You can also place assets into subdirectories, because subdirectories
653 are ignored by Tech Talk PSE, eg:
654
655  <img src="images/fig1.gif">
656
657 When running shell scripts, the current directory is also set to be
658 the directory containing the talk files, so the same rules about using
659 relative paths apply there too.
660
661 The environment variable C<$talkdir> is exported to scripts and it
662 contains the absolute path of the directory containing the talk files.
663 When a script is run, the current directory is the same as
664 C<$talkdir>, but if your script changes directory (eg. into a
665 subdirectory containing supporting files) then it can be useful to use
666 C<$talkdir> to refer back to the original directory.
667
668 =head1 WHAT MAKES A GOOD TALK
669
670 I like what Edward Tufte writes, for example his evisceration of
671 PowerPoint use at NASA here:
672 L<http://www.edwardtufte.com/bboard/q-and-a-fetch-msg?msg_id=0001yB>
673
674 However it is sometimes hard to translate his ideas into clear
675 presentations, and not all of that is the fault of the tools.  Here
676 are my thoughts and rules on how to deliver a good talk.
677
678 B<First, most important rule:> Before you start drawing any slides at
679 all, write your talk as a short essay.
680
681 This is the number one mistake that presenters make, and it is partly
682 a tool fault, because PowerPoint, OpenOffice, even Tech Talk PSE, all
683 open up on an initial blank slide, inviting you to write a title and
684 some bullet points.  If you start that way, you will end up using the
685 program as a kind of clumsy outlining tool, and then reading that
686 outline to your audience.  That's boring and a waste of time for you
687 and your audience.  (It would be quicker for them just to download the
688 talk and read it at home).
689
690 B<Secondly:> How long do you want to spend preparing the talk?  A good
691 talk, with a sound essay behind it, well thought out diagrams and
692 figures, and interesting demonstrations, takes many hours to prepare.
693 How many hours?  I would suggest thinking about how many hours of
694 effort your audience are putting in.  Even just 20 people sitting
695 there for half an hour is 10 man-hours of attention, and that is a
696 very small talk, and doesn't include all the extra time and hassle
697 that it took to get them all in one place.
698
699 I don't think you can get away with spending less than two full days
700 preparing a talk, if you want to master the topic and draw up accurate
701 slides.  Steve Jobs is reputed to spend weeks preparing his annual
702 sales talk to the Apple faithful.
703
704 B<Thirdly:> Now that you're going to write your talk as an essay, what
705 should go in the slides?  I would say that you should consider
706 delivering the essay, I<not> the slides, to people who don't make the
707 talk.  An essay can be turned into an article or blog posting, whereas
708 even "read-out-the-bullet-point" slides have a low information
709 density, large size, and end-user compatibility problems (*.pptx
710 anyone?).
711
712 What, then, goes on the slides?  Anything you cannot just say:
713 diagrams, graphs, videos, animations, and of course (only with Tech
714 Talk PSE!) demonstrations.
715
716 B<Lastly:> Once you've got your talk as an essay and slides, practice,
717 practice and practice again.  Deliver the talk to yourself in the
718 mirror, to your colleagues.  Practice going backwards and forwards
719 through the slides, using your actual laptop and the software so you
720 know what to click and what keys to press.  Partly memorize what you
721 are going to say (but use short notes written on paper if you need
722 to).
723
724 =head1 SEE ALSO
725
726 The Cognitive Style of PowerPoint, Tufte, Edward R.
727
728 =head1 AUTHOR
729
730 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
731
732 =head1 COPYRIGHT
733
734 Copyright (C) 2010 Red Hat Inc.
735
736 This program is free software; you can redistribute it and/or modify
737 it under the terms of the GNU General Public License as published by
738 the Free Software Foundation; either version 2 of the License, or
739 (at your option) any later version.
740
741 This program is distributed in the hope that it will be useful,
742 but WITHOUT ANY WARRANTY; without even the implied warranty of
743 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
744 GNU General Public License for more details.
745
746 You should have received a copy of the GNU General Public License
747 along with this program; if not, write to the Free Software
748 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.