Changeset 373

Timestamp:

06/01/08 23:30:31 (3 months ago)

Author:

ingy

Message:

v0.13

Files:

• trunk/src/ingy/Vroom/Changes (modified) (1 diff)
• trunk/src/ingy/Vroom/Makefile.PL (modified) (1 diff)
• trunk/src/ingy/Vroom/README (modified) (5 diffs)
• trunk/src/ingy/Vroom/lib/Vroom/Vroom.pm (modified) (14 diffs)

trunk/src/ingy/Vroom/Changes

@@ +1 @@
+---
+version: 0.13
+date:    Sun Jun  1 23:27:02 PDT 2008
+changes:
+- Support a .vroom/vimrc
+- Don't overwrite a .vimrc not created by vroom
+- Updated the docs
----
-version: 0.12

trunk/src/ingy/Vroom/Makefile.PL

@@ -7 +7 @@
-requires 'YAML::XS';
-requires 'Class::Field';
+requires 'File::HomeDir';
-
-install_script 'vroom';

trunk/src/ingy/Vroom/README

@@ -3 +3 @@
-
-SYNOPSIS
+        > mkdir MySlides    # Make a Directory for Your Slides
+        > cd MySlides       # Go In There
-        > vim slides.vroom  # Write Some Slides
-        > vroom --vroom     # Show Your Slides
@@ -20 +22 @@
-    exactly that.
-
-
-
-
-
+
+
+
+
+
+
+
-
-    Vroom takes advantage of Vim's syntax highlighting. It also lets you run
@@ -69 +74 @@
-        THE END
-
+    A line that starts with '==' is a header line. It will be centered.
+
+    Lines that begin with a '+' cause vroom to split the slide there,
+    causing an animation effect.
+
+CONFIGURATION OPTIONS
+    Each slide can have one or more configuration options. Options are a
+    comma separated list that follow the '----' header for a slide. Like
+    this:
+
+        ---- center
+        ---- html
+        ---- perl,i20
+        ---- config
+        ---- skip
+
+    skip
+        Ignore the following slide completely.
+
+    center
+        Center the contents of the slide.
+
+    i## 'i' followed by a number means to indent the contents by the number
+        of characters.
+
+    perl,ruby,python,js,yaml,make,html
+        Specifies that the slide is one of those syntaxen, and that the
+        appropriate file extension will be used, thus causing vim to syntax
+        highlight the slide.
+
+    config
+        The slide is really a yaml configuration. It will not be displayed
+        in the presentation, but will tell vroom what to do from that point
+        forward. You can use more than one config slide in your
+        "slides.vroom" file.
+
+    You can specify the following confguration options in a config slide:
+
+    title <text>
+        The title of your presentation.
+
+    height <number>
+        The number of lines in the terminal you plan to use when presenting
+        the show. Used for centering the content.
+
+    width <number>
+        The number of columns in the terminal you plan to use when
+        presenting the show. Used for centering the content.
+
+    list_indent <number>
+        Auto detect slides that have lists in them, and indent them by the
+        specified number of columns.
+
-KEY MAPPINGS
+    These are the standard key mappings specified in the local ".vimrc".
+
-    <SPACE>
-        Advance one slide.
@@ -79 +139 @@
-
-    <Q> Quit Vroom.
+
+CUSTOM CONFIGURATION
+    You can create a file called ".vroom/vimrc" in your home directory. If
+    vroom sees this file, it will append it onto every local ".vimrc" file
+    it creates.
+
+    Use this file to specify your own custom vim settings for all your vroom
+    presentations.
-
-NOTE
@@ -90 +158 @@
-
-AUTHOR
-ö
+ö
-
-COPYRIGHT
-ö
+ö
-
-    This program is free software; you can redistribute it and/or modify it

trunk/src/ingy/Vroom/lib/Vroom/Vroom.pm

