1XML_SPELLCHECK(1)     User Contributed Perl Documentation    XML_SPELLCHECK(1)
2
3
4

NAME

6       xml_spellcheck - spellcheck XML files
7

SYNOPSIS

9         xml_spellcheck [options] <files>
10

DESCRIPTION

12       xml_spellcheck lets you spell check the content of an XML file.  It
13       extracts the text (the content of elements and optionally of
14       attributes), call a spell checker on it and then recreates the XML
15       document.
16

OPTIONS

18       Note that all options can be abbreviated to the first letter
19
20       --conf <configuration_file>
21           Gets the options from a configuration file. NOT IMPLEMENTED YET.
22
23       --spellchecker <spellchecker>
24           The command to use for spell checking, including any option
25
26           By default "aspell -c" is used
27
28       --backup-extension <extension>
29           By default the original file is saved with a ".bak" extension. This
30           option changes the extension
31
32       --attributes
33           Spell check attribute content. By default attribute values are NOT
34           spell checked. NOT YET IMPLEMENTED
35
36       --exclude_elements <list_of_excluded_elements>
37           A list of elements that should not be spell checked
38
39       --include_elements <list_of_included_elements>
40           A list of elements that should be spell checked (by default all
41           elements are spell checked).
42
43           "--exclude_elements" and "--include_elements" are mutually
44           exclusive
45
46       --pretty_print <optional_pretty_print_style>
47           A pretty print style for the document, as defined in XML::Twig. If
48           the option is provided without a value then the "indented" style is
49           used
50
51       --version
52           Dislay the tool version and exit
53
54       --help
55           Display help message and exit
56
57       --man
58           Display longer help message and exit
59

EXAMPLES

BUGS

TODO

63       --conf option
64       --attribute option
65

PRE-REQUISITE

67       XML::Twig, Getopt::Long, Pod::Usage, File::Temp XML::Twig requires
68       XML::Parser.
69

SEE ALSO

71       XML::Twig
72
74       This program is Copyright 2003 by Michel Rodriguez
75
76       This program is free software; you can redistribute it and/or modify it
77       under the terms of the Perl Artistic License or the GNU General Public
78       License as published by the Free Software Foundation either version 2
79       of the License, or (at your option) any later version.
80
81       This program is distributed in the hope that it will be useful, but
82       WITHOUT ANY WARRANTY; without even the implied warranty of MER-
83       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
84       Public License for more details.
85
86       If you do not have a copy of the GNU General Public License write to
87       the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
88       USA.
89

AUTHOR

91       Michel Rodriguez <mirod@xmltwig.com>
92
93       xml_spellcheck is available at http://www.xmltwig.com/xmltwig/
94
95
96
97perl v5.16.3                      2012-05-17                 XML_SPELLCHECK(1)
Impressum