diff --git a/scripts/htdocs-helper/README.md b/scripts/htdocs-helper/README.md deleted file mode 100644 index 11e7df3cb5e..00000000000 --- a/scripts/htdocs-helper/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# JabRef helper tools - -## Helper scripts - -* [generate-htdocs-help-from-jabref-src-help](generate-htdocs-help-from-jabref-src-help) is a script generating the help files in `htdocs` based on the content from `src/main/resources/help` -* [validate-htdocs-syntax.pl](validate-htdocs-syntax.pl) is used for syntax checking of the `htdocs` repository. - -## Repository `htdocs` - -https://github.com/JabRef/htdocs is the git repository for the htdocs of http://jabref.sourceforge.net/. -It is uploaded manually to JabRef. - -`htdocs/images/es.png` and `us.png` are from the "Flag icons - http://www.famfamfam.com". -These icons are public domain, and as such are free for any use (attribution appreciated but not required). diff --git a/scripts/htdocs-helper/generate-htdocs-help-from-jabref-src-help.pl b/scripts/htdocs-helper/generate-htdocs-help-from-jabref-src-help.pl deleted file mode 100644 index aa8dda83f97..00000000000 --- a/scripts/htdocs-helper/generate-htdocs-help-from-jabref-src-help.pl +++ /dev/null @@ -1,302 +0,0 @@ -#!/usr/bin/perl -#requires: perl >= 5.10 - -#generate-htdocs-help-form-jabref-src-help.pl -#(c) 2012 Kolja Brix and Oliver Kopp - -#This scripts converts the help files -#from the source directory of JabRef (HELPDIR_JABREF) -#to help files for the web page (HELPDIR_WEB) - -#Start it from the root directory of your git repository. -# Windows: perl generate-htdocs-help-form-jabref-src-help.pl -#It will overwrite all help files in HELPDIR_WEB -#It will NOT delete files in HELPDIR_WEB which were removed in HELPDIR_JABREF - -#There are NO command line parameters - -#If you have newline issues at the generated files, -#adapt FORCE_WINDOWS_NEWLINES - - -#Error: -#Use of uninitialized value in concatenation (.) or string at generate-htdocs-help-from-jabref-src-help.pl line 174, <$infileH> line 138. -#Reason: -#A new language has been added to HELPDIR_JABREF, where no translation is contained in -#%translation_back_to_contents. Please add the language to there. - -use constant HELPDIR_JABREF => "../src/main/resources/help"; -use constant HELPDIR_WEB => "../../htdocs/help"; - -#0 for normal operationrequired -#1 for cygwin's perl -use constant FORCE_WINDOWS_NEWLINES => 0; - -#translations for "Back to contents" -our %translation_back_to_contents = ( - "da" => "Back to contents", - "de" => "Zurück zum Inhaltsverzeichnis", - "en" => "Back to contents", - "fr" => "Retour au contenu", - "in" => "Kembali ke Daftar Isi", - "ja" => "目次に戻る" -); - - -#build.xml for getting string replacements ${version} and ${year} -use constant BUILDXML => "../build.xml"; - -use warnings; -use strict; - -#enable "given/when" -use feature ":5.10"; - -sub handleDir; -sub handleFile; -sub loadPreferences; - -our $jabref_version; -our $jabref_year; -our $jabref_placeholder_version; -our $jabref_placeholder_year; - -loadPreferences(); - -#Debug call for a single file -#handleFile("../src/main/resources/help/About.html", "../../htdocs/help/About.php", "en"); -#exit; - - -# handle English -handleDir(HELPDIR_JABREF, HELPDIR_WEB, "en"); - -#handle other languages (contained in sub directories) - -my $helpdirJabRef; - -opendir($helpdirJabRef, HELPDIR_JABREF) or die $!; - -my $sourcedir; -my $targetdir; -my $lang; - -while (my $subdir = readdir($helpdirJabRef)) { - $sourcedir = HELPDIR_JABREF . "/$subdir"; - next unless (-d $sourcedir); - next if ($subdir =~ /\.\.?/); - - $targetdir = HELPDIR_WEB . "/$subdir"; - $lang = $subdir; - - handleDir($sourcedir, $targetdir, $lang); -} -close($helpdirJabRef); - -exit 0; - - - -# Parameters: -# sourcedir -# targetdir -# language -sub handleDir { - my $sourcedir = shift; - my $targetdir = shift; - my $lang = shift; - - print("Handling $sourcedir...\n"); - - if (!-d $targetdir) { - mkdir($targetdir); - } - - my $dh; - opendir($dh, $sourcedir) or die $!; - while (my $infilename = readdir($dh)) { - next unless ($infilename =~ /\.html$/); - my $outfilename = $infilename; - $outfilename =~ s/\.html/\.php/g; - my $sourcefilename = $sourcedir . "/" . $infilename; - my $targetfilename = $targetdir . "/" . $outfilename; - handleFile($sourcefilename, $targetfilename, $lang); - } - close($dh); -} - -# -# Parameters: -# infilename: source file (html) -# outfile: target file (php) -# lang: language (ISO-format) -# -sub handleFile { - my $infilename = shift; - my $outfilename = shift; - my $lang = shift; - - my $replace_placeholders = ($infilename =~ /About.html$/); - - #Debug output - #print("handleFile:\n$infilename\n$outfilename\n$lang\n$replace_placeholders\n\n"); - - open(my $infileH, "<", $infilename) or die "cannot open < $infilename: $!"; - my @infile = <$infileH>; - - my @outfile=(); - - # Determine title out of first h1 heading - my $title=""; - my $line; - foreach $line(@infile) { - if ($line =~ /\(.*)\<\/h1\>/) { - $title=$1; - if ($replace_placeholders) { - $title =~ s/$jabref_placeholder_version/$jabref_version/; - $title =~ s/$jabref_placeholder_year/$jabref_year/; - } - # title is found, go to the normal handling - last; - } - } - - #remove html tags from title - #even if is not allowed in h1 elements, JabRef doc uses that - $title =~ s#<(.|\n)*?>##g; - -#Following prefix does not work at sourceforge. -# -#We use php's header statement instead - - #add to the relative path to navigation|footer if help is non-english - my $pathaddition; - if ($lang eq 'en') { - $pathaddition = ""; - } else { - $pathaddition = "../"; - } - - my $navigationlink = $pathaddition . "../navigation.php"; - my $footerlink = $pathaddition . "../footer.php"; - - my $header=< - - - - - $title - - - - -
- - $translation_back_to_contents{$lang} - -HTML - - my $footer=< -
\n\n\n -HTML - - push(@outfile, $header); - - my $status=0; - # 0 out of html - # 1 in html - # 2 within basefont - - foreach $line(@infile) { - #Debug states - #print "$status / $line"; - - if ($status==0 && $line =~ /\/) { - $status=0; - } elsif ($status==1) { - #we may not transfer a "basefont" - if ($line =~ /\/) { - $status = 2; - } - } else { - if ($replace_placeholders) { - $line =~ s/$jabref_placeholder_version/$jabref_version/; - $line =~ s/$jabref_placeholder_year/$jabref_year/; - } - if (!($line =~ /href=\"http:\/\//)) { - #line does NOT contain a href to some http address - #we assume that line is NOT a reference to an external site - #replace "html" extension with "php" extension - #still allow links as "...html#part". - $line =~ s/href=\"([^\"]*)\.html/href=\"$1\.php/g; - } - push(@outfile, $line); - } - } elsif (($status==2) && ($line =~ /\/\>/)) { - #basefont ended, reset to "inhtml" - $status = 1; - } - } - - push(@outfile, $footer); - - open(OUTFILE,">$outfilename"); - - if (FORCE_WINDOWS_NEWLINES) { - foreach my $line (@outfile) { - $line =~ s/\r?\n|\r/\r\n/g; - } - } - - print OUTFILE @outfile; - - close(OUTFILE); - - close($infileH); -} - -#extracts info out of build.xml -# -# -# -# -sub loadPreferences { - open(my $buildXML, "<", BUILDXML) or die "cannot open < " . BUILDXML . ": $!"; - my @buildxml = <$buildXML>; - close($buildXML); - foreach my $line (@buildxml) { - #check for one-line property declaration name / value - if ($line =~ /property name="([^"]*)" value="([^"]*)"/) { - #copy value from value to local variable - #a non-hardcoded version using "eval" would also be possible - #the SLOC count would be equal to the count of the following (easier) given/when construct. - given($1) { - when ("jabref.version") { - $jabref_version = $2; - } - when ("jabref.year") { - $jabref_year = $2; - } - when ("jabref.placeholder.version") { - $jabref_placeholder_version = $2; - } - when ("jabref.placeholder.year") { - $jabref_placeholder_year = $2; - } - } - } - } -} \ No newline at end of file diff --git a/scripts/htdocs-helper/validate-htdocs-syntax.pl b/scripts/htdocs-helper/validate-htdocs-syntax.pl deleted file mode 100644 index 695d0400d08..00000000000 --- a/scripts/htdocs-helper/validate-htdocs-syntax.pl +++ /dev/null @@ -1,72 +0,0 @@ -#!/usr/bin/perl - -#validate-htdocs-syntax.pl -#(c) 2012 Oliver Kopp - -#This scripts validates the syntax of all files in the htdocs directory -#using tidy - -#This script requires "tidy". -#It was tested using cygwin's perl and cygwin's tidy. - -#Start it from the root directory of your git repository. -# Windows: perl validate-htdocs-syntax.pl - -#There are NO command line parameters - -#configuration: should there be a prompt after each error? -use constant WAITAFTEREACHERROR => 1; - - -#configuration: directory to check - -#online web site -use constant STARTDIR => "../../htdocs"; - -#single help -#use constant STARTDIR => "../../htdocs/help/ja"; - -#JabRef help -# never validates as no HTML head is used and no DOCTYPE is declared. -#use constant STARTDIR => "../src/main/resources/help/"; - - -use File::Find; -use strict; - -sub wait_for_keypress { - return unless WAITAFTEREACHERROR; - print "Press 'Return' to continue. (Enter \"exit\" to exit the whole process)\n"; - my $input = ; - exit 0 if $input =~ /exit/; -} - -sub verifyFile { - return unless -f; - #my $fullfilename = $File::Find::name; - my $filename = $_; - return unless ($filename =~ /(\.php)|(\.html)$/); - - #Debug output - #print "Checking $File::Find::name\n"; - - system("tidy", "-eq", "-utf8", "$filename"); - - if ($? == -1) { - print ("Failed to execute tidy."); - } elsif ($? & 127) { - printf "child died with signal %d, %s coredump\n", - ($? & 127), ($? & 128) ? 'with' : 'without'; - } elsif ($? != 0) { - #some error occured - - # html/php line offset is 11. I.e., if tidy outputs "276", the line in the .html is "265" - print "Above file was $File::Find::name and has errors\n\n"; - wait_for_keypress; - } -} - -#Debug call -#find(\&verifyFile, ("htdocs/contact.php")); - -find(\&verifyFile, (STARTDIR));