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
 147 GetOptions ("help|?" => \$help,
 148             "last" => \$last,
 149             "mozembed" => \$mozembed,
 150             "n=s" => \$start,
 151             "splash!" => \$splash,
 152             "start=s" => \$start,
 153             "verbose" => \$verbose,
 154             "version" => \$version,
 155     ) or pod2usage (2);
 156
 157 =back
 158
 159 =cut
 160
 161 pod2usage (1) if $help;
 162 if ($version) {
 163     print "@PACKAGE@ @VERSION@\n";
 164     exit
 165 }
 166 die "techtalk-pse: cannot use --start and --last options together\n"
 167     if defined $last && defined $start;
 168
 169 die "techtalk-pse: too many arguments\n" if !$mozembed && @ARGV >= 2;
 170
 171 # Get the true name of the program.
 172 $0 = abs_path ($0);
 173
 174 # Locate the talk.
 175 if (@ARGV > 0) {
 176     my $d = $ARGV[0];
 177     if (-d $d) {
 178         chdir $d or die "techtalk-pse: chdir: $d: $!";
 179     } else {
 180         # XXX In future allow people to specify an archive and unpack
 181         # it for them.
 182         die "techtalk-pse: argument is not a directory"
 183     }
 184 }
 185
 186 # Get the talk directory and set environment variable $talkdir
 187 # which is inherited by all the scripts.
 188 my $talkdir = getcwd;
 189 $ENV{talkdir} = $talkdir;
 190
 191 # Get the files.
 192 my @files;
 193 my %files;
 194 sub reread_directory
 195 {
 196     @files = ();
 197
 198     my $i = 0;
 199     foreach (glob ("*")) {
 200         if (/^(\d+)(?:-.*)\.(html|sh)$/) {
 201             print STDERR "reading $_\n" if $verbose;
 202
 203             my $seq = $1;
 204             my $ext = $2;
 205             warn "techtalk-pse: $_: command file is not executable (+x)\n"
 206                 if $ext eq "sh" && ! -x $_;
 207
 208             my $h = { name => $_, seq => $1, ext => $2, i => $i };
 209             push @files, $h;
 210             $files{$_} = $h;
 211             $i++;
 212         } else {
 213             print STDERR "ignoring $_\n" if $verbose;
 214         }
 215     }
 216
 217     if (@files > 0) {
 218         $files[0]->{first} = 1;
 219         $files[$#files]->{last} = 1;
 220     }
 221 }
 222 reread_directory ();
 223 print STDERR "read ", 0+@files, " files\n" if $verbose;
 224 if (@files == 0) {
 225     warn "techtalk-pse: no files found, continuing anyway ...\n"
 226 }
 227
 228 # Run with --mozembed: see below.
 229 run_mozembed () if $mozembed;
 230
 231 # Else, normal run of the program ...
 232
 233 # Work out what slide we're starting on.
 234 my $current;
 235 if (defined $current) {
 236     die "start slide not implemented yet XXX"
 237 }
 238 elsif (@files) {
 239     $current = $files[0];
 240 }
 241 # else $current is undefined
 242
 243 if ($splash) {
 244     my $w = Gtk2::AboutDialog->new;
 245     $w->set_authors ("Richard W.M. Jones");
 246     $w->set_comments (
 247         "Superior technical demonstration software\n"
 248         );
 249     $w->set_program_name ("Tech Talk Platinum Supreme Edition (PSE)");
 250     $w->set_version ("@VERSION@");
 251     $w->set_website ("http://people.redhat.com/~rjones");
 252     $w->set_license ("GNU General Public License v2 or above");
 253     $w->run;
 254     print STDERR "calling \$w->destroy on about dialog\n" if $verbose;
 255     $w->destroy;
 256
 257     # The dialog doesn't really get destroyed here.  We have
 258     # to add this hack to really destroy it.
 259     Glib::Idle->add (sub { Gtk2->main_quit; return FALSE; });
 260     Gtk2->main;
 261 }
 262
 263 MAIN: while (1) {
 264     if (defined $current) {
 265         my $go = show_slide ($current);
 266         if (defined $go) {
 267             print STDERR "go = $go\n" if $verbose;
 268             last MAIN if $go eq "QUIT";
 269
 270             my $i = $current->{i};
 271             print STDERR "i = $i\n" if $verbose;
 272             $i-- if $go eq "PREV" && $i > 0;
 273             $i++ if $go eq "NEXT" && $i+1 < @files;
 274             $i = 0 if $go eq "FIRST";
 275             $i = $#files if $go eq "LAST";
 276             $i = $1 if $go =~ /^I_(\d+)$/;
 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.  If all goes
 302         # well and it doesn't crash, it should print a line 'RESULT FOO'
 303         # where 'FOO' is the instruction (eg. 'NEXT', 'PREV', 'QUIT' etc).
 304         my @cmd = ($0, "--mozembed", $talkdir, $slide->{name});
 305         print STDERR "running subcommand: ", join (" ", @cmd), "\n"
 306             if $verbose;
 307         open CMD, "-|", @cmd
 308             or die "failed to execute subcommand: ", join(" ", @cmd), ": $!\n";
 309         my $r;
 310         while (<CMD>) {
 311             if (/^RESULT ([A-Z]+.*)/) {
 312                 $r = $1;
 313                 print STDERR "subcommand result: $r\n" if $verbose;
 314                 last;
 315             }
 316         }
 317         # No RESULT line?  Subcommand probably segfaulted, just
 318         # continue to next slide.
 319         $r ||= "NEXT";
 320         return $r;
 321     }
 322     # Run a shell command.
 323     elsif ($slide->{ext} eq "sh") {
 324         my $pid;
 325         # http://docstore.mik.ua/orelly/perl/cookbook/ch10_17.htm
 326         local *run_process = sub {
 327             $pid = fork ();
 328             die "fork: $!" unless defined $pid;
 329             unless ($pid) {
 330                 # Child.
 331                 POSIX::setsid ();
 332                 exec ("./".$slide->{name});
 333                 die "failed to execute command: ", $slide->{name}, ": $!";
 334             }
 335             # Parent returns.
 336         };
 337         local *kill_process = sub {
 338             print STDERR "sending TERM signal to process group $pid\n"
 339                 if $verbose;
 340             kill "TERM", -$pid;
 341         };
 342         run_process ();
 343
 344         my $r = "NEXT";
 345
 346         my $w = Gtk2::Window->new ();
 347
 348         my $s = $w->get_screen;
 349         $w->set_default_size ($s->get_width, -1);
 350         $w->move (0, 0);
 351         $w->set_decorated (0);
 352
 353         my $bbox =
 354             make_button_bar ((exists $slide->{first}),
 355                              (exists $slide->{last}),
 356                              sub { $r = $_[0]; $w->destroy },
 357                              restart => sub {
 358                                  kill_process ();
 359                                  run_process ();
 360                              },
 361             );
 362
 363         $w->add ($bbox);
 364
 365         $w->signal_connect (destroy => sub {
 366             Gtk2->main_quit;
 367             return FALSE;
 368         });
 369         $w->show_all ();
 370
 371         Gtk2->main;
 372
 373         kill_process ();
 374         print STDERR "returning r=$r\n" if $verbose;
 375         return $r;
 376     }
 377 }
 378
 379 # If invoked with the --mozembed parameter then we just display a
 380 # single page.  This is just to prevent crashes in MozEmbed from
 381 # killing the whole program.
 382 sub run_mozembed
 383 {
 384     my $w = Gtk2::Window->new ();
 385     my $vbox = Gtk2::VBox->new ();
 386     my $moz = Gtk2::MozEmbed->new ();
 387
 388     reread_directory ();
 389
 390     my $name = $ARGV[1];
 391     $current = $files{$name};
 392     my $url = "file://$talkdir/$name";
 393
 394     my $bbox =
 395         make_button_bar ($current->{first}, $current->{last},
 396                          sub { print "RESULT ", $_[0], "\n"; $w->destroy }
 397         );
 398
 399     $vbox->pack_start ($bbox, 0, 0, 0);
 400     $vbox->add ($moz);
 401     $w->fullscreen ();
 402     #$w->set_default_size (640, 480);
 403     $w->add ($vbox);
 404
 405     $w->signal_connect (destroy => sub {
 406         Gtk2->main_quit;
 407         return FALSE;
 408     });
 409     $w->show_all ();
 410
 411     $moz->load_url ($url);
 412
 413     Gtk2->main;
 414
 415     exit 0;
 416 }
 417
 418 # Make the standard button bar across the top of the page.
 419 sub make_button_bar
 420 {
 421     my $first = shift;
 422     my $last = shift;
 423     my $cb = shift;
 424     my %params = @_;
 425
 426     my $bbox = Gtk2::Toolbar->new ();
 427
 428     my $i = 0;
 429
 430     my $bnext = Gtk2::ToolButton->new (undef, "Next slide");
 431     $bnext->signal_connect (clicked => sub { &$cb ("NEXT") });
 432     $bnext->set_sensitive (!$last);
 433     $bbox->insert ($bnext, $i++);
 434
 435     my $bback = Gtk2::ToolButton->new (undef, "Back");
 436     $bback->signal_connect (clicked => sub { &$cb ("PREV") });
 437     $bback->set_sensitive (!$first);
 438     $bbox->insert ($bback, $i++);
 439
 440     if (exists $params{restart}) {
 441         $bbox->insert (Gtk2::SeparatorToolItem->new (), $i++);
 442
 443         my $brestart = Gtk2::ToolButton->new (undef, "Kill & restart");
 444         $brestart->signal_connect (clicked => $params{restart});
 445         $bbox->insert ($brestart, $i++);
 446     }
 447
 448     my $sep = Gtk2::SeparatorToolItem->new ();
 449     $sep->set_expand (TRUE);
 450     $sep->set_draw (FALSE);
 451     $bbox->insert ($sep, $i++);
 452
 453     my $optsmenu = Gtk2::Menu->new ();
 454
 455     my $bfirst = Gtk2::MenuItem->new ("First slide");
 456     $bfirst->signal_connect (activate => sub { \&$cb ("FIRST") });
 457     $bfirst->show ();
 458     $optsmenu->append ($bfirst);
 459
 460     my $blast = Gtk2::MenuItem->new ("Last slide");
 461     $blast->signal_connect (activate => sub { \&$cb ("LAST") });
 462     $blast->show ();
 463     $optsmenu->append ($blast);
 464
 465     my $slidesmenu = Gtk2::Menu->new ();
 466     foreach (@files) {
 467         my $item = Gtk2::MenuItem->new ($_->{name});
 468         my $index = $_->{i};
 469         $item->signal_connect (activate => sub { \&$cb ("I_$index") });
 470         $item->set_sensitive ($current->{i} != $index);
 471         $item->show ();
 472         $slidesmenu->append ($item);
 473     }
 474
 475     my $bslides = Gtk2::MenuItem->new ("Slides");
 476     $bslides->set_submenu ($slidesmenu);
 477     $bslides->show ();
 478     $optsmenu->append ($bslides);
 479
 480     my $sep2 = Gtk2::SeparatorMenuItem->new ();
 481     $sep2->show ();
 482     $optsmenu->append ($sep2);
 483
 484     my $bquit = Gtk2::MenuItem->new ("Quit");
 485     $bquit->signal_connect (activate => sub { \&$cb ("QUIT") });
 486     $bquit->show ();
 487     $optsmenu->append ($bquit);
 488
 489     my $boptions = Gtk2::MenuToolButton->new (undef, "Options");
 490     #$boptions->signal_connect (clicked =>
 491     #  sub { $optsmenu->popup (undef, undef, undef, undef, ?, ?) } );
 492     $bbox->insert ($boptions, $i++);
 493     $boptions->set_menu ($optsmenu);
 494
 495     return $bbox;
 496 }
 497
 498 1;
 499
 500 =head1 TUTORIAL
 501
 502 =head2 START WRITING A TALK
 503
 504 [Before you start writing your real talk, I urge you to read
 505 L</WHAT MAKES A GOOD TALK> below].
 506
 507 To start your talk, all you have to do is to make a new directory
 508 somewhere:
 509
 510  mkdir talk
 511  cd talk
 512
 513 A tech talk consists of HTML files ("slides") and shell scripts.  The
 514 filenames must start with a number, followed optionally by a
 515 description, followed by the extension (C<.html> or C<.sh>).  So to
 516 start our talk with two slides:
 517
 518  echo "This is the introduction" > 0010-introduction.html
 519  echo "This is the second slide" > 0020-second.html
 520
 521 To run it, run the command from within the talk directory:
 522
 523  techtalk-pse
 524
 525 Any other file in the directory is ignored, so if you want to add
 526 Makefiles, version control files etc, just go ahead.
 527
 528 =head2 TIPS FOR WRITING HTML
 529
 530 You may have your own techniques and tools for writing HTML, so
 531 this section is just to share my ideas.  I start every
 532 HTML file with a standard stylesheet and Javascript header:
 533
 534  <link rel="stylesheet" href="style.css" type="text/css"/>
 535  <script src="code.js" type="text/javascript"></script>
 536
 537 That just ensures that I can put common styling instructions for all
 538 my slides in a single file (C<style.css>), and I have one place where
 539 I can add all Javascript, if I need to use any (C<code.js>).
 540
 541 =head3 BACKGROUNDS, FONTS AND LOGOS
 542
 543 To add a common background and font size to all slides, put this in
 544 C<style.css>:
 545
 546  body {
 547      font-size: 24pt;
 548      background: url(background-image.jpg) no-repeat;
 549  }
 550
 551 To add a logo in one corner:
 552
 553  body {
 554      background: url(logo.jpg) top right no-repeat;
 555  }
 556
 557 =head3 SCALING AND CENTERING
 558
 559 Scaling slide text and images so that they appear at the same
 560 proportionate size for any screen resolution can be done using
 561 Javascript.  (See
 562 L<https://developer.mozilla.org/En/DOM/window.innerHeight>).
 563
 564 If you want to center text horizontally, use CSS, eg:
 565
 566  p.center {
 567      text-align: center;
 568  }
 569
 570 To center text vertically, CSS3 is supposed to offer a solution some
 571 time, but while you're waiting for that try
 572 L<http://www.w3.org/Style/Examples/007/center#vertical>.
 573
 574 =head3 PREVIEWING HTML
 575
 576 I find it helpful to have Firefox open to display the HTML files and
 577 styles as I edit them.  Just start firefox in the talk directory:
 578
 579  firefox file://$(pwd) &
 580
 581 When you edit an HTML file, click the Firefox reload button to
 582 immediately see your changes.
 583
 584 Tech Talk PSE uses Mozilla embedding to display HTML, which uses the
 585 same Mozilla engine as Firefox, so what you should see in Firefox
 586 should be identical to what Tech Talk PSE displays.
 587
 588 =head2 CREATING FIGURES
 589
 590 Use your favorite tool to draw the figure, convert it to an image (in
 591 any format that the Mozilla engine can display) and include it using
 592 an C<E<lt>imgE<gt>> tag, eg:
 593
 594  <img src="fig1.gif">
 595
 596 Suitable tools include: XFig, GnuPlot, GraphViz, and many TeX tools
 597 such as PicTex and in particular TikZ.
 598
 599 =head2 EMBEDDING VIDEOS, ANIMATIONS, ETC.
 600
 601 Using HTML 5, embedding videos in the browser is easy.  See:
 602 L<https://developer.mozilla.org/En/Using_audio_and_video_in_Firefox>
 603
 604 For animations, you could try L<Haxe|http://haxe.org/> which has a
 605 Javascript back-end.  There are many other possibilities.
 606
 607 If you are B<sure> that the venue will have an internet connection,
 608 why not embed a YouTube video.
 609
 610 =head2 DISPLAYING EXISTING WEB PAGES
 611
 612 Obviously you could just have an HTML file that contains a redirect to
 613 the public web page:
 614
 615  <meta http-equiv="Refresh" content="0; url=http://www.example.com/">
 616
 617 However if you want your talk to work offline, then it's better to
 618 download the web page in advance, eg. using Firefox's "Save Page As
 619 -E<gt> Web Page, complete" feature, into the talk directory, then
 620 either rename or make a symbolic link to the slide name:
 621
 622  ln -s "haXe - Welcome to haXe.html" 0010-haxe-homepage.html
 623
 624 =head2 TIPS FOR WRITING SHELL SCRIPTS
 625
 626 Make sure each C<*.sh> file you write is executable, otherwise Tech
 627 Talk PSE won't be able to run it.  (The program gives a warning if you
 628 forget this).
 629
 630 A good idea is to start each script by sourcing some common functions.
 631 All my scripts start with:
 632
 633  #!/bin/bash -
 634  source functions
 635
 636 where C<functions> is another file (ignored by Tech Talk PSE) which
 637 contains common functions for setting shell history and starting a
 638 terminal.
 639
 640 In C<functions>, I have:
 641
 642  # -*- shell-script -*-
 643
 644  # Place any local environment variables required in 'local'.
 645  if [ -f local ]; then source local; fi
 646
 647  export PS1="$ "
 648
 649  export HISTFILE=$talkdir/history
 650
 651  rm -f $HISTFILE
 652  touch $HISTFILE
 653
 654  add_history ()
 655  {
 656      echo "$@" >> $HISTFILE
 657  }
 658
 659  terminal ()
 660  {
 661      # Make $HISTFILE unwritable so the shell won't update it
 662      # when it exits.
 663      chmod -w $HISTFILE
 664
 665      # Run gnome-terminal.
 666      exec \
 667          gnome-terminal \
 668          --window \
 669          --geometry=+100+100 \
 670          --hide-menubar \
 671          --disable-factory \
 672          -e '/bin/bash --norc' \
 673          "$@"
 674  }
 675
 676 By initializing the shell history, during your talk you can rapidly
 677 recall commands to start parts of the demonstration just by hitting
 678 the Up arrow.  A complete shell script from one of my talks would look
 679 like this:
 680
 681  #!/bin/bash -
 682  source functions
 683  add_history guestfish -i debian.img
 684  terminal --title="Examining a Debian guest image in guestfish"
 685
 686 This is just a starting point for your own scripts.  You may want to
 687 use a different terminal, such as xterm, and you may want to adjust
 688 terminal fonts.
 689
 690 =head1 REFERENCE
 691
 692 =head2 ORDER OF FILES
 693
 694 Tech Talk PSE displays the slides in the directory in lexicographic
 695 order (the same order as C<LANG=C ls -1>).  Only files matching the
 696 following regexp are considered:
 697
 698  ^(\d+)(?:-.*)\.(html|sh)$
 699
 700 For future compatibility, you should ensure that every slide has a
 701 unique numeric part (ie. I<don't> have C<0010-aaa.html> and
 702 C<0010-bbb.html>).  This is because in future we want to have the
 703 ability to display multiple files side by side.
 704
 705 Also for future compatibility, I<don't> use file names that have an
 706 uppercase letter immediately after the numeric part.  This is because
 707 in future we want to allow placement hints using filenames like
 708 C<0010L-on-the-left.html> and C<0010R-on-the-right.html>.
 709
 710 =head2 BASE URL AND CURRENT DIRECTORY
 711
 712 The base URL is set to the be the directory containing the talk files.
 713 Thus you should use relative paths, eg:
 714
 715  <img src="fig1.gif">
 716
 717 You can also place assets into subdirectories, because subdirectories
 718 are ignored by Tech Talk PSE, eg:
 719
 720  <img src="images/fig1.gif">
 721
 722 When running shell scripts, the current directory is also set to be
 723 the directory containing the talk files, so the same rules about using
 724 relative paths apply there too.
 725
 726 The environment variable C<$talkdir> is exported to scripts and it
 727 contains the absolute path of the directory containing the talk files.
 728 When a script is run, the current directory is the same as
 729 C<$talkdir>, but if your script changes directory (eg. into a
 730 subdirectory containing supporting files) then it can be useful to use
 731 C<$talkdir> to refer back to the original directory.
 732
 733 =head1 WHAT MAKES A GOOD TALK
 734
 735 I like what Edward Tufte writes, for example his evisceration of
 736 PowerPoint use at NASA here:
 737 L<http://www.edwardtufte.com/bboard/q-and-a-fetch-msg?msg_id=0001yB>
 738
 739 However it is sometimes hard to translate his ideas into clear
 740 presentations, and not all of that is the fault of the tools.  Here
 741 are my thoughts and rules on how to deliver a good talk.
 742
 743 B<First, most important rule:> Before you start drawing any slides at
 744 all, write your talk as a short essay.
 745
 746 This is the number one mistake that presenters make, and it is partly
 747 a tool fault, because PowerPoint, OpenOffice, even Tech Talk PSE, all
 748 open up on an initial blank slide, inviting you to write a title and
 749 some bullet points.  If you start that way, you will end up using the
 750 program as a kind of clumsy outlining tool, and then reading that
 751 outline to your audience.  That's boring and a waste of time for you
 752 and your audience.  (It would be quicker for them just to download the
 753 talk and read it at home).
 754
 755 B<Secondly:> How long do you want to spend preparing the talk?  A good
 756 talk, with a sound essay behind it, well thought out diagrams and
 757 figures, and interesting demonstrations, takes many hours to prepare.
 758 How many hours?  I would suggest thinking about how many hours of
 759 effort your audience are putting in.  Even just 20 people sitting
 760 there for half an hour is 10 man-hours of attention, and that is a
 761 very small talk, and doesn't include all the extra time and hassle
 762 that it took to get them all in one place.
 763
 764 I don't think you can get away with spending less than two full days
 765 preparing a talk, if you want to master the topic and draw up accurate
 766 slides.  Steve Jobs is reputed to spend weeks preparing his annual
 767 sales talk to the Apple faithful.
 768
 769 B<Thirdly:> Now that you're going to write your talk as an essay, what
 770 should go in the slides?  I would say that you should consider
 771 delivering the essay, I<not> the slides, to people who don't make the
 772 talk.  An essay can be turned into an article or blog posting, whereas
 773 even "read-out-the-bullet-point" slides have a low information
 774 density, large size, and end-user compatibility problems (*.pptx
 775 anyone?).
 776
 777 What, then, goes on the slides?  Anything you cannot just say:
 778 diagrams, graphs, videos, animations, and of course (only with Tech
 779 Talk PSE!) demonstrations.
 780
 781 B<Lastly:> Once you've got your talk as an essay and slides, practice,
 782 practice and practice again.  Deliver the talk to yourself in the
 783 mirror, to your colleagues.  Practice going backwards and forwards
 784 through the slides, using your actual laptop and the software so you
 785 know what to click and what keys to press.  Partly memorize what you
 786 are going to say (but use short notes written on paper if you need
 787 to).
 788
 789 =head1 SEE ALSO
 790
 791 The Cognitive Style of PowerPoint, Tufte, Edward R.
 792
 793 =head1 AUTHOR
 794
 795 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 796
 797 =head1 COPYRIGHT
 798
 799 Copyright (C) 2010 Red Hat Inc.
 800
 801 This program is free software; you can redistribute it and/or modify
 802 it under the terms of the GNU General Public License as published by
 803 the Free Software Foundation; either version 2 of the License, or
 804 (at your option) any later version.
 805
 806 This program is distributed in the hope that it will be useful,
 807 but WITHOUT ANY WARRANTY; without even the implied warranty of
 808 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 809 GNU General Public License for more details.
 810
 811 You should have received a copy of the GNU General Public License
 812 along with this program; if not, write to the Free Software
 813 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.