Skip to content

Commit f2ae3ba

Browse files
dovdov
committed
Updated the manual
1 parent 769217c commit f2ae3ba

File tree

2 files changed

+168
-80
lines changed

2 files changed

+168
-80
lines changed

‎doc/giv.html‎

Lines changed: 121 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ <h1 align=center>A Manual for Giv<br></h1>
1717
</center>
1818
<h2 align=center>
1919
<img src="giv-logo-150.png"><br>
20-
<font size=+2>Version 0.9.33</font><br>
20+
<font size=+2>Version 0.9.36</font><br>
2121
<font size=-1>Dov Grobgeld</font><br>
2222
<font size=-1>Homepage: <a href="http://giv.sourceforge.net/giv">http://giv.sourceforge.net/giv</a></font><br>
2323
<font size=-1>Development: <a href="http://github.com/dov/giv">http://github.com/dov/giv</a></font><br>
2424
<font size=-1>Chat room: <a href="https://gitter.im/dov/giv?utm_source=share-link&utm_medium=link&utm_campaign=share-link">Gitter Giv Chat room</a></font><br>
2525
<font size=-1><a href="mailto:[email protected]">[email protected]</a></font><br>
26-
<font size=-1>Last modified: 2022-04-05 Tue</font>
26+
<font size=-1>Last modified: 2023-02-09 Thu</font>
2727
</h2>
2828

2929
<h2><a name="SEC1">1. Description</a></h2>
@@ -207,7 +207,40 @@ <h3><a name="SEC1.2">1.2. The giv files</a></h3>
207207

208208
</blockquote>
209209

210-
<h3><a name="SEC1.3">1.3. Text annotations</a></h3>
210+
<h3><a name="SEC1.3">1.3. Lines and Bezier Curves</a></h3>
211+
212+
<blockquote>
213+
After the header of the dataset, follows its data points.
214+
215+
giv follows the SVG model of drawing curves. A line is composed of a letter followed by the coordinates. By default the action is lineto, but the following are also supported:
216+
217+
<table>
218+
<tr><th bgcolor=#eeeeff>Letter
219+
<th bgcolor=#eeeeff>Meaning
220+
<th bgcolor=#eeeeff>Number parameters
221+
<th bgcolor=#eeeeff>Comment
222+
<tr><td bgcolor=#ffeeee valign=top>M
223+
<td bgcolor=#ffeeee valign=top>move to
224+
<td bgcolor=#ffeeee valign=top>2
225+
<td bgcolor=#ffeeee valign=top>Implicit for first point
226+
<tr><td bgcolor=#fbf2ee valign=top>L
227+
<td bgcolor=#fbf2ee valign=top>line to
228+
<td bgcolor=#fbf2ee valign=top>2
229+
<td bgcolor=#fbf2ee valign=top>Optional
230+
<tr><td bgcolor=#ffeeee valign=top>Z
231+
<td bgcolor=#ffeeee valign=top>line to
232+
<td bgcolor=#ffeeee valign=top>2
233+
<td bgcolor=#ffeeee valign=top>Close path
234+
<tr><td bgcolor=#fbf2ee valign=top>C
235+
<td bgcolor=#fbf2ee valign=top>curve to
236+
<td bgcolor=#fbf2ee valign=top>6
237+
<td bgcolor=#fbf2ee valign=top>A cubic Bezier
238+
</table>
239+
240+
</blockquote>
241+
242+
243+
<h3><a name="SEC1.4">1.4. Text annotations</a></h3>
211244

212245
<blockquote>
213246
Text is drawn by adding the letter "T" in front of a line. The "T" may have a number 1-9 appended describing the anchoring of the text. This numbers corresponds to their position on the numerical keyboard. The default alignment is 1, i.e. lower left. To write multiline text add string "\n".
@@ -253,7 +286,7 @@ <h3><a name="SEC1.3">1.3. Text annotations</a></h3>
253286
The backslash character is used as an escape character, so to get a literal backslash two slashes must be used. "\n" is used to indicate aline break.
254287
</blockquote>
255288

