@DATABASE "Default" @NODE "main" "PicShow Guide" @TOC "main" @{" Contents " LINK "main"} @{" Intro " LINK "e_intro"} @{" Install " LINK "e_install"} @{" Config " LINK "e_config"} @{" Usage " LINK "e_usage"} @{" Arexx " LINK "e_arexx"} @{" Keys " LINK "e_keys"} @{" Nav " LINK "e_nav"} @{" Future " LINK "e_future"} @{B}Contents@{UB} @{B}========@{UB} @{" Intro " LINK "e_intro"} What PicShow is @{" Install " LINK "e_install"} Where to copy PicShow @{" Config " LINK "e_config"} How to start PicShow @{" Usage " LINK "e_usage"} How to operate PicShow @{" Arexx " LINK "e_arexx"} How to influence PicShow from outside @{" Keys " LINK "e_keys"} How to configure your own function keys @{" Nav " LINK "e_nav"} How to configure the navigation panel @{" Future " LINK "e_future"} What I think to do next @{B}Contact@{UB} @{B}=======@{UB} Please send bug reports, feature requests and other suggestions to @{B}thomas-rapp@web.de@{UB}. @ENDNODE @NODE "e_intro" "PicShow Guide" @TOC "main" @{" Contents " LINK "main"} @{" Intro " LINK "e_intro"} @{" Install " LINK "e_install"} @{" Config " LINK "e_config"} @{" Usage " LINK "e_usage"} @{" Arexx " LINK "e_arexx"} @{" Keys " LINK "e_keys"} @{" Nav " LINK "e_nav"} @{" Future " LINK "e_future"} @{B}Introduction@{UB} @{B}============@{UB} This program is meant to be configured as picture viewer in directory tools like DirOpus or DosControl. It shows the doubleclicked picture in a borderless window on the specified custom screen. The remarkable about this program is that it reads the whole directory the picture is in and you can then choose other pictures out of this directory from a menu or by pressing the cursor keys. PicShow can also be used as a simple slide show program. It can display pictures either in sort order or randomly. When run on its own screen there are also some nice blend effects. @ENDNODE @NODE "e_install" "PicShow Guide" @TOC "main" @{" Contents " LINK "main"} @{" Intro " LINK "e_intro"} @{" Install " LINK "e_install"} @{" Config " LINK "e_config"} @{" Usage " LINK "e_usage"} @{" Arexx " LINK "e_arexx"} @{" Keys " LINK "e_keys"} @{" Nav " LINK "e_nav"} @{" Future " LINK "e_future"} @{B}Installation@{UB} @{B}============@{UB} 1. Copy the PicShow executable somewhere where your directory tool can find it. A good place is the C directory. 2. If you want to redefine the function keys, you need to create a file called PicShow.keys in one of the following directories: - S: - ENV: or ENVARC: - the directory the PicShow program is in - the directory PicShow is started from (e.g. where the pictures live) You can take the @{"provided file" LINK "PicShow.keys/MAIN"} as an Example. See the section about @{"key bindings" LINK "e_keys"} to learn about the contents of the file. 3. Copy the skin file PicShowNav.iff to the same directory as the PicShow program. If you choose another location, you must @{"configure PicShow" LINK "e_config" 103} to find it. Otherwise the @{"navigation panel" LINK "e_nav"} will not be usable. 4. The PicShowTem program is only needed, if you want to create your own skins for the navigation panel. Copy it to where your utilities live. @ENDNODE @NODE "e_config" "PicShow Guide" @TOC "main" @{" Contents " LINK "main"} @{" Intro " LINK "e_intro"} @{" Install " LINK "e_install"} @{" Config " LINK "e_config"} @{" Usage " LINK "e_usage"} @{" Arexx " LINK "e_arexx"} @{" Keys " LINK "e_keys"} @{" Nav " LINK "e_nav"} @{" Future " LINK "e_future"} @{B}Configuration@{UB} @{B}=============@{UB} Call PicShow as a Shell program with the following parameters. At the @{"bottom of the page" LINK "e_config" 126} is a step-by-step example how to configure a picture file type in DirectoryOpus Magellan. FILE The picture to show first. You can specify a directory here. In this case the directory is read first and then the topmost picture is shown. PUBSCREEN/K The pubscreen where to open the window. Default is the default pubscreen (usually Workbench). P=PATTERN/K Only picture files that match this name pattern are shown in the list. FLASH/S Flashes the screen (displays beep) after the directory read is complete. DONTCHECK/S Files are not checked if they are pictures before they are inserted into the list. This does speed up the directory read a lot, but files that are no pictures are shown in the list, too. You should use the PATTERN parameter to avoid this. DELAY/N/K Enable slide show: every n/10 seconds the next picture is shown (DELAY=20 means every 2 seconds a new picture). SCREEN/S Open a new screen for PicShow BG=BACKGROUND/K Background color for the new screen. Format is six hexadecimal numbers: rrggbb rr = amount of red color (00 - ff) gg = amount of green color (00 - ff) bb = amount of blue color (00 - ff) Default is 000000 (black). PORT/K Name of the Arexx port. Default is PICSHOW. MODEID/N Decimal ID of screen mode. Default is same as Workbench. DEPTH/N Depth to use for custom screen. Default is same as Workbench. QUIET/S Disabled error requesters when picture cannot be loaded CLOSEWB/S Attempt to close Workbench when screen is open REQ/S Force PicShow to open a file requester. FILE is taken as preset file name. KEYS/K Name of a file that contains key bindings NOINFO/S Disable the info bubble. It can be opened by a key anyway. SCALE/S Enable scaling. Pictures will be scaled up or down to fit the screen size. DOWN/S Scale only down (do not enlarge small pictures). FILL/S Scale up picture to totaly fill the screen. This maybe useful to check whether a picture (or part of) is usable as a backdrop. INTERPOL/S Scale pictures using interpolation. Needs much more time than without. CACHE/N/K Number of pictures that are to be cached. Default is 5. BLEND/K Enable/Disable blend effects. Choose one of the following: NONE disable blending RANDOM randomly use one of the following UP DOWN LEFT RIGHT RIGHTDOWN RIGHTUP LEFTDOWN LEFTUP RIGHTDOWN2 RIGHTUP2 LEFTDOWN2 LEFTUP2 BLENDTIME/K/N The time used for blending in 1/10th seconds. NOPOINTER/S Disable the mouse pointer. SHUFFLE/S Show pictures in random order. Does only affect slide show (Delay > 0) NAV=NAVIGATION/S Open the navigation panel. See the section about the @{"navigation panel" LINK "e_nav"} for more details. NAVSKIN/K Skin for navigation panel. Default is PROGDIR:PicShowNav.iff. See the section about the @{"navigation panel" LINK "e_nav" 72} for more details. NAVBUTTONS/K Sequence of buttons on the navigation panel. See the section about the @{"navigation panel" LINK "e_nav" 56} for more details. If PicShow is started from the Workbench all of the above can be entered as tooltypes, either in the program icon or in the picture icon that is activated first. Tooltypes in the picture icon overide those in the program icon. Picture icons can be activated by shift-click or by specifying PicShow as default tool. There is one additional option that can only be activated as ToolType: KEY= Rebind one key. May be specified multiple times for different keys. Read the section about @{"key bindings" LINK "e_keys"} for an explanation of . Example: KEY=X=QUIT enable the key X to quit PicShow @{B}Creating a picture file type in DirOpus Magellan@{UB} @{B}================================================@{UB} Just follow these steps: - choose menu Settings / File Types - click on Add - enter Name: picture - enter ID: pict - enter Pri: 0 - click on Add - choose Match DT Group - enter pict - click on Use - choose Double-click - click on Edit - click on Add - choose AmigaDOS - enter c:PicShow {f} pubscreen {Qs} pattern ~(#?.info) - switch on Run asynchronously - click on Use - click on Use - click on Save Instead of c:PicShow you must enter the path to where you installed PicShow. Behind the program name you can configure all settings as described @{"above" LINK "e_config" 12}. For more information please read the @{"DOpus manual" LINK "DOpus5:help/dopus5.guide/File Type Editor"} ! @ENDNODE @NODE "e_usage" "PicShow Guide" @TOC "main" @{" Contents " LINK "main"} @{" Intro " LINK "e_intro"} @{" Install " LINK "e_install"} @{" Config " LINK "e_config"} @{" Usage " LINK "e_usage"} @{" Arexx " LINK "e_arexx"} @{" Keys " LINK "e_keys"} @{" Nav " LINK "e_nav"} @{" Future " LINK "e_future"} @{B}Usage@{UB} @{B}=====@{UB} When the window showing a picture is open you can do this: NOTE: these are the default keys. Read the section about @{"key bindings" LINK "e_keys"} to learn how to change them. o Quit PicShow - double click into the window or - press the ESC key or - press Q o Show the next picture - press the cursor down key or - press the cursor right key or - press the cursor down or right keys on the numeric keypad o Show the previous picture - press the cursor up key or - press the cursor left key or - press the cursor up or left keys on the numeric keypad or - press backspace (the <- key above return) o Show a random picture - press space bar or - press return o Show the previous picture in the cache (retrace) - press R o Show the next picture in the cache (undo retrace) - press T o Show some infos about the current picture - keep the mouse pointer inside the window and don't move it for some time (can be disabled by an option) o If the picture is too large to fit into the screen - grab the picture with the left mouse button and move it around. o Choose a picture from the list - press the right mouse button and hold it down. The list can scroll up and down if there are more files than fit into one page. Just move the mouse pointer over the arrow(s). o Read a new directory - Press F1 o Swap display from Workbench to PicShow's own screen and back - Press F10 o Invert the background color of PicShow's own screen (e.g. from black to white and vice versa) - Press F9 o Pause / continue slide show - Press P o Save the picture as displayed on screen: - Press S o Save a hardcopy of the screen: - Press A Note: this command works different in window and screen mode: in window mode the part of the picture that is shown on the screen is saved. In screen mode a hardcopy of the entire screen is saved (the part of the picture that fits on screen plus frames). o Open/close the navigation panel - Press F5 In the example file @{"PicShow.keys" LINK "PicShow.keys/MAIN"} the following additional keys are defined: o Copy the displayed picture into RAM: - Press C The file name is "pic_xx.". Example: pic0001_640x480x8.ilbm This is only an example. Read the section about @{"key bindings" LINK "e_keys"} for a description on how to configure your own shell commands. o Open the picture list - press M o Enable/disable the info bubble - press I @ENDNODE @NODE "e_arexx" "PicShow Guide" @TOC "main" @{" Contents " LINK "main"} @{" Intro " LINK "e_intro"} @{" Install " LINK "e_install"} @{" Config " LINK "e_config"} @{" Usage " LINK "e_usage"} @{" Arexx " LINK "e_arexx"} @{" Keys " LINK "e_keys"} @{" Nav " LINK "e_nav"} @{" Future " LINK "e_future"} @{B}Arexx port@{UB} @{B}==========@{UB} The name of the ARexx port is PICSHOW. It can be changed by the parameter (or tooltype) PORT. The following commands can be sent to the Arexx port: QUIT Exit PicShow. NEXT Show next picture. PREV Show previous picture. FORWARD Show next picture in cache. BACK Show previous picture in cache (retrace). MENU Open the picture list. SCREEN Toggle screen / Workbench. SCREEN Open or close the screen as desired. PUBSCREEN Set the pubscreen name to a new value. FILE Show the named picture and read the new directory. REQ Open the file requester. FLASH Enable/Disable beep as desired. DONTCHECK Enable/Disable file checking as desired. DELAY Set the delay time to a new value. 0 = OFF. BACKGROUND Set the background color to a new value. PATTERN Choose a new file name pattern. Must be set before FILE or REQ. INVERTBG Invert background color of PicShow screen. DEPTH Change current screen depth (if screen is open) MODEID Change current screen mode id (if screen is open) Id is a decimal mode id inquired for example with GetModeID (included in the Visage archive on Aminet) SETDEPTH Set screen depth for next open SETMODEID Set screen mode id for next open Id is a decimal mode id inquired for example with GetModeID (included in the Visage archive on Aminet) CHANGE Reopen screen and apply the above changes. QUIET Dis-/Enables error requesters. CLOSEWB Set CLOSEWB flag as desired. KEYS Load a new key bindings file KEY Rebind one key. INFO Show the info bubble INFO Enable or disable the automatic info bubble NOINFO Disable the automatic info bubble SCALE Enable or disable scaling. See @{"parameter description" LINK "e_config" 62} for an explanation of DOWN and FILL. INTERPOL Enable or disable interpolation. CACHE Set cache size BLEND Enable/disable blending. See @{"parameter description" LINK "e_config" 76} for possible names. BLENDTIME Set blend time. POINTER Enable/disable mouse pointer. STOP Pause / continue slide show STOP ON Pause slide show STOP OFF Continue slide show SAVE Save picture HARDCOPY Save hardcopy SHUFFLE Enable/disable random order in slide show @ENDNODE @NODE "e_keys" "PicShow Guide" @TOC "main" @{" Contents " LINK "main"} @{" Intro " LINK "e_intro"} @{" Install " LINK "e_install"} @{" Config " LINK "e_config"} @{" Usage " LINK "e_usage"} @{" Arexx " LINK "e_arexx"} @{" Keys " LINK "e_keys"} @{" Nav " LINK "e_nav"} @{" Future " LINK "e_future"} @{B}Key bindings@{UB} @{B}============@{UB} Key bindings are read from the files S:PicShow.keys env:PicShow.keys PROGDIR:PicShow.keys CURRENTDIR:PicShow.keys the file specified by the KEYS function if they exist. Each file can contain any number of keys, one per line. Whenever I talk about a in this guide, the following format is meant: = The may not contain any spaces (except after the SHELL command). can be any key description that also a commodity would accept as a hot key, except qualifiers like shift, alt and ctrl. Examples: a, b, c, 1, 2, 3, Normal keys numpad 1, numpad 2, enter Keys on the numeric key pad f1, f2, f10, help Function keys return, del, backspace Special keys up, down, left, right Cursor keys is what the key should do. Valid commands are: QUIT Exit PicShow. NEXT Show next picture. PREV Show previous picture. RANDOM Show random picture. FORWARD Show next picture in cache. BACK Show previous picture in cache. MENU Open the picture list. SCREEN Toggle screen / Workbench. REQ Open the file requester. INFO Open the info bubble. INVERTBG Invert background color of PicShow screen. STOP Pause / continue slide show SAVE Save picture HARDCOPY Save hardcopy SHELL Execute the command line as a shell command. NOP Unbind this key. NAV Open / close the navigation panel In the command line of the SHELL command the following placeholders can be used to include information about the current picture: %p Path %f File name %n Number (starting with 1 at the top of the list) %w Width %h Height %d Depth %t Type The placeholders can contain any modifiers that a C format string accepts (for example %04n for a 4 digit number to the left padded with 0's), Please look into the file @{"PicShow.keys" LINK "PicShow.keys/MAIN"} for examples. @ENDNODE @NODE "e_nav" "PicShow Guide" @TOC "main" @{" Contents " LINK "main"} @{" Intro " LINK "e_intro"} @{" Install " LINK "e_install"} @{" Config " LINK "e_config"} @{" Usage " LINK "e_usage"} @{" Arexx " LINK "e_arexx"} @{" Keys " LINK "e_keys"} @{" Nav " LINK "e_nav"} @{" Future " LINK "e_future"} @{B}The navigation panel@{UB} @{B}====================@{UB} The navigation panel allows the user to navigate PicShow with the mouse. All functions available as key strokes are also available on the navigation panel. The panel is fully configurable. The navigation panel is activated by the NAV parameter or tooltype or by pressing the F5 key. @{B}Possible functions@{UB} @{B}------------------@{UB} The following PicShow functions can be integrated in the navigation panel. Descriptions on arrangement and skins follow. You can use either the number, the short or the long form to specify a function. No. Short Command Description 1 MO MOVE Move the navigation panel 2 NO NOP Empty key with no function 3 QU QUIT Exit picshow 4 CL CLOSE Close the navigation panel 5 RE REQ Open file requester 6 PF PREFS Edit preferences 7 ME MENU Open picture list 8 SC SCREEN Switch screen 9 IV INVERTBG Change background color 10 SA SAVE Save scaled picture 11 HA HARDCOPY Save hardcopy 12 PV PREV Show previous picture 13 NE NEXT Show next picture 14 BA BACK Browse cache backward 15 FO FORWARD Browse cache forward 16 RA RANDOM Show random picture 17 ST STOP Start/stop slide show 18 IF INFO Open/disable info bubble 19 U1 USER1 User definable command 20 U2 USER2 User definable command 21 U3 USER3 User definable command 22 U4 USER4 User definable command 23 U5 USER5 User definable command 24 U6 USER6 User definable command 25 U7 USER7 User definable command 26 U8 USER8 User definable command 27 U9 USER9 User definable command 28 U0 USER10 User definable command The Prefs and User commands do not yet have a function. @{B}How to arrange the buttons@{UB} @{B}--------------------------@{UB} The button arrangement of the navigation panel can be changed by the NAVBUTTONS parameter or tooltype. After the keyword follows a list of functions in the order of appearence. Functions are seperated by comma. Space characters are not allowed. The order is from left to right, alternating the top and bottom button. The MOVE operator must not be used in the arrangement ! It is added automaticaly on the left and right of the panel. The default arrangement is CL,QU,BA,PV,FO,NE,ST,RA,RE,PF,ME,IF,SC,IV,SA,HA. @{B}How to create new skins@{UB} @{B}-----------------------@{UB} The default skin is @{"PicShowNav.iff" LINK "PicShowNav.iff/MAIN"} in the same directory as PicShow. You can specify a different file name or location using the NAVSKIN parameter or tooltype. A skin consists of one picture file containing all buttons and their pressed pendants. The picture starts on the left with the drag bar symbol and its pressed image. Then the buttons follow, the original on the top and the pressed image below. In the default skin the width of the drag bar is 5 pixels and each button is 25 x 25 dots. Each element has a one pixel frame around it. Note that the frame is used by both adjacent buttons. If you want to vary the button size, you must keep the proportions. Use the supplied program @{"PicShowTem" LINK "e_nav" 106} to create a template. If you want to change the order of buttons in the skin or if you want to omit some unsused buttons, you must create an Icon for the picture file containing the tooltype BUTTONS. The BUTTONS argument works just like the @{"NAVBUTTONS" LINK "e_nav" 56} parameter of PicShow with the only exception that this time the string must start with the MOVE command. There are three buttons that change their function when pressed: STOP (start/pause slide show), INFO (show/disable info bubble) and RANDOM (enable/disable random order). In the skin picture the alternate function must follow immediately after the original. In the BUTTONS line the alternate button must get the same function as the original one. Note that the RANDOM button does not yet toggle. @{B}The PicShowTem program@{UB} @{B}----------------------@{UB} The program can be started from Workbench or from the Shell. If called without parameters it opens a GUI window. It needs the width and hight of one button and the number of buttons. It then saves template picture to the giver file name. Currently it does not create an icon for the file. @ENDNODE @NODE "e_future" "PicShow Guide" @TOC "main" @{" Contents " LINK "main"} @{" Intro " LINK "e_intro"} @{" Install " LINK "e_install"} @{" Config " LINK "e_config"} @{" Usage " LINK "e_usage"} @{" Arexx " LINK "e_arexx"} @{" Keys " LINK "e_keys"} @{" Nav " LINK "e_nav"} @{" Future " LINK "e_future"} @{B}Future Ideas / ToDo@{UB} @{B}===================@{UB} - German translation :-) - read configuration from ENV variable - palette requester for the background color - configuration editor - use multitasking instead of multithreading to speed up responsiveness. - preload pictures for more speed (needs multitasking) @{B}Known bugs:@{UB} - Scaling does only work well on >8bit screens. On <=8bit screens, pictures are first dithered and than scaled; looks ugly. - The palette of the displayed picture is corrupted when loading next picture and cache size is 1. - blendtime is exceeded on slow machines. @ENDNODE