sty2dtx (1feb11)

git-svn-id: svn://tug.org/texlive/trunk@21252 c570f23f-e606-0410-a88d-b1316a301751

2 files changed, 735 insertions, 79 deletions

diff --git a/Master/texmf-dist/doc/support/sty2dtx/README b/Master/texmf-dist/doc/support/sty2dtx/README
index 5ea1cc55a6c..99388299b5f 100644
--- a/Master/texmf-dist/doc/support/sty2dtx/README
+++ b/Master/texmf-dist/doc/support/sty2dtx/README
@@ -1,5 +1,5 @@
-Copyright (c) 2010-2011 Martin Scharrer <martin@scharrer-online.de>
-This is open source software under the GPL v3 or later.
+sty2dtx -- Converts a LaTeX .sty file to a documented .dtx file
+Version: v2.0 2011/01/31
 
 Converts a .sty file (LaTeX package) to .dtx format (documented LaTeX source),
 by surrounding macro definitions with 'macro' and 'macrocode' environments.
@@ -8,13 +8,23 @@ environemnt.
 Code lines outside macro definitions are wrapped only in 'macrocode'
 environments. Empty lines are removed.
 The script is not thought to be fool proof and 100% accurate but rather
-as a good start to convert undocumented style file to .dtx files.
-It does not generate a complete .dtx file, just the code section.
+as a good start to convert undocumented style files to .dtx files.
+
+
+Copyright (c) 2010-2011 Martin Scharrer <martin@scharrer-online.de>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
 
-Usage:
-   perl sty2dtx.pl infile [infile ...] outfile
-or
-   perl sty2dtx.pl < file.sty > file.dtx
+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 the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
 The following macro definitions are detected when they are at the start of a
@@ -28,5 +38,67 @@ line (can be prefixed by \global, \long, \protected and/or \outer):
   \providecommand\name   \providecommand*\name
   \@namedef{\name}       \@namedef\name
 
-The macro definition must either end at the same line or with a '}' on its own
-on a line.
+The following environment definitions are detected when they are at the start
+of a line:
+  \newenvironment{name}  \renewenvironemnt{name}  \provideenvironment{name}
+
+The macro and environment definition must either end at the same line or with
+a '}' on its own on a line.
+
+
+USAGE:
+
+sty2dtx.pl [<options>] [--<VAR>=<VALUE> ...] [--] [<infile> ...] [<outfile>]
+
+Files:
+  * can be '-' for STDIN or STDOUT, which is the default if no files are given
+  * multiple input files are merged to one output file
+
+Variables:
+  can be defined using --<VAR>=<VALUE> or --<VAR> <VALUE> and will be used for
+  substitutions in the template file.
+  Common variables:
+      author, email, maintainer, year (for copyright),
+      version, date, description (of package/class),
+      type (either 'package' default or 'class'),
+      filebase (automatically set from output or input file name),
+
+Options:
+  -h            : Print this help text
+  -H            : Print extended help
+  -V            : Print version and copyright
+  -v            : Be verbose
+  -o <output>   : Use given file as output
+  -O            : Overwrite already existing output file(s)
+  -B            : Use basename of single input file for output file
+  -I            : Also create .ins (install) file
+  -i <ins file> : Create .ins file with given name
+  -t <template> : Use this file as template instead of the default one
+  -T <template> : Use this file as template for the .ins file
+  -e <file>     : Export default .dtx template to file and exit
+  -E <file>     : Export default .ins template to file and exit
+  -D            : Use current date as file date
+  -F <file>     : Read more options and variables from file.
+                  Should contain one option or variable per line only.
+
+Examples:
+  Produce 'file.dtx' from 'file.sty':
+    sty2dtx.pl < file.sty > file.dtx
+   or
+    sty2dtx.pl file.sty file.dtx
+   or
+    sty2dtx.pl -B file.sty
+
+  Produce 'file.dtx' and 'file.ins' from 'file.sty':
+    sty2dtx.pl -I file.sty file.dtx
+   or
+    sty2dtx.pl file.sty -i file.sty file.dtx
+   or
+    sty2dtx.pl -IB file.sty
+
+  Set custom variable values:
+    sty2dtx.pl --author Me --email me@there.com mypkg.sty mypkg.dtx
+
+  Produce DTX file for a class:
+    sty2dtx.pl --type class mycls.sty mycls.dtx
+
diff --git a/Master/texmf-dist/scripts/sty2dtx/sty2dtx.pl b/Master/texmf-dist/scripts/sty2dtx/sty2dtx.pl
index 1823a84e811..f439ece2378 100755
--- a/Master/texmf-dist/scripts/sty2dtx/sty2dtx.pl
+++ b/Master/texmf-dist/scripts/sty2dtx/sty2dtx.pl
@@ -1,41 +1,133 @@
 #!/usr/bin/env perl
