| Subject: | Common misspelling on documentation |
I'm trying to package this module into Debian and lintian[1] complains
about lots of common misspelling:
[1] http://lintian.debian.org/tags/spelling-error-in-manpage.html
PATCH:
<diff>
--- a/bin/schema2example
+++ b/bin/schema2example
@@ -122,7 +122,7 @@
=item --show STRING
-A comma seperated list of comment components which should be included,
+A comma separated list of comment components which should be included,
by default C<ALL>. An empty string or C<NONE> will exclude all comments.
The STRING can also be a comma separated combination of C<struct>, C<type>,
C<occur>, and C<facets>.
--- a/lib/XML/Compile.pod
+++ b/lib/XML/Compile.pod
@@ -38,9 +38,9 @@
=item *
Imports and includes, as used in the schemas, are NOT performed
-automaticly. Schema's and such are NOT collected from internet
+automatically. Schema's and such are NOT collected from internet
dynamically; you have to call
L<XML::Compile::Schema::importDefinitions()|XML::Compile::Schema/"Administration">
-explictly with filenames of locally stored copies. Includes do only
+explicitly with filenames of locally stored copies. Includes do only
work if they have a targetNamespace defined, which is the same as that
of the schema it is included into.
--- a/lib/XML/Compile/FAQ.pod
+++ b/lib/XML/Compile/FAQ.pod
@@ -53,7 +53,7 @@
=head3 qualified elements
-One of the more noticable problems with schemas is the specification of
+One of the more noticeable problems with schemas is the specification of
the namespaces to be used for the schema. In older schema's, like many
important protocols, there was no way to specify whether elements should
be used qualified or not. Some schema's lack the target namespace
@@ -169,7 +169,7 @@
=head3 Example
This is a piece of code actually used. It shows various complications
-when an external schema is "loaded" "dynamically" into an other schema.
+when an external schema is "loaded" "dynamically" into another schema.
# In the top of your script
my $schema_dir = '/usr/share/schemas';
--- a/lib/XML/Compile/Iterator.pod
+++ b/lib/XML/Compile/Iterator.pod
@@ -25,13 +25,13 @@
=item XML::Compile::Iterator-E<gt>B<new>(NODE, PATH, FILTER,)
-The NODE is a XML::LibXML::Node object, of which the direct childs
+The NODE is a XML::LibXML::Node object, of which the direct children
are inspected.
The FILTER a CODE reference which is called for each child node.
-The only paramter is the parent NODE, and then it must return
+The only parameter is the parent NODE, and then it must return
either true or false. In case of true, the node is selected.
-The FILTERS is applied to all childs of the NODE once, when the
+The FILTERS is applied to all children of the NODE once, when the
first child is requested by the program.
=back
@@ -46,7 +46,7 @@
=item $obj-E<gt>B<node>()
-Returns the XML::LibXML::Node node of which the childs are walked
+Returns the XML::LibXML::Node node of which the children are walked
through.
=item $obj-E<gt>B<path>()
--- a/lib/XML/Compile/Schema.pod
+++ b/lib/XML/Compile/Schema.pod
@@ -68,7 +68,7 @@
print $type; # shows {myns}mytype
# using a compiled routines cache
- use XML::Compile::Cache; # seperate distribution
+ use XML::Compile::Cache; # separate distribution
my $schema = XML::Compile::Cache->new(...);
# Show which data-structure is expected
@@ -269,7 +269,7 @@
=item $obj-E<gt>B<addSchemas>(XML, OPTIONS)
Collect all the schemas defined in the XML data. The XML parameter
-must be a XML::LibXML node, therefore it is adviced to use
+must be a XML::LibXML node, therefore it is advised to use
L<importDefinitions()|XML::Compile::Schema/"Administration">, which has
a much more flexible way to
specify the data.
@@ -694,7 +694,7 @@
=item show_comments => STRING|'ALL'|'NONE'
-A comma seperated list of tokens, which explain what kind of comments need
+A comma separated list of tokens, which explain what kind of comments need
to be included in the output. The available tokens are: C<struct>,
C<type>,
C<occur>, C<facets>. A value of C<ALL> will select all available comments.
The C<NONE> or empty string will exclude all comments.
@@ -810,7 +810,7 @@
specify other resources for definitions. In the idea of the XML design
team, those files should be retrieved automatically via an internet
connection from the C<schemaLocation>. However, this is a bad concept; in
-XML::Compile modules you will have to explictly provide filenames on local
+XML::Compile modules you will have to explicitly provide filenames on local
disk using L<importDefinitions()|XML::Compile::Schema/"Administration">
or L<XML::Compile::WSDL11::addWSDL()|XML::Compile::WSDL11/"Extension">.
There are various reasons why I, the author of this module, think the
@@ -1455,7 +1455,7 @@
[improved with release 1.10]
The standard practice is to use the localName of the XML elements as
key in the Perl HASH; the key rewrite mechanism is used to change that,
-sometimes to seperate elements which have the same localName within
+sometimes to separate elements which have the same localName within
different name-spaces, or when an element and an attribute share a name
(key rewrite is applied to elements AND attributes) in other cases just
for fun or convenience.
--- a/lib/XML/Compile/Schema/NameSpaces.pod
+++ b/lib/XML/Compile/Schema/NameSpaces.pod
@@ -48,7 +48,7 @@
Lookup the definition for the specified KIND of definition: the name
of a global element, global attribute, attributeGroup or model group.
-The ADDRESS is constructed as C< {uri}name > or as seperate URI and NAME.
+The ADDRESS is constructed as C< {uri}name > or as separate URI and NAME.
-Option --Default
include_used <true>
@@ -62,12 +62,12 @@
=item $obj-E<gt>B<findID>(ADDRESS|(URI,ID))
Lookup the definition for the specified id, which is constructed as
-C< uri#id > or as seperate URI and ID.
+C< uri#id > or as separate URI and ID.
=item $obj-E<gt>B<findSgMembers>(CLASS, TYPE)
Lookup the substitutionGroup alternatives for a specific element, which
-is an TYPE (element full name) of form C< {uri}name > or as seperate
+is an TYPE (element full name) of form C< {uri}name > or as separate
URI and NAME. Returned is an ARRAY of HASHes, each describing one type
(as returned by L<find()|XML::Compile::Schema::NameSpaces/"Accessors">)
@@ -120,7 +120,7 @@
=item $obj-E<gt>B<schemas>(URI)
We need the name-space; when it is lacking then import must help, but that
-must be called explictly.
+must be called explicitly.
=item $obj-E<gt>B<use>(OBJECT)
--- a/lib/XML/Compile/Translate.pod
+++ b/lib/XML/Compile/Translate.pod
@@ -160,7 +160,7 @@
Checking whether the number of occurrences for an item are between
C<minOccurs> and C<maxOccurs> (implied for C<all>, C<sequence>, and
-C<choice> or explictly specified) takes time. Of course, in cases
+C<choice> or explicitly specified) takes time. Of course, in cases
errors must be handled. When this option is set to C<false>,
only distinction between single and array elements is made.
@@ -200,7 +200,7 @@
Per schema, it can be specified whether the elements and attributes
defined in-there need to be used qualified (with prefix) or not.
This can cause horrible output when within an unqualified schema
-elements are used from an other schema which is qualified.
+elements are used from another schema which is qualified.
The suggested solution in articles about the subject is to provide
people with both a schema which is qualified as one which is not.
@@ -245,7 +245,7 @@
, prefixes => \%namespaces
);
- # share the same namespace defs with an other component
+ # share the same namespace defs with another component
my $other = $schema->compile
( WRITER => ...
, prefixes => \%namespaces
@@ -348,7 +348,7 @@
sub want_block($$$$) ( my ($type,$ns,$local,$path) = @_; undef}
$schema->blockNamespace(\&want_block);
-It is very well posible that the blocking of some namespaces breaks the
+It is very well possible that the blocking of some namespaces breaks the
validness of messages: when those elements are required but set to be
ignored. There is no way to detect this, on the moment.
--- a/lib/XML/Compile/Translate/Reader.pod
+++ b/lib/XML/Compile/Translate/Reader.pod
@@ -277,7 +277,7 @@
=head3 Typemap to Object
-An other option is to implement an object factory: one object which creates
+Another option is to implement an object factory: one object which creates
other objects. In this case, the C<$xmltype> parameter can come of use,
to have one object spawning many different other objects.
</diff>