view doc/interpreter/doccheck/spellcheck @ 10791:3140cb7a05a1

Add spellchecker scripts for Octave and run spellcheck of documentation interpreter/doccheck: New directory for spelling/grammar scripts. interpreter/doccheck/README: Instructions for using scripts. interpreter/doccheck/spellcheck: Script to spellcheck a Texinfo file. interpreter/doccheck/aspell.conf: GNU Aspell configuration file for Octave documentation. interpreter/doccheck/aspell-octave.en.pws: Private Aspell dictionary. interpreter/doccheck/add_to_aspell_dict: Script to add new Octave-specific words to private Aspell dictionary. interpreter/octave.texi: New @nospell macro which forces Aspell to ignore the word marked by the macro. interpreter/mk_doc_cache.m: Skip new @nospell macro when building doc_cache.
author Rik <octave@nomad.inbox5.com>
date Sat, 17 Jul 2010 19:53:01 -0700
parents
children 0306e572c686
line wrap: on
line source

#!/usr/bin/perl -w

################################################################################
# File   : spellcheck
# Purpose: Spellcheck a single Texinfo file
#          written in Perl, rather than the shell, to be more portable to OS 
#          without good command lines such as Windows.
# Usage  : spellcheck FILENAME.texi
################################################################################
use File::Temp ":POSIX";

# Initialize variables
# Octave specific configuration file for Aspell
$aspell_conf = './doccheck/aspell.conf';

################################################################################
# Parse command line arguments
if (@ARGV != 1)
{
   die ("USAGE: spellcheck <filename.texi>\n",
        "       invoked from doc/interpreter directory\n");
}

################################################################################
# Run Aspell with Octave-specific configuration file.
# Avoid use of pipes and use temporary files for portability
$fname = shift(@ARGV);
$tmp_fname = &tmpnam();  # from File::Temp
system ("aspell --conf=$aspell_conf list < $fname > $tmp_fname");

if ($?)
{
   unlink ($tmp_fname);
   die ("Aspell command unsuccesful.  Cannot continue\n");
}

open (FH, "<$tmp_fname") or die "Unable to open misspelled words file: $tmp_fname\n";
while (<FH>) { $words{$_} = 1; }
close (FH);

# Print out sorted and uniquified list of misspelled words
print sort keys(%words);

################################################################################
# Clean up temporary files
unlink ($tmp_fname) or die "Unable to delete temporary file: $tmp_fname\n";