1GraphViz2::Utils(3)   User Contributed Perl Documentation  GraphViz2::Utils(3)
2
3
4

NAME

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

Synopsis

9       See "Synopsis" in GraphViz2.
10
11       See scripts/generate.index.pl.
12
13       Note: scripts/generate.index.pl outputs to a directory called 'html' in
14       the 'current' directory.
15
16       See:
17       <http://savage.net.au/Perl-modules/html/graph.easy.marpa/index.html>.
18

Description

20       Some utils to simplify generation of the demo page.
21
22       It is not expected that end-users would ever need to use this module.
23

Distributions

25       This module is available as a Unix-style distro (*.tgz).
26
27       See <http://savage.net.au/Perl-modules/html/installing-a-module.html>
28       for help on unpacking and installing distros.
29

Installation

31       Install GraphViz2 as you would for any "Perl" module:
32
33       Run:
34
35               cpanm GraphViz2
36
37       or run:
38
39               sudo cpan GraphViz2
40
41       or unpack the distro, and then either:
42
43               perl Build.PL
44               ./Build
45               ./Build test
46               sudo ./Build install
47
48       or:
49
50               perl Makefile.PL
51               make (or dmake or nmake)
52               make test
53               make install
54

Constructor and Initialization

56   Calling new()
57       "new()" is called as "my($obj) = GraphViz2::Utils -> new(k1 => v1, k2
58       => v2, ...)".
59
60       It returns a new object of type "GraphViz2::Utils".
61
62       Key-value pairs accepted in the parameter list:
63
64       o (none)
65

Methods

67   generate_demo_environment()
68       Returns a hashref of OS, etc, values.
69
70       Keys are "left" and "right", to suit
71       "htdocs/assets/templates/graph/easy/marpa/fancy.table.tx".
72
73       "*.tx" files are used by Text::Xslate.
74
75       Called by "generate_demo_index()".
76
77   generate_demo_index()
78       Calls "get_files($dir_name, $type)" in GraphViz2::Filer and
79       "generate_demo_environment()".
80
81       Writes "html/index.html".
82
83       See scripts/generate.index.pl.
84

Thanks

86       Many thanks are due to the people who chose to make Graphviz
87       <http://www.graphviz.org/> Open Source.
88
89       And thanks to Leon Brocard <http://search.cpan.org/~lbrocard/>, who
90       wrote GraphViz, and kindly gave me co-maint of the module.
91

Version Numbers

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

Machine-Readable Change Log

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

Support

101       Email the author, or log a bug on RT:
102
103       <https://rt.cpan.org/Public/Dist/Display.html?Name=GraphViz2>.
104

Author

106       GraphViz2 was written by Ron Savage <ron@savage.net.au> in 2011.
107
108       Home page: <http://savage.net.au/index.html>.
109

111       Australian copyright (c) 2011, Ron Savage.
112
113               All Programs of mine are 'OSI Certified Open Source Software';
114               you can redistribute them and/or modify them under the terms of
115               The Perl License, a copy of which is available at:
116               http://dev.perl.org/licenses/
117
118
119
120perl v5.32.0                      2020-07-28               GraphViz2::Utils(3)
Impressum