#!/usr/bin/perl
#vim:et:ts=4:
# converts vim documentation to simple html
# Sirtaj Singh Kang (taj@kde.org)
# Wed Oct 8 01:15:48 EST 1997
# Edited and extended by Dion Nicolaas
# (version 2.0, 3.0, 3.1, 3.3, 3.3.1)
# Made into a CGI by Thorsten Maerz
# (version 3.2)
# New in version 2.0:
# - Added Windows NT date command
# - fixed ARGV bug
# - Let Vim do the HTMLizing, just add links afterwards (this adds syntax
# highlighting)
# Wed 27-09-2000
# New in version 3.0:
# - Use Perl date
# - Use lowercase html tags to work with vim 6.0
# - Match every keyword that appears in the text
# Tue 25-09-01
#
# New in version 3.1:
# - Option for HTML level
# - Do replace < and > when no HTML
# Thu 27-09-01
# New in version 3.2:
# - works as cgi script
# Thu 27-09-01
# New in version 3.3:
# - More nevermatch words
# - Remove modelines from files
# - improved Perl HTMLising
# Fri 28-09-01
# New in version 3.3.1:
# - use vims colorschemes (quickndirty)
use strict;
# set $isCGI to 1 to run as a cgi-script
my $isCGI = 1;
# Set this to your executable of Vim
#my $vimcmd = "d:/bin/vim/vim60/gvim.exe";
my $vimcmd = "vim";
# Set this to all words you don't want to match, in between **
my $nevermatch = "*is* *as* *end* *section* *various* *case* *put* *help* *starting* *go*";
# ======================================================================
# Nothing below this line should have to be changed.
# ======================================================================
my %syn;
my $CGIfilename;
my $CGIsearch;
my $CGIbasename;
if ($isCGI) {
use Fcntl;
use POSIX qw(tmpnam);
use CGI qw/:standard/;
($CGIbasename = $0) =~ s#.*/([^/]+)#$1#;
}
my $date = gmtime;
my %url = ();
my %file = ();
my $opt_htmlising = 2;
my $progID = "vim2html.pl 3.2";
sub readTagFile
{
my($tagfile) = @_;
my($tag, $file);
open(TAGS,"$tagfile") || die "can't read tags\n";
while (
s/
s/>/>/g;
/^(.*)\t(.*)\t/;
$tag = $1;
if ($isCGI) {
$file{$tag}= $2;
# $url{$tag} = "$tag";
$url{$tag} = " if (param('cs')) { $url{$tag} .= "?cs=".param('cs').'&'; } else { $url{$tag} .= '?'; } $url{$tag} .= "page=$file{$tag}#$tag\">$tag
}
else {
($file{$tag}= $2) =~ s/.txt$/.html/g;
$url{$tag} = "$tag";
}
}
close(TAGS);
}
sub vim2html
{
# viminfile is the original which will be munched by vim.
my ($viminfile) = @_;
my $infile;
$infile = "$viminfile.html";
if ($opt_htmlising < 2) {
open (IN, "$viminfile") or die "Can't read input file $viminfile: $?";
if ($isCGI) {
# try new temporary filenames until we get one that didn't already
# exist; the check should be unnecessary, but you can't be too careful
do { $infile = tmpnam() }
until sysopen(INTER, $infile, O_RDWR|O_CREAT|O_EXCL);
}
else {
open(INTER, ">$infile")
or die "Can't write intermediate file $infile: $?";
}
if ($opt_htmlising == 1) {
# write header
print INTER "
";";}
my ($example, $examplecount) = 0;
my $curly = 0;
# Create a "safe" file
while (
) { # Replace tabs with spaces (ts=8)
my $pos;
while (($pos = index($_, "\t")) != -1) {
$pos %= 8;
if ($pos == 8) { $pos = 0; }
my $padding = substr(" ", 0, 8 - $pos);
s/\t/$padding/;
}
s/
s/>/>/g;
if ($opt_htmlising == 1 || $isCGI) {
# bugs
# intro.txt:*CTRL-{char}*
# do syntax highlighting in Perl
s/^\<$//; # only <
s/^\<(\s)/ $1/; # leading <
s/\>$// unless /\</; # trailing >
s/(.*)~$/$syn{'Header'}$1$syn{'end'}/; # trailing ~
s/^[-=]+$/$syn{'SectionDelim'}$&$syn{'end'}/g; # ===== or ----
# dont highlight ^*word* : wouldnt be recognized as jump target later
s/ \*[^ *]*\*/$syn{'HyperTextEntry'}$&$syn{'end'}/g; # *Entry*
s/(?
s/(?
s/(?
s/(?
# multiline fails on usr_40.txt
#s/(?
#if (s/(?
#if ($curly) { s/[^}]*}/$&$syn{'end'}/g and $curly = 0; }
s/(?
s/(?
s/(?
s/(?
s/(?
s/(?
s/(?
s/^CTRL-./$syn{'Special'}$&$syn{'end'}/g;
s/\bN\b/$syn{'Special'}$&$syn{'end'}/g; # Not quite right
#s/"(.*)"/$&<\/b>/g; # bold "word"
}
print INTER $_;
}
if ($opt_htmlising == 1) {
# write footer
print INTER "
}
close(INTER);
}
else {
# execute
# gvim $viminfile -c "so $VIMRUNTIME/syntax/2html.vim" -c "wq" -c "q"
# to let vim do the HTMLizing
my $socmd;
if ($ENV{'OSTYPE'} =~ /linux/i) {
$socmd = "so \$VIMRUNTIME/syntax/2html.vim"
}
else {
$socmd = "\"so \$VIMRUNTIME/syntax/2html.vim\""
}
my (@args) = ($vimcmd, $viminfile, "-c", $socmd, "-c", "wq", "-c", "q");
print @args;
system(@args) == 0
or die "system @args failed: $?";
}
my $outfile;
open(IN, "$infile") || die "Couldn't read from $infile.\n";
($outfile = $infile) =~ s/.*\///g;
# infile is called .txt.html
$outfile =~ s/\.txt\.html$//g;
if ($isCGI) {
open(OUT, ">-");
}
else {
open(OUT, ">$outfile.html")
|| die "Couldn't write to $outfile.html.\n";
}
my $dontmatch = ""; # tags not to match in this paragraph
my $currentlabel = ""; # used to build $dontmatch
# Replace applicable parts
while (
# Change the title and add an H1
s/
VimDoc: $CGIfilename |
EOF
}
sub CGIEndHTML
{
$CGIsearch=param('search') || '';
my $color=param('cs');
print <
Automatically generated by $progID on $date