From 47d455dd55be855e4cc691c32f687f723d9247ee Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdegraphics@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- doc/kuickshow/Makefile.am | 4 + doc/kuickshow/index.docbook | 1041 ++++++++++++++++++++++++++++++++++++++++++ doc/kuickshow/screenshot.png | Bin 0 -> 235434 bytes 3 files changed, 1045 insertions(+) create mode 100644 doc/kuickshow/Makefile.am create mode 100644 doc/kuickshow/index.docbook create mode 100644 doc/kuickshow/screenshot.png (limited to 'doc/kuickshow') diff --git a/doc/kuickshow/Makefile.am b/doc/kuickshow/Makefile.am new file mode 100644 index 00000000..085981d9 --- /dev/null +++ b/doc/kuickshow/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kuickshow/index.docbook b/doc/kuickshow/index.docbook new file mode 100644 index 00000000..e454e2bf --- /dev/null +++ b/doc/kuickshow/index.docbook @@ -0,0 +1,1041 @@ + + + + + +]> + + + + + +The &kuickshow; Handbook + + + +Carsten +Pfeiffer + +
&Carsten.Pfeiffer.mail;
+ + + + + + +2001 +&Carsten.Pfeiffer; + + +&FDLNotice; + +2005-12-29 +0.8.7 + + + + + +&kuickshow; is a comfortable image browser/viewer. + + + + +KDE +kdegraphics +kuickshow +image +viewer + + + + + +Introduction + + +&kuickshow; is a comfortable image browser/viewer. It displays a +filebrowser where you can select images which are then shown. + + + + +The following image formats are supported: + +jpg + +gif + +tiff + +png + +bmp + +psd + +xpm + +ppm + +pgm + +pbm + +pnm + +eim + +xcf + + + +Images can be displayed either in their own window, as large as +the image, or fullscreen. + + + + +Using &kuickshow; + +Using &kuickshow; is very simple. The file browser lists files, +which you can select with a &LMB; click or the Return +key. + + +Here's a screenshot of &kuickshow; + + + + + + + + + Screenshot + + + + + + +More &kuickshow; features + +The options dialog makes available more possibilities: + + +Images can be automatically shrunk to fit onto the +screen, if they are larger. + +You can configure whether images should show up in +their own window, or always use the same window. + +You can set the delay time for a slide show. + +You can tell the browser which file types to show. + +You can tweak the speed/quality +ratio + + +If you are looking for a certain file, just enter the first few +characters of it's filename in the browser. A small edit window will +pop up in the bottom right corner. When a matching file is found, it +is highlighted. You can leave the edit window by pressing +Return or &Esc;. + + + + + +The <guilabel>&kuickshow; Configuration</guilabel> +Dialog + +The &kuickshow; Configuration dialog +contains 5 tabs. Three of them, General, Modifications +and Slideshow +configure the operation of &kuickshow;, and the other two, +Viewer Shortcuts +and Browser Shortcuts +allow you to personalize the shortcuts for the +respective windows. + + +<guilabel>General</guilabel> Options + +The General contains the options to +configure and tune &kuickshow;. + + + +Fullscreen mode + +If this is selected, images open in full screen mode. If the +image is not large enough to fill the screen, the rest of the screen +is filled with the background color selected below. The default is +off. + + + + +Preload next image + +If this is selected, &kuickshow; will load the next image in the +folder, while you are looking at the current one. This reduces the +delay when you select the next image, and is especially useful for +slide shows. + + + + +Remember last folder + +If this is selected, &kuickshow; saves the name of the last folder on exit. +On next start &kuickshow; will open this folder in the browser window. + + + + +Background color: + +Click on the colored bar to select a background color. This is +used to fill the screen in fullscreen mode, or the window, if you have +resized it larger than the image. + + + + +Show only files with extension: + +You can configure &kuickshow; to only show you some of the file +types it is capable of. + + + + + + +<guilabel>Quality/Speed</guilabel> + +Fast rendering +Render things fast. + + + + +Dither in HiColor (15/16bit) modes + + + + + + +Dither in LowColor (<=8bit) modes + + + + + + +Use own color palette + + + + + + +Fast palette remapping + + + + + + +Maximum cache size (MB): + + + + + + + + + + +The <guilabel>Modifications</guilabel> Tab + +Check Apply default image modifications to open an image +with these modifications in &kuickshow;. + + +<guilabel>Scaling</guilabel> + +Shrink image to screen size, if larger + +If this is selected, large images are displayed in maximized window. The default is +on. + + + + +Shrink image to screen size, if smaler, up to factor: + +If this is selected, &kuickshow; increases the magnification of small images up to +the selected factor. + + + + + + +<guilabel>Geometry</guilabel> + +Flip vertically +Flips the image vertically. + + + + +Flip horizontally +Flips the image horizontally. + + + + +Rotate image +Rotates the image to 0, 90, 180 or 270 degrees. + + + + + + + +<guilabel>Adjustments</guilabel> + +Brightness: +Lightens/darkens the image. + + + + +Contrast: +Adds/Removes contrast. + + + +Gamma: +More/less gamma. + + + + + + +A Preview of the Original +and Modified image is displayed below this options. + + + + +The <guilabel>Slideshow</guilabel> Tab + + + + +Switch to full-screen + +Indicates if &kuickshow; should switch to full-screen mode +when starting the slideshow. + + + + +Start with current image + +Indicates if the slideshow should start with the first +image in the folder or with the image which is selected. + + + + +Delay between slides: + +The length of time between image changes during the slideshow. +You can use the slider, type a new value into the field, +or use the small arrows to increase or decrease the value. The +default is 3 seconds. + + + + +Iterations (0 = infinite): + +The amount of iterations. If set to 0 it will loop untill you +abort the slideshow. You can use the slider, type a new value into the +field, or use the small arrows to increase or decrease the value. The +default is 1. + + + + + + + +The <guimenu>Shortcuts</guimenu> Tabs +Change the shortcuts for the different modes of &kuickshow; +in the Viewer Shortcuts and the Browser Shortcuts tabs. + + + + + +Menu Reference + + +The <guimenu>File</guimenu> Menu + + + + + +&Ctrl;O + +File +Open + +Opens a new image in &kuickshow;. + + + + +File +Show Image + +Displays the selected image in a new image +window. + + + + +File +Show Image in Aktive Window + +Displays the selected image in the active image +window. + + + + +File +Show Image in Fullscreen Mode + +Displays the selected image in fullscreen mode. + + + + + +F2 +File +Start Slideshow + +Starts a slideshow of the images in the folder. + + + + +&Ctrl; +P +File +Print Image... + +Prints the image. + + + + +&Ctrl;Q +File +Quit + +Quits &kuickshow;. If you have several +images windows open, all of them are closed. + + + + + + + +The <guimenu>Edit</guimenu> Menu + + + + +F10 +Edit +New Folder... + + +Create a new folder. + + + + + +&Shift;Delete +Edit +Delete + +Deletes the current file. You will be asked to confirm the +action. + + + + + +&Alt;Return +Edit +Properties + +Displays the properties of the current image file. + + + + + + +The <guimenu>View</guimenu> Menu + + + + +F6 +View +Short View + +If this option is selected, only the names of the files and folders will be shown. +Compare this to detailed view. + + + + +F7 +View +Detailed View + +If this option is selected, the names, sizes, dates, permissions, file owners and group ownerships are shown. +Compare this to short view. + + + + +F8 +View +Show Hidden Files + +This will toggle between revealing and hiding normally hidden files. + + + + +F12 +View +Separate Folders + +Use this option to toggle between a 2 pane view of the file system (one pane for the folders +and one pane for the files) and a one pane view of the file system with folders and files. + + + + +View +Large Icons + +Display the image files in the folder with large icons. +This item is only available in Short View mode. + + + + +View +Small Icons + +Display the image files in the folder with small icons. +This item is only available in Short View mode. + + + + +View +Thumbnail Previews + +Display a preview of the images in the folder. This item is only available in Short View mode. + + + + +&Ctrl;- +View +Zoom Out + +Reduces the image size by ten percent. Again +this refers to the current size of the +image. + + + + +&Ctrl;+ +View +Zoom In + +Enlarges the image by ten percent. Notice that +this refers to the current size of the +picture. + + + + + + +The <guimenu>Settings</guimenu> Menu + + + + +Settings +Configure &kuickshow;... + +Opens a dialog for changing some options as +described in the section + + + + + + + +The <guimenu>Help</guimenu> Menu + + + + + + +F1 + +Help +&kappname; Handbook + + +Invokes the &kde; Help system starting at the +&kappname; help pages. (this document). + + + + +Help +Report Bug... + +Opens the Bug report dialog where you can +report a bug or request a wishlist feature. + + + + +Help +About &kappname; + +This will display version and author +information. + + + + +Help +About KDE + +This displays the &kde; version and other basic +information. + + + + + + + + +Command Reference + + +The Image Window + +All the shortcuts are configurable from the Configuration Dialog. + + +Image Window Keyboard Shortcuts + + + +Key +Action + + + + +Page Down +Load the next image + + +Page Up +Load the previous image + + +Home +Loads the first image + + +End +Loads the last image + + ++ +Zooms into the image + + +- +Zooms out of the image + + +* +Flips the image horizontally + + +/ +Flips the image vertically + + +7 +Rotates 270° clockwise (which is also 90° +counter-clockwise) + + +8 +Rotates 90° clockwise + + +9 +Rotates 180° clockwise + + +Arrow keys +Move the image (or rather, you, the viewer,) if it is larger +than the screen + + +Return +Toggles between fullscreen and window mode + + +Space +Toggles the display of the browser + + +&Esc; +Closes the image window. This will close &kuickshow; entirely, +if you don't have a browser window open. + + +B/&Shift;B +Lightens/darkens the image + + +C/&Shift;C +Adds/Removes contrast + + +G/&Shift;G +More/less gamma + + +O +Shows the image in original size. This is only useful when you +have enabled automatic scaling. + + +Enter +Redisplays the image with the default settings and +size. + + +&Ctrl;S +Opens the Save As dialog + + +Delete +Deletes the current image. You will be asked to confirm the +request. + + +&Shift;Delete +Deletes the current image without asking for +confirmation + + +&Alt;Return +Displays the properties of the image + + +F1 +Opens the online help (this file) + + +&Ctrl;W +Quits &kuickshow; + + + +
+ + +Image Window Mouse Usage + + + +Mouse button +Action + + + + +Right click +Opens the context menu, with several options + + +Left drag +Moves the image, if it doesn't fit in the window. + + +&Shift;Left + drag +Marks a rectangle you can zoom into. + + +Left double click +Closes the current image + + + +
+ + + + +The Browser Window + + +Browser Window Keybindings + + + +Keybinding +Action + + + + +Return +Enters a folder, or opens an image window, depending on the +item selected. + + +Page Down +Advances one page in the list of files + + +Page Up +Moves back up a page in the list of files + + +Home +Selects the first file or folder + + +End +Selects the last file or folder + + +Space +Toggles showing the browser, if an image window is open + + +any alpha-numeric character +Opens the edit field used for completion. Enter +the first characters of a filename to search for, and if found, the +file will be selected. + + +&Ctrl;G +Go to — lets you enter a folder to go +to. + + +Delete +Deletes the current file. You will be asked to confirm the +action. + + +&Shift;Delete +Deletes the current file without asking for +confirmation. + + +F1 +Opens the online help (this file) + + +&Ctrl;Q +Quits &kuickshow; + + + +
+ + +Browser Window Mouse Usage + + + +Mouse Usage +Action + + + + +Left click +Enter a folder, or select an image window. + + +Right click +Opens a context menu, with several options. + + +Double click +Loads the selected image or enters the selected +folder + + + + +
+ + + + + + + + +Credits and License + + +&kuickshow; + + +Program copyright 1998-2002 &Carsten.Pfeiffer; &Carsten.Pfeiffer.mail; + + + +Documentation copyright 2001 &Carsten.Pfeiffer; &Carsten.Pfeiffer.mail; + +Converted to DocBook &XML; and extended by &Lauri.Watts; +&Lauri.Watts.mail; + + + +&underFDL; + +&underGPL; + + + + +Installation + + +How to obtain &kuickshow; + +&install.intro.documentation; + + + + +Requirements + +To be written + + + + + + +Compilation and Installation + +&install.compile.documentation; + + + + + +&documentation.index; + + + + diff --git a/doc/kuickshow/screenshot.png b/doc/kuickshow/screenshot.png new file mode 100644 index 00000000..a57bd4c7 Binary files /dev/null and b/doc/kuickshow/screenshot.png differ -- cgit v1.2.1