Skip to content

Commit

Permalink
Include tag browser in docs
Browse files Browse the repository at this point in the history
Almost ready for a 1.3 release
  • Loading branch information
lehitoskin committed Dec 4, 2016
1 parent 5b175b6 commit 00ad217
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 10 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ place it in `/Applications/`.

## Usage

### GUI Interface

OS X note: All <kbd>Ctrl</kbd>- keyboard shortcuts are available as
<kbd>Cmd</kbd>-.

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

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

Ivy comes with a tag browser mode (available from the `View` 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.

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 "Edit Tags" from the menu.

### Animated GIF Support

Animated GIF support is currently marked as experimental. To animate a GIF,
select View -> GIF Animation. Due to the unstable natue of the related code,
know that some GIF's may not load properly or at all.
Binary file modified doc/ivy.1.bz2
Binary file not shown.
9 changes: 7 additions & 2 deletions doc/ivy.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ <h1 id="name">NAME</h1>
<h1 id="synopsis">SYNOPSIS</h1>
<p>ivy [option ... ] [args] ...</p>
<h1 id="description">DESCRIPTION</h1>
<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>
<h2 id="gui-interface">GUI Interface</h2>
<p>OS X note: All Ctrl- keyboard shortcuts are available as Cmd-.</p>
<ul>
<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>
Expand All @@ -14,8 +16,11 @@ <h1 id="description">DESCRIPTION</h1>
<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>
<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>
</ul>
<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>
<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>
<h2 id="tag-browser">Tag Browser</h2>
<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>
<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>
<h2 id="animated-gif-support">Animated GIF Support</h2>
<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>
<h1 id="options">OPTIONS</h1>
<h2 id="mutually-exclusive-options">Mutually exclusive options</h2>
<h3 id="v---version">-V, --version</h3>
Expand Down
29 changes: 23 additions & 6 deletions doc/ivy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% IVY(1) Ivy Image Viewer | Version 1.2
% IVY(1) Ivy Image Viewer | Version 1.3

# NAME
Ivy Image Viewer
Expand All @@ -7,6 +7,12 @@ Ivy Image Viewer
ivy [option ... ] [args] ...

# DESCRIPTION

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.

## GUI Interface
OS X note: All Ctrl- keyboard shortcuts are available as
Cmd-.

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

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

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.
Ivy comes with a tag browser mode (available from the `View` 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.

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 "Edit Tags" from the menu.

## Animated GIF Support

Animated GIF support is currently marked as experimental. To animate a GIF,
select View -> GIF Animation. Due to the unstable natue of the related code,
know that some GIF's may not load properly or at all.

# OPTIONS

Expand Down

0 comments on commit 00ad217

Please sign in to comment.