256-
<h3><a name="SEC1.4">1.4. Colors</a></h3>
289+
<h3><a name="SEC1.5">1.5. Colors</a></h3>
257290

258291
<blockquote>
259292
For all the properties that take colors as arguments the color may be given in several ways:
@@ -269,7 +302,7 @@ <h3><a name="SEC1.4">1.4. Colors</a></h3>
269302
</ul>
270303
</blockquote>
271304

272-
<h3><a name="SEC1.5">1.5. Styles</a></h3>
305+
<h3><a name="SEC1.6">1.6. Styles</a></h3>
273306

274307
<blockquote>
275308
Instead of explicitly listing all properties for a dataset, this may be done inderectly by the creation of a style. A style is created and has properties added to it through the <tt>$def_style</tt> keyword. Each use of <tt>$def_style</tt> adds one property to the style. A style is then referenced in the beginning of a dataset with the <tt>$style</tt> keyword followed by the style name.
@@ -295,7 +328,7 @@ <h3><a name="SEC1.5">1.5. Styles</a></h3>
295328
<font size=-1 color=red> 20: </font>200 150 </pre></table>
296329
</blockquote>
297330

298-
<h3><a name="SEC1.6">1.6. Giv file example</a></h3>
331+
<h3><a name="SEC1.7">1.7. Giv file example</a></h3>
299332

300333
<blockquote>
301334
Here is an extensive giv file example showing off the various features of
@@ -450,83 +483,91 @@ <h3><a name="SEC1.6">1.6. Giv file example</a></h3>
450483
<b>Note:</b> The example above contains just a few points. Giv very easily supports several hundred thousand points. The only limitations are the physical memory and the speed of the CPU.
451484
</blockquote>
452485

486+
<h3><a name="SEC1.8">1.8. Balloons and paths</a></h3>
487+
488+
One of the features of giv is that each dataset may have a tooltip popup attached to it. These popups are knows as "balloons". This allows adding auxilliary information to the display that is revealed only when the cursor hovers above the dataset.
489+
490+
In addition, a dataset may be given a hiearchical path. This path is referenced in the marks viewer, and may be used to toggle on and off datasets. If no balloon was explicitely set for a dataset, then the dataset name is used for the balloon.
491+
492+
Balloons are toggled by the "b" popup.
493+
453494
<h2><a name="SEC2">2. Interaction</a></h2>
454495

455496
<blockquote>
456497
<table>
457498
<tr><th bgcolor=#eeeeff>Option
458499
<th bgcolor=#eeeeff>Description
459500

