Skip to content

Commit 00ad217

Browse files
committed
Include tag browser in docs
Almost ready for a 1.3 release
1 parent 5b175b6 commit 00ad217

File tree

4 files changed

+49
-10
lines changed

4 files changed

+49
-10
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ place it in `/Applications/`.
4444

4545
## Usage
4646

47+
### GUI Interface
48+
4749
OS X note: All <kbd>Ctrl</kbd>- keyboard shortcuts are available as
4850
<kbd>Cmd</kbd>-.
4951

@@ -87,5 +89,20 @@ OS X note: All <kbd>Ctrl</kbd>- keyboard shortcuts are available as
8789
press the "Set" button or <kbd>Enter</kbd> key, and the entry for that image will be
8890
deleted.
8991

90-
Animated GIF support is currently marked as experimental. To animate a GIF, select
91-
View -> GIF Animation. Know that some GIF's may not load properly or at all.
92+
### Tag Browser
93+
94+
Ivy comes with a tag browser mode (available from the `View` menu or with
95+
<kbd>Ctrl</kbd>-<kbd>b</kbd>) so that you may view every tag category and its
96+
contents. Clicking on a tag will show the images you have tagged. Clicking on
97+
the image will show a thumbnail preview which is itself clickable. Clicking on
98+
the thumbnail button will tell Ivy to load the source image for further viewing.
99+
100+
From the tag browser it is also possible to delete entire tag categories or
101+
rename them. Also, it is possible to edit the taglist of an image by clicking on
102+
an image path and selecting "Edit Tags" from the menu.
103+
104+
### Animated GIF Support
105+
106+
Animated GIF support is currently marked as experimental. To animate a GIF,
107+
select View -> GIF Animation. Due to the unstable natue of the related code,
108+
know that some GIF's may not load properly or at all.

doc/ivy.1.bz2

263 Bytes
Binary file not shown.

doc/ivy.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ <h1 id="name">NAME</h1>
33
<h1 id="synopsis">SYNOPSIS</h1>
44
<p>ivy [option ... ] [args] ...</p>
55
<h1 id="description">DESCRIPTION</h1>
6+
<p>Calling Ivy without a path will simply open the GUI. Supplying a path will tell Ivy to load the provided image. Supplying multiple paths will tell Ivy to load them as a collection.</p>
7+
<h2 id="gui-interface">GUI Interface</h2>
68
<p>OS X note: All Ctrl- keyboard shortcuts are available as Cmd-.</p>
79
<ul>
810
<li><p>Calling <em>ivy</em> by itself will start Ivy with the image-viewing area blank. You can then load images from the menu (File -&gt; Open), or with the keyboard shortcut Ctrl-O.</p></li>
@@ -14,8 +16,11 @@ <h1 id="description">DESCRIPTION</h1>
1416
<li><p>If you are currently editing tags and wish to revert any unsaved changes, simply hit the Esc key. Hitting Esc when there's no pending changes to be saved will unfocus the tag text field.</p></li>
1517
<li><p>To remove any set tags, simply delete the contents in the tag text field, press the &quot;Set&quot; button or Enter key, and the entry for that image will be deleted.</p></li>
1618
</ul>
17-
<p>Animated GIF support is currently marked as experimental. To animate a GIF, select View -&gt; GIF Animation. Know that some GIF's may not load properly or at all.</p>
18-
<p>Calling Ivy without a path will simply open the GUI. Supplying a path will tell Ivy to load the provided image. Supplying multiple paths will tell Ivy to load them as a collection.</p>
19+
<h2 id="tag-browser">Tag Browser</h2>
20+
<p>Ivy comes with a tag browser mode (available from the <code>View</code> menu or with <kbd>Ctrl</kbd>-<kbd>b</kbd>) so that you may view every tag category and its contents. Clicking on a tag will show the images you have tagged. Clicking on the image will show a thumbnail preview which is itself clickable. Clicking on the thumbnail button will tell Ivy to load the source image for further viewing.</p>
21+
<p>From the tag browser it is also possible to delete entire tag categories or rename them. Also, it is possible to edit the taglist of an image by clicking on an image path and selecting &quot;Edit Tags&quot; from the menu.</p>
22+
<h2 id="animated-gif-support">Animated GIF Support</h2>
23+
<p>Animated GIF support is currently marked as experimental. To animate a GIF, select View -&gt; GIF Animation. Due to the unstable natue of the related code, know that some GIF's may not load properly or at all.</p>
1924
<h1 id="options">OPTIONS</h1>
2025
<h2 id="mutually-exclusive-options">Mutually exclusive options</h2>
2126
<h3 id="v---version">-V, --version</h3>

doc/ivy.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% IVY(1) Ivy Image Viewer | Version 1.2
1+
% IVY(1) Ivy Image Viewer | Version 1.3
22

33
# NAME
44
Ivy Image Viewer
@@ -7,6 +7,12 @@ Ivy Image Viewer
77
ivy [option ... ] [args] ...
88

99
# DESCRIPTION
10+
11+
Calling Ivy without a path will simply open the GUI.
12+
Supplying a path will tell Ivy to load the provided image.
13+
Supplying multiple paths will tell Ivy to load them as a collection.
14+
15+
## GUI Interface
1016
OS X note: All Ctrl- keyboard shortcuts are available as
1117
Cmd-.
1218

@@ -50,12 +56,23 @@ Cmd-.
5056
press the "Set" button or Enter key, and the entry for that image will be
5157
deleted.
5258

53-
Animated GIF support is currently marked as experimental. To animate a GIF, select
54-
View -> GIF Animation. Know that some GIF's may not load properly or at all.
59+
## Tag Browser
5560

56-
Calling Ivy without a path will simply open the GUI.
57-
Supplying a path will tell Ivy to load the provided image.
58-
Supplying multiple paths will tell Ivy to load them as a collection.
61+
Ivy comes with a tag browser mode (available from the `View` menu or with
62+
<kbd>Ctrl</kbd>-<kbd>b</kbd>) so that you may view every tag category and its
63+
contents. Clicking on a tag will show the images you have tagged. Clicking on
64+
the image will show a thumbnail preview which is itself clickable. Clicking on
65+
the thumbnail button will tell Ivy to load the source image for further viewing.
66+
67+
From the tag browser it is also possible to delete entire tag categories or
68+
rename them. Also, it is possible to edit the taglist of an image by clicking on
69+
an image path and selecting "Edit Tags" from the menu.
70+
71+
## Animated GIF Support
72+
73+
Animated GIF support is currently marked as experimental. To animate a GIF,
74+
select View -> GIF Animation. Due to the unstable natue of the related code,
75+
know that some GIF's may not load properly or at all.
5976

6077
# OPTIONS
6178

0 commit comments

Comments
 (0)