[Xfce4-commits] <docs:master> Add ristretto help pages.
Mike Massonnet
noreply at xfce.org
Sun Nov 6 11:10:01 CET 2011
Updating branch refs/heads/master
to 22518e812402a6b50f6794206001b76d8b57baa4 (commit)
from 9930fe57ba593a92743ec46451b88d723e29f7c7 (commit)
commit 22518e812402a6b50f6794206001b76d8b57baa4
Author: Mike Massonnet <mmassonnet at xfce.org>
Date: Sun Nov 6 11:09:29 2011 +0100
Add ristretto help pages.
help/ristretto/C/getting-started.html | 146 ++++++++++++++++
help/ristretto/C/index.html | 43 +++++
help/ristretto/C/media/preferences-behaviour.png | Bin 0 -> 27343 bytes
help/ristretto/C/media/preferences-control.png | Bin 0 -> 23519 bytes
help/ristretto/C/media/preferences-display.png | Bin 0 -> 36038 bytes
help/ristretto/C/media/preferences-slideshow.png | Bin 0 -> 26586 bytes
help/ristretto/C/media/ristretto.png | Bin 0 -> 42716 bytes
help/ristretto/C/media/view-images-1.png | Bin 0 -> 162435 bytes
help/ristretto/C/preferences.html | 181 ++++++++++++++++++++
.../index.css => ristretto/ristretto.css} | 0
index.php | 2 +-
11 files changed, 371 insertions(+), 1 deletions(-)
diff --git a/help/ristretto/C/getting-started.html b/help/ristretto/C/getting-started.html
new file mode 100644
index 0000000..d0b097f
--- /dev/null
+++ b/help/ristretto/C/getting-started.html
@@ -0,0 +1,146 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html xmlns:str="http://exslt.org/strings">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Getting Started...</title>
+<link rel="stylesheet" type="text/css" href="../ristretto.css">
+</head>
+<body class="">
+<div class="headbar"><div class="linktrails"><div class="linktrail">
+<a class="linktrail" href="index.html">Ristretto</a> › <a class="linktrail" href="index.html#introduction">Introduction</a> » </div></div></div>
+<div class="body">
+<div class="header"><h1 class="title">Getting Started...</h1></div>
+<div class="contents">
+<p class="p">
+ When <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto Image Viewer</span> is first started, it shows an
+ empty window with two toolbars.
+ </p>
+<div class="figure">
+<div class="title title-figure">First Started</div>
+<div class="figure-contents"><div class="media media-image first-child"><img src="media/ristretto.png" alt=""></div></div>
+</div>
+<p class="p">
+ Image-files can be opened using the <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Open</span> button on the top
+ toolbar, or the <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">File</span> menu.
+ </p>
+</div>
+<div class="section" id="view">
+<div class="header"><h2 class="title">Viewing an image</h2></div>
+<div class="contents">
+<p class="p first-child">
+ When an image is opened in ristretto, it might look like the
+ image below. Notice how a thumbnail-bar appears showing the
+ other images in the same folder as the one just opened.
+ </p>
+<div class="figure">
+<div class="title title-figure">Viewing an image</div>
+<div class="figure-contents"><div class="media media-image first-child"><img src="media/view-images-1.png" alt=""></div></div>
+</div>
+</div>
+<div class="section" id="zooming">
+<div class="header"><h3 class="title">Zooming</h3></div>
+<div class="contents">
+<p class="p first-child">
+ Showing an image like this is nice, but sometimes you want to
+ zoom in on a detail, get a closer look. To do this
+ <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> provides the ability to zoom in on a
+ section of the image. There are several ways to do zoom in on an image,
+ </p>
+<div class="list"><div class="list-contents"><ol class="list" style="list-style-type:upper-roman">
+<li class="item-list first-child"><p class="p first-child">
+ The first way to zoom is via the zoom buttons on the side toolbar.
+ It is possible to zoom in, out, to 100% or to make the image fit
+ the screen. These buttons can also be reached from the
+ <span xmlns:e="http://projectmallard.org/experimental/" class=" guiseq"><span class=" gui">View</span> ▸ <span class=" gui">Zooming</span></span> menu.</p></li>
+<li class="item-list">
+<p class="p first-child">
+ A second way is using the scroll-wheel on the mouse, Moving the
+ mouse-wheel forward zooms in on the image, moving the
+ mouse-wheel backward will zoom out.</p>
+<div class="note note-advanced"><div class="note-inner"><div class="note-contents"><p class="p first-child">
+ The zoom-direction of the mouse-wheel can be adjusted, see
+ <span xmlns:e="http://projectmallard.org/experimental/" class=" link"><a href="preferences.html" title="">Preferences</a></span> for more details.
+ </p></div></div></div>
+</li>
+<li class="item-list"><p class="p first-child">
+ The third, and last way to zoom on an image is using so-called
+ BOX-ZOOM, or selection-zoom. Press
+ <span xmlns:e="http://projectmallard.org/experimental/" class=" keyseq"><span class=" key">Control</span>+Click</span>, and drag the
+ mouse-cursor. This way a box appears, when the mouse-button is
+ released, <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> will zoom in on the selected
+ portion of the image.</p></li>
+</ol></div></div>
+</div>
+</div>
+<div class="section" id="rotation">
+<div class="header"><h3 class="title">Rotating</h3></div>
+<div class="contents">
+<p class="p first-child">
+ Sometimes, it is necessary to rotate an image because it is not
+ positioned in the right orientation. To solve this, you can use
+ the <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Rotate</span> buttons on the toolbar.
+ </p>
+<div class="note note-tip"><div class="note-inner"><div class="note-contents"><p class="p first-child">Some digital cameras store the image-orientation inside the
+ EXIF data. If this information is present, <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span>
+ reads this information and automatically rotates the image.
+ </p></div></div></div>
+<div class="note note-important"><div class="note-inner"><div class="note-contents"><p class="p first-child"><span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> does not provide a way to save the
+ altered orientation back into the file. If you want to modify
+ the image-data, this needs to be done with an image-editor, like
+ <span xmlns:e="http://projectmallard.org/experimental/" class=" app">The GIMP</span>.
+ </p></div></div></div>
+</div>
+</div>
+</div>
+<div class="section" id="">
+<div class="header"><h2 class="title">Switching between images</h2></div>
+<div class="contents">
+<p class="p first-child">
+ When an image is opened in <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span>, it shows a list of
+ images in the <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Thumbnailbar</span>, these are the other images
+ located inside the same folder as the currently opened image. The
+ arrow-buttons on the <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">navigation toolbar</span> allow for easy
+ switching between different images.
+ </p>
+<p class="p">
+ Also, using the scroll-wheel on the opened image, or on the
+ <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Thumbnailbar</span> will switch to the next or previous image.
+ Allowing for fast and easy navigation between images.
+ </p>
+</div>
+<div class="section" id="">
+<div class="header"><h3 class="title">Slideshow</h3></div>
+<div class="contents">
+<p class="p first-child">
+ To run a slideshow of all the opened images, all you need to do is
+ press the <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Play</span> button. This can be found on the Toolbar
+ and the <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">View</span> menu.
+ </p>
+<div class="note note-tip"><div class="note-inner"><div class="note-contents"><p class="p first-child">
+ The duration of the timeout before the next image is shown can be
+ configured inside the <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Preferences</span> dialog, by default it
+ is set to 5 seconds.
+ </p></div></div></div>
+<div class="note note-tip"><div class="note-inner"><div class="note-contents"><p class="p first-child">
+ When <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Wrap around images</span> is disabled, the slideshow will stop at
+ the last image. To prevent this, enable the option
+ <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Wrap around images</span> in the <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Preferences Dialog</span>.
+ </p></div></div></div>
+</div>
+</div>
+</div>
+<div class="section autolinkssection">
+<div class="header"><h2 class="title">Further Reading</h2></div>
+<div class="autolinks">
+<div class="title"><span>More About</span></div>
+<ul><li class="autolink"><a href="index.html#introduction">Introduction</a></li></ul>
+<div class="title"><span>See Also</span></div>
+<ul><li class="autolink">
+<a href="preferences.html">Preferences</a><span class="desc"> — <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Image Viewer</span> Preferences</span>
+</li></ul>
+</div>
+</div>
+</div>
+<div class="footbar"><div class="copyrights"></div></div>
+</body>
+</html>
diff --git a/help/ristretto/C/index.html b/help/ristretto/C/index.html
new file mode 100644
index 0000000..ecbb3e3
--- /dev/null
+++ b/help/ristretto/C/index.html
@@ -0,0 +1,43 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html xmlns:str="http://exslt.org/strings">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Ristretto</title>
+<link rel="stylesheet" type="text/css" href="../ristretto.css">
+</head>
+<body class="">
+<div class="headbar"></div>
+<div class="body">
+<div class="header"><h1 class="title">Ristretto</h1></div>
+<div class="contents"><div class="topiclinks"></div></div>
+<div class="section" id="introduction">
+<div class="header"><h2 class="title">Introduction</h2></div>
+<div class="contents">
+<p class="p first-child">
+ The <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto Image Viewer</span> is an application that can be
+ used to scroll through images. It can be used to run a slideshow of
+ images, open images with other applications like an image-editor
+ or set the Xfce wallpaper.
+ </p>
+<div class="topiclinks"><a href="getting-started.html"><div class="linkdiv">
+<div class="title">Getting Started...</div>
+<div class="desc">Getting started with <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto Image Viewer</span>
+</div>
+</div></a></div>
+</div>
+</div>
+<div class="section" id="image-viewer">
+<div class="header"><h2 class="title">Image Viewer</h2></div>
+<div class="contents"><div class="topiclinks"><table class="twocolumn"><tr>
+<td class="twocolumnleft"><a href="preferences.html"><div class="linkdiv">
+<div class="title">Preferences</div>
+<div class="desc">
+<span xmlns:e="http://projectmallard.org/experimental/" class=" app">Image Viewer</span> Preferences</div>
+</div></a></td>
+<td class="twocolumnright"></td>
+</tr></table></div></div>
+</div>
+</div>
+<div class="footbar"><div class="copyrights"></div></div>
+</body>
+</html>
diff --git a/help/ristretto/C/media/preferences-behaviour.png b/help/ristretto/C/media/preferences-behaviour.png
new file mode 100644
index 0000000..fa7caf8
Binary files /dev/null and b/help/ristretto/C/media/preferences-behaviour.png differ
diff --git a/help/ristretto/C/media/preferences-control.png b/help/ristretto/C/media/preferences-control.png
new file mode 100644
index 0000000..41d2eb4
Binary files /dev/null and b/help/ristretto/C/media/preferences-control.png differ
diff --git a/help/ristretto/C/media/preferences-display.png b/help/ristretto/C/media/preferences-display.png
new file mode 100644
index 0000000..ebff616
Binary files /dev/null and b/help/ristretto/C/media/preferences-display.png differ
diff --git a/help/ristretto/C/media/preferences-slideshow.png b/help/ristretto/C/media/preferences-slideshow.png
new file mode 100644
index 0000000..87ee707
Binary files /dev/null and b/help/ristretto/C/media/preferences-slideshow.png differ
diff --git a/help/ristretto/C/media/ristretto.png b/help/ristretto/C/media/ristretto.png
new file mode 100644
index 0000000..ac47d56
Binary files /dev/null and b/help/ristretto/C/media/ristretto.png differ
diff --git a/help/ristretto/C/media/view-images-1.png b/help/ristretto/C/media/view-images-1.png
new file mode 100644
index 0000000..84a6227
Binary files /dev/null and b/help/ristretto/C/media/view-images-1.png differ
diff --git a/help/ristretto/C/preferences.html b/help/ristretto/C/preferences.html
new file mode 100644
index 0000000..064c99f
--- /dev/null
+++ b/help/ristretto/C/preferences.html
@@ -0,0 +1,181 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html xmlns:str="http://exslt.org/strings">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Preferences</title>
+<link rel="stylesheet" type="text/css" href="../ristretto.css">
+</head>
+<body class="">
+<div class="headbar"><div class="linktrails"><div class="linktrail">
+<a class="linktrail" href="index.html">Ristretto</a> › <a class="linktrail" href="index.html#image-viewer">Image Viewer</a> » </div></div></div>
+<div class="body">
+<div class="header"><h1 class="title">Preferences</h1></div>
+<div class="contents"><p class="p">
+ The behaviour and looks of <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> can be modified,
+ mostly through options displayed in the <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Preferences Dialog</span>.
+ </p></div>
+<div class="section" id="preferences-dialog">
+<div class="header"><h2 class="title">Preferences Dialog</h2></div>
+<div class="contents"><p class="p first-child">
+ The Preferences dialog allows a user to configure different
+ aspects of <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span>. These options are grouped
+ under the following tabs.
+ </p></div>
+<div class="section" id="display-preferences">
+<div class="header"><h3 class="title">Display preferences</h3></div>
+<div class="contents">
+<p class="p first-child">
+ </p>
+<div class="figure">
+<div class="title title-figure">Display preferences</div>
+<div class="figure-contents"><div class="media media-image first-child"><img src="media/preferences-display.png" alt=""></div></div>
+</div>
+</div>
+<div class="section" id="">
+<div class="header"><h4 class="title">Override background color</h4></div>
+<div class="contents"><p class="p first-child">
+ Did you notice how the background-color around the image was
+ the same as the rest of the window? It was themed by Gtk+,
+ when you enable this option, the theme-color is overridden by
+ whatever you set here.
+ Most people like it black, but there is no limitation to the
+ colors you can pick.
+ </p></div>
+</div>
+<div class="section" id="">
+<div class="header"><h4 class="title">Merge toolbars</h4></div>
+<div class="contents"><p class="p first-child">
+ By default, <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> comes with two toolbars,
+ one containing the file-operations, and one for navigating
+ the opened images. If you want to reduce the amount of
+ space used for the different buttons, you can enable this
+ option and the two toolbars merge into one.
+ </p></div>
+</div>
+<div class="section" id="">
+<div class="header"><h4 class="title">Hide Thumbnailbar when fullscreen</h4></div>
+<div class="contents"><p class="p first-child">
+ If the <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> window is fullscreen, you can
+ choose to automatically hide the thumbnailbar. Even though
+ the thumbnailbar is normally visible. This option overrides
+ the <span xmlns:e="http://projectmallard.org/experimental/" class=" keyseq"><span class=" key">Control</span>+<span class=" key">t</span></span>
+ shortcut for toggleing the visibility of the thumbnailbar.
+ </p></div>
+</div>
+</div>
+<div class="section" id="slideshow-preferences">
+<div class="header"><h3 class="title">Slideshow preferences</h3></div>
+<div class="contents">
+<p class="p first-child">
+ </p>
+<div class="figure">
+<div class="title title-figure">Slideshow preferences</div>
+<div class="figure-contents"><div class="media media-image first-child"><img src="media/preferences-slideshow.png" alt=""></div></div>
+</div>
+</div>
+<div class="section" id="">
+<div class="header"><h4 class="title">Timeout</h4></div>
+<div class="contents"><p class="p first-child">
+ When showing a slideshow of images, the value of this
+ slider determines how long <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> will show each image.
+ </p></div>
+</div>
+</div>
+<div class="section" id="control-preferences">
+<div class="header"><h3 class="title">Control preferences</h3></div>
+<div class="contents">
+<p class="p first-child">
+ </p>
+<div class="figure">
+<div class="title title-figure">Control preferences</div>
+<div class="figure-contents"><div class="media media-image first-child"><img src="media/preferences-control.png" alt=""></div></div>
+</div>
+</div>
+<div class="section" id="">
+<div class="header"><h4 class="title">Revert zoom direction</h4></div>
+<div class="contents"><p class="p first-child">
+ By default, <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> zooms <span xmlns:e="http://projectmallard.org/experimental/" class=" em">in</span> when
+ you turn the scroll-wheel forward, and zooms <span xmlns:e="http://projectmallard.org/experimental/" class=" em">out</span> when you turn
+ the scroll-wheel backward. For touch-pads, this can be awkward, because
+ a two-finger scroll is more of a pushing and pulling action.
+ With this option set, turning the scroll-wheel forward
+ will zoom <span xmlns:e="http://projectmallard.org/experimental/" class=" em">out</span> (pushing the image away) and turning the
+ scroll-wheel backward will zoom <span xmlns:e="http://projectmallard.org/experimental/" class=" em">in</span> (pulling the image closer).
+ </p></div>
+</div>
+</div>
+<div class="section" id="behaviour-preferences">
+<div class="header"><h3 class="title">Behaviour preferences</h3></div>
+<div class="contents">
+<p class="p first-child">
+ </p>
+<div class="figure">
+<div class="title title-figure">Behaviour preferences</div>
+<div class="figure-contents"><div class="media media-image first-child"><img src="media/preferences-behaviour.png" alt=""></div></div>
+</div>
+</div>
+<div class="section" id="">
+<div class="header"><h4 class="title">Maximize window on startup when opening an image</h4></div>
+<div class="contents"><p class="p first-child">
+ This option will automatically maximize the main window whenever
+ <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> is launched with a file argument.
+ </p></div>
+</div>
+<div class="section" id="">
+<div class="header"><h4 class="title">Wrap around images</h4></div>
+<div class="contents"><p class="p first-child">
+ With this option set, <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> will wrap
+ around images. When pressing <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Next</span> on the last image, or
+ <span xmlns:e="http://projectmallard.org/experimental/" class=" gui">Previous</span> on the first image, it will jump to
+ the <span xmlns:e="http://projectmallard.org/experimental/" class=" em">Last</span> or <span xmlns:e="http://projectmallard.org/experimental/" class=" em">First</span> image respectively.
+ </p></div>
+</div>
+</div>
+</div>
+<div class="section" id="advanced-preferences">
+<div class="header"><h2 class="title">Advanced options</h2></div>
+<div class="contents"><p class="p first-child">
+ </p></div>
+<div class="section" id="thunar-properties-dialog">
+<div class="header"><h3 class="title">Don't use Thunar to show the file-properties dialog</h3></div>
+<div class="contents">
+<p class="p first-child">
+ By default, <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> will ask thunar to pop-up
+ the file-properties dialog. This way, you'll have the
+ advantage of all of thunar's plugins that extend it's file-properties
+ dialog beyond it's native functionality. Aswell as a consistent
+ look-and-feel throughout the xfce desktop.
+ </p>
+<p class="p">
+ However, there are some cases where you want <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> not
+ to use Thunar, but go for the build-in dialog all the times.
+ This can be the case when you have Thunar installed, but don't use it.
+ Launching the file-properties dialog from <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto</span> will then
+ cause Thunar to be launched, making it a pretty expensive
+ dialog.
+ </p>
+<p class="p">
+ Being a somewhat advanced feature, this option is not
+ exposed through the preferences-dialog, and can only be enabled through
+ the <span xmlns:e="http://projectmallard.org/experimental/" class=" app">xfconf command-line utility</span> <span xmlns:e="http://projectmallard.org/experimental/" class=" cmd">xfconf-query</span>.
+ This can be done as followed:
+ </p>
+<pre class="screen"><span xmlns:e="http://projectmallard.org/experimental/" class="output-prompt output">$ </span><span xmlns:e="http://projectmallard.org/experimental/" class=" input">xfconf-query -c ristretto -p /window/use-thunar-properties -n -t bool -s false</span></pre>
+</div>
+</div>
+</div>
+<div class="section autolinkssection">
+<div class="header"><h2 class="title">Further Reading</h2></div>
+<div class="autolinks">
+<div class="title"><span>More About</span></div>
+<ul><li class="autolink"><a href="index.html#image-viewer">Image Viewer</a></li></ul>
+<div class="title"><span>See Also</span></div>
+<ul><li class="autolink">
+<a href="getting-started.html">Getting Started...</a><span class="desc"> — Getting started with <span xmlns:e="http://projectmallard.org/experimental/" class=" app">Ristretto Image Viewer</span></span>
+</li></ul>
+</div>
+</div>
+</div>
+<div class="footbar"><div class="copyrights"></div></div>
+</body>
+</html>
diff --git a/help/xfce4-clipman-plugin/index.css b/help/ristretto/ristretto.css
similarity index 100%
copy from help/xfce4-clipman-plugin/index.css
copy to help/ristretto/ristretto.css
diff --git a/index.php b/index.php
index e795911..37e037e 100644
--- a/index.php
+++ b/index.php
@@ -38,7 +38,7 @@
</ul>
<h3>Applications</h3>
<ul>
- <!-- <li><a href="/help.php?package=ristretto">Ristretto</a></li> -->
+ <li><a href="/help.php?package=ristretto">Ristretto</a></li>
<li><a href="/help.php?package=terminal">Terminal</a></li>
</ul>
<h3>Panel Plugins</h3>
More information about the Xfce4-commits
mailing list