DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:rrdgraph

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Both sides next revision
plugin:rrdgraph [2016-01-23 17:02]
62.216.218.122
plugin:rrdgraph [2021-01-23 14:24] (current)
Flash-Systems
Line 5: Line 5:
 author     : Daniel Goß author     : Daniel Goß
 email      : developer@flashsystems.de email      : developer@flashsystems.de
-type       : syntax, action, admin, helper, render +type       : syntax, action, helper, render 
-lastupdate : 2016-01-23 +lastupdate : 2019-01-12 
-compatible : Ponder StibbonsHrunDetritus++compatible : DetritusElenor Of TsortFrusterick Manners, Greebo+
 screenshot_img : http://www.flashsystems.de/wp-content/uploads/rrdgraph.png screenshot_img : http://www.flashsystems.de/wp-content/uploads/rrdgraph.png
 tags       : rrd, rrdtool, images, graphs tags       : rrd, rrdtool, images, graphs
  
-downloadurl: https://github.com/FlashSystems/rrdgraph/archive/r4.zip+downloadurl: https://github.com/FlashSystems/rrdgraph/archive/r7.zip
 bugtracker : https://github.com/FlashSystems/rrdgraph/issues bugtracker : https://github.com/FlashSystems/rrdgraph/issues
 sourcerepo : https://github.com/FlashSystems/rrdgraph sourcerepo : https://github.com/FlashSystems/rrdgraph
 ---- ----
 +
 +
 +:!: **This Plugin is no longer maintained. If you want to take over maintaining it go ahead and contact me. ** :!:
  
 ===== Installation ===== ===== Installation =====
 :!: **Important Warning:** The RRDgraph plugin uses the cache to store the generated images and the recipes. Please make sure you have a [[https://www.dokuwiki.org/tips:maintenance|maintenance task]] in place to avoid filling your DokuWiki cache directory with useless junk! :!: **Important Warning:** The RRDgraph plugin uses the cache to store the generated images and the recipes. Please make sure you have a [[https://www.dokuwiki.org/tips:maintenance|maintenance task]] in place to avoid filling your DokuWiki cache directory with useless junk!
  
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest release version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually
 + 
 +==== Prerequisites ==== 
 +To use this plugin your PHP installation must have been compiled with __GD support__ and the __rrd extension__ must be installed and activated. Regarding GD support also see [[tips:phpwithgd|PHP with GD]] for more information. 
 + 
 +If one of these prerequisites is not met the RRDgraph plugin will display an error message at the top of each wiki page.
  
 ===== Introduction ===== ===== Introduction =====
Line 74: Line 82:
 OPT:h=100 OPT:h=100
 LINE:1#FF0000 LINE:1#FF0000
-</ttd>+</rrd>
 </code> </code>
  
Line 185: Line 193:
 | ''false'' | Always contains a false value. | | ''false'' | Always contains a false value. |
 | ''fullscreen'' | Contains true if the graph was clicked and is shown full screen. If the graph is shown embedded within a DokuWiki page this value contains false. | | ''fullscreen'' | Contains true if the graph was clicked and is shown full screen. If the graph is shown embedded within a DokuWiki page this value contains false. |
-| ''range'' | Contains the nummeric index of the tab that was clicked. Conting starts with the left tab at 0. |+| ''range'' | Contains the nummeric index of the tab that was clicked. Counting starts with the left tab at 0. |
 | ''page'' | Contains the DokuWiki page id of the current wiki page. | | ''page'' | Contains the DokuWiki page id of the current wiki page. |
  
Line 205: Line 213:
  
 === Preparing the SVG file === === Preparing the SVG file ===
-SVG files are XML documents. They contain XML tags specifying what the web-browser should draw on the screen. One too to easily create SVG files is [[https://inkscape.org/de/|inkscape]].+SVG files are XML documents. They contain XML tags specifying what the web-browser should draw on the screen. One tool to easily create SVG files is [[https://inkscape.org/de/|inkscape]].
  
 To allow SVG binding the XML syntax of an SVG file is extended with the non standard ''bind'' tag. This tag can be used to specify what values from the RRDgraph recipe should be inserted into the SVG file. Look at the following example: To allow SVG binding the XML syntax of an SVG file is extended with the non standard ''bind'' tag. This tag can be used to specify what values from the RRDgraph recipe should be inserted into the SVG file. Look at the following example:
Line 236: Line 244:
   * There is the new ''BDEF'' keyword that is processed by RRDgraph.   * There is the new ''BDEF'' keyword that is processed by RRDgraph.
  
-:!: **Important:** The ''XPORT'' keyword described on the manual page of RRDtool must not be used. Use the ''BDEF'' keyword as described below. Using this keyword will generate an error message.+:!: **Important:** The ''XPORT'' keyword described on the manual page of RRDtool must not be used. Use the ''BDEF'' keyword as described below. Using ''XPORT'' will generate an error message.
  
 As the ''XPORT'' statement described on RRDtools manual page the ''BDEF'' keyword exports the data for binding with the SVG file. The syntax is ''BDEF:variable=source:AGGREGATE''. The ''variable'' value specifies the name specified on the ''var'' attribute on the ''bind'' tag within the SVG file. The ''source'' value is the name of a ''DEF'' or ''CDEF''. The ''AGGREAGGTE'' value is the name of an aggregate function that is used to condense the values created by the ''DEF'' or ''CDEF'' statement into a single value to insert into the SVG file. The following aggregate functions are provided by RRDgraph: As the ''XPORT'' statement described on RRDtools manual page the ''BDEF'' keyword exports the data for binding with the SVG file. The syntax is ''BDEF:variable=source:AGGREGATE''. The ''variable'' value specifies the name specified on the ''var'' attribute on the ''bind'' tag within the SVG file. The ''source'' value is the name of a ''DEF'' or ''CDEF''. The ''AGGREAGGTE'' value is the name of an aggregate function that is used to condense the values created by the ''DEF'' or ''CDEF'' statement into a single value to insert into the SVG file. The following aggregate functions are provided by RRDgraph:
Line 280: Line 288:
  
 The graphs do ACL checking by themselves. If the user can not access the DokuWiki page the graph is on it will not display. The graphs do ACL checking by themselves. If the user can not access the DokuWiki page the graph is on it will not display.
 +
 +=== Virtual namespace for RRD graphs ===
 +This sets up the virtual namespace that is used for the generated graphs. This media namespace is not visible within the media manager. 
 +
 +:!: **Important Warning:** Please make sure this namespace does not collide with an already existing namespace within the media manager. If a collision occurs the existing namespace will be inaccessible until you change this setting.
 +
 +The default setting is ''rrdrender''. With this setting all generated graphs are put below ''/_media/rrdrender:...''.
  
 ===== Change Log ===== ===== Change Log =====
Line 291: Line 306:
     * Compatibility with PHP7 (thanks to splitbrain).     * Compatibility with PHP7 (thanks to splitbrain).
     * Implemented RRD binding mode to create SVG files showing values from the RRD database.     * Implemented RRD binding mode to create SVG files showing values from the RRD database.
 +  * **2016-08-28** Release 5
 +    * Update for DokuWiki release "Elenor of Tsort"
 +    * Using a configurable media namespace for image rendering. This solves problems with initializing DokuWiki from within graph.php on some installations.
 +    * Show a nice error message if GD or rrdgraph are missing.
 +  * **2017-06-21** Release 6
 +    * Litte bug-fix to make rrdgraph compatible with PHP 7 (again).
 +  * **2017-06-21** Release 7
 +    * Minor bug-fix: If the drop down menu is used for range switching instead of the tabs (on small screens) this only works one time and then goes completely haywire.
 +  * **2019-01-12** Release 8
 +    * Minor bug-fix: Missing quotes on string constant.
 +    * Converted all line endings to LF.
 +
        
 ===== FAQ ===== ===== FAQ =====
 No FAQ yet. No FAQ yet.
plugin/rrdgraph.1453564937.txt.gz · Last modified: 2016-01-23 17:02 by 62.216.218.122