source: branches/mbutscher/work/WikidPadHelp/data/WikiStructureGraphs.wiki @ 195

Last change on this file since 195 was 178, checked in by mbutscher, 11 years ago

2.0preAlpha (internal)

Works so far, now editing help wiki.

File size: 2.4 KB
Line 
1++ Wiki Structure Graphs
2
3You can create some graphs of the relations of the wikiwords to each other in the wiki. This needs the GraphViz application suite to be properly installed.
4
5In the "plugins" menu you will see the four entries "Show relation graph", "Show rel. graph source", "Show child graph", "Show child graph source". If you choose one of them the current tab shows one of the graphs or its source (the dot script to create it).
6
7If you want to go back to editor or preview, use the "View" menu and select "Switch Ed./Prev.", "Show editor" or "Show preview".
8
9If you want to export these graphs use the [Insertions] \[:graph.relation:] or \[:graph.child:].
10
11
12+++ Relation graph
13
14This graph uses relations defined by attributes in a wikiword. The key of the attribute names the kind of relation, the value names the wiki word (which must exist) to which it is related.
15
16An example could be on a page "Bird" the attributes
17<<
18[isA: Animal]
19[eats: Fish]
20>>
21
22
23There are two attributes to define which attribute keys should be taken into account for relation. You can either use "global.graph.relation.exclude" to define which keys should not be taken into account (the "alias" key is e.g. a good candidate) or "global.graph.relation.include" to list the keys that only should be taken into account.
24
25These attributes apply for the whole wiki, regardless on which page they are placed. If you use both keys in the same wiki, the "...include" is ignored.
26
27The values in these attributes should be delimited by a semicolon. Each value (which is in fact an attribute key) also applies to all subkeys (e.g. "foo" also applies to "foo.bar", but not to "foobar").
28
29
30+++ Child graph
31
32This graph shows the parent->child relationship of the words in the wiki.
33
34
35+++ Options
36
37In the options settings there is an option page named "GraphVizStructure" which provides some possibilities to control the presentation of the above graphs. Each of the entries can be set empty to use the default settings.
38
39
40*Node font name*
41*Node font size*
42Name of the font to use and the font size for the node label
43
44*Node border color*
45Color of the small line surrounding each node
46
47*Node background color*
48Color of the node background. If the page described by this node has a "color" attribute this color attribute overrides the option setting.
49
50*Edge color*
51Color of the edges connecting nodes.
52
53
Note: See TracBrowser for help on using the repository browser.