NAME

GraphViz2::Utils - Some utils to generate the demo page

Synopsis

See "Synopsis" in GraphViz2.

See scripts/generate.index.pl.

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

See: http://savage.net.au/Perl-modules/html/graph.easy.marpa/index.html.

Description

Some utils to simplify generation of the demo page.

It is not expected that end-users would ever need to use 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 GraphViz2 as you would for any Perl module:

Run:

        cpanm GraphViz2

or run:

        sudo cpan GraphViz2

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) = GraphViz2::Utils -> new(k1 => v1, k2 => v2, ...).

It returns a new object of type GraphViz2::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/graph/easy/marpa/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 GraphViz2::Filer and "generate_demo_environment()".

Writes html/index.html.

See scripts/generate.index.pl.

Thanks

Many thanks are due to the people who chose to make Graphviz Open Source.

And thanks to Leon Brocard, who wrote GraphViz, and kindly gave me co-maint of the module.

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=GraphViz2.

Author

GraphViz2 was written by Ron Savage <ron@savage.net.au> in 2011.

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

Copyright

Australian copyright (c) 2011, 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 Perl License, a copy of which is available at:
        http://dev.perl.org/licenses/

cpanm GraphViz2

perl -MCPAN -e shell
install GraphViz2