-################################################################################
-# Copyright (c) 2010-2011 Martin Scharrer <martin@scharrer-online.de>
-# This is open source software under the GPL v3 or later.
-#
-# Converts a .sty file (LaTeX package) to .dtx format (documented LaTeX source),
-# by surrounding macro definitions with 'macro' and 'macrocode' environments.
-# The macro name is automatically inserted as an argument to the 'macro'
-# environemnt.
-# Code lines outside macro definitions are wrapped only in 'macrocode'
-# environments. Empty lines are removed.
-# The script is not thought to be fool proof and 100% accurate but rather
-# as a good start to convert undocumented style file to .dtx files.
-#
-# Usage:
-#    perl sty2dtx.pl infile [infile ...] outfile
-# or
-#    perl sty2dtx.pl < file.sty > file.dtx
-#
-#
-# The following macro definitions are detected when they are at the start of a
-# line (can be prefixed by \global, \long, \protected and/or \outer):
-#   \def   \edef   \gdef   \xdef
-#   \newcommand{\name}     \newcommand*{\name}
-#   \newcommand\name       \newcommand*\name
-#   \renewcommand{\name}   \renewcommand*{\name}
-#   \renewcommand\name     \renewcommand*\name
-#   \providecommand{\name} \providecommand*{\name}
-#   \providecommand\name   \providecommand*\name
-#   \@namedef{\name}       \@namedef\name
-#
-# The macro definition must either end at the same line or with a '}' on its own
-# on a line.
-#
-# $Id: sty2dtx.pl 2091 2011-01-28 01:25:44Z martin $
-################################################################################
 use strict;
 use warnings;
+################################################################################
+# $Id: sty2dtx.pl 2114 2011-01-31 00:54:57Z martin $
+################################################################################
+my $COPYRIGHT = << 'EOT';
+  Copyright (c) 2010-2011 Martin Scharrer <martin@scharrer-online.de>
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  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 the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+EOT
+################################################################################
+my $DESCRIPTION = << 'EOT';
+  Converts a .sty file (LaTeX package) to .dtx format (documented LaTeX source),
+  by surrounding macro definitions with 'macro' and 'macrocode' environments.
+  The macro name is automatically inserted as an argument to the 'macro'
+  environemnt.
+  Code lines outside macro definitions are wrapped only in 'macrocode'
+  environments. Empty lines are removed.
+  The script is not thought to be fool proof and 100% accurate but rather
+  as a good start to convert undocumented style files to .dtx files.
+
+  Usage:
+     perl sty2dtx.pl infile [infile ...] outfile
+  or
+     perl sty2dtx.pl < file.sty > file.dtx
+
+
+  The following macro definitions are detected when they are at the start of a
+  line (can be prefixed by \global, \long, \protected and/or \outer):
+    \def   \edef   \gdef   \xdef
+    \newcommand{\name}     \newcommand*{\name}
+    \newcommand\name       \newcommand*\name
+    \renewcommand{\name}   \renewcommand*{\name}
+    \renewcommand\name     \renewcommand*\name
+    \providecommand{\name} \providecommand*{\name}
+    \providecommand\name   \providecommand*\name
+    \@namedef{\name}       \@namedef\name
+
+  The following environment definitions are detected when they are at the start
+  of a line:
+    \newenvironment{name}  \renewenvironemnt{name}  \provideenvironment{name}
+
+  The macro and environment definition must either end at the same line or with
+  a '}' on its own on a line.
+
+EOT
+################################################################################
+my $VERSION = "v2.0 " . substr('$Date: 2011-01-31 00:54:57 +0000 (Mon, 31 Jan 2011) $', 7, 10);
+$VERSION =~ tr/-/\//;
+my $TITLE = << "EOT";
+  sty2dtx -- Converts a LaTeX .sty file to a documented .dtx file
+  Version: $VERSION
+EOT
+
+sub usage {
+    print << "EOT";
+sty2dtx.pl [<options>] [--<VAR>=<VALUE> ...] [--] [<infile> ...] [<outfile>]
+Version: $VERSION
+EOT
+    print << 'EOT';
+Files:
+  * can be '-' for STDIN or STDOUT, which is the default if no files are given
+  * multiple input files are merged to one output file
+
+Variables:
+  can be defined using --<VAR>=<VALUE> or --<VAR> <VALUE> and will be used for
+  substitutions in the template file.
+  Common variables:
+      author, email, maintainer, year (for copyright),
+      version, date, description (of package/class),
+      type (either 'package' default or 'class'),
+      filebase (automatically set from output or input file name),
+
+Options:
+  -h            : Print this help text
+  -H            : Print extended help
+  -V            : Print version and copyright
+  -v            : Be verbose
+  -o <output>   : Use given file as output
+  -O            : Overwrite already existing output file(s)
+  -B            : Use basename of single input file for output file
+  -I            : Also create .ins (install) file
+  -i <ins file> : Create .ins file with given name
+  -t <template> : Use this file as template instead of the default one
+  -T <template> : Use this file as template for the .ins file
+  -e <file>     : Export default .dtx template to file and exit
+  -E <file>     : Export default .ins template to file and exit
+  -D            : Use current date as file date
+  -F <file>     : Read more options and variables from file.
+                  Should contain one option or variable per line only.
+
+Examples:
+  Produce 'file.dtx' from 'file.sty':
+    sty2dtx.pl < file.sty > file.dtx
+   or
+    sty2dtx.pl file.sty file.dtx
+   or
+    sty2dtx.pl -B file.sty
+
+  Produce 'file.dtx' and 'file.ins' from 'file.sty':
+    sty2dtx.pl -I file.sty file.dtx
+   or
+    sty2dtx.pl file.sty -i file.sty file.dtx
+   or
+    sty2dtx.pl -IB file.sty
+
+  Set custom variable values:
+    sty2dtx.pl --author Me --email me@there.com mypkg.sty mypkg.dtx
+
+  Produce DTX file for a class:
+    sty2dtx.pl --type class mycls.sty mycls.dtx
+
+EOT
+    exit (0);
+}
+
+my $ERROR = "sty2dtx: Error:";
 
 # Used as format string of printf so that the '%' must be doubled:
 my $macrostart = <<'EOT';
@@ -43,6 +135,23 @@ my $macrostart = <<'EOT';
 %%    \begin{macrocode}
 EOT
 
+my $environmentstart = <<'EOT';
+%% \begin{environment}{%s}
+%%    \begin{macrocode}
+EOT
+
+my $macrodescription = <<'EOT';
+%%
+%% \DescribeMacro{\%s}
+%%
+EOT
+
+my $envdescription = <<'EOT';
+%%
+%% \DescribeEnv{%s}
+%%
+EOT
+
 # Printed normally:
 my $macrostop = <<'EOT';
 %    \end{macrocode}
@@ -50,6 +159,12 @@ my $macrostop = <<'EOT';
 %
 EOT
 
+my $environmentstop = <<'EOT';
+%    \end{macrocode}
+% \end{environment}
+%
+EOT
+
 my $macrocodestart = <<'EOT';
 %    \begin{macrocode}
 EOT
@@ -59,15 +174,18 @@ my $macrocodestop = <<'EOT';
 %
 EOT
 
-my $mode = 0;
+my $USAGE = '';  # Store macro names for usage section
+my $IMPL  = '';   # Store implementation section
 