@@ -7 +7 @@
-# use diagnostics;
-
-2
+3
-
-use IO::All;
@@ -13 +13 @@
-use Class::Field 'field', 'const';
-use Getopt::Long;
+use File::HomeDir;
+use Cwd;
-use Carp;
-
@@ -25 +27 @@
-    height => 24,
-    width => 80,
-
-
-
+
-
-sub new {
@@ -38 +38 @@
-    $self->getOptions;
-
-$self->cleanUp
+unlink(glob "0*")
-    return if $self->clean;
-
@@ -48 +48 @@
-sub getOptions {
-    my $self = shift;
+
+    die <<'...' if cwd eq File::HomeDir->my_home;
+
+Don't run vroom in your home directory.
+
+Create a new directory for your slides and run vroom from there.
+...
+
-    GetOptions(
-        "clean" => \$self->{clean},
@@ -56 +64 @@
-    do { delete $self->{$_} unless defined $self->{$_} }
-        for qw(clean input vroom);
-}
-
-sub cleanUp {
-    unlink(glob "0*");
-    unlink(".vimrc");
-}
-
@@ -147 +150 @@
-    for my $option (split /\s*,\s*/, $string) {
-        $config->{$1} = 1
-
+
+
+
+
+
-        $config->{indent} = $1
-            if $option =~ /i(\d+)/;
@@ -189 +196 @@
-    my $ext = 
-        $config->{perl} ? ".pl" :
+        $config->{js} ? ".js" :
-        $config->{python} ? ".py" :
-        $config->{ruby} ? ".rb" :
+        $config->{html} ? ".html" :
-        $config->{shell} ? ".sh" :
-        $config->{yaml} ? ".yaml" :
@@ -223 +232 @@
-sub writeVimrc {
-    my $self = shift;
+
+    my $home_vroom = File::HomeDir->my_home . "/.vroom/vimrc";
+    my $home_vimrc = -e $home_vroom ? io($home_vroom)->all : ''; 
+
+    die <<'...'
+The .vimrc in your current directory does not look like vroom created it.
+
+If you are sure it can be overwritten, please delete it yourself this one
+time, and rerun vroom. You should not get this message again.
+
+...
+    if -e '.vimrc' and io('.vimrc')->getline !~ /Vroom-\d\.\d\d/;
+
-    my $title = "%f         " . $self->config->{title};
-    $title =~ s/\s/_/g;
-    io(".vimrc")->print(<<"...");
+" This .vimrc file was created by Vroom-$VERSION
-map <SPACE> :n<CR>:<CR>gg
-map <BACKSPACE> :N<CR>:<CR>gg
@@ -234 +257 @@
-set laststatus=2
-set statusline=$title
+
+" Overrides from $home_vroom
+$home_vimrc
-...
-}
@@ -241 +267 @@
-}
-
+=encoding utf8
+
-=head1 NAME
-
@@ -247 +275 @@
-=head1 SYNOPSIS
-
+    > mkdir MySlides    # Make a Directory for Your Slides
+    > cd MySlides       # Go In There
-    > vim slides.vroom  # Write Some Slides
-    > vroom --vroom     # Show Your Slides
@@ -326 +356 @@
-    THE END
-
+A line that starts with '==' is a header line. It will be centered.
+
+Lines that begin with a '+' cause vroom to split the slide there,
+causing an animation effect.
+
+=head1 CONFIGURATION OPTIONS
+
+Each slide can have one or more configuration options. Options are
+a comma separated list that follow the '----' header for a slide.
+Like this:
+
+    ---- center
+    ---- html
+    ---- perl,i20
+    ---- config
+    ---- skip
+
+=over
+
+=item skip
+
+Ignore the following slide completely.
+
+=item center
+
+Center the contents of the slide.
+
+=item i##
+
+'i' followed by a number means to indent the contents by the number of
+characters.
+
+=item perl,ruby,python,js,yaml,make,html
+
+Specifies that the slide is one of those syntaxen, and that the
+appropriate file extension will be used, thus causing vim to syntax
+highlight the slide.
+
+=item config
+
+The slide is really a yaml configuration. It will not be displayed
+in the presentation, but will tell vroom what to do from that point
+forward. You can use more than one config slide in your
+C<slides.vroom> file.
+
+=back
+
+You can specify the following confguration options in a config slide:
+
+=over
+
+=item title <text>
+
+The title of your presentation.
+
+=item height <number>
+
+The number of lines in the terminal you plan to use when presenting the
+show. Used for centering the content.
+
+=item width <number>
+
+The number of columns in the terminal you plan to use when presenting
+the show. Used for centering the content.
+
+=item list_indent <number>
+
+Auto detect slides that have lists in them, and indent them by the
+specified number of columns.
+
+=back
+
-=head1 KEY MAPPINGS
-
+These are the standard key mappings specified in the local C<.vimrc>.
+
-=over
-
@@ -347 +451 @@
-
-=back
+
+=head1 CUSTOM CONFIGURATION
+
+You can create a file called C<.vroom/vimrc> in your home directory. If
+vroom sees this file, it will append it onto every local C<.vimrc> file
+it creates.
+
+Use this file to specify your own custom vim settings for all your vroom
+presentations.
-
-=head1 NOTE