460-
<tr><td bgcolor=#ffeeee valign=top>1
461-
<td bgcolor=#ffeeee valign=top>Sets one image pixel equal to one screen pixel.
462-
<tr><td bgcolor=#fbf2ee valign=top>a
463-
<td bgcolor=#fbf2ee valign=top>Toggle anti aliasing
464-
<tr><td bgcolor=#ffeeee valign=top>b
465-
<td bgcolor=#ffeeee valign=top>Toggle the balloon popup.
466-
<tr><td bgcolor=#fbf2ee valign=top>c
467-
<td bgcolor=#fbf2ee valign=top>Reduce contrast. Useful for viewing overlay on binary images.
468-
<tr><td bgcolor=#ffeeee valign=top>i
469-
<td bgcolor=#ffeeee valign=top>Show information window
470-
<tr><td bgcolor=#fbf2ee valign=top>f
471-
<td bgcolor=#fbf2ee valign=top>Fill data to window
472-
<tr><td bgcolor=#ffeeee valign=top>g
473-
<td bgcolor=#ffeeee valign=top>Toggle the pixel grid. (Only shown at high zoom ratios).
474-
<tr><td bgcolor=#fbf2ee valign=top>h
475-
<td bgcolor=#fbf2ee valign=top>Horizontal flip
476-
<tr><td bgcolor=#ffeeee valign=top>m
477-
<td bgcolor=#ffeeee valign=top>Toggle overlay.
478-
<tr><td bgcolor=#fbf2ee valign=top>o
479-
<td bgcolor=#fbf2ee valign=top>Popup dataset browser.
480-
<tr><td bgcolor=#ffeeee valign=top>q
481-
<td bgcolor=#ffeeee valign=top>Quit
482-
<tr><td bgcolor=#fbf2ee valign=top>s
483-
<td bgcolor=#fbf2ee valign=top>Shrink wrap
484-
<tr><td bgcolor=#ffeeee valign=top>v
485-
<td bgcolor=#ffeeee valign=top>Vertical flip
486-
<tr><td bgcolor=#fbf2ee valign=top>Shift-V
487-
<td bgcolor=#fbf2ee valign=top>Toggle vertical zoom locking.
488-
<tr><td bgcolor=#ffeeee valign=top>Control+c
489-
<td bgcolor=#ffeeee valign=top>Copy contents of balloon text to clip board
490-
<tr><td bgcolor=#fbf2ee valign=top>Control+d
491-
<td bgcolor=#fbf2ee valign=top>Copy contents of the last measurement to the clipboard.
492-
<tr><td bgcolor=#ffeeee valign=top>Control+x
493-
<td bgcolor=#ffeeee valign=top>Copy XY coordinate to the to clip board
494-
<tr><td bgcolor=#fbf2ee valign=top>Esc
495-
<td bgcolor=#fbf2ee valign=top>Abort remote command pick points
496-
<tr><td bgcolor=#ffeeee valign=top>=<br>Ctrl-B1
497-
<td bgcolor=#ffeeee valign=top>Zoom in by a factor of 2
498-
<tr><td bgcolor=#fbf2ee valign=top>-<br>Ctrl-B3
499-
<td bgcolor=#fbf2ee valign=top>Zoom out by a factor of 2
500-
<tr><td bgcolor=#ffeeee valign=top>Scroll wheel up
501-
<td bgcolor=#ffeeee valign=top>Zoom in by a factor of 1.4
502-
<tr><td bgcolor=#fbf2ee valign=top>Scroll wheel down
503-
<td bgcolor=#fbf2ee valign=top>Zoom out by a factor of 1.4
504-
<tr><td bgcolor=#ffeeee valign=top>Shift+Scroll wheel up
505-
<td bgcolor=#ffeeee valign=top>Zoom in by a factor of 1.1
506-
<tr><td bgcolor=#fbf2ee valign=top>Shift+Scroll wheel down
507-
<td bgcolor=#fbf2ee valign=top>Zoom out by a factor of 1.1
508-
<tr><td bgcolor=#ffeeee valign=top>Control+Scroll wheel up
509-
<td bgcolor=#ffeeee valign=top>Zoom in by a factor of 2
510-
<tr><td bgcolor=#fbf2ee valign=top>Control+Scroll wheel down
511-
<td bgcolor=#fbf2ee valign=top>Zoom out by a factor of 2
512-
<tr><td bgcolor=#ffeeee valign=top>Alt + Scroll wheel up
513-
<td bgcolor=#ffeeee valign=top>Zoom in of quiver vectors by a factor of 1.2
514-
<tr><td bgcolor=#fbf2ee valign=top>Alt + Scroll wheel down
515-
<td bgcolor=#fbf2ee valign=top>Zoom out of quiver vectors by a factor of 1.2
516-
<tr><td bgcolor=#ffeeee valign=top>B3
517-
<td bgcolor=#ffeeee valign=top>Popup options menu.
501+
<tr><td bgcolor=#fbf2ee valign=top>1
502+
<td bgcolor=#fbf2ee valign=top>Sets one image pixel equal to one screen pixel.
503+
<tr><td bgcolor=#ffeeee valign=top>a
504+
<td bgcolor=#ffeeee valign=top>Toggle anti aliasing
505+
<tr><td bgcolor=#fbf2ee valign=top>b
506+
<td bgcolor=#fbf2ee valign=top>Toggle the balloon popup.
507+
<tr><td bgcolor=#ffeeee valign=top>c
508+
<td bgcolor=#ffeeee valign=top>Reduce contrast. Useful for viewing overlay on binary images.
509+
<tr><td bgcolor=#fbf2ee valign=top>i
510+
<td bgcolor=#fbf2ee valign=top>Show information window
511+
<tr><td bgcolor=#ffeeee valign=top>f
512+
<td bgcolor=#ffeeee valign=top>Fill data to window
513+
<tr><td bgcolor=#fbf2ee valign=top>g
514+
<td bgcolor=#fbf2ee valign=top>Toggle the pixel grid. (Only shown at high zoom ratios).
515+
<tr><td bgcolor=#ffeeee valign=top>h
516+
<td bgcolor=#ffeeee valign=top>Horizontal flip
517+
<tr><td bgcolor=#fbf2ee valign=top>m
518+
<td bgcolor=#fbf2ee valign=top>Toggle overlay.
519+
<tr><td bgcolor=#ffeeee valign=top>o
520+
<td bgcolor=#ffeeee valign=top>Popup dataset browser.
521+
<tr><td bgcolor=#fbf2ee valign=top>q
522+
<td bgcolor=#fbf2ee valign=top>Quit
523+
<tr><td bgcolor=#ffeeee valign=top>s
524+
<td bgcolor=#ffeeee valign=top>Shrink wrap
525+
<tr><td bgcolor=#fbf2ee valign=top>v
526+
<td bgcolor=#fbf2ee valign=top>Vertical flip
527+
<tr><td bgcolor=#ffeeee valign=top>Shift-V
528+
<td bgcolor=#ffeeee valign=top>Toggle vertical zoom locking.
529+
<tr><td bgcolor=#fbf2ee valign=top>Control+c
530+
<td bgcolor=#fbf2ee valign=top>Copy contents of balloon text to clip board
531+
<tr><td bgcolor=#ffeeee valign=top>Control+d
532+
<td bgcolor=#ffeeee valign=top>Copy contents of the last measurement to the clipboard.
533+
<tr><td bgcolor=#fbf2ee valign=top>Control+x
534+
<td bgcolor=#fbf2ee valign=top>Copy XY coordinate to the to clip board
535+
<tr><td bgcolor=#ffeeee valign=top>Esc
536+
<td bgcolor=#ffeeee valign=top>Abort remote command pick points
537+
<tr><td bgcolor=#fbf2ee valign=top>=<br>Ctrl-B1
538+
<td bgcolor=#fbf2ee valign=top>Zoom in by a factor of 2
539+
<tr><td bgcolor=#ffeeee valign=top>-<br>Ctrl-B3
540+
<td bgcolor=#ffeeee valign=top>Zoom out by a factor of 2
541+
<tr><td bgcolor=#fbf2ee valign=top>Scroll wheel up
542+
<td bgcolor=#fbf2ee valign=top>Zoom in by a factor of 1.4
543+
<tr><td bgcolor=#ffeeee valign=top>Scroll wheel down
544+
<td bgcolor=#ffeeee valign=top>Zoom out by a factor of 1.4
545+
<tr><td bgcolor=#fbf2ee valign=top>Shift+Scroll wheel up
546+
<td bgcolor=#fbf2ee valign=top>Zoom in by a factor of 1.1
547+
<tr><td bgcolor=#ffeeee valign=top>Shift+Scroll wheel down
548+
<td bgcolor=#ffeeee valign=top>Zoom out by a factor of 1.1
549+
<tr><td bgcolor=#fbf2ee valign=top>Control+Scroll wheel up
550+
<td bgcolor=#fbf2ee valign=top>Zoom in by a factor of 2
551+
<tr><td bgcolor=#ffeeee valign=top>Control+Scroll wheel down
552+
<td bgcolor=#ffeeee valign=top>Zoom out by a factor of 2
553+
<tr><td bgcolor=#fbf2ee valign=top>Alt + Scroll wheel up
554+
<td bgcolor=#fbf2ee valign=top>Zoom in of quiver vectors by a factor of 1.2
555+
<tr><td bgcolor=#ffeeee valign=top>Alt + Scroll wheel down
556+
<td bgcolor=#ffeeee valign=top>Zoom out of quiver vectors by a factor of 1.2
557+
<tr><td bgcolor=#fbf2ee valign=top>B3
558+
<td bgcolor=#fbf2ee valign=top>Popup options menu.
518559
<!--
519-
<tr><td bgcolor=#fbf2ee valign=top>c
520-
<td bgcolor=#fbf2ee valign=top>Toggle cross hair.
560+
<tr><td bgcolor=#ffeeee valign=top>c
561+
<td bgcolor=#ffeeee valign=top>Toggle cross hair.
521562
-->
522-
<tr><td bgcolor=#ffeeee valign=top>Left/Space
523-
<td bgcolor=#ffeeee valign=top>Show next image in directory.
524-
<tr><td bgcolor=#fbf2ee valign=top>Right/BackSpace
525-
<td bgcolor=#fbf2ee valign=top>Show previous image in directory.
526-
<tr><td bgcolor=#ffeeee valign=top>Shift-Down
527-
<td bgcolor=#ffeeee valign=top>Choose next image when several $image references are given or next image for multi depth images.
528-
<tr><td bgcolor=#fbf2ee valign=top>Shift-Up
529-
<td bgcolor=#fbf2ee valign=top>Choose previous $image image
563+
<tr><td bgcolor=#fbf2ee valign=top>Left/Space
564+
<td bgcolor=#fbf2ee valign=top>Show next image in directory.
565+
<tr><td bgcolor=#ffeeee valign=top>Right/BackSpace
566+
<td bgcolor=#ffeeee valign=top>Show previous image in directory.
567+
<tr><td bgcolor=#fbf2ee valign=top>Shift-Down
568+
<td bgcolor=#fbf2ee valign=top>Choose next image when several $image references are given or next image for multi depth images.
569+
<tr><td bgcolor=#ffeeee valign=top>Shift-Up
570+
<td bgcolor=#ffeeee valign=top>Choose previous $image image
530571
</table>
531572
</blockquote>
532573