+my $mode = 0;
 # 0 = outside of macro or macrocode environments
 # 1 = inside macro environment
 # 2 = inside macrocode environment
 
 # RegExs for macro names and defintion:
-my $macroname = qr/[a-zA-Z\@:]+/;    # Add ':' for LaTeX3 style macros
-my $definition = qr/
+my $rmacroname = qr/[a-zA-Z\@:]+/;    # Add ':' for LaTeX3 style macros
+my $rusermacro = qr/[a-zA-Z]+/;       # Macros intended for users
+my $rmacrodef = qr/
     ^                                                        # Begin of line (no whitespaces!)
      (
        (?:(?:\\global|\\long|\\protected|\\outer)\s*)*       # Prefixes (maybe with whitespace between them)
@@ -77,42 +195,243 @@ my $definition = qr/
         | (?:new|renew|provide)command\s* \*? \s* {? \s* \\  # LaTeX definitions
         | \@namedef{?                                        # Definition by name only
      )
-     ($macroname)                                            # Macro name without backslash
+     ($rmacroname)                                           # Macro name without backslash
+     \s* }?                                                  # Potential closing brace
+     (.*)                                                    # Rest of line
+    /xms;
+
+my $renvdef = qr/
+    ^                                                        # Begin of line (no whitespaces!)
+     \\(
+        (?:new|renew|provide)environment\s* { \s*            # LaTeX definitions
+     )
+     ($rmacroname)                                           # Environment names follow same rules as macro names
+     \s* }                                                   # closing brace
      (.*)                                                    # Rest of line
     /xms;
 
+
+# Print end of environment, if one is open
+sub close_env {
+    if ( $mode == 1 ) {
+        # Happens only if closing brace is not on a line by its own.
+        $IMPL .= $macrostop;
+    }
+    elsif ( $mode == 2 ) {
+        $IMPL .= $macrocodestop;
+    }
+    elsif ( $mode == 3 ) {
+        $IMPL .= $environmentstop;
+    }
+}
+
+my ($mday,$mon,$year) = (localtime(time))[3..5];
+$mon = sprintf("%02d", $mon + 1);
+$year += 1900;
+
+my @files;
+my $outfile = '';
+my $verbose = 0;
+my $install = 0;
+my $usebase = 0;
+my $overwrite = 0;
+my $installfile;
+my $templfile;
+my $installtempl;
+my $checksum = 0;
+
+# Holds the variables for the templates, is initiated with default values:
+my %vars = (
+    type  => 'package',
+    class => 'ltxdoc',
+    year  => "$year",
+);
+
+# Handle options
+sub option {
+    my $opt = shift;
+    if ($opt eq 'h') {
+        usage();
+    }
+    elsif ($opt eq 'H') {
+        print $TITLE;
+        print "\n";
+        print $DESCRIPTION;
+        exit (0);
+    }
+    elsif ($opt eq 'B') {
+        $usebase = 1;
+    }
+    elsif ($opt eq 't') {
+        close (DATA);
+        $templfile = shift @ARGV;
+        open (DATA, '<', $templfile) or die "$ERROR Couldn't open template file '$templfile'\n";
+    }
+    elsif ($opt eq 'e') {
+        my $templ = shift @ARGV;
+        if ($templ ne '-') {
+            open (STDOUT, '>', $templ) or die "$ERROR Couldn't open new template file '$templ'\n";
+        }
+        while (<DATA>) {
+            last if /^__INS__$/;
+            print;
+        }
+        print STDERR "Exported default template for .dtx files to file '$templ'\n"
+            if $verbose;
+        exit (0);
+    }
+    elsif ($opt eq 'E') {
+        my $templ = shift @ARGV;
+        if ($templ ne '-') {
+            open (STDOUT, '>', $templ) or die "$ERROR Couldn't open new template file '$templ'\n";
+        }
+        while (<DATA>) {
+            last if /^__INS__$/;
+        }
+        while (<DATA>) {
+            print;
+        }
+        print STDERR "Exported default template for .ins files to file '$templ'\n"
+            if $verbose;
+        exit (0);
+    }
+    elsif ($opt eq 'v') {
+        $verbose ++;
+    }
+    elsif ($opt eq 'I') {
+        $install = 1;
+    }
+    elsif ($opt eq 'i') {
+        $installfile = shift @ARGV;
+        $install = 1;
+    }
+    elsif ($opt eq 'T') {
+        $installtempl = shift @ARGV;
+    }
+    elsif ($opt eq 'V') {
+        print $TITLE;
+        print "\n";
+        print $COPYRIGHT;
+        exit (0);
+    }
+    elsif ($opt eq 'F') {
+        my $optfile = shift @ARGV;
+        # Read more options and variables from file
+        open(my $OPT, '<', $optfile) or die ("Couldn't open options file '$optfile'!\n");
+        while (my $line = <$OPT>) {
+            chomp $line;
+            # Split variable lines without equal sign into name and value
+            if (substr($line, 0, 2) eq '--' and index($line, '=') == -1) {
+                my ($var, $val) = split (/\s+/, $line, 2);
+                $val =~ s/^["']|["']$//g;
+                unshift @ARGV, $var, $val;
+            }
+            else {
+                unshift @ARGV, $line;
+            }
+        }
+        close ($OPT);
+    }
+    elsif ($opt eq 'D') {
+        $vars{date} = "$year/$mon/$mday";
+    }
+    elsif ($opt eq 'o') {
+        $outfile = shift @ARGV;
+    }
+    elsif ($opt eq 'O') {
+        $overwrite = 1;
+    }
+    else {
+        print STDERR "sty2dtx: unknown option '-$opt'!\n";
+        exit (2);
+    }
+}
+
+# Count number of backslashes in code for file checksum
+sub addtochecksum {
+    my $line = shift;
+    $checksum += $line =~ tr{\\}{\\};
+}
+
+################################################################################
+# Parse arguments
+while (@ARGV) {
+    my $arg = shift;
+    # '--' Marks rest of arguments as files
+    if ($arg eq '--' ) {
+        push @files, @ARGV;
+        last;
+    }
+    # Options and variables
+    elsif ($arg =~ /^(-+)(.+)$/ ) {
+        my $dashes = $1;
+        my $name   = $2;
+        # Single dash => option
+        if (length($dashes) == 1) {
+            foreach my $opt (split //, $name) {
+                option($opt);
+            }
+        }
+        # Douple Dash => Variable
+        # Form "--var=value"
+        elsif ($name =~ /^([^=]+)=(.*)$/) {
+                $vars{lc($1)} = $2;
+        }
+        # Form "--var value"
+        else {
+            $vars{lc($name)} = shift;
+        }
+    }
+    # Files
+    else {
+        push @files, $arg;
+    }
+}
+
+
 # Last (but not only) argument is output file, except if it is '-' (=STDOUT)
-if (@ARGV > 1) {
-    my $outfile = pop;
-    if ($outfile ne '-') {
-        open (OUTPUT, '>', $outfile) or die ("Could not open output file '$outfile'!");
-        select OUTPUT;
+if ($outfile || @files > 1) {
+    $outfile = pop @files unless $outfile;
+    $vars{filebase} = substr($outfile, 0, rindex($outfile, '.')) if not exists $vars{filebase};
+}
+elsif (@files == 1) {
+    my $infile = $files[0];
+    $vars{filebase} = substr($infile, 0, rindex($infile, '.')) if not exists $vars{filebase};
+    if ($usebase) {
+        $outfile = $vars{filebase} . '.dtx';
     }
 }
+if ($outfile && $outfile ne '-') {
+    if (!$overwrite && -e $outfile && $outfile ne '/dev/null') {
+        die ("$ERROR output file '$outfile' does already exists! Use the -O option to overwrite.\n");
+    }
+    open (OUTPUT, '>', $outfile) or die ("$ERROR Could not open output file '$outfile'!");
+    select OUTPUT;
+}
+
 
+################################################################################
+# Read input files
+@ARGV = @files;
 while (<>) {
     # Test for macro definition command
-    if (/$definition/) {
+    if (/$rmacrodef/) {
         my $pre  = $1 || "";    # before command
         my $cmd  = $2;          # definition command
         my $name = $3;          # macro name
         my $rest = $4;          # rest of line
-        if ( $cmd =~ /command\*?{/ ) {
-            $rest =~ s/^}//;    # handle '\newcommand{\name}
-        }
 
-        # Print end of environment, if one is open
-        if ( $mode == 1 ) {
-            # Happens only if closing brace is not on a line by its own.
-            print $macrostop;
-        }
-        elsif ( $mode == 2 ) {
-            print $macrocodestop;
+        # Add to usage section if it is a user level macro
+        if ($name =~ /^$rusermacro$/i) {
+            $USAGE .= sprintf ($macrodescription, $name);
         }
 
+        close_env();
+
         # Print 'macro' environment with current line.
-        printf $macrostart, $name;
-        print $_;
+        $IMPL .= sprintf( $macrostart, $name );
+        addtochecksum($_);
+        $IMPL .= $_;
 
         # Inside macro mode
         $mode = 1;
@@ -121,14 +440,52 @@ while (<>) {
         # $pre is tested to handle '{\somecatcodechange\gdef\name{short}}' lines
         my $prenrest = $pre . $rest;
         if ( $prenrest =~ tr/{/{/ == $prenrest =~ tr/}/}/ ) {
-            print $macrostop;
+            $IMPL .= $macrostop;
+            # Outside mode
+            $mode = 0;
+        }
+    }
+    # Test for environment definition command
+    elsif (/$renvdef/) {
+        my $cmd  = $1;          # definition command
+        my $name = $2;          # macro name
+        my $rest = $3;          # rest of line
+
+        # Add to usage section if it is a user level environment
+        # Can use the same RegEx as for macro names
+        if ($name =~ /^$rusermacro$/i) {
+            $USAGE .= sprintf ($envdescription, $name);
+        }
+
+        close_env();
+
+        # Print 'environment' environment with current line.
+        $IMPL .= sprintf( $environmentstart, $name );
+        addtochecksum($_);
+        $IMPL .= $_;
+
+        # Inside environment mode
+        $mode = 3;
+
+        # Test for one line definitions.
+        my $nopen  = ($rest =~ tr/{/{/);
+        if ( $nopen >= 2 && $nopen == ($rest =~ tr/}/}/) ) {
+            $IMPL .= $environmentstop;
             # Outside mode
             $mode = 0;
         }
     }
-    # A single '}' on a line ends a 'macro' environment
+    # A single '}' on a line ends a 'macro' environment in macro mode
     elsif ($mode == 1 && /^}\s*$/) {
-        print $_, $macrostop;
+        addtochecksum($_);
+        $IMPL .= $_ . $macrostop;
+        $mode = 0;
+    }
+    # A single '}' on a line ends a 'environemnt' environment in environment
+    # mode
+    elsif ($mode == 3 && /^}\s*$/) {
+        addtochecksum($_);
+        $IMPL .= $_ . $environmentstop;
         $mode = 0;
     }
     # Remove empty lines (mostly between macros)
@@ -137,24 +494,251 @@ while (<>) {
     else {
         # If inside an environment
         if ($mode) {
-            print;
+            addtochecksum($_);
+            $IMPL .= $_;
         }
         else {
             # Start macrocode environment
-            print $macrocodestart, $_;
+            $IMPL .= $macrocodestart . $_;
+            addtochecksum($_);
             $mode = 2;
         }
     }
 }
 
-# Print end of environment, if one is open
-if ( $mode == 1 ) {
-    # Happens only if closing brace is not on a line by its own.
-    print $macrostop;
+close_env();
+
+################################################################################
+# Set extra/auto variables
+$vars{IMPLEMENTATION} = $IMPL;
+$vars{USAGE}      = $USAGE;
+$vars{type}       = "\L$vars{type}";
+$vars{Type}       = "\L\u$vars{type}";
+$vars{extension}  = $vars{type} eq 'class' ? 'cls' : 'sty';
+$vars{checksum}   = $checksum if not exists $vars{checksum}; # Allow user to overwrite
+$vars{maintainer} = $vars{author}
+    if not exists $vars{maintainer} and exists $vars{author};
+
+################################################################################
+# Write DTX file
+$vars{IMPLEMENTATION} = $IMPL;
+$vars{USAGE}          = $USAGE;
+$vars{type}           = "\L$vars{type}";
+$vars{Type}           = "\L\u$vars{type}";
+$vars{extension}      = $vars{type} eq 'class' ? 'cls' : 'sty';
+$vars{maintainer}     = $vars{author}
+    if not exists $vars{maintainer} and exists $vars{author};
+
+while (<DATA>) {
+    last if /^__INS__$/;
+    # Substitute template variables
+    s/<\+([^+]+)\+>\n?/exists $vars{$1} ? $vars{$1} : "<+$1+>"/eg;
+    print;
+}
+
+if ($verbose) {
+    print STDERR "Generated DTX file";
+    print STDERR " '$outfile'" if $outfile and $outfile ne '-';
+    print STDERR " using template '$templfile'" if $templfile;
+    print STDERR ".\n";
+}
+
+################################################################################
+# Write INS file if requested
+exit(0) unless $install;
+
+if ( ( !$outfile || $outfile eq '-' ) && !$installfile) {
+    print STDERR "Warning: Did not generate requested .ins file because main file\n";
+    print STDERR "         was written to STDOUT and no -i option was given.\n";
+    exit(1);
+}
+
+if ($installtempl) {
+    open (DATA, '<', $installtempl) or die "$ERROR Could't open template '$installtempl' for .ins file.";
+}
+$installfile = $vars{filebase} . '.ins' unless defined $installfile;
+if (!$overwrite && -e $installfile && $installfile ne '/dev/null') {
+    die ("$ERROR Output file '$installfile' does already exists! Use the -O option to overwrite.\n");
+}
+open (INS, '>', $installfile) or die "$ERROR Could't open new .ins file '$installfile'.";
+
+while (<DATA>) {
+    # Substitute template variables
+    s/<\+([^+]+)\+>\n?/exists $vars{$1} ? $vars{$1} : "<+$1+>"/eg;
+    print INS $_;
 }
-elsif ( $mode == 2 ) {
-    print $macrocodestop;
+
+if ($verbose) {
+    print STDERR "Generated INS file '$installfile'";
+    print STDERR " using template '$installtempl'" if $installtempl;
+    print STDERR ".\n";
 }
+################################################################################
+# The templates for the DTX file and INS file
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Adepted from the skeleton file provided by the 'dtxtut' (DTX tuturial).
+# The '<+var+>' format was choosen because it is used by the latex suite for Vim.
+# Therfore all variables which are not expanded are easily accessible to the
+# user using a certain feature in the latex suite.
+#
+__DATA__
+% \iffalse meta-comment
+%
+% Copyright (C) <+year+> by <+author+> <<+email+>>
+% ---------------------------------------------------------------------------
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3
+% of this license or (at your option) any later version.
+% The latest version of this license is in
+%   http://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
+%
+% This work has the LPPL maintenance status `maintained'.
+%
+% The Current Maintainer of this work is <+maintainer+>.
+%
+% This work consists of the files <+filebase+>.dtx and <+filebase+>.ins
+% and the derived filebase <+filebase+>.<+extension+>.
+%
+% \fi
+%
+% \iffalse
+%<*driver>
+\ProvidesFile{<+filebase+>.dtx}
+%</driver>
+%<<+type+>>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
+%<<+type+>>\Provides<+Type+>{<+filebase+>}
+%<*<+type+>>
+    [<+date+> <+version+> <+description+>]
+%</<+type+>>
+%
+%<*driver>
+\documentclass{ltxdoc}
+\usepackage{<+filebase+>}[<+date+>]
+\EnableCrossrefs
+\CodelineIndex
+\RecordChanges
+\begin{document}
+  \DocInput{<+filebase+>.dtx}
+  \PrintChanges
+  \PrintIndex
+\end{document}
+%</driver>
+% \fi
+%
+% \CheckSum{<+checksum+>}
+%
+% \CharacterTable
+%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
+%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
+%   Digits        \0\1\2\3\4\5\6\7\8\9
+%   Exclamation   \!     Double quote  \"     Hash (number) \#
+%   Dollar        \$     Percent       \%     Ampersand     \&
+%   Acute accent  \'     Left paren    \(     Right paren   \)
+%   Asterisk      \*     Plus          \+     Comma         \,
+%   Minus         \-     Point         \.     Solidus       \/
+%   Colon         \:     Semicolon     \;     Less than     \<
+%   Equals        \=     Greater than  \>     Question mark \?
+%   Commercial at \@     Left bracket  \[     Backslash     \\
+%   Right bracket \]     Circumflex    \^     Underscore    \_
+%   Grave accent  \`     Left brace    \{     Vertical bar  \|
+%   Right brace   \}     Tilde         \~}
+%
+%
+% \changes{<+version+>}{<+date+>}{Converted to DTX file}
+%
+% \DoNotIndex{\newcommand,\newenvironment}
+%
+% \providecommand*{\url}{\texttt}
+% \GetFileInfo{<+filebase+>.dtx}
+% \title{The \textsf{<+filebase+>} package}
+% \author{<+author+> \\ \url{<+email+>}}
+% \date{\fileversion~from \filedate}
+%
+% \maketitle
+%
+% \section{Introduction}
+%
+% Put text here.
+%
+% \section{Usage}
+%
+% Put text here.
+%
+<+USAGE+>
+%
+% \StopEventually{}
+%
+% \section{Implementation}
+%
+% \iffalse
+%<*<+type+>>
+% \fi
+%
+<+IMPLEMENTATION+>
+%
+% \iffalse
+%</<+type+>>
+% \fi
+%
+% \Finale
+\endinput
+__INS__
+%% Copyright (C) <+year+> by <+author+> <<+email+>>
+%% --------------------------------------------------------------------------
+%% This work may be distributed and/or modified under the
+%% conditions of the LaTeX Project Public License, either version 1.3
+%% of this license or (at your option) any later version.
+%% The latest version of this license is in
+%%   http://www.latex-project.org/lppl.txt
+%% and version 1.3 or later is part of all distributions of LaTeX
+%% version 2005/12/01 or later.
+%%
+%% This work has the LPPL maintenance status `maintained'.
+%%
+%% The Current Maintainer of this work is <+maintainer+>.
+%%
+%% This work consists of the files <+filebase+>.dtx and <+filebase+>.ins
+%% and the derived filebase <+filebase+>.<+extension+>.
+%%
+
+\input docstrip.tex
+\keepsilent
+
+\usedir{tex/latex/<+filebase+>}
+
+\preamble
+
+This is a generated file.
+
+Copyright (C) <+year+> by <+author+> <<+email+>>
+--------------------------------------------------------------------------
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3
+of this license or (at your option) any later version.
+The latest version of this license is in
+  http://www.latex-project.org/lppl.txt
+and version 1.3 or later is part of all distributions of LaTeX
+version 2005/12/01 or later.
+
+\endpreamble
+
+\generate{\file{<+filebase+>.<+extension+>}{\from{<+filebase+>.dtx}{<+type+>}}}
 
-__END__
+\obeyspaces
+\Msg{*************************************************************}
+\Msg{*                                                           *}
+\Msg{* To finish the installation you have to move the following *}
+\Msg{* file into a directory searched by TeX:                    *}
+\Msg{*                                                           *}
+\Msg{*     <+filebase+>.<+extension+>                                          *}
+\Msg{*                                                           *}
+\Msg{* To produce the documentation run the file <+filebase+>.dtx    *}
+\Msg{* through LaTeX.                                            *}
+\Msg{*                                                           *}
+\Msg{* Happy TeXing!                                             *}
+\Msg{*                                                           *}
+\Msg{*************************************************************}
 
+\endbatchfile