drupal-module/README.txt at master · multigraph/drupal-module · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
INTRODUCTION

This is the Multigraph project for Drupal.

Multigraph is an open-source tool for creating interactive data graphs
in web pages.  The current version of Multigraph is a Flash
application, but Multigraph uses a language-independent XML
specificaiton (called MUGL) to define the graphs it displays, and
future versions of Multigraph may be implemented using technologies
other than Flash.  Multigraph is independent of Drupal and is
available from www.multigraph.org.

This project contains two modules that facilitate the creation and
display of Multigraph graphs in a Drupal site:

 * The "Multigraph" module defines a new content type whose body
   contains the source XML, or MUGL, for a graph.  The normal view mode
   of a Multigraph node displays the graph itself, and the add/edit
   form displays the MUGL source code for the graph.

 * The "Multigraph Filter" module defines a text input filter that
   makes it easy to embed an interactive Multigraph into
   content anywhere on your Drupal site by writing tags such as:

     <multigraph width="500" height="200" src="/multigraph/mugl/5" />

   See MULTIGRAPH FILTER MARKUP TAGS below for complete details.


INSTALLATION

1. Unpack the distribution tar.gz file in your site's modules
   directory

2. Download the latest Multigraph distribution from
   www.multigraph.org, unpack it, and move the resulting directory
   into the 'multigraph' subdirectory of this 'multigraph' module
   directory.  The end result of this should be that there is a copy
   of the Multigraph distribution residing at a path such as the
   following:

       .../sites/all/modules/multigraph/multigraph/multigraph-3.3

   If you need to support multiple versions of Multigraph on your
   Drupal site, you can install multiple verions in the
   sites/all/modules/multigraph/multigraph directory.  The module
   will then give users the ability to choose which version
   of Multigraph is used for each graph.

   (Note: The only part of the Multigraph distribution that this
   Drupal module really needs is the Multigraph .swf file.  The module
   simply looks for all files matching the pattern Multigraph*.swf
   living anywhere inside the directory structure rooted at
   ...sites/all/modules/multigraph/multigraph.  So you may also just
   drop one or more Multigraph .swf files into that directory if you
   want.)

3. Enable the "Multigraph" and/or the "Multigraph Filter" modules for
   your site.  Each of these modules is independent of the other ---
   you may enable either one of them individually, or both at the same
   time.

MULTIGRAPH FILTER MARKUP TAGS

The Multigraph Filter module defines a 'Multigraph' text input filter
that lets you embed a Multigraph graph into any page (or any other
content where input filters are used) on your site by writing a simple
tag syntax such as:

    <multigraph width="500" height="200" src="/multigraph/mugl/5" />

The complete specification for this tag is:

    <multigraph
      width="WIDTH"
      height="HEIGHT"
      src="MUGL_LOCATION"
      nid="NID"
      swf="SWF" />

where:

    WIDTH = The pixel width of the graph. Required, unless NID is
        specified.


    HEIGHT = The pixel height of the graph. Required, unless NID is
        specified.

    SRC = a URL that returns the MUGL source for the graph.  This may
	be a relative URL from this site, or an absolute URL from
	another site.  Note that if this URL points to another site,
	that site needs to have a crossdomain policy file that allows
	requests from this site.

	Required, unless NID is specified.

    NID = Optional; the NID of a Multigraph node on this site.  This
	may be used to embed a reference to a Multigraph node on this
	site.  If a NID is specified, the SRC attribute should be
	omitted, and the WIDTH and HEIGHT attributes are optional
	(they will default to the width and height values associated
	with the referenced Multigraph node).

    SWF = Optional; the version of Multigraph to be used to display
	the graph.  If this is omitted, defaults to the most recent
	version found in the ...sites/all/modules/modules directory.
	If it is present, it should be the path to a Multigraph .swf
	file relative to ...sites/all/modules/modules.