GraphViz2::Marpa::Demo

Table of contents

NAME
Synopsis
Description
Distributions
Installation
Constructor and Initialization
Calling new()
Methods
generate_demo_environment()
generate_demo_index()
get_files($dir_name, $type)
justify($string)
Machine-Readable Change Log
Version Numbers
Repository
Support
Author
Copyright

NAME

GraphViz2::Marpa::Demo - A demo page generator for GraphViz2::Marpa

Synopsis

See "Synopsis" in GraphViz2::Marpa.

Description

GraphViz2::Marpa provides a Marpa-based parser for Graphviz dot files, and this module helps generate the demo page.

This module is really only of interest to the author.

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::Marpa as you would for any Perl module:

Run:

        cpanm GraphViz2::Marpa

or run:

        sudo cpan GraphViz2::Marpa

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

It returns a new object of type GraphViz2::Marpa::Demo.

Key-value pairs accepted in the parameter list:

o authortest => $Boolean

This allows generate.demo.pl to control whether it's processing data/ ot xt/author/data/.

Methods

generate_demo_environment()

Called by generate_demo_index().

Generates a table to be inserted into html/index.html.

See scripts/generate.demo.pl.

generate_demo_index()

Generates html/index.html.

Does not run any programs to generate other files, e.g. html/*.svg. See scripts/generate.demo.sh for that.

get_files($dir_name, $type)

Returns a sorted list of files of type (extension) $type from directory $dir_name.

justify($string)

Right justify the $string in a field of 20 spaces.

Machine-Readable Change Log

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

Version Numbers

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

Repository

https://github.com/ronsavage/GraphViz2-Marpa

Support

Email the author, or log a bug on RT:

https://rt.cpan.org/Public/Dist/Display.html?Name=GraphViz2::Marpa.

Author

GraphViz2::Marpa was written by Ron Savage in 2012.

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

Copyright

Australian copyright © 2012, 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/