Commits

Anonymous committed 4b8ea92

Removed the boilerplate.

  • Participants
  • Parent commits 5997cde

Comments (0)

Files changed (4)

File XML-GrammarBase/Changes

 Revision history for XML-GrammarBase
 
-0.01    Date/time
-        First version, released on an unsuspecting world.
+0.0.1    TODO - FILL IN
+         First version, released on an unsuspecting world.
 

File XML-GrammarBase/README

 XML-GrammarBase
 
-The README is used to introduce the module and provide instructions on
-how to install the module, any machine dependencies it may have (for
-example C compilers and installed libraries) and any other information
-that should be provided before the module is installed.
+This module provides a set of base classes for processors of various XML
+Grammars (commonly found under XML:: and especially XML::Grammar). It aims
+to provide the following functionality:
 
-A README file is required for CPAN modules since CPAN extracts the README
-file from a module distribution so that people browsing the archive
-can use it to get an idea of the module's uses. It is usually a good idea
-to provide version information here so that people can decide whether
-fixes for the module are worth downloading.
+1. Base functionality for validating an XML against a Relax NG schema.
 
+2. Support some XSLT converters from XML to XHTML, XSL-FO, etc.
+
+3. Support for converters from a prototype language that will in turn
+be converted to the XML. See for example:
+
+http://search.cpan.org/perldoc?XML::Grammar::Screenplay::FromProto
 
 INSTALLATION
 

File XML-GrammarBase/lib/XML/GrammarBase.pm

 
 =head1 NAME
 
-XML::GrammarBase - The great new XML::GrammarBase!
+XML::GrammarBase - Provide base classes for processors of specialized XML grammars.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.0.1
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.0.1';
 
 
 =head1 SYNOPSIS
 
-Quick summary of what the module does.
+    package XML::Grammar::MyGrammar::RelaxNG::Validate;
 
-Perhaps a little code snippet.
+    use Moose;
 
-    use XML::GrammarBase;
-
-    my $foo = XML::GrammarBase->new();
-    ...
-
-=head1 EXPORT
-
-A list of functions that can be exported.  You can delete this section
-if you don't export anything, such as for a purely object-oriented module.
+    extends(
+        "XML::Grammar::MyGrammar::Base",
+        "XML::GrammarBase::RelaxNG::Validate"
+    );
 
 =head1 FUNCTIONS
 
-=head2 function1
-
-=cut
-
-sub function1 {
-}
-
-=head2 function2
-
-=cut
-
-sub function2 {
-}
-
 =head1 AUTHOR
 
 Shlomi Fish, C<< <shlomif at cpan.org> >>
 
     perldoc XML::GrammarBase
 
-
 You can also look for information at:
 
 =over 4

File XML-GrammarBase/t/boilerplate.t

 }
 
 TODO: {
-  local $TODO = "Need to replace the boilerplate text";
+  # local $TODO = "Need to replace the boilerplate text";
 
   not_in_file_ok(README =>
     "The README is used..."       => qr/The README is used/,
   );
 
   module_boilerplate_ok('lib/XML/GrammarBase.pm');
-
-
 }