@@ -560,10 +601,14 @@ <h2><a name="SEC3">3. Gallery</a></h2>
560601
<tr><td align=center><img src="gallery-cat-pseudo-color.jpg">
561602
<td align=center><img src="alpha-example.jpg">
562603
</tr>
563-
<tr><td align=center><img src="svg-marks-example.png">
604+
<tr><td align=center valign=top>Pseudo color
605+
<td align=center width=25%>A gray level image with transparent overlay
606+
</tr>
607+
608+
<tr><td align=center><img width="40%" src="svg-marks-example.png">
564609
</tr>
565610
<tr>
566-
<td align=center valign=top>Example use of <tt>svgmarks</tt> where the markers are read from an external svg file.
611+
<td align=center valign=top>Example use of <tt>svgmarks</tt> <br/>where the markers are read from an <br/>external svg file.
567612
</tr>
568613

569614
<!----->

‎doc/giv.phtml‎

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,13 @@ sub code_snippet { # usage: code_snippet($filename, title)
9393
</center>
9494
<h2 align=center>
9595
<img src="giv-logo-150.png"><br>
96-
<font size=+2>Version 0.9.33</font><br>
96+
<font size=+2>Version 0.9.36</font><br>
9797
<font size=-1>Dov Grobgeld</font><br>
9898
<font size=-1>Homepage: <a href="http://giv.sourceforge.net/giv">http://giv.sourceforge.net/giv</a></font><br>
9999
<font size=-1>Development: <a href="http://github.com/dov/giv">http://github.com/dov/giv</a></font><br>
100100
<font size=-1>Chat room: <a href="https://gitter.im/dov/giv?utm_source=share-link&utm_medium=link&utm_campaign=share-link">Gitter Giv Chat room</a></font><br>
101101
<font size=-1><a href="mailto:[email protected]">[email protected]</a></font><br>
102-
<font size=-1>Last modified: 2022-04-05 Tue</font>
102+
<font size=-1>Last modified: 2023-02-09 Thu</font>
103103
</h2>
104104

105105
<: section("Description") :>
@@ -289,6 +289,38 @@ sub code_snippet { # usage: code_snippet($filename, title)
289289

290290
</blockquote>
291291

292+
<: subsection("Lines and Bezier Curves") :>
293+
<blockquote>
294+
After the header of the dataset, follows its data points.
295+
296+
giv follows the SVG model of drawing curves. A line is composed of a letter followed by the coordinates. By default the action is lineto, but the following are also supported:
297+
298+
<table>
299+
<: TR() :><th bgcolor=#eeeeff>Letter
300+
<th bgcolor=#eeeeff>Meaning
301+
<th bgcolor=#eeeeff>Number parameters
302+
<th bgcolor=#eeeeff>Comment
303+
<:TR():><: td() :>M
304+
<: td() :>move to
305+
<: td() :>2
306+
<: td() :>Implicit for first point
307+
<:TR():><: td() :>L
308+
<: td() :>line to
309+
<: td() :>2
310+
<: td() :>Optional
311+
<:TR():><: td() :>Z
312+
<: td() :>line to
313+
<: td() :>2
314+
<: td() :>Close path
315+
<:TR():><: td() :>C
316+
<: td() :>curve to
317+
<: td() :>6
318+
<: td() :>A cubic Bezier
319+
</table>
320+
321+
</blockquote>
322+
323+
292324
<: subsection("Text annotations") :>
293325
<blockquote>
294326
Text is drawn by adding the letter "T" in front of a line. The "T" may have a number 1-9 appended describing the anchoring of the text. This numbers corresponds to their position on the numerical keyboard. The default alignment is 1, i.e. lower left. To write multiline text add string "\n".
@@ -351,6 +383,13 @@ giv. The result is shown in the screenshow below.
351383
<b>Note:</b> The example above contains just a few points. Giv very easily supports several hundred thousand points. The only limitations are the physical memory and the speed of the CPU.
352384
</blockquote>
353385

386+
<: subsection("Balloons and paths") :>
387+
One of the features of giv is that each dataset may have a tooltip popup attached to it. These popups are knows as "balloons". This allows adding auxilliary information to the display that is revealed only when the cursor hovers above the dataset.
388+
389+
In addition, a dataset may be given a hiearchical path. This path is referenced in the marks viewer, and may be used to toggle on and off datasets. If no balloon was explicitely set for a dataset, then the dataset name is used for the balloon.
390+
391+
Balloons are toggled by the "b" popup.
392+
354393
<: section("Interaction") :>
355394
<blockquote>
356395
<table>
@@ -459,10 +498,14 @@ giv. The result is shown in the screenshow below.
459498
<tr><td align=center><img src="gallery-cat-pseudo-color.jpg">
460499
<td align=center><img src="alpha-example.jpg">
461500
</tr>
462-
<tr><td align=center><img src="svg-marks-example.png">
501+
<tr><td align=center valign=top>Pseudo color
502+
<td align=center width=25%>A gray level image with transparent overlay
503+
</tr>
504+
505+
<tr><td align=center><img width="40%" src="svg-marks-example.png">
463506
</tr>
464507
<tr>
465-
<td align=center valign=top>Example use of <tt>svgmarks</tt> where the markers are read from an external svg file.
508+
<td align=center valign=top>Example use of <tt>svgmarks</tt> <br/>where the markers are read from an <br/>external svg file.
466509
</tr>
467510

468511
<!----->

0 commit comments

Comments
 (0)