-
Notifications
You must be signed in to change notification settings - Fork 0
/
help.html
153 lines (129 loc) · 3.85 KB
/
help.html
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>Help</title>
<style>
dd {
font-family: monospace;
}
.highlight {
border-left: .5em solid red;
padding-left: .5em;
}
</style>
</head>
<body>
<h1>Help</h1>
<h2>Interaction</h2>
<p>No surprises here. Need to learn shortcuts are marked.
</p>
<h3>File</h3>
<dl>
<dt>Open GraphViz DOT file</dt>
<dd>Drag and Drop</dd>
<dd>Ctrl+O</dd>
<dt>Save (download) GraphViz DOT file</dt>
<dd>Ctrl+S</dd>
</dl>
<h3>Editing</h3>
<dl>
<dt>New Node</dt>
<dd>Double click on empty space</dd>
<dt>Edit Node Label</dt>
<dd>Double click on the node</dd>
<dt>Select Node/Edge</dt>
<dd>Click</dd>
<dt>Select More Nodes/Edges</dt>
<dd>Tap</dd>
<dd>Ctrl+Click</dd>
<dt>Delete Selected Nodes/Edges</dt>
<dd>Delete</dd>
<dd>Backspace</dd>
<dt class="highlight">New Edge (Connect Nodes)</dt>
<dd>Select source node, then Shift+Click on target node(s)</dd>
<dt>Undo</dt>
<dd>Ctrl+Z</dd>
<dd>Alt+Backspace</dd>
<dt>Redo</dt>
<dd>Ctrl+Y</dd>
<dd>Ctrl+Shift+Z</dd>
<dt>Clear</dt>
<dd>Use browser "Reload" function, e.g.:</dd>
<dd>Ctrl+R</dd>
<dd>F5</dd>
</dl>
<h3>Editing Node Label</h3>
<dl>
<dt>Save Changes</dt>
<dd>Ctrl+S</dd>
<dt>Cancel Editor</dt>
<dd>Escape</dd>
</dl>
<h3>Viewing</h3>
<dl>
<dt>Zoom In</dt>
<dd>Mouse scroll up</dd>
<dd>+</dd>
<dd>=</dd>
<dd>[</dd>
<dd>PgUp</dd>
<dt>Zoom Out</dt>
<dd>Mouse scroll down</dd>
<dd>-</dd>
<dd>]</dd>
<dd>PgDn</dd>
<dt class="highlight">Zoom to Fit</dt>
<dd>F4</dd>
<dd>Ctrl+E</dd>
<dt>Pan</dt>
<dd>Mouse drag on empty space</dd>
<dd>Arrows</dd>
<dt>Stop Animation (Physics Simulation)</dt>
<dd>Escape</dd>
</dl>
<h2>File Format</h2>
<p>Any GraphViz <a href="http://graphviz.org/doc/info/lang.html">DOT</a> (*.gv, *.dot) file may be imported
(success is reported in JavaScript console log of the browser).
Saved file is a standard and rather simple GraphViz DOT file with HTML-like node labels.
It is meant to be viewed and printed with <a href="http://graphviz.org/">GraphViz</a> (open source graph visualization software).
</p>
<h2>Min. Requirements</h2>
<ul>
<li>Chrome 31</li>
<li>Edge 12</li>
<li>Firefox 14</li>
<li>Opera 17</li>
<li>Safari 9.1</li>
</ul>
<p class="highlight">Beware that not all customized browsers allow all shortcuts (do check Ctrl+S (DOT file save) functionality).
</p>
<h2>Installation</h2>
<p>vismm is a client-side application.
No information is sent or received from network.
No information is deliberately stored in browser cache.
vismm could be started from its local copy of HTML/CSS/JS file structure.
There are examples of CSS/JS to guide creation of custom display styles.
</p>
<h2>Dependancies (included)</h2>
<ul>
<li><a href="http://visjs.org/">vis.js "Network"</a> modified version 8.3.3</li>
<li><a href="http://pegjs.org/">PEG.js</a> version 0.10.0</li>
<li><a href="https://github.com/obermann/PEG4DOT">PEG4DOT</a></li>
</ul>
<h2>License</h2>
<p>vismm is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
</p>
<p>vismm is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
</p>
<p>You should have received a copy of the GNU General Public License
along with vismm. If not, see <a href="https://www.gnu.org/licenses/"><https://www.gnu.org/licenses/></a>.
</p>
</body>
</html>