Ron Savage > MarpaX-Demo-StringParser-1.05 > MarpaX::Demo::StringParser::Utils

Download:
MarpaX-Demo-StringParser-1.05.tgz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.05   Source   Latest Release: MarpaX-Demo-StringParser-1.08

NAME ^

MarpaX::Demo::StringParser::Utils - Utils used by MarpaX::Demo::StringParser

Synopsis ^

See scripts/generate.index.pl.

Note: scripts/generate.index.pl outputs to a directory called 'html' in the 'current' directory.

See the demo page for sample output.

Description ^

Some utils to simplify testing.

End-users do not need to call the methods in this module.

Distributions ^

This module is available as a Unix-style distro (*.tgz).

See http://savage.net.au/Perl-modules/html/installing-a-module.html for help on unpacking and installing distros.

Installation ^

Install MarpaX::Demo::StringParser as you would for any Perl module:

Run:

        cpanm MarpaX::Demo::StringParser

or run:

        sudo cpan MarpaX::Demo::StringParser

or unpack the distro, and then either:

        perl Build.PL
        ./Build
        ./Build test
        sudo ./Build install

or:

        perl Makefile.PL
        make (or dmake or nmake)
        make test
        make install

Constructor and Initialization ^

Calling new()

new() is called as my($obj) = MarpaX::Demo::StringParser::Utils -> new(k1 => v1, k2 => v2, ...).

It returns a new object of type MarpaX::Demo::StringParser::Utils.

Key-value pairs accepted in the parameter list:

o (none)

Methods ^

generate_demo_environment()

Returns a hashref of OS, etc, values.

Keys are left and right, to suit htdocs/assets/templates/marpax/demo/stringparser/fancy.table.tx.

*.tx files are used by Text::Xslate.

Called by "generate_demo_index()".

generate_demo_index()

Calls "get_files($dir_name, $type)" in MarpaX::Demo::StringParser::Filer and "generate_demo_environment()".

Writes html/index.html.

See scripts/generate.index.pl.

Version Numbers ^

Version numbers < 1.00 represent development versions. From 1.00 up, they are production versions.

Machine-Readable Change Log ^

The file CHANGES was converted into Changelog.ini by Module::Metadata::Changes.

Support ^

Email the author, or log a bug on RT:

https://rt.cpan.org/Public/Dist/Display.html?Name=MarpaX::Demo::StringParser.

Author ^

MarpaX::Demo::StringParser was written by Ron Savage <ron@savage.net.au> in 2013.

Home page: http://savage.net.au/index.html.

Copyright ^

Australian copyright (c) 2013, Ron Savage.

        All Programs of mine are 'OSI Certified Open Source Software';
        you can redistribute them and/or modify them under the terms of
        The Artistic License, a copy of which is available at:
        http://www.opensource.org/licenses/index.html
syntax highlighting: