Difference between revisions of "Wgraph"

From FollowTheScore
Jump to: navigation, search
(Replacing page with '{{subst::Dynamic Page List}}')
Line 1: Line 1:
== Wgraph -- the mediawiki graph definition tool ==
+
'''DPL is a report generator for MediaWikis'''. It creates ''lists of articles'' that match certain criteria. ''Meta data'' like  author, popularity or date of last update can be added. ''Contents'' from articles can be included in the result, based on chapters, templates or special markers in the text.
  
''Wgraph'' is a mediawiki extension which supports graph drawing. With ''Wgraph'' you '''define the semantics of a graph''' in an abstract textual notation called WGL (''Wiki Graph Language''). You may add hints for layout, but the graph itself is being produced automatically. ''Wgraph'' is a powerful visualisation instrument for objects and their relations. It is NOT a 'wysiwyg' drawing tool.
+
== [[mw:Extension:DynamicPageList|DynamicPageList]] &nbsp; -- &nbsp; current release is <big> [[DPL:Version History|1.2.5]] </big> ==
 
 
{|
 
|
 
{{#wgraph: svg | thumb = 40 |
 
  node wgl        { type data    label "text notation\n-- WGL --" }
 
  edge wgl wgraph  { kind rightnear color red }
 
  node wgraph      { type process  label "Wgraph\nmediawiki extension" }
 
  edge wgraph gdl  { }
 
  node gdl        { type data    label "graph definition\n-- GDL --" }
 
  edge gdl aisee  { }
 
  node aisee      { type process  label "aiSee\nlayout generator"
 
                    href aiSee } // hyperlink to article (only svg)
 
  edge aisee img  { kind leftnear }
 
  node img        { type data    label "image\n-- png, svg --"
 
                    shape hexagon }
 
  nodetype data    { shape ellipse, color lightyellow,
 
                    bordercolor khaki, height 60 }
 
  nodetype process { shape box color lightmagenta
 
                    bordercolor magenta height 60 }
 
  xspace=70, yspace=100
 
}}
 
|
 
<small><pre><nowiki>
 
{{#wgraph: svg | thumb = 40 |
 
  node wgl        { type data    label "text notation\n-- WGL --" }
 
  edge wgl wgraph { kind rightnear color red }
 
  node wgraph      { type process  label "Wgraph\nmediawiki extension" }
 
  edge wgraph gdl  { }
 
  node gdl        { type data    label "graph definition\n-- GDL --" }
 
  edge gdl aisee  { }
 
  node aisee      { type process  label "aiSee\nlayout generator" }
 
  edge aisee img  { kind leftnear }
 
  node img        { type data    label "image\n-- png, svg --"
 
                    shape hexagon }
 
  nodetype data    { shape ellipse, color lightyellow,
 
                    bordercolor khaki, height 60 }
 
  nodetype process { shape box color lightmagenta
 
                    bordercolor magenta height 60 }
 
  xspace=70, yspace=100
 
}}
 
</nowiki></pre></small>
 
|}
 
 
----
 
Graph layout is a very challenging task. ''Wgraph'' delegates most of this task to a brilliant product called '''[http://www.aisee.com aiSee]'''. aiSee came out of the German university area one decade ago and is now being marketed commercially by [http://www.absint.com ''AbsInt - Angewandte Informatik'', Saarbrücken, Germany]. You can download a [http://www.absint.com/aisee/download/ free 30-day trial license]. ''aiSee can be registered for free for non-commercial use.'' Non-commercial use is educational, academic research and private use. Non-commercial users can get a license key that extends the usage period of the trial version until February 14, 2008. After that you will have to download aiSee again (and the usage period will be extended for another year, provided the usage is still non-commercial).
 
 
 
== The two modes to use ''Wgraph'' ==
 
 
 
''Wgraph'' is an interface between mediawiki and aiSee. It hides aiSee completely from the eyes of the user and adds a small additional abstraction layer to make graph definitions even more comfortable than with native aiSee.
 
 
 
* The direct way to use ''wgraph'' is to invoke the parser function ''#wgraph'' with your WGL code as a parameter.
 
* In combination with another mediawiki extension (called DPL: ''Dynamic Page List'') you can even visualize structural aspects of your wiki as a '''wikigraph'''. In a [[wikigraph]] articles map to nodes, categories to nodetypes and relations are deduced from template calls.
 
 
 
With ''wgraph'' you can view a graph definition from different angles. You can '''hide''' certain nodes / edges and emphasize others. You can '''group nodes to subgraphs''' and show them in a special surrounding box. There are several '''layout strategies''' to choose from. You control the graphical representation of nodes and edges using '''shapes, colors, linestyles, arrows''' and even '''bitmap images'''. To avoid redundancy and reach a higher level of abstraction you can take advantage of the built-in WGL '''type concept'''.
 
 
 
Graphs are produced in png and svg format. In addition there is a png thumb image. Apart from viewing the generated graph in the browser, aiSee can be used as a local client application. This gives enhanced possibilities of edge concentration, subgraph folding etc. Make sure that you comply to the licensing terms of [http://www.absint.com].
 
  
 
{|class=wikitable
 
{|class=wikitable
!more to read ..
+
|valign=top|
!Other stuff
+
* General
!Gallery
+
** [[DPL:Overview]]
|-
+
** [[:Category:DPL Manual|DPL:Manual]]
|
+
** [[DPL:Requests for new features]]
* '''[[Wgraph fundamentals]]'''
+
** [[DPL:Bug Reports]]
* [[Wgraph:Architecture]]
+
** [[DPL:Websites using DPL]]
* [[Wgraph:Tutorial]]
+
** [[DPL:Discussion]]
* [[Wgraph:Commandline arguments]]
+
** [[DPL:Load Test]]
* [[Wgraph:Manual]]
+
** '''[[DPL:Version History]]'''
|
+
** [[:Media:Dplsrc.zip|DPL:Download]]
* [[Wgraph:Installation]]
 
* [[Wgraph:Bugs]]
 
* [[Wgraph:To do | the author's to do list]]
 
|
 
* [[Wgraph:Sample Genealogy]]
 
* [[Wgraph:Demo 1]]
 
* [[Wgraph:Demo 2]]
 
* [[Wgraph:Demo 3]]
 
|}
 
  
== A first example ==
+
|valign=top|
 +
* Applications based on DPL
 +
** [[Test calendar|Calendar]]
 +
** [http://meta.wikimedia.org/wiki/DPLforum DPLForum]
  
{|class=wikitable
+
* Examples
![[Wgraph:Sample 1.wgl|WGL source]]
+
** [[Example 1|simple example]]
!orientation = top_to_bottom<br>node.color = lightyellow
+
** [[Example 2|realistic example]]
!align=left|orientation = left_to_right<br>node.color = lightmagenta<br>node.shape = hexagon<br>node.width = 30<br>edge.color = red
+
** [[Example 3|other examples]]
|-
 
|{{Wgraph:Sample 1.wgl}}
 
|{{#wgraph: name= wgraph_sample_1  | png | svg |
 
  
  {{Wgraph:Sample 1.wgl}}
+
|valign=top|
    node.color = lightyellow
+
* Other Stuff (javascript, sortable tables)
  }}
+
** [[Javascript extension]]
  
|{{#wgraph: name= wgraph_sample_1a | png | svg |
+
* News
 +
** ''Try the '''[[Special:DynamicPageListSP|new DPL special page]]'''!''
  
  {{Wgraph:Sample 1.wgl}}
+
<p><br>&nbsp;
    orientation = left_to_right
+
* ''Other Extensions available on this site:''
    node.color = lightmagenta
+
** [[mw:Extension:StackFunctions|StackFunctions]]
    node.shape = hexagon
 
    node.width = 30
 
    edge.color = red
 
  }}
 
 
|}
 
|}
  
[[Category:Wgraph]]
+
If you are using DPL please put a reference to your wiki in [[DPL:Websites using DPL]]. If you would like to have DPL as part of the Wikipedia, [http://bugzilla.wikimedia.org/show_bug.cgi?id=9203 , vote for it].

Revision as of 12:03, 21 July 2007

DPL is a report generator for MediaWikis. It creates lists of articles that match certain criteria. Meta data like author, popularity or date of last update can be added. Contents from articles can be included in the result, based on chapters, templates or special markers in the text.

DynamicPageList   --   current release is 1.2.5


 

If you are using DPL please put a reference to your wiki in DPL:Websites using DPL. If you would like to have DPL as part of the Wikipedia, , vote for it.