NAME

XML::CompareML - A processor for the CompareML markup language

VERSION

version 0.2.12

SYNOPSIS

    use XML::CompareML::HTML;

    my $converter =
        XML::CompareML::HTML->new(
            'input_filename' => "my-comparison.xml",
            'output_handle' => \*STDOUT,
        );

    $converter->process();

Or alternatively:

    use XML::CompareML::DocBook;

    my $converter =
        XML::CompareML::DocBook->new(
            'input_filename' => "my-comparison.xml",
            'output_handle' => \*STDOUT,
        );

    $converter->process();

VERSION

version 0.2.12

USAGE

The CompareML language is currently undocumented, but one can see an example for a document written it in the t/files/scm-comparison.xml example in the distribution.

To convert a CompareML document to HTML instantiate an XML::CompareML::HTML object, and pass it the filename as the input_filename named parameter, and a reference to the IO handle to output the result as the output_handle named parameter.

To convert a CompareML document to DocBook do the same procedure only using an XML:CompareML::DocBook object.

AUTHOR

Shlomi Fish, http://www.shlomifish.org/ .

BUGS

Please report any bugs or feature requests to bug-xml-compareml@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=XML::CompareML. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2005 Shlomi Fish, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as the MIT X11 license.

AUTHOR

Shlomi Fish <shlomif@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by Shlomi Fish.

This is free software, licensed under:

  The MIT (X11) License

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/xml-compareml/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc XML::CompareML

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

• MetaCPAN

  A modern, open-source CPAN search engine, useful to view POD in HTML format.

  https://metacpan.org/release/XML-CompareML

• Search CPAN

  The default CPAN search engine, useful to view POD in HTML format.

  http://search.cpan.org/dist/XML-CompareML

• RT: CPAN's Bug Tracker

  The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

  https://rt.cpan.org/Public/Dist/Display.html?Name=XML-CompareML

• AnnoCPAN

  The AnnoCPAN is a website that allows community annotations of Perl module documentation.

  http://annocpan.org/dist/XML-CompareML

• CPAN Ratings

  The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.

  http://cpanratings.perl.org/d/XML-CompareML

• CPANTS

  The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

  http://cpants.cpanauthors.org/dist/XML-CompareML

• CPAN Testers

  The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

  http://www.cpantesters.org/distro/X/XML-CompareML

• CPAN Testers Matrix

  The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

  http://matrix.cpantesters.org/?dist=XML-CompareML

• CPAN Testers Dependencies

  The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

  http://deps.cpantesters.org/?module=XML::CompareML

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-xml-compareml at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=XML-CompareML. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/shlomif/xml-compareml

  git clone git://github.com/shlomif/xml-compareml.git

cpanm XML::CompareML

perl -MCPAN -e shell
install XML::CompareML