Home

FSI documentation - eRez Imaging Server Login

1. Width and Height Description Source image dimensions Syntax Number in pixels Default Context FPX Query FPXWidth and FPXHeight Required parameters specifying the width and height of the source image Please refer to the chapter Retrieving Parameters Automatically for information on how to automatically retrieve these values from the imaging server NeptuneLabs FSI Viewer 23 Configuration Width and height specifications for a source image Width value 3330 gt lt Height value 4660 gt FPX Optional Parameters The following parameters are not required to run FSI Viewer They can be used to alter the appearance of the FSI Viewer user interface Skin Description Filename of FSI Skin to use without extension Syntax String Default Context Options Filename of FSI Skin file to use omit the file extension FSI Skins determine the appearance of the user interface and are located in the subdirectory skins In addition to the default skins that ship with FSI Viewer customized skins are available on demand Please note that using unregistered skins activates the evaluation mode Intro Description Filename of start animation to use without extension Syntax String Default Context Options Filename of animation to display on startup omit the file extension FSI Viewer ships with a default start
2. Please note that when using fullscreen the plugin the Adobe Flash Player prohibits keyboard entries 148 NeptuneLabs FSI Viewer Plug ins Reference Plug in History Plug in Target r interf Si ids History Back History Forward Plug in Location plugins history plg A Function History functionality to jump to previously viewed image sections Syntax Plugin src history length 25 The History plug in extends the user interface by 2 buttons History Back and History Forward Using these two buttons the user is able to navigate through image sections previously viewed Plug in Parameters MenuOffset Description Indentation of the menu buttons Syntax Number Default 0 Context Plug in Tag Specifies the space in pixels left of the menu button s of the plug in Length Description Length of the history list Syntax Number Default 10 Context Plug in tag The number of image sections that will be stored in the view history from 1 to 99 If the list exceeds the amount of entries defined by the length parameter the first entry of the list will be replaced Loop Description Loop the history list Syntax Boolean Default false Context Plug in tag If this value is set to true the viewer will display the first viewed section when exceeding the last entry of the history and the last entry when step
3. Print Description Minimum Height of items in the list Default true Context ShoppingList Version 5 0 0 Enable Disable printing ShowListOnAddl tem Description Show shoppinglist behaviour Syntax string Default once Context ShoppingList Version 5 0 0 Defines wether the shoppinglist is displayed after an item has been added TargetURL Description Defines the target for shoppinglist Default Context ShoppingList Version 5 0 0 Defines the target URL of the servlet the shoppinglist data is send to Template Description Template to use Syntax template name Context ShoppingList Version 5 0 0 Defines the HTML templates to be used for rendering the pages ShowListOnAddl tem Description Show shoppinglist behaviour Default once Context ShoppingList Version 5 0 0 Description of the template 214 NeptuneLabs FSI Viewer Plug ins Reference DialogHeight Description Defines the height of the shoppinglist dialog window Syntax Number Default 400 Context ShoppingList Version 5 0 0 Defines the height of the shoppinglist dialog window DialogWidth Description Defines the width of the shoppinglist dialog window Syntax Number Default 600 Context ShoppingList Version 5 0 0 Defines the width of the shoppinglist dialog window
4. ssse me 87 PageNumbers seem enn 88 PageNumiBGColor re e be tate tents 89 PageNumcColor See ee 88 PageNumlndent AA 88 PAGENUMPOS ec rere rr ern tne rer c 88 PageNUMSi Zoco 88 PageOrderRTL eese 78 Page Oe Sidi eene bh rs 98 Rageverlav bow zZoomed AAA 99 PagelurnS peed uoo tait 79 PreloadBackward 98 PreloadForward idee ea 97 PIE eg ege Ver ee an a 100 PrintEle cs aci tegere 100 PrintResolutton ron rnnnnnnrn 100 PrintTemplate ecce ee tis 100 al 74 Ratio eode noe dett ted ttn ree tasas 84 RememberLastViewedPage cesceesereeeeeeeeeeeeeees 97 RememberLastViewedPageExpireAfter 97 REMOVEPAGES science 71 ReversePageOrder cece eee eeeeeeteteaeeeeeeeeetenes 77 RomanPageNumbersOffset AAA 89 ROtAtION veria hp tees 95 bL CREE 101 SaveAllowSavingl Mages scccrrere 102 SaveDocumentFile esc 101 SaveEffects ainas aen oN a a eei aE 102 SaveOptions n iin a a T een 103 SG vebesolution ec ce ceseseceeeeeeeeeeeeeeeeteteneeaeaeaeees 102 G velemplste AAA 103 SaveURLPrefix and SaveUrlSuffix 101 SaVeURLTArget enne 101 SCrollATEQOWS dre putet stel te era 86 ScrollBaseColor ne 86 Scroll Tracks eire Rr iterare te Parere 86 SII E 103 SearchAutoExactMatch screener 104 SearchAutoWildCards see 104 NeptuneLabs FSI Viewer SearchCustOMURL sssseeee eee 104
5. Offset from right NeptuneLabs FSI Viewer 139 Plug ins Reference posY Description Vertical position Syntax String Number Default Depends on MenuAlign parameter Context Plug in attribute Defines the vertical position of the progress indicator Possible values C Centered vertically Number gt 0 Offset from top Number lt 0 Offset from bottom 140 NeptuneLabs FSI Viewer Plug in ColorAdjust Plug in Target User interface Plug in Location plugins coloradjust plg Function Adjusts the color level of images Syntax Plugin src coloradjust gt Plug in Parameters Color Adjustments Plug ins Reference Drag teh sliders to modify the color balance or brightness of the image AutoHideDialog Description Auto Hide Dialog Syntax Boolean Default true Context ColorAdjust Version 5 0 0 Hides the interface dialog when changing values Blue Description Blue value Syntax Float Default 100 Context ColorAdjust Version 5 0 0 Amount of blue Brightness Description Brightness of image Syntax Float Default 100 Context ColorAdjust Version 5 0 0 The image brightness NeptuneLabs FSI Viewer 141 Plug ins Reference Green Description Green value Syntax Float Default
6. Width Description Width of the select box Syntax Pixels Default 200 depending on skin Context Plug in attribute Usually the FSI Pages skin defines the width and position of the select box Alternatively you can specify a fixed with in pixels using this parameter 136 NeptuneLabs FSI Viewer Plug ins Reference Sort Description Sort index items by page number Syntax Boolean Default true Context Plug in attribute Version 4 1 5 or above By default the plug in sorts the index items ascending by page number Set this parameter to false to use the order in which the index items are listed in the XML file Update Description Update the selected index on page flip Syntax Boolean Default true Context Plug in attribute Version 4 1 5 or above By default the plug in automatically selects the matching index item after a page flip Set this parameter to false to display the first index item always e g to make the plug in display Go to section always ValidateData Description Use valid index items only Syntax Boolean Default true Context Plug in attribute Version 4 1 5 or above By default the plug in does not display items that refer to page numbers higher than the last page or lower than first page Set this parameter to display all index items even if refer to non existing pages Index Item Attributes E
7. ee eee 123 ThumbbBorderWidth esee 123 ThumbEffects a oco iter er reet ae 117 Thumbtace menn 122 ThumbspacingX and ThumbspacingY 121 IDEE 116 UselnitialView eese 116 115 FSI Showcase Add on Basic Parameters BaseColor Description Base color of the thumbnail bar Syntax HexColor Default DDDDDD light gray Context Showcase plug in node or HTTP query prefixed with showcase_ Base color for the thumbnail frame work the scroll bar and the background of the thumbnail bar All color values will automatically be derived from this color if not defined separately see Advanced Parameters BaseScale Description Scale of thumbnail images Syntax Number Default 100 Context Showcase plug in node or HTTP query prefixed with showcase_ Scale of thumbnails in percent e g 150 for 150 of the original size The user can additionally scale the thumbnails by clicking the corresponding buttons in the drag bar menu Please note that this value does not change the dimension of thumbnails being retrieved from the server see ImageWidth and ImageHeight Layout Description Defines the way FSI Showcase integrates into the viewer Syntax outside inside or floating Default outside Context Showcase plug in node or HTTP query prefixed with showcase Outside default The showcase occupies the entire heig
8. Index page 20 label Chapter 2 file chapter2 pdf gt Index page 30 label Chapter 3 file chapter3 pdf Indexdata Please note If you use the FSI Pages parameters SaveUrlPrefix and or SaveUrlSuffix all file attribute values will be prefixed and or suffixed with the values you specified This way you can enter the file names only and provide the path to the files using the FSI Pages parameter SaveUrlPrefix Searching in FSI Pages FSI Pages provides an optional search dialog to perform full text search in documents For performance reasons FSI Pages does not perform the actual search itself Instead it accesses eRez server or any other server capable of returning search results in XML format To enable the search dialog in FSI Pages you simply need to set the FSI Pages parameter Search to true This will add a button to FSI Pages to show or hide the search dialog Depending on the dimension of the FSI Pages instance you might want to increase the size of the search dialog using the FSI Pages parameters SearchDialogWidth and SearchDialogHeight By default FSI Pages adds wildcards to the search keywords the user entered You can disable this feature in case you prefer displaying exact matches or if you are using an external server to return search results that performs wildcard searching by default 62 NeptuneLabs FSI Viewer FSI Pages Add on Using eRez to return Search Result
9. 109 FSI Showcase Add on Image Order The order of the images within the thumbnail bar corresponds to the order of the lt image gt declarations within the lt images gt section Graphical Bookmarks and Product Tours The Showcase does not re load images if the image source did not change e g FPXSrc and Effects You can therefore use the Showcase to create graphical bookmarks or product tours by specifying the same image source FPXSrc for multiple images and defining different InitialView parameters The Showcase parameter UselnitialView should be set to true default in this case FSI Parameters and FSI Showcase All FSI parameters and FSI Plug in parameters can be used with FSI Showcase Add on The only exception is the plug in integration which will be described later on The Showcase Add on follows the hierarchy displayed below to build the configuration for an image Hierarchy of parameter definitions Default Configuration File Showcase Configuration File Image Configuration File Image Node HTTP Query PEDIA This way you can define global parameters for all images by defining the parameters in 1 default configuration 2 showcase configuration or 5 by HTTP query Parameters specific to certain images have to be defined in the external image configuration file 3 or in the lt image gt node of the image list 4 Due to the hierarchy displayed above parameters declared by query override all other
10. 228 NeptuneLabs FSI Viewer Example of a _default fsi file lt fsi_parameter gt This file contains default parameters All parameters will be overwritten by additional fsi files or query parameters gt lt EPX gt lt ServerType value eRez Base value http erez neptunelabs com erez erez src FPX Plugins Plugins src mousemodes PLUGIN src zoommeter SrcRelative 1 gt Plugins Options lt FSIBase value config lt ScenePreload value true lt MenuAlign value BR gt lt Options gt lt fsi_parameter gt Example of an image specific FSI configuration file lt fsi_parameter gt lt FPX gt SS wull ise meets AS as Of gleewe tsi gt Suec value 3d object fpx Width value 8128 gt Height value 9168 TilesX value 4 TilesY value 3 FPX Options XInitialAction value NextScene lt InitialActionDelay value 3 gt lt MenuAlign value TL gt lt NoNav value true gt lt Options gt lt fsi_parameter gt NeptuneLabs FSI Viewer 229 Credits Special thanks go to the following persons for their valuable support such as providing translations sharing their ideas regarding improvements and beta testing Bora Alioglu Oscar Applegren Sven Erik Andersen M rton Bal zs Radu Basca Radoslav Bielik Simone Chiaretta Maciej Chojnacki Jacky Choy Petr Cihar Je
11. Context Plug in tag Specifies an URL to open when the user clicks the button named ID You can specify a URL to a web page or alternatively a script call e g javascript void alert foo Please note You can use templates to be replaced by FSI Viewer at runtime The button appears disabled if no URL is specified 1D Frame Description HTML frame to open the specified URL in Syntax String Default _self Context Plug in tag Specifies the HTML frame in which to open the specified URL for the button named ID Besides using an identifier of a frame inside your HTML frame set you can as well use one of the predefined values self top blank or parent 1D ToolTip Description Toltipte Syntax String Default Context Plug in tag Specifies the tool tip to be displayed when the user places the cursor above the custom button named ID I D LabelFrame Description Symbol displayed on the button Syntax Number Default 1 Context Plug in Tag Specifies the symbol to be displayed on top of the custom button named ID The predefined symbols are NeptuneLabs FSI Viewer 145 Plug ins Reference GFX ID Example 1 Information 2 Close Resize or Restore 4 Open window 5 Print LA You can add your own graphics to be used as a label for custom buttons Please refer to the FS
12. TextColor Description Color of the hints tool tips displayed below the list Syntax HexColor Default 000000 Context Plug in attribute Color of the help texts below the bookmark list ScrollBaseColor ScrollArrow Scroll Track Description Colors for the scroll bar Syntax HexColor Default Context Plug in attribute ScrollBaseColor defines the base color for the scroll bar in the bookmark list Additionally you specify a HexColor value for the Arrows and the track area of the scroll bar Use these parameters to enable or disable the buttons below the bookmark list EnableAddFullBookmark EnableAddLinkBookmark EnableAddCustomBookmark EnableSendBookmarks Description Show or hide the buttons Syntax Boolean Default Depending on loaded add on SendBookmarks false Context Plug in attribute e EnableAddFullBookmark e EnableAddLinkBookmark e EnableAddCustomBookmark e EnableSendBookmarks Enable bookmarking of entire images or pages Enable bookmarking of links Enable bookmarking of custom areas Enable sending bookmark data I mageEffects Description Image modification parameters Syntax String Default Context Plug in attribute Optional parameter to add image parameters for the thumbnail images For eRez server you can for example sharpen an image or adjust the image compression level e g amp sharpen 100 amp quality 90 ExpandS
13. Clicking the HotSpot selects another image inside FSI Showcase The index can be specified absolutely by providing a number only The first image is being represented by 0 Alternatively you can select an image relatively from the currently selected image To select an image relatively you have to provide a number prefixed by or e g 1 selects the next image 158 NeptuneLabs FSI Viewer Plug ins Reference Hotspot Authoring The following section provides tips on how to obtain the string value required to define the Spot and the optional View parameter of a HotSpot The Spot parameter consists of 7 numbers concatenated with commas and provides the scene set the scene the image section as a rectangle and the rotation Example 1 10 0 19056 0 33579 0 44862 0 59385 35 scene set 1 scene 10 rectangle 0 19056 0 33579 0 44862 0 59385 rotation 35 Although you can manually enter the parameters it is recommended to use the plug in SelectFrame to obtain this value Obtaining Hot Spot positions Include the plug in SelectFrame by adding the following parameters to the default fsi or any other configuration file Including the SelectFrame plug in lt Plugins gt Plugin src SelectFrame visible 1 window 1 rotate 1 AspectRatio 1 1 Plugins After including the plug in you will be able to author hotspots directly in FSI Viewer You can use the value displayed in
14. 0 transparent 100 opaque Size Description Size of progress indicator Syntax Number Default 60 Context Plug in Tag Defines the overall size of the progress indicator in pixel 138 NeptuneLabs FSI Viewer Plug ins Reference Color1 Description Color of the area representing the amount of pending data Syntax HexColor Default 000000 Context Plug in attributes A 6 digit hexadecimal number defining the color of the area representing the amount of pending data Color2 Description Color of the area representing the amount of data already loaded Syntax HexColor Default FFFFFF Context Plug in attributes A 6 digit hexadecimal number defining the color of the area representing the amount of data already loaded LineColor Description Line color Syntax HexColor Default 000000 Context Plug in attribute A 6 digit hexadecimal number defining the color of the lines TextColor Description Text color Syntax HexColor Default 000000 Context Plug in attribute A 6 digit hexadecimal number defining the color of the text posX Description Horizontal Position Syntax String Number Default Depends on MenuAlign parameter Context Plug in attribute Defines the horizontal position of the progress indicator Possible values C Centered horizontally Number gt O Offset from left Number 0
15. 6 digit hexadecimal color value specifying the highlighted top left part of the tip box border ShadowColor Description Border shadow color Syntax HexColor Default 999999 Context Plug in node or HTTP query prefixed with largetooltips 6 digit hexadecimal color value specifying the shadow bottom right part of the tip box border 170 NeptuneLabs FSI Viewer Plug ins Reference LineWidth Description Thickness of the tip box border Syntax Number Default 2 Context Plug in node or HTTP query prefixed with largetooltips_ Thickness of the tip box border in pixels TextFont Description Defines the font of the tool tip text Syntax String Context Plug in node or HTTP query prefixed with largetooltips_ Version 5 0 0 Defines the font of the tool tip text Please note that the desired font must be available on the users machine You need to specify the font name e g Courier New or use one of the Flash Player predefinitions _sans _serif or rr typewriter TextColor Description Default text color Syntax HexColor Default 000000 Context Plug in node or HTTP query prefixed with largetooltips Default text color of text in the tip box To use different colors in a tool tip you can use the HTML tag font color RRGGBB gt in the tool tip text data TextSize Description Default text
16. FSI Pages Plug in Location plugins pagesounds plg Function Adds page flip sounds to FSI Pages Syntax Plugin src pagesounds gt This plug in adds page flip sounds to FSI Pages and does not have any effect with FSI Showcase or FSI Viewer instances Plug in Parameters Volume Description Volume of the page flip sounds Syntax Number Default 50 Context Plug in tag The volume to play the flip sounds at from 0 off to 100 maximum volume Library Description File name of the sound library to use Syntax File Name Default pagesoundlib_coated swf Context Plug in tag File name of an SWF file compiled Flash movie containing the flip sounds FSI Viewer ships with two different sound libraries pagesoundlib_coated swf coated pages like catalogs pagesoundlib_newspaper swf uncoated pages like newspapers 198 NeptuneLabs FSI Viewer Plug in PagesThumbBar Plug in Target Viewport of FSI Pages Plug in Location plugins thumbbar plg Function Displays a bar with thumbnail images Syntax Plugin src thumbbar gt Plug in Parameters REI G1 Pie feel Plug ins Reference KK lt SCA 7o eas AlignLeft Description Keep current image aligned to the left Syntax Number Pixels Default false Context PagesThumbBar Version 5 0 0 When enabled the thumbnail of the currently active image is sh
17. Suffix to add to 3D image URLs Syntax String Default Context Options Version 4 0 7 Prefix or suffix to add to the image src gt values You might want to use these parameters to pass a prefix or suffix by HTTP query rather than using the corresponding prefix and suffix attributes in the images3d node Parameters for tiled source images Method B only TilesX and TilesY Description Number of individual images for 3D presentations Syntax Number Default 1 Context lt FPX gt Query FPXTilesX and FPXTilesY Number of individual images contained in the source image in x and y direction respectively Example 3D image containing 6 x 4 tiles arranged in 3 scene sets Even with asymmetrical scene orders like in the example to the left the number of tiles would be 6 in the x direction and 4 in the y direction NeptuneLabs FSI Viewer 45 3D Configuration Definition of 3 scene sets containing 6 x 4 24 tiles lt rilesex value 6 gt lt TilesY value 4 gt lt FPX gt Options lt SceneSets value 1 8 9 16 17 24 lt Options gt Parameters for all 3D presentations Method A or Method B SceneSets Description Scene sequence definition 3D Syntax String Default 1 n tiles Context lt Options gt Using this parameter you can define scene sets for 3D views Scene sets define the order of scenes to be d
18. Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages Run the FSI Pages in demonstration mode and turn pages automatically when the user does not interact move the mouse for 2 seconds IdleAutoTurnDelay Description Min delay between automatic page flips Syntax Floating Point Number seconds Default 2 Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 Show each page for at least n seconds when flipping pages automatically Please note that a page might be displayed for longer if loading the page takes longer than the time specified IdleAutoTurnMinPage dleAutoTurnMaxPage Description Auto flip range Syntax Number page Default all pages Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 Loop the auto flip action between IdleAutoTurnMinPage and IdleAutoTurnMaxPage This way you can restrict the auto flip to a range of pages If the initial page is outside the range specified FSI Pages flips towards the range before looping between the range specified DemoURL Description Global link when clicking FSI Pages Syntax URL Default Context Pages plug in node or HTTP query prefixed with pages Version 3 5 5 or higher Specifies a link to open when the user clicks anywhere on the FSI Pages instance This parameter is especially us
19. ZoomRightPage Zoom the right page NormalPageView Exit zoom view ShowHidePagel ndex Show or hide the page index thumbnail view 74 NeptuneLabs FSI Viewer Parameters to retrieve mage Collections FSI Pages Add on Server Description Address of eRez imaging server Syntax URL Default Context Pages plug in node or HTTP query prefixed with pages The URL of the setup path of eRez imaging server to be used when retrieving image collections Dir Description Image directory Syntax String Default Context Pages plug in node or HTTP query prefixed with pages The directory on eRez imaging server containing the images to use for FSI Pages Query Description Search query Syntax String Default Context Pages plug in node or HTTP query prefixed with pages A search query to collect images from eRez imaging server to be used for FSI Pages ListTemplate Description Template used to retrieve image list from eRez Syntax String Default fsi image_list xml Context Pages plug in node or HTTP query prefixed with pages_ The XML based template to use when retrieving image lists from eRez server via dir or query parameters Available templates are located in the WEB INF templates fsi directory of your eRez server setup NeptuneLabs FSI Viewer 75 FSI Pages Add on Alphabetical I ndex of FSI P
20. Context Plug in attribute Version 3 2 5 and above Specifies whether the plug in sends plug in event notivications Plug in events can be handled when using JSBridge plug in or FSI Viewer Component The following events apply to this plug in Event ID Parameter Description onMeasureEnable Boolean The measure tool gets enabled or disabled The user starts measuring onMeasureStart String The parameter provides the current distance and angle as displayed in the measure tool The user drags the measure tool onMeasure String The parameter provides the current distance and angle as displayed in the measure tool The user stopped measuring onMeasureStop String The parameter provides the current distance and angle as displayed in the measure tool 180 NeptuneLabs FSI Viewer Plug ins Reference Plug in Mousemodes K Plug in Target m User interface A qm Cy G Plug in Location plugins mousemodes plg Function Integrates buttons into the menu bar to select the mouse mode Syntax lt Plugin src mousemodes gt The Mousemodes plug in provides 3 buttons 2D images or 4 buttons 3D presentations to select the current mouse mode Plug in Parameters MenuOffset Description Indentation of the menu buttons Syntax Number Default 0 Context Plug in Tag Specifies the space in pixels left of the menu button s of the plug in Mode n Descriptio
21. Default BL Context Pages plug in node or HTTP query prefixed with pages_ Alignment of page numbers The default is BL for bottom left Please specify the alignment for even left pages Uneven right pages will be aligned correspondingly Possibly values are any combination of T Top L Left C Center and C Center B Bottom R Right PageNumli ndent Description Indentation of page numbers Syntax Number in percent of the page width Default 196 Context Pages plug in node or HTTP query prefixed with pages Specifies the indentation in percent of the page width This parameter does not apply if the page number position is centered horizontally PageNumSize Description Size of page numbers Syntax Number in percent of the page height Default 8 Context Pages plug in node or HTTP query prefixed with pages_ Size of page numbers in percent of the page height PageNumColor Description Color of page numbers Syntax HexColor Default 000000 Context Pages plug in node or HTTP query prefixed with pages_ 6 digit hex color of page numbers NeptuneLabs FSI Viewer 89 FSI Pages Add on PageNumBGColor Description Background color of page numbers Syntax HexColor Default false Context Pages plug in node or HTTP query prefixed with pages 6 digit hex color of page numbers or false for no backgr
22. FF0000 00FF00 The corresponding parameters for active and selected state are ThumbActiveFace and ThumbSelectedFace 124 NeptuneLabs FSI Viewer FSI Showcase Add on ThumbBorderWidth Description Thickness of the thumbnail border Syntax Pixel Default 1 Context Showcase plug in node or HTTP query prefixed with showcase_ Thickness of the border around the thumbnail Enter 0 to disable the border The corresponding parameters for active and selected state are ThumbBorderActiveWidth and ThumbBorderSelectedWidth ThumbBorderHighlight Description Highlight color of the thumbnail border Syntax HexColor Default Color derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the color of the highlighted section of the thumbnail border left and top The corresponding parameters for active and selected state are ThumbBorderActiveHighlight and ThumbBorderSelectedHighlight ThumbBorderShadow Description Shadow color of the thumbnail border Syntax HexColor Default Color derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the color of the darkened section of the thumbnail border right and bottom The corresponding parameters for active and selected state are ThumbBorderActiveShadow and ThumbBorderSelectedShadow EdgeRadius Descrip
23. ForcelnitialPage if you want FSI Pages to show a specific page independent of the last viewed page Note When using image collections retrieved from eRez server FSI Pages uses the dir or query parameter to identify the image collection automatically If you create image collections manually you additionally need to add the parameter Uniquel D so that the last viewed page can be assigned to this image collection RememberLastViewedPageExpireAfter Description Expire time for RememberLastViewedPage parameter in seconds Syntax Number seconds Default Undefined infinite Context Pages plug in node or HTTP query prefixed with pages Version 4 0 9 or above By default the last viewed page will be restored on the next visit of a user if you enable the RememberLastViewedPage parameter You might want to specify an expire time after that the last viewed page will be discarded Please specify the expire time in seconds e g 3600 for one hour AutoZoom Description Initial magnification in FSI Viewer Syntax Number in percent of the source image or fitWidth or fitHeight Default Context Pages plug in node or HTTP query prefixed with pages The initial magnification in FSI Viewer after the user selected an image to zoom Specify the magnification in percent of the source image e g 100 zooms to the physical resolution of the source image default maximum magnification Wi
24. ImagePanbBu ttons enn 27 InfoTemplate AAA 39 Initial te TE 29 InitialActionDelay nc rra 29 InitialActionPersistent a 30 Initial MouseMode m 30 InitialVIQW s ic ete aiii 28 InitialViewPersistent aa 29 Li e WEE 24 A T 21 Magnifvmallmages ccc teeeeeteteeaeeeeeeeeeeetes 32 Max Zoom evel eee nnn 38 20 MenuAlign orte ter is 26 MetaDataQueryParameters 39 Mo useVelocity siria aan 41 NavEffects c0occcnncccnnnncnnnncccn nn canon eee nene nns 36 NavFramecColor ee eme 28 NavMaskAlpha me 28 NAVMaSKCOIOL emnes 28 Eu Etc dame ete dude t hn eig 28 dE e diarias rd 28 NolmageBlend m 33 No MVision te tento eb Pur a ra 27 RoundedSkinCorners eee 33 SceneEffects ictie ico nine hc e ida 36 ServerTemplate AAA ER SUP a 22 EIER E AAN 24 ME da rios 23 StrictViewport ne 32 TileEffects in cata de 37 ES RA O 39 RRE e 39 TilEModeRelative 38 UlSwitchable iecore terree ere enc e eer osa 33 lite UC IR A0 Usel ntermediateZoombLevels sese 40 VieWerBOrder s idco cur rene c De c dec ra trad v c rc 33 Width and Height 23 ZOOMCACN O ooocccnnnccnnncccnnnancnn noo eee nennen 37 ZoomaQachel Dis e tet eer vH boc nns 37 Kieler Bil e 31 ZoombLimitMin oocnnnnncnnnncacnnn rana nara non rra rr nora rr rn rar nn nana 31 NeptuneLabs FSI Viewer Configuration Retrieving Parameters from maging Servers Depending on the type of imaging server
25. SearchCustomwValue 105 SearchDialogWidth and SearchDialogHeight 103 SearchParameters sse 104 SearchSortResults sse eee 105 SearchUseMethodGet oocccccccccnocccnnnnnnonnnnnnnnnnnonnnos 105 Sei Vel isis code d c n b n e TER a 74 ShowLinksWhileFlipping een 90 ShowLoadProgress ete tede 79 SingleSided es E RA aed 84 SiO cas atc eet oad cot censet ye ota te did 78 ie c ET 78 ThumbPAadding ssssssee 87 ThuMbSiZ aida ert ga aida 87 NeptuneLabs FSI Viewer FSI Pages Add on UsebomanbagehkumbersTobage A 89 ViewerMarginLeft ViewerMarginTop ViewerMargin Right ViewerMarginBottom ssseeeese 87 AME BS eebe nes Ae E bed laos der atio cons 99 ZOOM sec svcccessnecersacceretecsesncceessaccetandvensseceectasdeanndzeedss 79 ZoomAreaAnimationSpeedln esseere 80 ZoomAreaAnimationSpeedOut 80 ZoomAreaAnimationType ee e 80 ZoomAreaTargetScale ena 80 77 FSI Pages Add on Emptyl mages Description Define blank pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages_ Version 3 3 0 or higher Using this parameter you can add blank pages The value of the parameter must contain one or more image page numbers of the blank pages to be inserted E g EmptyImages value 2 10 adds two blank pages at page 2 and page 10 moving the other images in your collection corresponding
26. ZIS For the Image Server from TrueSpectra please enter the value TrueSpectra if you are using the stand alone server and TrueSpectra Bridge if you are using the TrueSpectra Bridge API 22 NeptuneLabs FSI Viewer ServerTemplate Description Real time template of the imaging server Syntax String template name Default fsi Context lt FPX gt Query FPXServerTemplate Version 2 1 0 or higher This parameter applies to eRez Imaging Servers only and specifies the name of a real time template used when accessing the imaging server Using these templates you can specify e g the image compression maximum image dimensions and watermarks Src Description URL of the source image to be displayed Syntax URL Default Context FPX Query FPXSrc Specify either a relative URL or the absolute URL of the source image on the imaging server The parameter FPXBase can be used to specify a base path to the imaging server Please refer to the documentation of your imaging server for details on supported image formats Absolute addressing eRez I maging Servers lt FPX gt Src value http www domain com erez erez src project foo tif gt FPX Absolute addressing I seemedia I maging Servers lt HEX gt Src value http www domain com fif project foo fpx FPX Partial relative addressing SES Src value project foobar fpx FPX
27. fsi swf cfg foo fsi amp pages marginleft 100 amp pages zoom true FSI Pages Converter FSI Pages Converter is a Java based conversion tool to split PDF documents into separate TIFF files optimized for use with eRez imaging server Besides converting PDF documents into individual TIFF files the conversion tool automatically extracts hyperlinks from the PDF document and generates partial PDF documents of the document for download Please contact your FSI dealer to get a copy of FSI Pages Converter Aspect Ratio of the Pages By default FSI Pages uses the aspect ratio of the first image in the image collection to determine the aspect ratio for all pages Alternatively you can manually define an aspect ratio for all pages using the ratio parameter E g Plugin src pages ratio 1 2 or Plugin src pages ratio 640 480 Layout and Skins FSI Pages ships with two default skins that correspond to the default skins of FSI Viewer and an additional skin providing the user interface in a side bar You can easily change the FSI Pages skin being used by specifying the file name of the skin using the FSI Pages skin parameter e g Plugin src pages skin silverbar gt Additional custom skins are available on demand and may contain additional functionality and designs You can modify the layout of FSI Pages and FSI Viewer using the Margin and ViewerMargin parameters The following illustrations show the use of these
28. parameter value b Add the template to the LabelTemplates value Each template needs to be entered as an XML node while the node name is the name of the full configuration parameter name like you would use the parameter in the HTML query for FSI Viewer e g lt FPXWidth gt or lt Showcase Dir NeptuneLabs FSI Viewer 129 FSI Showcase Add on Thumbnail labels with runtime templates Plugin src showcase gt lt LabelContent gt lt b gt lt ImageIndex gt lt ImageLabel gt lt b gt lt br gt Size FPXWidth x lt FPXHeight gt px lt LabelContent gt lt LabelTemplates value FPXWidth FPXHeight Plugin The resulting label with this configuration looks like this 1 Somel mageName tif Size 2048 x 1024 px The two templates ImageIndex and ImageLabel gt are built in templates containing the numeric index of an image and the label attribute of the image node of the image list eRez users might want to add templates adding IPTC data served by eRez server to the thumbnail labels Please create your configuration file based on the FSI Showcase preset fsi config showcase presets showcase info fsi in this case LabelPrefix Description Prefix applied to thumbnail texts Syntax String Default Context Showcase plug in node or HTTP query prefixed with showcase A prefix string applied to all thumbnail labels or false for no prefix LabelT
29. 3D of the pages Syntax Glossy or Matte Default Glossy Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or above The effect Glossy adds highlights and shadows while Matte adds shadows only like with FSI Pages version 3 Please use BendEffectl ntensity parameter to modify the effect level or disable the visual effect BendEffectl ntensity Description Level of visual 3D effects Syntax Number Default 65 Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or above Defines the 3D effect level of the pages in percent Using a value of 0 disables the visual 3D effect The value additionally affects the opacity of the drop shadow NeptuneLabs FSI Viewer 85 FSI Pages Add on DropShadow Description Enable or diable the dropshadow effect for the pages Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages_ Version 4 0 0 or above Enables or disables the drop shadow of the pages DropShadowDistance Description Distance of the page s drop shadow Syntax Number Default 50 Context Pages plug in node or HTTP query prefixed with pages_ Version 4 0 0 or above Distance of the pages drop shadow in percent where 100 is the greatest possible distance I mageAlign Description Alignment of images on the pages
30. Context Pages plug in node or HTTP query prefixed with pages Version 3 5 0 or higher 6 digit hex color for the scroll bar in the page index ScrollArrow Description Color for the scroll bar s arrows Syntax HexColor Default 000000 Context Pages plug in node or HTTP query prefixed with pages Version 3 5 0 or higher 6 digit hex color for the arrows of the scroll bar in the page index ScrollTrack Description Color for the scroll bar s track bar Syntax HexColor Default DDDDDD Context Pages plug in node or HTTP query prefixed with pages Version 3 5 0 or higher 6 digit hex color for the track bar of the scroll bar in the page index NeptuneLabs FSI Viewer 87 FSI Pages Add on MarginLeft MarginTop MarginRight MarginBottom Description Margin of the turning pages Syntax Number in pixel Default 0 Context Pages plug in node or HTTP query prefixed with pages_ Margin on each side of the turning pages in pixel The margin effects the position of the pages only not the user interface of FSI Pages You should at least specify a bottom margin to provide space for the interface PageMarginOuter PageMarginTop PageMarginl nner PageMarginBottom Description Margin of the page content Syntax Number in percent of the page width height Default 0 Context Pages plug in node or HTTP query prefixed with pages
31. CropTop Image CropBottom 1 CropRight or CropOuter PageNumindent 1 PageNumPos PageNUmsSize etc 57 FSI Pages Add on Defining Image Collections The images to be displayed in FSI Pages have to be defined in an lt images gt node added to your XML configuration file The format and the options of the collections are the same as those of the FS Showcase Add on collections Defining FSI Pages image nodes lt Images gt lt Image file imagel fsi label My First Image gt lt Image file image2 fsi label My Second Image gt lt Images gt There are three different ways of defining image lists 1 Retrieving automatically generated image lists from eRez server The most convenient way to create image collections is using the template system of eRez imaging Server You can either do so by using the Publish to Web option in eRez web interface or by specifying the server address and a directory or search query manually Retrieving Directory based I mage Collections from eRez I maging Server lt Plugins gt Plugin src pages server dir gt g pag Plugins Retrieving Search based I mage Collections from eRez maging Server Plugins Plugin src pages server query lt Plugins gt This way eRez uses an image list template to return the matching images in XML format Depending on the list template eRez serves
32. Default 520 Context Pages plug in node or HTTP query prefixed with pages Version 5 0 0 or above Defines the speed of the zoom animation when zooming in ZoomAreaAnimationSpeedOut Description Defines the animation speed of in place maginifications initiated by zoomarea hyperlinks Syntax Number Default 240 Context Pages plug in node or HTTP query prefixed with pages Version 5 0 0 or above Defines the speed of the zoom animation when zooming out ZoomAreaAnimationType Description Defines the animation type of in place maginifications initiated by zoomarea hyperlinks Syntax Number Default 5 Context Pages plug in node or HTTP query prefixed with pages Version 5 0 0 or above Defines the animation type of the zoom animation ZoomAreaTargetScale Description Magnification level of in place maginifications initiated by zoomarea hyperlinks Syntax Number Default 200 Context Pages plug in node or HTTP query prefixed with pages Version 5 0 0 or above Defines the zoom factor for the link Two limitations apply The zoomfactor must be 110 or greater otherwise no zoom area is displayed The zoomarea may not exceed the FSI Pages instance size NeptuneLabs FSI Viewer 81 FSI Pages Add on DoublePageAllow nteractivity Description Enables the interactive zoom mode Syntax Boolean Default false Cont
33. FSI Viewer Back over ong 84 BackCoverl Mage sse 83 Background ion EORR 122 BackgroundAlpha seee 122 170 BackgroundColor seee 170 191 BackgroundGradientAngle 191 BaseColor urbe ee 223 BaseColo ice adu oda exerce 116 Basel airada tal 116 BaseURL iet Eege 152 BendEffect n n C em 85 BendEffectl ntensity eee 85 GET as cuina 179 223 Bt glo Oe MC 179 223 BlankBackCover sse 83 BlankFrontCover neee 83 BUG sca onte doit thee crt rrr td 141 li ts 197 BOGOR citet orbes orba bee oe pa eas 224 BorderColor s inet det etes 224 BordenW dh 224 Briglitrigss c r o te een tog etel 141 BUON spe ERE ERE 144 Buttonsbiretl astbage eee 96 Callback acond 168 210 A Ra 22 CRG ihe P 158 Cckbagefo Zoom s e EN l t inte ct ata oe 157 217 225 COMO RE 139 tere fer Ped rd 139 Colored ndex cccceeceeeeeeeeteeeseseeeeeeeenaaeaa 136 GolorHighlight 2 e e 218 ColorShadow sss 218 ConcurrentRequesStS eee A0 ele 156 CornerRadius sss 171 CropBottom e copre Ped 106 COPIE du eee atta 107 GropLeft e etc eec 106 CIODOULGE i corti te dee retinas ta pre e See ek 107 CropReGE seht ii Tr 26 GropRIght ai Su Sete ee 106 CropThumbnails seeeeeeeeees 132 CEODTOD i oio e lc ORE Rees 106 231 232 e E eer 177 DefaultCFG codo fada 22 DefaultColor cool 154 Defa ltFill 2 a trt 154 DefaultFillAlp
34. IPTC data belonging to an image e g for links as well Please note that you can only specify a directory or search query in plain text if the image share you access allows public access list role to the images Otherwise you need to use an encrypted string representing the list provided by eRez in the Publish to Web section of the web interface Retrieving Directory based I mage Collections from eRez I maging Server lt Plugins gt lt Passing a directory as plain text gt Plugin src pages server dir images flowers lt Passing an encrypted string representing a directory gt Plugin src pages server dir XzPzLUFVSHtmeeFxOYONUUO Plugins 58 NeptuneLabs FSI Viewer FSI Pages Add on 2 Creating image nodes referencing external XML configuration files Creating collections manually using XML configuration files lt Images gt lt Image file imagel fsi label My First Image gt lt Image file image2 fsi label My Second Image gt lt Images gt 3 Creating image nodes containing complete image configurations Creating collections manually with complete XML configurations lt Images gt lt Image label My First Image gt lt FPX gt lt SRC value imagel fpx FPX lt Image gt lt Image label My Second Image gt lt FPX gt lt SRC value image2 fpx gt lt Width value 8096 gt lt Height value 12300 gt lt FPX
35. IPTC data for each page can then automatically be retrieved by FSI Pages using the eRez template system This is the way it works when using Publish as FSI Pages with links in eRez web interface A great advantage of this option is that the data persists even when renaming or moving images For imaging servers not capable of serving IPTC data to FSI Pages you need to choose one of the alternative methods below b Using individual XML files An alternative way to provide XML page data is using external XML files With this method each image requires a related XML file containing the page e data stored in a directory on your web server The page xml XML dat Ps ES XML files have to be named after the related images Pru g with the additional suffix xml Image Image date Example The XML file name for the image page065 tif must be page065 tif xml Usually FSI Pages Converter creates the required files for you when converting a PDF document Please enable the option XML Output of FSI Pages Converter in this case Example You converted a PDF document catalogi pdf using FSI Pages Converter and enabled the XML Output option In the output directories you specified in FSI Pages converter you can now find the TIFF files and the related XML files e g page01 tif page01 tif xml page02 tif page02 tif xml Now you need to upload the images to your imaging server and upload the XML files to a direc
36. Margins of the content of each page in percent of the page width inner and outer or page height top and bottom ViewerMarginLeft ViewerMarginTop ViewerMarginRight ViewerMarginBottom Description Margin of FSI Viewer Syntax Number in pixel Default 0 Context Pages plug in node or HTTP query prefixed with pages Margin on each side of FSI Viewer in pixel when zooming into a page Usually you need to set ViewerMarginBottom to the height of the FSI Pages interface ThumbSize Description Max size of thumbnails in the page index Syntax Number in pixel Default 60 Context Pages plug in node or HTTP query prefixed with pages_ The maximum size of thumbnails displayed in the index The actual width and height depend on the aspect ratio of the pages see parameter ratio ThumbPadding Description Padding between thumbnails in the index Syntax Number in pixel Default 10 Context Pages plug in node or HTTP query prefixed with pages_ The padding between thumbnails displayed in the page index in pixel 88 NeptuneLabs FSI Viewer FSI Pages Add on PageNumbers Description Display page numbers on pages Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages_ Show or hide page numbers on pages PageNumPos Description Alignment of page numbers Syntax String
37. NeptuneLabs FSI Viewer 157 Plug ins Reference Target Description Target frame for hyperlinks Syntax String Default _blank Context HotSpot tag Defines the targetframe for HotSpot hyperlinks Valid parameters include _blank self top parent and names of frames inside a HTML frameset Please refer to the DefaultTarget parameter for details on how to set a default target for hyperlinks CFG Description FSI parameters to be used on click Syntax String query Default Context HotSpot tag If you define a CFG parameter for a HotSpot the viewer will be reinitialized with the given configuration if the user clicks the HotSpot This can be useful to switch from one image to another if the user clicks a HotSpot The syntax of the CFG parameter has to consist of FSI Parameters concatenated with the ampersand character like a HTTP query Parameteri valuel amp Parameter2 value2 Example cfg cfg image2 amp NoNav 1 Defining the parameter like this the viewer would reinitialize using the configuration file image2 fsi providing the FSI parameter NoNav with a value of true Please refer to the FSI Viewer manual for a list of all FSI Parameters and for details on how to create a query string that provides FSI parameters Selectl mage Description Select another image FSI Showcase only Syntax Number Default Context HotSpot tag
38. Number Pixels Default 600 Context PrintSave Version 5 0 0 Defines the maximum size of the image in pixels to download for printing Please note that the actual size depends on the size of the image and with eRez server on the maximum size defined in the real time template used with FSI Viewer see parameter PrintTemplate SaveTemplate Description eRez image template to be used Syntax String Default Context PrintSave Version 5 0 0 Defines the eRez real time template used to download an image 206 NeptuneLabs FSI Viewer Plug ins Reference Plug in Resize Plug in Target User interface Plug in Location plugins resize plg Function Rearranges user interface elements after resizing the viewer Syntax Plugin src resize MaxWidth 800 MaxHeight 600 gt Using the resize plug in you can define the viewer dimension in percent of your HTML document After resizing the plug in rearranges the user interface according to the size of the object tag without reloading the entire viewer instance and without the need for client side scripting Note that this plug in is required only if you want to allow the user to dynamically resize an FSI Viewer instance Plug in Parameters MaxWidth and MaxHeight Description Maximum width and height Syntax Number in pixel Default Context Plug in Tag FSI Viewer can not be resized to a dimension greater th
39. Saving PDF or other document types In addition to downloading images you might want to enable users to download the complete source PDF or specific parts of the source PDF documents This documentation refers to PDF documents only but you can also provide other file types for download 1 Downloading the entire PDF Document Enabling this option is as easy as adding the FSI Pages parameter SaveDocumentFile providing the absolute URL to a PDF document to download Example SaveDocumentFile value http foo com somepdf pdf 2 Downloading single or double pages In order to enable the user to download a PDF document containing the page currently viewed in FSI Pages the XML based data for a page needs to contain the corresponding URL or file name to that document If you are using FSI Pages Converter to convert your PDF document you only need to enable the PDF Output option in FSI Pages Converter and FSI Pages Converter splits your source document into multiple partial PDF documents You will then need to upload these files to some web server to provide them for download and add the FSI Pages parameter SaveURLPrefix specifying the URL to the directory on your server containing these files Example You uploaded the PDF documents created by FSI Pages converter to your server and the URL to download the files is e g http www foo com downloads catalog1 pdf NeptuneLabs FSI Viewer 61 FSI Pages Add on For this ex
40. TR top right BL bottom left BC bottom center BR bottom right 26 NeptuneLabs FSI Viewer Configuration Language Description Interface language Syntax String Default english Context lt Options gt Version FSI Viewer 2 0 or higher FSI Showcase 2 15 or higher Defines the language of tool tips for the user interface Possible values depend on the XML based language files located in the sub index languages of the FSI Viewer setup path To specify a language please enter the filename without file extension e g german You can modify existing or add your own anguage files I magePanButtons Description Show or hide pan buttons on the image Syntax Boolean Default false Context Options Version 4 0 0 and above Show or hide the optional pan buttons on the image If the user points at a pan button the image pans into the direction indicated The buttons automatically disappear if the edge of the image has been reached DetailBuffer Description Enable or disable the detail buffer Syntax Boolean Default true Context Options Version 3 0 0 and above Enabling the detail buffer keeps previously loaded image details visible when zooming in or out instead of displaying the low resolution preview image while loading additional image details This way zoom transitions appear smoother NoNav Description Hide th
41. URL of custom help page Syntax String Default http help fsi viewer com Context Options Version 1 3 0 or higher If you want to create a custom help page for your FSI Viewer enter the complete absolute URL to this page using this parameter HelpURLTarget Description Target frame for custom help page Syntax String Default blank Context Options Version 1 3 0 or higher Using this parameter you can define the target name of the browser window if a user opens the help page The default value blank opens a new browser window Initial MouseMode Description Mouse mode on startup Syntax Number Default 0 Context Options Specifies the selected mouse mode on startup Possible values 0 Zoom 1 Pan 2 Rotate 3D 3 Rotate 2D Some plug ins provide additional mouse modes Please refer to the corresponding plug in reference for details 30 NeptuneLabs FSI Viewer Configuration EnableZooml nPanMode Description Enable zooming in pan mode Syntax Boolean Default false Context Options Version 4 1 2 Set this parameter to true if you want to enable the user to zoom by clicking the image while mouse mode pan is enabled HandCursor Description Shape of the mouse cursor Syntax Boolean Default true Context Options If you set this parameter to false the default arrow cursor will be u
42. Width of the tool tip box The height of the box will be adjusted according to the length of the contained text Delay Description Delay before displaying a tool tip Syntax Number milliseconds Default 600 Context Plug in node or HTTP query prefixed with largetooltips You can specify a delay in milliseconds 1000 milliseconds 1 sec after pointing at a link area and before displaying a tool tip Use 0 to display the tool tips immediately without a delay NeptuneLabs FSI Viewer 169 Plug ins Reference Shadow Description Display a drop shadow Syntax Boolean Default true Context Plug in node or HTTP query prefixed with largetooltips_ Display true or hide false a drop shadow for the tool tip box BackgroundColor Description Background color of the tool tip box Syntax HexColor Default FFFFFF Context Plug in node or HTTP query prefixed with largetooltips_ Background color of the tool tip box BackgroundAlpha Description Opacity of the background of the tool tip box Syntax Number Default 90 Context Plug in node or HTTP query prefixed with largetooltips_ Defines the opacity of the tool tip background from 0 invisible to 100 opaque HighlightColor Description Border highlight color Syntax HexColor Default 999999 Context Plug in node or HTTP query prefixed with largetooltips
43. ZOOM ini rai rte Ree aA 225 Wide 23 136 169 191 Relative Addressing e 23 24 WildOW icu ette e P tetra 209 Rotation 9 10 A Hia ve ba e ba e EXE a PR ex A EM RE MERE 187 MES iio 46 47 227 XMLBase iere ada 100 Thumbnail Effects AAA 119 EE 188 LO Mi a tido ds 80 ZoomAreaAnimationSpeediln 81 ZoomAreaAnimationSpeedOut 81 Zoom reahnimationTvpe EN ZoomAreaTargetScale e 81 ZoormCaclie EE 37 ZoomCachel D 37 let E le 31 ZoomLimitMin eee 31 Plugin ReferenCe ooooooooococicnonorononcnnnnononononnnnns 133 Plugeitis ip ecos 133 Plugins Backgroundlmage seee 134 Chapters nu tech ee erre exte ee 135 ClockProgress E 138 Color AUS Econo cette pags 141 CONTEXIMOGNU i casan reo at 143 A vet eene 144 Fullscreen a 148 HISCORY EE D e EREa 149 HO POL o cree ee heo a m ced 151 J SBridge or RES 161 LargeTool ipsS oet rr te 169 ole cnet era ena 172 OK e el 174 Measures 175 Mouse Modes eeen 181 Mouse Mode Select 183 MUSIC eoa er RO Re DO RD 185 NavExtension sss 187 Notepad te Reg 189 bagecMimor reenen 197 PageSounds eege AE ee elena 198 PagesThumbBar eeen 199 PENTSA m 204 Resl28 o tacita 207 236 NeptuneLabs FSI Viewer FSI Viewer FSI Pages FSI Showcase Flash based Single Source I mage Viewer NeptuneLabs GmbH Detmolder Str 210a 32791 Lage Germany Fon 49 0 5232 9999 7 0 Fax 49 0 5232 9999 7 29 eMail infoggneptunelabs
44. a PDF document containing all pages Syntax URL Default Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or higher URL to a document containing all pages displayed in an FSI Pages instance This is the URL the user will be redirected to when choosing the Entire Document option in the Save dialog Please refer to the chapter Printing and Saving Pages for details SaveURLPrefix and SaveUrlSuffix Description Prefix or suffix for page download URLs Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or higher Specifies a prefix and or suffix for the URL FSI Pages opens when the user chooses the Left Page or Right Page option in the Save dialog Please refer to the chapter Printing and Saving Pages for details SaveURLTarget Description Target frame for downloading a file related to a page Syntax String Default _ blank Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or higher HTML frame to open page related files SaveURL in Please refer to the chapter Printing and Saving Pages for details 102 NeptuneLabs FSI Viewer FSI Pages Add on ForceSaveURL Description URL to use for downloading a file related to a page Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or hig
45. a server other than eRez to return search results Please refer to the chapter Searching in FSI Pages for details SearchUseMethodGet Description Use HTTP GET method to request search results Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or higher By default FSI Pages requests search results using the HTTP POST method Using this parameter you can force FSI Pages to use the HTTP GET method when requesting search results Please refer to the chapter Searching in FSI Pages for details SearchSortResults Description Sort search results Syntax Boolean Default True Context Pages plug in node or HTTP query prefixed with pages Version 5 0 4 If set to true the search results are ordered by page number If set to false the search results are listed in the order the imaging server sends them to FSI Pages CropLeft CropTop CropRight CropBottom Description Crop page images Syntax Number in pixel or percent Default 0 Context Pages plug in node or HTTP query prefixed with pages Specify the amount in pixel e g 100 or in percent e g 10 to crop from the specified side of the page image This parameter is especially useful to remove crop marks from catalogs Instead of using the crop amounts CropLeft and CropRight you might want to use CropInner and CropOuter for alternating crop margins f
46. affect URL and mailto links ForceLinkUrlPrefix ForceLinkUrlSuffix Description Force a link prefix suffix for all links on pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or above Force FSI Pages to use this prefix suffix for all links on all pages This overwrites any prefixes and suffixes specified in the page data Prefixes and suffixes will not be applied to absolute URLs and special link values like javascript 92 NeptuneLabs FSI Viewer FSI Pages Add on ForceLinkTip Description Force a tool tip for all links on pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or above Force FSI Pages to use this tool tip for all links on the pages This overwrites any tool tips specified in the page data DefaultLinkURL Description Default URL for links on pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or above Use this URL for links if no URL has been specified in the page data DefaultLinkTarget Description Default target frame for all hyperlinks on all pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or above Use this HTML target frame for links if no target
47. amp height height amp left 0 amp top O0 amp right l amp bottom 1 amp tmp template The URL template can for example be used to set the src attribute of an lt IMG gt tag Prior to using the template you have to replace the place holders bold in brackets with valid values The template place holder applies to eRez imaging servers only ToolTip The ToolTip event parameter provides the tool tip text that is about to be displayed The values depend on the tool tip language selected You have to use the JavaScript function decodeURI Component before displaying this parameter NeptuneLabs FSI Viewer 167 Plug ins Reference J SBridge Plug in Parameters AllowDomains Description Sub domains allowed to acces the JSBridge interface Syntax Domain list separated by Default Subdomain of FSI Viewer www domain tld domain tld domain tld Context Plug in attribute Version 4 1 0 or above With Adobe Flash version 8 an additional limitation regarding J avascript to Flash access has been introduced Starting with version 8 only a script from the same subdomain as the Flash movie e g erez domain com is allowed to access Flash the J SBridge interface With FSI Viewer and eRez server it is very likely that you use FSI Viewer from erez yourdomain tld while your HTML document resides in the subdomain www yourdomain tld Therefore JSBridge plug in allows script
48. animation Custom intros are available on demand Please note that using an unregistered intro activates the evaluation mode Debug Description Activate debug mode Syntax Bool Default false Context Options Activate the debug mode providing configuration details warnings and error messages It is strongly recommended to activate the debug mode when implementing new images with FSI Viewer Please refer to the chapter Debug Mode for a detailed description 24 NeptuneLabs FSI Viewer Configuration FSI Base Description Path to FSI configuration files Syntax Relative path Default Context Options _default fsi only Enter the relative path from FSI Viewer to the image specific configuration files here If this parameter is specified the path is added to all relative CFG parameters Definition of FSIBase in the default fsi file Options lt FSIBase value config lt Options gt Specifying FSI files using the CFG parameter COIS oo a gt lt PARAM name movie VALUE fsi fsi swf CFG imagedir imagel gt lt Object gt The content of the parameter CFG will be extended by the parameter FSIBase to config imagedir imagel fsi Base Description Image Server URL Syntax URL Default Context lt FPX gt Domain and path to the imaging server All FPXSrc parameters containing relative paths without http w
49. be provided in the following form Parameter1 Valuel amp Parameter2 Valuez2 Characters that are not URL compatible such as and amp within the values need to be provided O Providing parameters by HTTP query Object classid clsid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia com pub shockwave cabs flash swflash cab version 6 0 65 0 width 320 height 240 gt lt PARAM NAME movie VALUE fsi fsi swf cfg foo amp debug 1 amp MenuAlign TL lt Object gt Due to the missing possibility to define parameter groups when providing FSI parameters by HTTP query you have to prefix parameters with the name of the parameter group they belong to Prefixing parameters with group names XML Syntax lt FPX gt Src value foo tif lt ServerType value eRez lt FPX gt Equivalent HTTP Query FPXSrc foo tif amp FPXServerType eRez Most parameters belong to the global options group These parameters do not need to be prefix in order to keep HTTP queries as short as possible Providing lt Options gt parameters by query XML Syntax Options Debug value true lt MenuAlign value TL lt Options gt HTTP Query equivalent debug true amp MenuAlign TL The FSI parameter reference provided in this documentation contains the parameter group a parameter belongs to as well as the long parameter including the group names for
50. be specified separately using the skin parameter of FSI Viewer Slider Description Show hide the page slider Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages Show true or hide false the slider to select pages I ndex Description Enable disable table of contents Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages Enable true or disable false the user to show the page index containing thumbnails of all pages NeptuneLabs FSI Viewer 79 FSI Pages Add on Keepl ndex Description Keep index data when hiding the index Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages Setting the value to true default speeds up showing and hiding the page index with a possible overall performance penalty when presenting many pages Setting the value to false deletes index data when hiding the index forcing the viewer to build the index each time it is shown PageTurnSpeed Description Speed when turning pages Syntax Number Default 82 Context Pages plug in node or HTTP query prefixed with pages The speed of the page turning effect 0 is the slowest and 100 the fastest value possible Zoom Description Enable disable zooming into pages Syntax Boolean Default true Cont
51. com WWW www neptunelabs com www fsi viewer com No part of this manual including the software described in it may be reproduced transmitted transcribed stored in a retrieval system or translated into any language in any form or by any means except documentation kept by the purchaser for backup purposes without the express written permission of NeptuneLabs Specifications and information contained in this manual are furnished for informational use only and are subject to change at any time without notice and should not be construed as a commitment by NeptuneLabs NeptuneLabs assumes no responsibility or liability for any errors or inaccuracies in this manual including the software described in it Copyright 2002 2009 NeptuneLabs GmbH Germany All rights reserved www fsi viewercom Neptune Labs NeptuneLabs GmbH Detmolder Str 210a 32791 Lage Germany fon 49 5232 99997 0 fax 49 5232 99997 29 info neptunelabs com www neptunelabs com
52. creates a gradient from top left to bottom right Has no effect if you used a single color value for the BackgroundColor parameter NeptuneLabs FSI Viewer 191 Plug ins Reference FrameWidth Description Width of the window frame Syntax Floating Point Number pixels Default 1 1 Context Plug in attribute Version Obsolete from version 5 0 0 defined by FSI Viewer Skin Width of the window border FrameColor Description Color of the window frame Syntax HexColor Default 000000 Context Plug in attribute Version Obsolete from version 5 0 0 defined by FSI Viewer Skin Color of the window border EdgeRadius Description Radius of the window corners Syntax Number Default 6 Context Plug in attribute Version Obsolete from version 5 0 0 defined by FSI Viewer Skin Radius of the window corners Use 0 for straight edges I mageBackgroundColor Description Color of the background behind the thumbnails Syntax HexColor Default EEEEEE Context Plug in attribute Color of the background behind the thumbnails ItemButtonsBackgroundColor Description Color of the background behind the item buttons Syntax HexColor Default EEEEEE Context Plug in attribute Color of the background behind the items buttons right of the bookmarks 192 NeptuneLabs FSI Viewer Plug ins Reference
53. effects parameter for a detailed description ShowControls Description Show or hide image changing buttons Default true Context Options Version 3 1 1 or higher If set to false the buttons to switch to the next or previous iages are hidden NeptuneLabs FSI Viewer 119 FSI Showcase Add on I mageList Parameters If you are using eRez imaging server version 3 or above with FSI Showcase you can additionally use automatically generated showcase configuration files for a specific directory on the server or according to a search query The generated showcase configuration contains all required data listing images in alphabetical order Experienced users might additionally edit the server template files used to generate the image list The corresponding file is located in the WEB INF templates fsi directory of your eRez imaging server Filename Description image list xml Creates the Images section of the Showcase configuration You can specify custom templates to create the image list using the ListTemplate parameter The following parameters have to be passed to the showcase in order to use automatic showcase configurations Dir Description eRez image share eRez only Syntax String Default Context Showcase plug in node or HTTP query prefixed with showcase Specifies the image directory on the eRez Imaging Server the Images section will be c
54. entire XML sections in the configuration file to work properly For information on a specific plug in please refer to the P ug in Reference Defining plug in parameters Plugins Plugin src navextension MenuOffset 10 visible true Plugin src zoommeter gt lt SRCRelative value true Plugin lt Plugins gt NeptuneLabs FSI Viewer 53 FSI Plug ins Defining Plug in Parameters dynamically To provide plug in parameters by query you have to prefix the corresponding parameter with the name of the plug in and an underscore character PluginName ParameterName value Providing plug in parameters via HTTP query fsi swf navextension visible true amp history length 10 The example above sets the visible parameter of the NavExtension plug in to true and the length parameter of the History plug in to 10 Similar to providing plug in parameters you can provide plug in parameters in the options section of FSI Viewer configuration files by prefixing the parameter name with the name of the plug in This way you can specify plug in parameters without actually including the plug in again Providing plug in parameters as global parameters Options history length value 10 gt Options 54 NeptuneLabs FSI Viewer FSI Pages Add on NeptuneLabs FSI Viewer FSI Pages Add on Using FSI Pages you can present image collections on line simulating a printed catalog bookle
55. gt Options lt NoNav value true lt Options gt lt Image gt lt Images gt Method 2 and Method 3 can be freely combined while Method 1 retrieves a complete image list ignoring previously defined lt images gt nodes Image Order The order of the images this is the page order corresponds to the order of the lt image gt declarations within the lt images gt section Inserting Blank Pages You can insert blank pages by adding lt image empty true gt nodes anywhere in your image collection Alternatively you can use the FSI Pages parameter Empty mages to pass the page numbers to insert blank pages before seperated by commas This is especially useful if you retrieve the image collection from eRez imaging server Method 1 Removing certain mages from a List Using the parameter RemovePages you can disable remove certain images from an image list In this case you pass the page number s of the pages you want to remove separated by commas This is especially useful if you retrieve the image collection from eRez imaging server Method 1 NeptuneLabs FSI Viewer 59 FSI Pages Add on Page Reading Order requires FSI Pages version 4 1 5 or above By default FSI Pages displays pages in western reading order left to right For documents with right to left reading order e g Arab documents you can change the reading order to RTL right to left using the boolean FSI Pages parameter PageOrderRT
56. image src 05 image src 06 gt lt images3d gt lt fsi_parameter gt Please note that the sequence of the lt image gt nodes defines the sequence of the 3D scenes You can use the parameter SceneSets to modify the sequence by configuration later on You can either enter the complete path for each image or use the prefix and suffix attributes to have FSI Viewer assemble the file names from prefix images src suffix In the example above the image path for the first image is therefore my3dimage image_01 tif Besides adding the lt images3d gt node to your configuration file you can alternatively load an external file containing the image list This can be useful if you have a server side script or database containing the image paths for 3D views In this case you only need to specify the images3dURL parameter which should contain the URL to the image list to retrieve Note for eRez Users If you are using eRez Imaging server you can have eRez setup the image list for you automatically based on a directory or search query In this case you can choose Publish to Web gt Publish as FSI Viewer 3D from either a directory or search result 42 NeptuneLabs FSI Viewer 3D Configuration Method B Using a single tiled source image In this case you need to prepare the source image in the way that it contains all required images as tiles of equal dimension Please see the figure below which shows a so prepared sou
57. in sends the notepad data in XML format via HTTP POST to the server The data is being send in the data post variable e The answer the content of the receiving page of the web server in return must be simple XML data result success true gt filename xml lt result gt if the server succeeded in saving the file OR result success false error reason lt result gt Depending on the result the plug in displays the web page specified by the SendXMLUrlSuccess or SendXMLUrlFailed The plug in posts the following values to the success or failure HTML page Data Description datafile The file name of the stored XML file returned by the server error Error description FSI Url The URL of the calling FSI Viewer instance FSI notepad id The unique id of the notepad UniqueID 194 NeptuneLabs FSI Viewer Plug ins Reference LoadXML Description URL or file name of an XML data file to load Syntax String Default Context Plug in attribute URL or file name of an XML data file to load from a web server If you add this parameter the notepad loads the bookmarks from the file specified instead of loading bookmarks from the user s system LoadXMLPrefix Description Prefix to use for the LoadXML parameter Syntax String Default Context Plug in attribute You can use this value e g in the _default fsi configuration file to specify the server address
58. in use FSI Viewer is capable of retrieving image specific parameters provided by the imaging server The following table shows the parameters that can be retrieved automatically eRez Iseemedia I maging True Spectra I maging I maging Server Server Server FPXWidth Yes Yes Yes FPXHeight Yes Yes Yes FPXTilesX Yes FPXTilesY Yes SceneSets Yes Image Collections Yes E In which case will these values be retrieved automatically FSI Viewer tries to retrieve the parameters FPXWidth and FPXHeight from the server if one of these values has not been defined manually If the server delivers additional parameters e g FPXTilesX FPXTilesY these parameters will only have an effect if they have not been defined manually Requirements for Automatic Parameter Supply If you are using FSI Viewer and eRez server you don t need to care about the requirements below as the default setup of FSI Viewer in eRez imaging server ensures communication between eRez and FSI Viewer within the same domain Cross Domain Access As Flash movie clips can not access data across domain boundaries by default FSI Viewer has to be setup to the same domain IP address as the imaging server For imaging servers that integrate into common web servers eRez TrueSpectra Bridge this can easily be accomplished by setting up FSI Viewer to a subdirectory of the web server For imaging servers delivering images through thei
59. lt EMBED TYPE application x shockwave flash PLUGINS PAGE http www macromedia com shockwave download index cgi P1_ Prod Version ShockwaveFlash SRC fsi_url WIDTH Swidth HEIGHT Sheight BGCOLOR Sbgcolor MENU false ALLOWSCRIPTACCESS always ALLOWFULLSCREEN true QUALITY high gt lt EMBED gt lt object gt cho template 2 gt lt BODY gt lt HTML gt NeptuneLabs FSI Viewer 51 FSI Plug ins NeptuneLabs FSI Viewer Plug ins FSI Plug ins dynamically extend the functionality of FSI Viewer and can be included at runtime Plug ins have been introduced with FSI Viewer version 2 0 Depending on the plug in additional buttons might be added to the menu bar The sequence of these buttons results from the sequence of the plug in definitions inside the lt Plugins gt section of the configuration file Using FSI Viewer Plug ins To include a plug in you simply list the desired plug ins in the lt Plugins gt section of any fsi configuration file or the _default fsi file The required plug in files are located in the plugins folder of the FSI setup directory Using FSI Plug ins fsi parameter Plugins Plugin src mousemodes Plugin src history length 10 Plugins fsi parameter The Src attribute which applies to all plug ins specifies the plug in to be included Src Description Name
60. newer to be displayed in browsers FSI Viewer has been successfully tested with the following software versions Adobe Flash Plug in 6 0 65 0 to 10 0 12 36 YaWah eRez Imaging Server 2 5 4 5 0 10 iSeeMedia Zooml mageServer 4 0 4 6 TrueSpectra Image Server 4 1 1 Service Patch 3 NeptuneLabs FSI Viewer 7 Using FSI Viewer Using FSI Viewer FSI Viewer is navigated by the menu bar here below the image and by using the mouse directly on the image For example you can select a section of the image you want to magnify The mouse functions are determined by the corresponding buttons on the menu bar zoom pan rotate etc The example to the left shows the mouse mode zoom The optional small navigator window bottom right displays the position of the image section currently viewed The Menu Bar FSI Viewer The menu bar might look different depending on skins or additional plug ins O Main Functions Back to Initial View Undoes zoom pan and rotation and restores the initial view identical with pressing space bar Zoom In 000 Zoom Out NeptuneLabs FSI Viewer Using FSI Viewer Mouse Modes The Mousemodes or MousemodeSelect plug in is required to display the following mouse mode buttons Ji Mouse Zoom In Choose this function to enlarge segments using the mouse Click on the image and drag the frame over the desired segment Alternati
61. nian 115 Keepl mageSection sssem 130 LabelContent A 127 LabelMarginTop and LabelMarginBottom 129 LabelMode AAA 127 LabelOffsetleft si cereo hee eene 130 LabelOffsetTop esseere 129 LabelOnRight peo ees 129 EabelPrefix ie pid eg eir ons 128 LabelTemplates AAA 127 LabelTextAlign rn rnrnnnnran 128 LabelT xtColor otro cett tmt rete rhe 129 LabelTextFont A 129 NeptuneLabs FSI Viewer LabelTextSize 2 o meret tna 127 LabelTextWidth and LabelTextHeight 128 E V I renos cre seed caca a 114 ListTemplate AAA 119 Margin BOLtOIs s inre ete HE eet 125 MarginLeft AAA 125 MargihRIght iniri de 125 MarginTOp ceste eere dE Reit eee nd 124 MinimizeOnSelect see 117 OffsetBottom saiae aireari ieai Henne 124 Offsetkeft iim at tem te one a a ana 124 OffsetRight 5 ctm ned eges 124 OMSCUTOP agdroe ee certe ot RE EN 124 PaddingBottom ssssseeeee n 125 CH lie EE 126 PaddingRight seesee n 126 Padding Le KEE 125 PrelOaAdTHUMDS een 130 QU 118 Scroll AFTOW rectc te e 120 ScrollBaseColor eeee nara nono r rro naranons 120 ScrollTrack oooocconcnnnnnnani nn nano een 120 Sei Vel used eir pp e ER b De E E RES 118 SHOWGONTtIOIS EEN 117 TextOutsideFrame ooonnccccnoccnnnnaconananonoranonorinonanna 117 ThumbBorderHighlight senes 123 ThumbBorderShadow
62. of the plug in Syntax String Default Context Plugins Version 2 0 0 or higher This attribute defines the name of the plug in e g history The value has to be stated without the file extension plg Alternatively you can integrate plug ins by HTTP query using the plugins parameter with a comma separated list of the desired plug ins Using the Src Parameter Plugin src mousemodes MenuOffset 10 This option is available from FSI version 3 0 only Using the Src Parameter lt PARAM name movie VALUE fsi fsi swf plugins mousemodes history gt The example above integrates the plug in mousemodes and the plug in history 52 NeptuneLabs FSI Viewer FSI Plug ins Deactivating Plug ins To disable previously integrated plug ins e g plug ins defined in the _default fsi file you can set a parameter with the name of the plug in and a value of false to the lt Options gt section of your configuration file or provide a corresponding parameter via HTTP query Disabling the History Plug in Options History value false lt Options gt or by HTTP query Using a Query to disable History Plug in Object lt PARAM NAME movie VALUE fsi swf cfg image fsi amp history false Object Defining Plug in Parameters Plug in parameters are usually defined as attributes of the Plugin tag Please note that some plug ins might require specific attributes or even
63. scrollbar of the thumbnail bar of the showcase Please see the Showcase measurements figures for details MarginRight Description Margin from the right of the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the margin in pixels from the right of the thumbnail bar to the content and scrollbar of the thumbnail bar of the showcase Please see the Showcase measurements figures for details PaddingTop Description Padding of thumbnails inside the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the top padding of thumbnails inside the thumbnail bar of the showcase Please see the Showcase measurements figures for details PaddingBottom Description Padding of thumbnails inside the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the bottom padding of thumbnails inside the thumbnail bar of the showcase Please see the Showcase measurements figures for details NeptuneLabs FSI Viewer 127 FSI Showcase Add on PaddingLeft Description Padding of thumbnails inside the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value
64. serves the XML data to FSI Pages eRez ux GEI Image date PDF Tiff with IPTC data with links Pages l Converter 1 Convert the source PDF document using FSI Pages Converter Make sure to check the nclude Links option in the Hyperlinks option section This way FSI Pages Converter extracts link information from the PDF document Make sure to uncheck the Enable XML Output option in the XML Output option section This way FSI Pages Converter writes the XML data directly to the IPTC data of the converted TIFF files 2 Upload the TIFF files containing the IPTC data to a directory on eRez server 3 Go to eRez Image Browser and select the directory containing the TIFF files 4 Select Publish to Web Publish as FSI Pages Make sure to use a configuration preset with links e g Catalog with links 64 NeptuneLabs FSI Viewer FSI Pages Add on Providing XML page data to FSI Pages There are three alternative ways to provide XML data like links for each page a Using eRez Server and IPTC data fields eRez Imaging Server is capable of serving the IPTC data contained in an image file to d FSI Viewer FSI Pages By default FSI Pages e Rez Converter adds the required IPTC data to the output Image date TIFF files You can edit this data using eRez web Tiff with interface Edit File in case you want to edit the IPTC data data manually l XML page data The
65. size Syntax Number Default 11 Context Plug in node or HTTP query prefixed with largetooltips Default text size of text in the tip box To use different sizes in a tool tip you can use the HTML tag font size n gt in the tool tip text data CornerRadius Description Radius of box corners Syntax Pixel Default 20 Context Plug in node or HTTP query prefixed with largetooltips Radius of the box corners Use 0 for straight edges and positive values for rounded edges NeptuneLabs FSI Viewer 171 Plug ins Reference Plug in Magnifier Plug in Target User interface Plug in Location plugins magnifier plg Function Adds a magnifier to the user interface Syntax Plugin src magnifier visible true size 10 The Magnifier plug in adds a magnifier to the user interface that can be dragged using the mouse Using the magnifier plug in does not cause additional data traffic as the plug in enlarges already loaded image data by software The magnifier can be hidden and shown using a corresponding button in the menu bar The level of magnification and the magnifier size can be defined by plug in parameters Plug in Parameters Specifies the space in pixels left of the menu button of the plug in MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attribute Visible Descript
66. string contains the templates S width S Sheight and S templates eRez only which need to be replaced in JavaScript or server side script URLScene Same as above but representing the entire scene image Aspect ratio representing the factor width heigth sDownloadBakioss You can use this value to calculate the width of the image to download Zoom Current magnification relative to the initial size of the image A string representing the current selection SEH requires plug in SelectFrame Measure A string representing the current measurement requires plug in Measure NeptuneLabs FSI Viewer 147 Plug ins Reference Plug in Fullscreen Plug in Target User interface Plug in Location plugins fullscreen plg Function switch to fullscreen mode Syntax Plugin src fullscreen gt If using the object tag when embedding FSI Viewer please note the parameter allowfullscreen has to be set as shown HTML integration without considering old browsers Object classid cl1sid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia com pub shockwave cabs flash swflash cab version 6 0 65 0 width Width height Height gt lt PARAM name movie VALUE URL and Parameter gt lt PARAM name bgcolor VALUE Background color gt lt PARAM name menu VALUE false gt lt PARAM name allowfullsreen VALUE true gt lt Object gt
67. use in HTTP queries NeptuneLabs FSI Viewer 17 Configuration Hierarchy of Configuration Parameters As explained before parameters can be provided in three different ways 1 The default configuration file default fsi located in the same folder as the main viewer file fsi swf will always be evaluated first 2 You can store image specific parameters in additional fsi files 3 You can provide parameters by HTTP query Parameters specified in multiple ways for example in the default configuration and by HTTP query will be evaluated in the following way e Parameters defined in configuration files override parameters defined in the default configuration file default fsi e Parameters provided by HTTP query override parameters in all configuration files The list below shows the hierarchy resulting from the sequential evaluation of the different configuration methods Configuration Hierarchy 1 HTTP Query 2 Configuration file fsi 3 Default configuration file _default fsi Choosing the adequate Configuration Method So far you learned that FSI Viewer can be configured by any combination of e The default configuration file _default fsi e Additional configuration files fsi e HTTP queries These configuration options are not only alternate methods Combining these methods offers the possibility to provide configuration parameters as easily as possible and as dynamically as required The following con
68. 0 Set 2 Scenes 10 9 8 7 6 5 4 3 2 1 Set 3 Scenes 5 6 7 8 9 10 Set 4 Scenes 8 9 10 1 2 3 You can review the resulting scene sets in the Info section of the Debug Window 46 NeptuneLabs FSI Viewer 3D Configuration ScenePreload Description Load scenes in high resolution 3D Syntax Boolean Default false Context Options If this parameter is activated default all scenes will be loaded at high resolution on startup Otherwise preview images will be loaded with at a lower resolution This parameter can significantly influence loading times and traffic volumes Setting this parameter to false leads to faster startup times and high resolution scene images will be loaded as soon as they need to be displayed TilePaddingX and TilePaddingY Description Crops each scene image by a given number of pixel Syntax Number pixel or percent Default 0 Context FPX Version 2 2 0 or higher Specifies a positive number of pixels that each source scene image 2D and 3D will be cropped by This parameter can be used to eliminate image margins especially with 3D objects containing polychrome backgrounds You can specify the padding either absolutely as a number of pixel or in percent of the source image NoSceneAnimation Description No SceneSet animations 3D Syntax Boolean Default false Context Options Disable animations between scenes
69. 100 Context ColorAdjust Version 5 0 0 Amount of green MenuOffset Description MenuOffset Syntax Number Pixels Default Context ColorAdjust Version 5 0 0 Defines the menu offset Red Description Red value Syntax Float Default 100 Context ColorAdjust Version 5 0 0 Amount of red SetValuesForEachl mage Description Save Values for each image seperately Syntax Boolean Default false Context ColorAdjust Version 5 0 0 If enabled the color values can be set for each image If disabled default the values are used for all images ShowUI Description Show Interface Syntax Boolean Default true Context ColorAdjust Version 5 0 0 If disabled the user interface will be hidden enabling the effects 142 NeptuneLabs FSI Viewer Plug ins Reference Plug in ContextMenu Plug in Target User interface First Page Previous page Plug in Location N Next page plugins contextmenu plg Last page Show Hide Index Function Zoom this Page Adds FSI Viewer related items to the Flash player s context menu Requirements About FSI Vi hn Flash player 7 or above out iewer Syntax Plugin src contextmenu This plug in does not provide any parameters You can on the other hand translate the menu items or additional items The example below shows the built in configuration of this plug in Remove Drag B
70. 126 OffsetLeft zi eec ee 126 201 OffsetRight bet 126 202 OfPSELTOD DEE 126 Padding sc ehe trt e Ries 202 Raddingbottom isnie aii 127 baddmgal ett 128 PaddingRight uiii teretes 128 PaddingTop ae a ena eE EEEE ELESE 127 PageBackgroundlmage nsee 84 PageBackgroundl mageEffects 84 PageBorderColor sseeeeeeeees 87 bageC achel mit 99 PageCacheRemoveTime scere 99 P geColor c e 86 agepak ENEE dea PEE eene 96 PageLogDelay sssini 97 PageLogTarget ren 97 PageLogURL rrt eee 97 PageMarginBottom 88 PageMarginINNEL eee 88 PageMarginOuter AA 88 PageMarginTOp nano nonononnnns 88 bagehlumber eee 89 136 218 PageNUMBGCOIOF seenen 90 PageNumcColor seen 89 PageNuml ndent sss 89 234 PageNumbOos retener i bate cera a 89 PageNumsSize A 89 PageOrderRTL eea 79 PageOverlayS ACEN citada 99 PageOverlayShowZoomed 100 A cc cceeeeeeeeeeeeeeeeeeeeeeeneaeaaas 80 PauUseQNST0P serria reini 186 BerslstentGstorage a 218 PersistentStorageExpiresAfter 219 POSICION tad A 219 DO m 139 DOSY anda a A 140 PON EE 177 PreloadBackward seres 99 PreloadForward ccccscccsssseeseeeeeeeeeeeeeenans 98 PreloadThUMbS ssssssssesesiriereerrrrrreerrrrrreeens 132 ID tena td CA 101 204 Print E fE CES uso adas 101 204 PrintResolution n rnise 101 205 Pr
71. 2 y2 The coordinates are floating point values between 0 and 1 where 0 is the left side of the image and 1 is the right side of the image For y coordinates 0 is top of the image and 1 is the bottom o the image A valid shape must at least consist of 6 values 3 points You can use multiple shape nodes in an area node if you want to specify multiple shapes for the same link me Sege OOOO Comma separated coordinates describing the link shape Coords see above lt shape gt node lt Page gt lt Links gt lt Area gt Simspe coords 0 0 1 0 1 15 0l 0 0 AS lt Area gt lt Links gt lt Page gt The example describes a rectangular shape filling the entire image Please provide larger shapes first when providing overlapping shapes FSI Pages stacks shapes above each other in the order they have been defined O 68 NeptuneLabs FSI Viewer FSI Pages Add on You can use any closed polygon shape Please note that complex polygons might lead to reduced page flip performance FSI Pages will automatically close non closed polygons by connecting the last point to the start point lt text gt nodes optional Each lt area gt may contain a lt text gt node providing HTML formatted text providing a description for the link The LargeToolTips plug in uses the content of this node to display tool tips for hyperlinks shape node Page Links Area Siege cordo 0 0 1 05 1 1
72. 25 Context Plug in attribute or HotSpots group tag Version 5 0 4 Defines the default fill opacity for HotSpots that do not contain the FillAlpha attribute where 0 is transparent and 100 fully opaque Defining Default Attributes The following attributes define default attributes to all HotSpot that do not contain a corresponding attribute itself E g defining a DefaultTarget of self will open all hyperlinks in the frame the viewer resides in provided that there is no individual Target attribute defined in a hotspot node DefaultTarget Description Default target for hyperlinks Syntax String Default blank Context Plug in attribute or HotSpots group tag Defines the default target frame for HotSpot hyperlinks Valid parameters are blank self top parent and names of frames inside a HTML frameset NeptuneLabs FSI Viewer 153 Plug ins Reference DefaultMove Description Zoom to HotSpot area by default Syntax Bool Default true Context Plug in attribute or lt HotSpots gt group tag Defines the default value for all subsequent HotSpots that do not contain the Move attribute DefaultSkew Description Permit skewing of HotSpots Syntax Bool Default false Context Plug in attribute or lt HotSpots gt tag Defines the default value for all subsequent HotSpots that do not contain the Skew attribute Def
73. 3 swf gt Overlays lt PageOverlays gt lt Plugins gt The example above does the following add a default overlay myDefaultOverlay swf adds the overlay file myOverlay1 swf to page 5 adds myOverlay2 swf and myOverlay3 swf to page 21 The attributes of the lt overlay gt nodes can be used to specify variables for an overlay Note that you can but don t need to define a default overlay Please refer to the FS Contrib package if you want to modify or create custom page overlay files 72 NeptuneLabs FSI Viewer FSI Pages Add on FSI Pages Presets in eRez Publish to Web Using FSI Pages with eRez imaging server you can choose from the following presets when using the Publish as FSI Pages option e Simple Brochure Each image represents a page no page margins no overlays NOTE XML page data in the source images will be ignored e Catalog with links Each image represents a page no page margins no overlays If the image contains XML data in the IPTC_FSI data field links will be presented on the page e Catalog with links chapters Like the above but including the Chapters plug in to quickly access chapters in your catalog You need to specify an XML file describing the document structure in this case Please refer to the Chapters plug in reference for details e Catalog with links colored chapters Like the above but with colored page borders and colored index representing the chapters e T
74. Color Description Default text color Syntax HexColor Default 000000 Context Plug in attribute Default text color To use different text colors you can use the HTML tag font color RRGGBB gt 222 NeptuneLabs FSI Viewer Plug ins Reference TextSize Description Default text size Syntax Number Default 11 Context Plug in attribute Default text size To use different sizes in the text you can use the HTML tag lt font size n gt Height Description Height of the text box Syntax Pixels Default 60 Context Plug in attribute Height of the text box in pixels BGColor Description Background color of the text box Syntax HexColor Default FFFFFF Context Plug in attribute Background color of the text box BGAlpha Description Opacity of the text box Syntax Number Default 100 Context Plug in attribute Opacity of the background from 0 invisible to 100 opaque BaseColor Description Base color for the interface parts Syntax HexColor Default DDDDDD Context Plug in attribute Base color to use for the interface parts of the plug in e g the scroll bar and the border 223 NeptuneLabs FSI Viewer Plug ins Reference Border Description Display a border to separate the text from the view port Syntax Boolean Default true Context Plug in attribute D
75. Contrib package for a sample and instructions how to create your own custom button icons You will need Adobe Flash editor to add custom icons Using Templates in URL parameters Starting from FSI version 3 2 3 you can use templates when defining URLs for custom buttons These templates will be replaced by FSI Viewer when the user clicks a custom button This way you can retrieve parameters from FSI Viewer dynamically and pass the values to a J avaScript function or a server side script Templates in CustomButton URLs Plugin src custombutton buttons btn1 btnl URL javascript alert cfg FPXWidth s Gegen V gt The example above outputs the size of the source image via J avaScript 146 NeptuneLabs FSI Viewer Plug ins Reference The list below shows available templates for custom button URLs Template in URL Replaced by The value of the FSI Viewer parameter name Be sure to use the long parameter names only e g FPXWidth instead of Width You can retrieve parameter values retrieved from the imaging server using this template as well E g S cfg FPXWidth returns the size of the source image whether specified manually or retrieved from the imaging server cfg Name A string representing the current image section in FSI Viewer see Parameter ENEE InitialView for details The complete URL to the image currently displayed in FSI Viewer The SSURLView resulting
76. Description Adjust horizontal position of thumbnail text Syntax Pixel Default 10 Context Showcase plug in node or HTTP query prefixed with showcase_ Version 4 1 3 You can use this value to adjust the horizontal position of the text area of the thumbnail Negative values move the text area to the left while positive values move the text area to the right PreloadThumbs Description Load all thumbnail images on startup Syntax Number Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ Setting the value to 0 makes the showcase load thumbnails on demand Setting positive values enables the pre loader which loads all images on startup The given value specifies the number of images to preload simultaneously Please note Be careful when activating this option especially with automatically generated image lists or large image lists as it might cause higher server loads and increased and possibly unnecessary network traffic CropThumbnails Description Crop images to match thumbnail dimension Syntax Boolean Default false Context Showcase plug in node or HTTP query prefixed with showcase Version 3 5 0 or higher Automatically crop images to match the dimensions of the thumbnails Keepl mageSection Description Preserve the view when selecting thumbnails Syntax Boolean Default false Context Showcase plug in node or HTTP q
77. GEN Viewer 5 Let your website visitors have a closer look User Manual FSI Viewer Pages Add on Showcase Add on Plug ins FSI Viewer FSI Plug ins FSI Pages Add on FSI Shouicase Add on Developed by NeptuneLabs GmbH Detmolder Str 210a D 32791 Lage Germany O 2003 2009 NeptuneLabs All rights reserved Last updated February 2009 FSI Viewer Version 5 0 4 FSI Pages 5 0 4 FSI Showcase Version 5 0 4 Manual Revision 043 All brands and product names are trademarks or registered trademarks of the respective producers FSI Viewer is a registered trademark of NeptuneLabs GmbH Germany Table of Contents aere e Dei EEN 7 Compatibility and User System Requirements esee 7 Using oe 1 23 m m RP 8 Tie Men Bal oui net abd euet so del tu ecco ardt cene rs 8 MOUSE MOdBST iaa Rute donet ae Fab 9 Additional CR eg e EEN 9 Using the navigator WINdOW EE 9 Keyboard SHOMGUUS 2 ae Os E dodi sigue AE A EE NA 10 En NEEN 11 Index str ctureof FSI VIEWER aa os E 11 Setting UP ES VIO WE is EAS AAA AAA AAA n e Yu dude V Dey A 12 LICENCIA e 13 Integration into HTML Pages ccooccooncoonccnnonnnnonanenonennnonnn non renncnnnrnnnrnnnrennncnnnrnannn 14 Required HTML Source Code sia dia 14 Configura LEE 15 Using XML Configuration Files 7 Teil 15 Using REENEN 17 Hierarchy of Configuration Parameters eeeeeeeeneennn nennen nenne 18 Conngurauonm Files x ec
78. Imaging Servers Using FSI Viewer you can present two dimensional images as well as three dimensional photorealistic presentations consisting of multiple individual images By using Single Source Imaging Servers only one high resolution source image is required for each image to be displayed Based on Adobe Flash plug in FSI Viewer can be integrated almost independently of the browser version As today the penetration of this plug in exceeds 97 of all internet users FSI products can be used without downloading or setting up a browser plug in in almost all cases By means of a large number of configuration options and optional FSI Skins FSI Viewer FSI Pages Add on and FSI Showcase Add on can widely be adjusted to integrate seamlessly into your website The FSI Plug in system is capable of integrating additional functionality into FSI Viewer at runtime without increasing the download size in general Thank you for using NeptuneLabs software www fsi viewer com Online Resources for FSI Viewer Visit www fsi viewer com for software updates regularly updated samples tutorials and downloads Compatibility and User System Requirements Imaging Servers FSI products covered by this manual can at present securely be run with eRez Imaging Server from version 2 54 iSeeMedia Zoom Image Server from version 4 and TrueSpectra version 4 1 1 Adobe Flash FSI Viewer FSI Pages Add on and FSI Showcase Add on require Flash Plug in version 6 or
79. L Defning Right To Left reading order Plugins Plugin src pages gt lt PageOrderRTL value true gt lt Plugin gt lt Plugins gt Changing the page order to RTL changes all aspects of FSI Pages related to the page sequence and page numbering including the page sequence the page numbering and the thumbnail display Please note that the page adressing does not change so that e g setting the IntitialPage parameter to 10 shows the contents on startup independet of the PageOrderRTL parameter The same applies to page n hyperlinks in PDF documents If you just want to reverse the page sequence without changing the reading order you can use the booelan FSI Pages parameter ReversePageOrder Printing Pages If you want to enable users to print pages from within FSI Pages you can enable the built in print function by setting the FSI Pages parameter print to true Enabling Print Options Plugins Plugin src pages gt lt Print value true gt lt PrintResolution value 1024 gt lt Plugin gt lt Plugins gt This adds a Print button to the menu bar Clicking the Print button displays the Print dialog of FSI Pages The Print dialog offers different printing options to the user depending on the current page and if the user zoomed into a page The printing options cover Both Pages on a single sheet of paper Left Page Right Page The currently zoomed image section A
80. L configuration files lt fsi_parameter gt lt Viewer gt lt parameter value lt Viewer gt XEPX lt parameter value lt FPX gt lt Plugins gt lt parameter lt Plugins gt Options parameter lt Options gt lt fsi_parameter gt Simple XML configuration file lt fsi_parameter gt lt FPX gt lt Src value image fpx gt lt FPX gt lt Options gt lt Debug value 1 gt lt Options gt lt fsi_parameter gt Please keep in mind the following rules when using XML configuration files e Value attributes must be provided in quotation marks e Configuration files might be cached by your browser so that changes in these files require flushing the browser cache This does not apply when using the debug mode e Make sure to save configuration files in Unicode format if your configuration file contains language specific diacritics Japanese characters and alike You can comment on or disable sections of an XML configuration file using the usual XML comment syntax Comments and disabling parameters temporarily This is a comment gt value image fpx gt Ihe following section will be ignored gt value image fpx gt lt FPX gt 16 NeptuneLabs FSI Viewer Configuration Using HTTP Queries In addition to using XML configuration files you can define FSI parameters by adding a HTTP query to the URL of the FSI Viewer movie clip In this case parameters have to
81. Link Bbarameters 69 Relative and ADSOIUEe EIKS rc caladas Odd wa Medi To Mae elle sica 70 Page OVER cM CIT las diria dde ida 72 Event Notifications and ACUONS eiii Ferd ret eran kn ten e EK rena n Font 74 Parameters to retrieve Image Collections esseeseeen mH 15 Alphabetical Index of FSI Pages Parameters mem 76 Basic ENEE 78 Parameters for the Front and Backcover Hen 83 Parameters defining the Layout and Appearance m 85 Parameters for FSI Pages Thumbnails iii ete pr rre an ea Re x eed rain 94 Parameters fot Statisties cod Ya vous 96 deus aub atu asinus O 107 FSI Showcase e EN 108 Using FSI STioWCdSeuls iso tn aa di 108 Defining Image EE 108 FS SNOW Case Ka YOU lancia aaa odias 111 Using FSI Showcase and FSI plug inS avia 113 SHOWCASE Paramete S ceno pti AA CODE V CIR CO AAE iA 114 Alphabetical Index of FSI Showcase Parameters sssssseee m 115 Basic Paramiel ers qure sie ient cunts O 116 age Re eent 120 Advanced Para Melee ld Ee 122 Plug in Reference cnc nn 133 Plug in Backgrourndlrmage io a aaa 134 PIO MCRL deal DELE LOU 135 Plug in ee de scita aste d o e Od n Er sende dd er bte a aaa 138 Pl gsin ColopAdIUSEs seca pose n i e ere xh dev er ied Pd va de esce e c d ed 141 Plug in ele og OT WEEN 143 Plug in CUSTOMBUTION veu co sect din e dr parve vbt pter ente tela eo d odd e c df dieta 144 Plug in FUISTE Moria a a dde 148 Plug in ele aa ala a OR 149 PIUG 1 e e EE 151 Plug i
82. NeptuneLabs FSI Viewer 215 Plug ins Reference Plug in SoftwareCursor Plug in Target User interface Plug in Location plugins softwarecursor plg Function Adds a software cursor to the FSI Viewer Syntax Plugin src softwarecursor gt The Software Cursor plug in adds a software cursor representing the current mouse mode Zoom Drag Rotate 2D Rotate 3D Plug in parameters Library Description File name of an SWF containing cursor graphics Syntax String Default built in library Context Plug in attributes File name of an SWF compiled Flash movie file containing custom cursor graphics Please refer to the FSI Contrib package for a sample and instructions how to create your own cursor library 216 NeptuneLabs FSI Viewer Plug ins Reference Plug in StickyNotes Plug in Target User interface of FSI Pages Plug in Location plugins stickynotes plg Function Adds bookmark functionality to FSI Pages Syntax Plugin src stickynotes gt Plug in Parameters AllowMirroredNotes Description Enable Disable mirrored note text Syntax Boolean Default false Context StickyNotes Version 5 0 0 When enabled the notes text will be mirrored when the page is turned otherwise it will not be displayed Alpha Description Opacity of the sticky notes Syntax Number Default 50 Context StickyN
83. Q1 gt lt Text gt lt b gt Some descriptive text lt b gt lt Text gt lt Area gt lt Links gt lt Page gt Link Parameters and Hierarchy of Link Parameters FSI Pages provides a number of ways to define link properties This provides a flexible way to configure links without the need to change the page XML data but adds a certain level of complexity This chapter describes how FSI Pages assembles link URLs and the hierarchy of link parameters in general Example Hierarchy of LinkURL parameters and attributes Parameter XML Attribute Location Description ForceLinkUrl FSI Pages parameter Force this URL for ALL links URL lt area gt node URL for this link DefaultURL lt links gt node Default URL for all child links DefaultLinkUrl FSI Pages parameter Default URL for links FSI Pages checks if there is a global FSI Pages Parameter ForceLinkURL first In this case all link URLs will be overwritten with this parameter If the area node does not contain an URL attribute FSI Pages uses the DefaultURL attribute of the parent links node If this attribute is undefined FSI Pages uses the global FSI Pages Parameter DefaultLinkURL The same process applies to the target tip prefix suffix and javascripttarget parameters Force Parameter Default Parameter links node area node ForceLinkURL DefaultLinkURL DefaultURL URL ForceLinkTarget De
84. RAM name allowfullscreen value true gt lt PARAM name quality value high gt lt EMBED name application x shockwave flash PLUGINSPAGE http www macromedia com shockwave download index cgi P1 Prod Version ShockwaveFlash SRC URL and Parameter WIDTH Width HEIGHT Height BGCOLOR Background color MENU false ALLOWSCRIPTACCESS always ALLOWFULLSCREEN true QUALITY high gt lt EMBED gt lt Object gt Variables in the lt object gt and lt embed gt tags Width Width of the viewer in pixel or percent Height Height of the viewer in pixel or percent Background color Background color hexadecimal e g FFFFFF for white URL and parameter URL to FSI Viewer and parameters provided as HTTP query e g cfg foo For further possible parameters or XHTML configuration options please refer to Flash documentation or renowned HTML references 14 NeptuneLabs FSI Viewer Configuration NeptuneLabs FSI Viewer Configuration Configuration parameters can be provided using XML configuration files and or by HTTP queries appended to the URL of the Flash movie clip Providing parameters by HTTP query is recommended if you plan to display large numbers of images Automated Implementation of Images In the simplest case you only define the relative path to a configuration file within the src parameter of the lt object gt Tag using the cfg parameter Defining the CFG parameter inside t
85. SBridge plug in or FSI Component 210 NeptuneLabs FSI Viewer The following events apply to this plug in Plug ins Reference Event ID Parameter Description onSelectFrameEnable Boolean The select has been enabled or disabled onSelectFrameStart The user starts selecting f The user modifies the select frame RE Sting The parameter provides a string representing the current selection l The user stopped modifying the selection es stop String The parameter provides a string representing the current selection NeptuneLabs FSI Viewer 211 Plug ins Reference Plug in ShoppingList Plug in Target User interface of FSI Pages Plug in Location plugins shoppinglist plg Function Add shopping cart functionality to FSI Pages Syntax Plugin src shoppinglist Plug in Parameters Shopping List Please click product s basket icon on one of teh pages to add the product to the shopping list Use the butttons below the list to remove items print or email the list pce Zur Website pce Zur Website 18 00 Unit Price 9 00 9 00 Unit Price 9 00 Total Value 27 00 Currency Description Defines the currency Default Context ShoppingList Version 5 0 0 Defines the currency inside the shoppinglist DecimalCharacter Description Decimal delimeter Syntax String Default Cont
86. Size of interactive page edges Syntax Number Default 5 Context Pages plug in node or HTTP query prefixed with pages_ Version 3 5 5 or higher Specifies the size of the interactive outer page edges you can use to flip pages You can either specify the size in pixels or in percent of the page width Setting this parameter to 0 disables interactive page flipping by dragging the page edges NeptuneLabs FSI Viewer 107 FSI Showcase Add on NeptuneLabs FSI Viewer FSI Showcase Add on FSI Showcase Add on integrates a resizable scroll pane to FSI Viewer displaying thumbnails of multiple images Clicking a thumbnail displays the image in FSI Viewer This way a single viewer instance can be used to display hundreds of images presenting thumbnails and optional texts for each image Using FSI Showcase The integration of FSI Showcase is very similar to an ordinary FSI plug in To enable the showcase you have to add a plug in node to your default XML configuration file Integrating FSI Showcase lt Plugins gt lt Plugin src showcase basecolor 58A8FE gt lt Plugins gt Defining Image Lists The images to be displayed in FSI Showcase have to be defined in an lt images gt node added to your XML configuration file The format and options of the collections is the same as the collections for FSI Pages Add on Defining FSI Showcase image nodes Images Image label My First Image file
87. Syntax String Default TC Context Pages plug in node or HTTP query prefixed with pages_ Alignment of the images on the pages The default is TC which centers the images horizontally on top of the page Please specify the alignment for even left pages Uneven right pages will be aligned correspondingly Possible values are any combination of T Top L Left C Center and C Center B Bottom R Right PageColor Description Page background color Syntax HexColor Default FFFFFF Context Pages plug in node or HTTP query prefixed with pages_ Background color of the pages specified as 6 digit web color 86 NeptuneLabs FSI Viewer FSI Pages Add on PageBorderColor Description Color of page borders Syntax HexColor Default CCCCCC Context Pages plug in node or HTTP query prefixed with pages Color of the page borders specified as 6 digit web color Use false for no border at all Helpl mageURL Description Help image to be displayed left of the first page Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or above An absolute or relative ImageURL like FPXSrc to an image on the imaging server that FSI Pages displays left of the first page of the catalog ScrollBaseColor Description Base color for the scroll bar Syntax HexColor Default CCCCCC
88. URLPrefix Prefix to add to all URLs specified in the child lt area gt nodes URLSuffix Suffix to add to all URLs specified in the child lt area gt nodes DefaultURL Default URL to use for lt area gt nodes without a URL attribute DefaultTarget Default target frame for lt area gt nodes without a target attribute DefaultTip Default tool tip for lt area gt nodes without a tip attribute The prefix and suffix will be used for relative links only Special links beginning with javascript mailto or page will be skipped as well NeptuneLabs FSI Viewer 67 FSI Pages Add on lt links gt node lt Page gt Links URLPrefix http foo com DefaultTip No Top gt lt area gt lt area gt lt Links gt lt Page gt lt area gt nodes This node represents a link on a page Each link must contain at least one lt shape gt node describing the link area The table below lists the attributes recognized by FSI Pages Attribute Description URL URL to open when the user clicks the link Target Target frame to open the URL in Tip Tool tip to display when the user points at the link lt area gt node lt Page gt lt Links gt seem sure mito Drettel blem dug Meio ile gt lt Area gt lt Links gt lt Page gt lt shape gt nodes These child nodes of the lt area gt node provide the coordinates of a link polygon The format for the coordinates is x1 y1 x
89. abled the data will be cached for the given time defined by PersistentStorageExpiresAfter 218 NeptuneLabs FSI Viewer Plug ins Reference PersistentStorageExpiresAfter Description Keep note data for given time Syntax Number Context StickyNotes Version 5 0 0 Defines after which period of time the cached note data expires Position Description Position of the sticky notes Syntax String Default top Context StickyNotes Version 5 0 0 Sticky notes position on the page top bottom or right Scale Description Size of the sticky notes Syntax Number Default 100 Context StickyNotes Version 5 0 0 Defines the size of the sticky notes Spacing Description Defines the distance between the sticky notes Syntax Number Pixels Default 8 Context StickyNotes Version 5 0 0 Defines the distance between the sticky notes NeptuneLabs FSI Viewer 219 Plug ins Reference Plug in Synchronize Plug in Target N A Plug in Location plugins synchronize plg Function Synchronize multiple instances of FSI Viewer Syntax Plugin src synchronize ID UNIQUE STRING gt Enterprise editions of FSI Viewer contain this plug in by default O For all other editions this plug in can be optionally obtained Using the Synchronize plug in you can synchronize multiple instances of FSI Viewer To synch
90. access from the subdomain www yourdomain tld and from the main domain yourdomain tld by default In case you need to access JSBridge from other sub domains you can specify a list of subdomains separated by using this parameter e g allowdomains value www domain com www domain2 com gt Explore Description Activate debug output of Button Ds Syntax Boolean Default false Context Plug in attribute If enabled the debug window will display the Button ID of each button pressed inside FSI Viewer This way you are able to determine Button IDs not listed in this documentation Additionally the debug window will output each command received by the JSBridge plug in Callback Description Enable J avaScript callbacks Syntax Boolean Default false Context Plug in attribute If enabled the events of FSI Viewer FSI Pages or FSI Showcase will be forwarded to a specific JavaScript function Please refer to the section mplementing JavaScript Callbacks for details I mageUris Description Provide ImageUrl templates with J avaScript callbacks Syntax Boolean Default false Context Plug in attribute This parameter depends on the Callback parameter above If Callback and ImageUrls parameter have been set to true Imageurl notifications providing image URL templates will be sent to the JavaScript callback function Please refer to the ImageURL callbac
91. ach index node represents an item in the chapters drop down referring the user to a page in your document The following attributes need to or can be added to each index item Attribute Description page Index of the page to refer to required label Title for a chapter required file File to download for a chapter from version 4 0 0 See chapter Saving Pages for details color 6 digit hexcolor for use with ColoredI ndex parameter An absolute or relative URL to an MP3 file to play for this chapter from version musicSong 4 0 7 Please note that you need to add the plug in music as well in this case NeptuneLabs FSI Viewer 137 Plug ins Reference Plug in ClockProgress Plug in Target User interface Plug in Location plugins clockprogress plg Function Replacement for default progress bar Syntax Plugin src clockprogress The ClockProgress plug in replaces the default progress bar with a round progress indicator Plug in Parameters The clockprogress plug in can be customized by adding attributes to the plugin tag E g Plugin src clockprogress alpha 20 gt The following attributes can be used to customize the clockprogress plug in Alpha Description Opacity of progress indicator Syntax Number Default 50 Context Plug in attributes Defines the opacity of the progress indicator Possible values range from 0 to 100
92. ackground image Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 5 0 0 Defines image modification parameters to apply to images used The value of this parameter depends on the imaging server being used With eRez server you can sharpen the image and define the JPEG compression level e g sharpen 100 amp quality 95 84 NeptuneLabs FSI Viewer Parameters defining the Layout and Appearance FSI Pages Add on Ratio Description Aspect ratio of pages Syntax String Default auto Context Pages plug in node or HTTP query prefixed with pages_ The aspect ratio of pages displayed in FSI Pages You can specify any aspect ration e g 320 240 or 1 2 or specify auto to use the aspect ratio of the first image in the image collection SingleSided Description Use images on uneven or even pages only Syntax String Default false even uneven Context Pages plug in node or HTTP query prefixed with pages_ By default FSI Pages creates a page for each image in the image collection Using this parameter you can advise FSI Pages to use images on even or uneven pages only inserting a blank page on the opposite side Use false to display images on all pages default Use even to display images on even pages only Use uneven to display images on uneven pages only BendEffect Description Visual
93. ad 149 Library uir NI entes 198 216 Line Color oro d ree cee 139 178 LineWidth i da cot 171 LnktllAlpoba eda e ia 91 LinkRGBAActive cavas cosida tete 91 LinkRGBAHoVver neee 91 LINKRGBANOrmMal eeen 91 LnkTemplatefiata a 94 Link Templates sss 94 Lsttemplate AAA 75 121 O aisect irl errem 195 ES A rie rens 195 LOOP ME E 149 186 Magonification nee 173 MagnifyCurrentPages s 201 MaonifvGmalllmages 32 MarginBottom crcr 88 127 201 MarginLeft AAA 88 127 MarginRight ico ene 88 127 Maroinfop c 88 126 201 MaskAlpha e Eee 209 MaskColor a tres 209 MaxHelght buscara ti 207 Max Width Ze itur aerate rectae 207 MaxZoombLewvel sse 38 ug TRES 94 Mentira tanda papada 26 Menu lt eris eii Eoi ess 143 MenuOffset 142 144 149 172 174 176 183 185 1 87 194 204 208 Metatatauervbarameters e 39 233 MinHelght O 207 MinimizeOnSelect eee 119 oli Tele MEET 207 Mode Ti Ere ie 183 MouseVelocity ereere 41 MOV 156 MovePages 5esrene e rta 100 NaturalRotation sese 218 NavEffeCtS AAA 36 NavFramecColor seen 28 NaVHeight eroe 28 NavMaskaAlpha see 28 NavMaskColor eae aaa 28 NaVWItH 0 ce eee rara nc rca ranieri 28 Nol mageBlend eiie 33 A pr te e ihe Rr te nb snb cs 27 NoSceneAnimMation ae eee 47 NoSceneLoop AANEREN 47 NoSetLO OP ie sre toten entre dh rei etr ea 47 Offset x nano sob dee RU 197 ODffsetBottom eccerre
94. ag to integrate a Flash movie clip Older browsers use the obsolete lt Embed gt tag instead Sample HTML code to integrate FSI Viewer into HTML pages Variable data printed in bold and square brackets HTML integrations for modern and old browsers Object classid clsid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia com pub shockwave cabs flash swflash cabitversion 6 0 65 0 width Width height Height gt lt PARAM name movie VALUE URL and Parameter gt lt PARAM name bgcolor VALUE Background color gt lt PARAM name menu VALUE false gt lt PARAM name allowscriptaccess value always gt lt PARAM name allowfullscreen value true gt lt PARAM name quality value high gt lt Object gt Embed Tag For browsers e g Netscape 4 x that do not support the lt object gt tag an additional encapsulated lt embed gt tag with identical parameters is required HTML integrations for modern and old browsers Object classid clsid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia com pub shockwave cabs flash swflash cab version 6 0 65 0 width Width height Height gt lt PARAM name movie VALUE URL and Parameter lt PARAM name bgcolor VALUE Background color lt PARAM name menu VALUE false gt lt PARAM name allowscriptaccess value always lt PA
95. ages Parameters AutoCropPag6es ite eode tete rete eod Ped RO I Faden 79 AUTO ZOOM EE 97 BackCoVver eege Eege ER BackCoverConfig cocooocococnonicicccnononnnann non nnn nn cnn nnnaraninnns 83 BackCoverl mage sse 82 BendEffect sisir iin eue te ote 84 BendEffectl ntensity A 84 BlankbBacktC over ER BlankEFoOntCO VE cocoa ado 82 ButtonsFirstLastPage ena 95 ClickPageloZoom tenet textes 80 CropBottori i irren cin ri a nnda 105 COP DIE assi ihrer rrt rris 106 Cropbetft s set Em beta 105 CropO ter cien rn nnne 106 CropRightsi iile teet erre ert Dee ENER 105 r Lol DEE 105 Default avascriptTarget a 92 DefaultLinkTarget A 92 DefaultLinkTip uote cte tne 93 DefaultLinkU RLE s scitote ter ers 92 DefaultLinkUrlPrefix em 92 DefaultLinkUrlSuffix ssse 92 DemoURL conan tl pedia EE 94 De moURLTarget viii aa 95 A fpes er berztr cie Tee eseou A 74 DoublePageAllowl nteractivity esesse 81 DoublePageZoom ssee nnn nc nn narannnnns 81 DoublePageZoomS calle a 81 Drop hadow nn 85 Drop hadowflstance ea 85 EmptylImag8s cutis ic reete tere do g 71 EV NES gt ocn eret e ener e e e dec n E dns 106 Firstbageh umber e 78 ll ege 106 FlipEdgeSize ee dc 106 FolloWEIRKS 2 tete reta tien ee 89 Force avascriptTarget eenen 91 ForcebinkTarget aee rne 91 ForceLinkTip miii 92 ForceEinkURE cocto a 91 ForceLinkUrlPref
96. ample your configuration should look like this Enabling Save Options lt Plugins gt lt Plugin src pages gt Save value true gt lt SaveDocumentFile value http www foo com downloads catalog1 all pd f gt lt SaveURLPrefix value http www foo com downloads catalogl lt Plugin gt lt Plugins gt Note for users of imaging servers other than eRez I maging Server If you are using an imaging server other than eRez server you need to enable the XML Output option in FSI Pages Converter before converting a PDF document to have FSI Pages Converter write the XML data for each page to separate files rather than adding the data to the IPTC data of each TIFF file Please refer to the chapter Using external page data files for detailed instructions 3 Downloading parts of the Document If your document is separated into logical parts e g chapters or product groups you might want to enable the user to download parts of the document In this case you need to use the FSI Viewer plug in Chapters which enables the user to select and go to a predefined section in your document For each section you can specify a separate document to offer for download This way the user will be presented an option to download the current section chapter in the Save dialog Example XML data for the Chapters plug in including download files lt Indexdata gt Index page 1 label Chapter 1 file chapterl pdf gt
97. an specified by these values MinWidth and MinHeight Description Minimum width and height Syntax Number in pixel Default Context Plug in Tag FSI Viewer can not be resized to a dimension smaller than specified by these values EnlargeBy Description Resize viewer in steps of n pixels Syntax Number Default 1 Context Plug in tag Specifies the steps FSI Viewer will be resized by Entering 1 means that the viewer resizes exactly according to the size of the object tag Entering greater numbers forces the viewer to resize by the number of pixels specified Using values 1 increases the chance of imaging server cache hits and might thus reduce server load NeptuneLabs FSI Viewer 207 Plug ins Reference Plug in SelectFrame Plug in Target User interface Plug in Location plugins selectframe plg Function cs Provides a resizable select frame Eigen 0 68200862 0 80817611 0 Syntax Plugin src selectframe gt This plug in adds a resizable select frame into FSI Viewer Pressing SHIFT locks the aspect ratio of the selection Pressing CTRL resizes the selection relative to the center Pressing ALT rotates the selection Pressing ALT SHIFT rotates the selection in steps of 5 degrees Plug in Parameters The following attributes can be assigned to the lt plugin gt tag You might as well define all plug in parameters via query or inside the lt options gt g
98. and folder to load XML notepad data files from Example http foo com notepaddata SendXMLStoreURL Description URL to post notepad data to Syntax String Default Context Plug in attribute URL of a web server receiving the notepad data in XML format See Loading and Posting Data on the preceding page for details SendXMLUrlSuccess Description URL to open if sending XML data succeeded Syntax String Default Context Plug in attribute Url to open if sending the XML data to the web server specified by SendXMLStoreURL parameter succeeded SendXMLUriFailed Description URL to open if sending XML data failed Syntax String Default Context Plug in attribute URL to open if sending the XML data to the web server specified by SendXMLStoreURL parameter failed NeptuneLabs FSI Viewer 195 Plug ins Reference SendXMLUriSuccessTarget SendXMLUrlFailedTarget Description HTML target frame to open the URL in Syntax String Default blank Context Plug in attribute HTML target frame to open the SendXMLUrlSuccess or the SendXMLUrlFailed page in Plug in Parameters Advanced Customization Customizing mage You can replace the default animations images displayed when the bookmark list is empty when the user adds a custom or a link bookmark The plug in loads the optional custom help images from your imaging server Th
99. and remarks created by Userl Additionally you can provide predefined notepad data for example to present hot products special offers and alike In this case you provide the URL to a predefined XML data file using the LoadXML parameter This way the notepad on the client computer loads the notepad data from this file instead of using any data stored locally on the user s computer Plug in Parameters Basic Required Parameter O Uniquel D Description Unique String used to store notepad data locally Syntax String see description Default Context Plug in attribute A unique string identifying the notepad data Using the same or no UniquelD for different images or image collections catalogs will present false bookmarks in the notepad You can for example use the path of the image or the name of a catalog Do not use the following characters in UniquelDs Space amp lt gt Alternatively to the plug in parameter you can use the global FSI Parameter UniqueID to specify a unique identifier Revision Description Revision of the notepad data Syntax Number Default 1 Context Plug in attribute You can use different revisions for the same UniquelD Changing the revision invalidates all bookmarks for a given UniquelD You might for example change the revision if you change add or remove pages in an FSI Pages catalog 190 NeptuneLabs FSI Viewer Plug
100. and scene sets This can be useful if different scenes represent different states of an object instead of a rotation NoSetLoop Description No 360 rotation around the y axis 3D Syntax Boolean Default false Context Options The first and the last scene set will be considered ending points E g for partial rotations 360 Please note The blur animation is turned off if NoSetLoop is activated NoSceneLoop Description No 360 rotation around the x axis 3D Syntax Boolean Default false Context Options The first and last scene in the each scene set will be considered ending points E g for partial rotations 360 Please note The blur animation is turned off if NoSceneLoop is activated NeptuneLabs FSI Viewer 47 Debug Mode NeptuneLabs FSI Viewer Debug Mode Enabling the Debug Mode The debug mode can be enabled or disabled by passing the Debug parameter either by HTTP query or in an XML configuration file Please use debug 1 to enable the debug mode and debug 0 or omit the debug parameter to disable the debug mode To disable the debug mode permanently you can safely delete the debug directory of your FSI setup directory Example If FSI Viewer does not work or look as expected in an HTML page you can quickly debug FSI Viewer as follows e View the source code of the HTML document and search for the FSI Viewer HTML Code e Copy the en
101. anually as FSI Pages Converter creates the XML data for you The description below provides information on the format in case you want to edit the data manually or if you want to use a different tool to create the page data 66 NeptuneLabs FSI Viewer FSI Pages Add on XML Page data with 2 links lt Page file pagel6 pdf Links urlprefix http somesite com product php id gt lt Area tip Some Tip url 599 gt Smeg coords 0 20 0 73 0525 05 79 0 255 0572 012 0 12 AS lt Shape coords O o OnO 5410579 0 241 0 72 05359 0572 gt lt Text gt Some long descriptive text lt Text gt lt Area gt lt Area tip Another Tip url 210 gt lt Shape cosrdls 0 20 0 75 0 239 00 73 0525505725 0542505725 gt lt Area gt lt Links gt lt Page gt lt page gt node This is the root node for XML page data The following attributes will be recognized by FSI Pages Attribute Description URL or file name to use for the als save functionality of FSI Pages lt page gt node lt page file pagel6 pdf gt lt links gt nodes These nodes encapsulate one or more lt area gt nodes Each lt area gt node represents a link You can use the following attributes to specify default values for all child lt area gt nodes Using multiple lt links gt nodes you can use different default values for the lt area gt nodes contained Attribute Description
102. aultColor Description Default color of HotSpot borders Syntax HexColor Default FF0000 Context Plug in attribute or HotSpots tag Defines the default color of HotSpot borders DefaultFill Description Fill the HotSpot area by default Syntax Boolean Default true Context Plug in attribute or HotSpots group tag Defines the default value for all subsequent HotSpots that do not contain the Fill attribute If this value is set to false all HotSpots will be shown as outlines by default DefaultFillColor Description Default fill color for the HotSpot areas Syntax HexColor Default FFFFFF white Context Plug in attribute or HotSpots group tag Defines the default fill color for HotSpots that do not contain the FillColor attribute 154 NeptuneLabs FSI Viewer Plug ins Reference DefaultFillAlpha Description Default fill opacity for the HotSpot areas Syntax Number Default 25 Context Plug in attribute or lt HotSpots gt group tag Defines the default fill opacity for HotSpots that do not contain the FillAlpha attribute where 0 is transparent and 100 fully opaque Defining Individual HotSpots Each HotSpot definition must at least contain the name of the HotSpot shape and the spot attribute which defines the position of the HotSpot The tag name of each definition specifies the shape of the HotSpot Available default shapes
103. bar Syntax Number Pixels Default 0 Context PagesThumbBar Version 5 0 0 Defines the offset of the thumbnail bar Padding Description Thumbnail Padding Syntax Number Pixels Default 10 Context PagesThumbBar Version 5 0 0 Defines the distance between the thumbnails SelectionBorderWidth Description Border of the active thumbnail Syntax Number Default 4 Context PagesThumbBar Version 5 0 4 Width of the border around the active thumbnail SelectionColor Description Color of the active thumbnail Syntax HexColor Context PagesThumbBar Version 5 0 4 Defines the backgroundcolor of the active pages in the thumbnail bar SelectionMarginBottom Description Bottom margin of the active thumbnail Syntax Number Default 6 Context PagesThumbBar Version 5 0 4 Defines the bottom margin of the active thumbnail 202 NeptuneLabs FSI Viewer Plug ins Reference SelectionRoundCorner Description Round corner size of active thumbnail Syntax Number Default 4 Context PagesThumbBar Version 5 0 4 Defines the rounded corner effect for the active thumbnail Straight corners if set to 0 TextColor Description Color of page numbers Syntax HexColor Context PagesThumbBar Version 5 0 4 Defines the rounded corner effect for the active thumbnail Straight corn
104. ble depending on your FSI Viewer skin and integrated plug ins All command strings have to be provided exactly as stated in the lists below especially regarding upper lowercase writing and white spaces 1 Direct Commands Usage FSIViewer SetVariable FSICMD command To stop the initiated action use FSIViewer SetVariable FSICMD Command Description empty string Stop current action Release Button Reset Reset Viewer Zoomi n Start zooming in ZoomOut Start zooming out Up Start panning upwards Down Start panning downwards Left Start panning to the left Right Start panning to the right RotateLeft Start rotating counter clockwise Z axis RotateRight Start rotating clockwise Z axis NextScene Start rotating clockwise Y axis PreviousScene Start rotating counter clockwise Y axis NextSceneSet Start rotating clockwise X axis PreviousSceneSet Start rotating counter clockwise X axis DebugWindow Show Hide the debug window if available __InfoWindow Show Hide the about window if available FSI Showcase only Description Previousl mage Select previous Image Nextl mage Select next Image Select image n Important Use SetVariable newImagelndex n where n is 0 images prior to sending this command Selectl mage Alternatively you can select an image relatively from the currently selected image To select an image r
105. bnail bar NeptuneLabs FSI Viewer 117 FSI Showcase Add on DragMenu Description Show Hide the buttons in the thumbnail bar Syntax Boolean Default true Context Showcase plug in node or HTTP query prefixed with showcase_ Show the buttons of the thumbnail bar enabling the user to resize the thumbnails and the bar itself This parameter is always false if the parameter DragBar is hidden DragMenuWidth Description Size of the menu of the drag bar Syntax Number Default 9 Context Showcase plug in node or HTTP query prefixed with showcase A floating point value defining the size of the menu inside the drag bar Usel nitialView Description Use InitialView parameters for thumbnail images Syntax boolean Default true Context Showcase plug in node or HTTP query prefixed with showcase Use the image section defined by the parameter InitialView to create the thumbnail image if set to true If set to False the entire image will be used I nitiall mage Description Image selected at startup Syntax Number Default 1 Context Showcase plug in node or HTTP query prefixed with showcase_ The index of the image selected on startup Enter the index of the image from 1 to n images ToolTips Description Show tool tips when hovering above a thumbnail Syntax Boolean Default true Context Showcase plug in node
106. ce image but no scene set is defined a scene set containing all the scenes from left to right top to bottom will be created by default Referring to Figure B this would be lt SceneSets value 1 24 As the presentation of Figure B consists of 6 by 4 individual images while 8 images represent a complete rotation around the Y axis the definition of the following 3 scene sets is required NeptuneLabs FSI Viewer 43 3D Configuration I mage Tiles Y Axis X Axis 1 8 0 to 360 15 9 16 0 to 360 0 17 24 0 to 360 T1159 The required configuration to rotate the object around the Y axis moving the mouse horizontally and rotating the object around the X axis moving the mouse vertically looks like this Configuration for a 3D view as displayed in Figure B MilesX value 6 TilesY value 4 lt FPX gt Options lt SceneSets value 1 8 9 16 17 24 lt Options gt You can use the SceneSet parameter to specify the image sequence independent of the way you setup the 3D view multiple source images or a tiled source image Please refer to the description of the SceneSets parameter for details on the different ways of defining images contained in a scene set Tip If you are not sure about the number of images in your tiled source image in the x and y direction try entering the value 1 for TilesX and TilesY In the viewer you will then see the entire source image structure Pa
107. d abruptly without transition NeptuneLabs FSI Viewer 33 Configuration Effects Description Image manipulation parameters for all images Syntax String Default Context Options Version 1 3 0 or higher The effects parameter can be used to pass image manipulation parameters to the imaging server The range of available parameters depends on the imaging server being used Typical manipulation parameters include the image compression quality or qlt and image sharpening blurring sharpen or ftr If no effect is specified the default settings of the server apply Please refer to your imaging server for a list of available parameters 34 NeptuneLabs FSI Viewer Configuration Example quality The quality or qlt parameter specifies the JPEG compression of images delivered by the imaging server Practical values range from 50 to max 90 quality 5 quality 90 xr el a ES Ze lt effects value quality 5 gt lt effects value quality 90 gt Example sharpen The sharpen or ftr parameter blurs negative values or sharpens positive values images delivered by the imaging server sharpen 300 blur sharpen 150 e nt effects value sharpen 300 pM value sharpen 150 Other effects change for example the color saturation hue or contrast Please refer to your imaging server documentation for a complete description of availabl
108. defines the left padding of thumbnails inside the thumbnail bar of the showcase Please see the Showcase measurements figures for details PaddingRight Description Padding of thumbnails inside the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase This value defines the right padding of thumbnails inside the thumbnail bar of the showcase Please see the Showcase measurements figures for details HoverZoom Description Zoom thumbnails onMouseOver Syntax Number Default 100 disabled Context Showcase plug in node or HTTP query prefixed with showcase Zoom thumbnails when the user points at a thumbnail The default value is 100 no effect Possible values are 100 no effect to 250 HoverRotation Description Rotate thumbnails onMouseOver Syntax Number Default 0 disabled Context Showcase plug in node or HTTP query prefixed with showcase Rotate thumbnails when the user points at a thumbnail The default value is 0 no effect Possible values are O degree to 360 degree 128 NeptuneLabs FSI Viewer FSI Showcase Add on The following parameters can be used to customize the text displayed on the thumbnails LabelTextSize Description Text size of the thumbnail labels Syntax Pixel Default 0 no text Context Showcase plug in node or HTTP query prefix
109. ds Directing the search query to your server side script Please use the FSI Pages parameter SearchCustomURL to provide the URL to the script on your server performing the search and returning the XML based results To identify the FSI Pages instance catalog to return results for you might need to pass a value identifying the catalog This can be done using the FSI Pages Parameter SearchCustomValue Both parameters can as usual be specified by query or by adding the parameter to a configuration file Configuration parameters for external searching Plugins Plugin src pages gt lt SearchCustomURL value http foo com search php gt lt SearchCustomValue value 12345 lt Plugin gt lt Plugins gt Using the parameters like in the example above will force FSI Pages to direct the search to the URL specified using the HTTP POST method The POST data contains the following values searchvalue The search text entered by the user customvalue The value you specified using SearchCustomValue You might want to pass multiple comma separated values to SearchCustomValue in case you need multiple values to identify a given FSI Pages instance Returning the XML based list of matches to FSI Pages Your script needs to return the search result in XML format Each result must be returned as a child node of the root node result see example below Each result item must at least contain the page number corresp
110. e image effect commands brightness 10 coss o Fatti s Ao c effects value brightness 10 effects value brightness 10 gt NeptuneLabs FSI Viewer 35 Configuration The format of the effects parameter is similar to a HTTP query You can combine different effects by concatenating the parameter value pairs with an ampersand amp character effects value quality 658sharpen 30 gt When passing effects by HTTP query the value of the effects parameter has to be provided as an url encoded string e g 9626 instead of amp and 3D instead of fsi swf effects quality 3D65 26sharpen 3D30 In general FSI Viewer passes the value of the effects parameter through to the imaging server Therefore using the effects parameter you can pass through all parameters your imaging server offers for static image manipulation For example with eRez imaging server you can force the use of a real time template by passing the tmp parameter lt effects value tmp fsi gt Applying Effects to Specific Images Only While the effects parameter holds image manipulation parameters for all images you can also apply effects to specific types of images in FSI Viewer see NavEffects SceneEffects and TileEffects For example it is sometimes useful to sharpen the images inside the navigator window as small images tend to appear a little blurry To do so you can add a corresponding NavEffects parameter Shar
111. e navigator window Syntax Boolean Default false Context Options Show or hide the navigator window displaying the miniature image and the current image section NeptuneLabs FSI Viewer 27 Configuration NavWidth and NavHeight Description Maximum size of the navigator window Syntax Number in percent or pixel Default 80 Context lt Options gt Version 3 0 0 and above Defines the maximum width and height of the image inside the navigator window The value can be defined absolutely or in percent of the viewer size Use parameter NoNav to hide the navigator window NavFrameColor Description Color of the selection frame inside the navigator window Syntax HexColor Default FF0000 depending on the skin Context Options Version 3 0 0 and above Specify a 6 digit HexColor to change the color of the selection frame inside the navigator window e g 0000FF for blue NavMaskColor Description Color of the area around the selection frame of the navigator window Syntax HexColor Default depends on the skin Context lt Options gt Version 3 0 0 and above Specify a 6 digit hexadecimal color to change the color of the area outside the selection frame of the navigator window e g FFFFFF for white NavMaskAlpha Description Opacity of the area around the selection frame of the navigator window Syntax Number 0 100 Default dep
112. e syntax of these parameters therefore corresponds to the FPXSrc parameter If you specified the FPXBase parameter you only need to provide the path to the image e g helpimages emptynotepad tif The following images can be defined ImageHelpMain image to display when the bookmark list is empty ImageHelpLinkBookmark image to display while the user adds a link bookmark in FSI Pages ImageHelpLinkCustom image to display while the user adds a custom bookmark 196 NeptuneLabs FSI Viewer Plug ins Reference Plug in PagesMirror Plug in Target Viewport of FSI Pages Plug in Location plugins pagesmirror plg Function Displays a mirror like effect Syntax Plugin src pagesmirror gt g pag Plug in Parameters Blur Description Defines the blur effect of pages Syntax Number Default Context PagesMirror Version 5 0 0 Defines the blur factor of the mirrored images Offset Description Defines distance between the pages and the mrror effect Syntax Number Pixels Default Context PagesMirror Version 5 0 0 Defines the distance of the mirror effect and the pages StartAlpha Description Alphablending Syntax Number Default 70 Context PagesMirror Version 5 0 0 Defines the mirror effects opacity on the near end NeptuneLabs FSI Viewer 197 Plug ins Reference Plug in PageSounds Plug in Target
113. ectory FSIBase NeptuneLabs FSI Viewer 135 Plug ins Reference If you store XML files in the directory fsi config pages xml you therefore only need to specify the file name of the XML file to load Please note You need to use an external XML file in UTF 8 format when using special language specific characters characters gt 0x80 PageNumbers Description Display a starting and ending pages of chapters Syntax Boolean Default true Context Plug in attribute Add the starting and ending page of a chapter to the chapter label ComboLabelBackgroundAlpha Description Background opacity of the select box background Syntax Number Default 10 Context Plug in attribute Opacity of the select box background from O transparent to 100 opaque Coloredl ndex Description Display colored index markers in the select box Syntax Boolean Default true Context Plug in attribute Display the color specified in the document structure XML data in front of the chapter labels IndexMarginWidth Description Width of the colored page index Syntax Number Default 0 Context Plug in attribute Floating point value specifying the width of the colored index located on the outer page margin in percent of the page width Enter O to disable the colored page margin Please note This value requires setting Coloredl ndex to true as well
114. ed LoadProgress Number percent SE corresponding to the progress bar inside FSI iewer Press Button ID The button ID has been pressed Release Button ID The button ID has been released e The tool tip String is about to be displayed MEUS Sting escaped See details below this table The image section currently displayed MESS Image Section Can be used with the Goto command Provides a template that can be used to build an image URL corresponding to the image being Imagen abe template displayed in FSI Viewer See details below this table Action Action ID The action ID is currently being executed Modal true false The viewer enters a passive true or an active false state MouseMode Mouse Mode ID The mouse mode ID has been activated Zoom Magnification percent The magnification has changed I mageSelected Image index 0 nImages A new image has been selected FSI Showcase only FSI Pages only Called after the FSI Pages Add on is ready for use RE Integer The parameter provides the total number of pages Called each time before the user goes to a different onPagesGotoPage Integer page The parameter provides the target page number Called each time after the current page has changed onPagesPageChanged Integer The parameter provides the index of the page currently visible Called each time the load progress of FSI Pages onPagesProgress Integer changes The parameter prov
115. ed with showcase Text size in pixel for the text presented below the thumbnail image Use 0 to disable text and positive values e g 8 to enable texts on the thumbnails LabelMode Description Content of the thumbnail labels Syntax Number Default 0 Context Showcase plug in node or HTTP query prefixed with showcase Obsolete Please use LabelContent and LabelTemplates parameters described below instead LabelContent Description Content of thumbnail labels Syntax String Default Context Showcase plug in node or HTTP query prefixed with showcase The specified string serves as a label for the thumbnail images in the thumbnail bar The string may contain basic HTML tags to format the text Additionally you can add templates being replaced at runtime Please see LabelTemplates parameter below for details LabelTemplates Description Runtime Templates for thumbnail labels Syntax String Default Context Showcase plug in node or HTTP query prefixed with showcase FSI Showcase add on replaces the specified templates in the thumbnail labels parameter LabelContent with the value specified in the image s configuration at runtime This is any configuration value specified in default fsi image fsi or by HTTP Query can be integrated into the thumbnail label To do so you need to a Add a corresponding template to the LabelContent
116. efined in the real time template used with FSI Viewer see parameter PrintTemplate PrintEffects Description Image effects for the image to print Syntax String Default Context Pages plug in node or HTTP query prefixed with pages_ Version 3 6 0 or higher Defines image modification parameters to apply to images used for printing The value of this parameter depends on the imaging server being used With eRez server you can sharpen the image and define the JPEG compression level e g sharpen 100 amp quality 95 PrintTemplate Description Real time template for the image to print eRez only Syntax String Default fsi Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or higher Defines the eRez real time template used to load the print image By default FSI Pages uses the default real time template fsi NeptuneLabs FSI Viewer 101 FSI Pages Add on Save Description Enable disable saving of pages Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages_ Version 3 6 0 or higher Enables save functionality Using the save function you can enable the user to open or download a document related to the current page e g the source PDF document of a catalog Please refer to the chapter Printing and Saving Pages for details SaveDocumentFile Description URL to
117. eful when using a small preview of a catalog to lead the user to the full size version of FSI Pages You can use URLs starting with javascript to have a Javascript function called when the user clicks the viewer NeptuneLabs FSI Viewer 95 FSI Pages Add on DemoURLTarget Description Global link when clicking FSI Pages Syntax URL Default Context Pages plug in node or HTTP query prefixed with pages Version 3 5 5 or higher HTML frame in which to open the URL specified by DemoURL parameter in You can use default frame names like self or blank or use a custom frame of your HTML frame set Rotation Description Rotation in degrees of the thumbnail Syntax Number Default 0 Context Pages plug in node or HTTP query prefixed with pages Version 4 1 0 or higher Optional rotation of FSI Pages thumbnails Please note that using the rotation parameters with normal size FSI Pages instances is not recommended as zooming printing index view and alike do not correspond to the rotation Pagel nput Description Show or hide Page Input field Syntax Boolean Default true Context Pages plug in Version 4 0 0 or higher Defines wether the input form for page numbers is shown ButtonsFirstLastPage Description Show or hide First Last Page buttons Syntax Boolean Default true Context Pages plug in Version 4 0 0 or highe
118. elatively you have to set newImagelndex to a number prefixed by or e g 1 selects the next image SwitchThumbs Show Hide Thumb bar 162 NeptuneLabs FSI Viewer Plug ins Reference FSI Pages only Description FirstPage Go to first page LastPage Go to last page NextPage Go to next page PreviousPage Go to previous page Go to page n Important Use SetVariable newImagelndex n where n is 0 pages prior to sending this command GotoPage Alternatively you can specify a page relative to the current page To go to a page relatively you have to set newImageIndex to a number prefixed by or e g 1 is the same as NextPage Print Open or close the print dialog Save Open or close the save dialog Search Open or close the search dialog ZoomLeftPage Zoom the left page ZoomRightPage Zoom the right page NormalPageView Exit zoom view ShowHidePagel ndex Show or hide the page index thumbnail view 2 Button press release Using this command remotely presses releases a button in FSI Viewer FSI Showcase There can not be more than one button pressed at a time Pressing another button by script will automatically release the previous button Usage FSIViewer SetVariable FSICMD Button ButtonID To release the button previously pressed use FSIViewer SetVariable FSICMD Button D empty string Description Re
119. electionTol mage Description Expand image selections to fill entire thumbnail Syntax Boolean Default true Context Plug in attribute By default the notepad plug in expands bookmark selections custom and link bookmarks to fill the entire thumbnail area Setting the value to false disables expanding bookmark selections NeptuneLabs FSI Viewer 193 Plug ins Reference AddButton Description Add notepad button to menu bar Syntax Boolean Default true FSI Pages false Context Plug in attribute Add a button to the FSI Viewer menu bar to show or hide the notepad FSI Pages skins provide a button independent of this parameter MenuOffset Description Offset of the notepad button Syntax Number pixels Default 0 Context Plug in attribute Offset of the notepad button in the menu bar FSI Viewer only Plug in Parameters Loading and Posting Data The parameters below are required only if you want to send or load bookmark data to or from a web server Loading bookmarks from an XML file is as easy as specifying the URL to the XML data file using the parameter LoadXML You can use the LoadXMLPrefix parameter to prefix all LoadXML parameters e g with the server URL Sending the XML data to a web server e Make sure to enable the EnableSendBookmarks parameter to display the corresponding button below the bookmark list e If the user clicks the button the plug
120. enced to section of the about box Entering the Licence Key After receiving your licence key you need to add the key to your _default fsi configuration file located in the main index of your FSI Viewer setup directory Users of eRez imaging server can alternatively enter the FSI licence key in the eRez Administration Console using the Enter FSI Licence Key option The general way for all systems to enter the key is 1 Open the file configuration file default fsi using a text editor 2 Copy the licence key you received 3 Paste the licence key including the licence tag 4 Save the modified file Licence key added to the default fsi file fsi parameter licence Licence key goes here lt licence gt lt fsi_parameter gt Make sure to flush your browser cache as the _ default fsi file might have been cached by your browser O Please note that FSI Viewer will run in evaluation mode regardless of the licence key if you access FSI Viewer via a different domain or IP address than you have licenced FSI Viewer to The same applies to unregistered FSI Plug ins or FSI Skins In this case please check the FSI Viewer debug window which provides information on the licencing status and contact your dealer if the problem persists NeptuneLabs FSI Viewer 13 Setup NeptuneLabs FSI Viewer Integration into HTML Pages Required HTML Source Code Object Tag All recent browsers require an lt Object gt t
121. encoding foreach fpx parameter as fpx key gt fpx val query collection fpx key rawurlencode fpx val Make one large query string fsi query implode amp query collection Add Query to FSI Viewer URL fsi url fsi swf S fsi query 50 NeptuneLabs FSI Viewer Automation 3 Creating the HTML Code dynamically Create a variable that contains the lt object gt and lt embed gt tag with all variables provided as script variables Replace all variables inside the template using server side scripting You will usually need to replace the following 4 variables URL see above 2 Creating image specific URLs Width Height Background Color HTML Template lt HTML gt lt BODY gt lt php include fetch fpx image php fsi url fsi fsi swf FPXSrc image fpx amp FPXTilesx 4 amp FPXTilesY 3 Sichen 3205 Sheight 300 Sbgcolor FFFFFE Stemplate Object classid clsid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia com pub shockwave cabs flash swflash cab version 6 0 65 0 width Swidth height Sheight gt lt PARAM name movie VALUE S fsi_url gt lt PARAM name bgcolor VALUE Sbgcolor gt lt PARAM name menu VALUE false gt lt PARAM name allowscriptaccess value always gt lt PARAM name allowfullscreen value true gt lt PARAM name quality value high gt
122. end on the FSI Skin being used The figure to the right illustrates the parameters OffsetTop MarginTop and PaddingTop The values for the right left and bottom side can be set accordingly e Use Offset to offset the entire thumbnail bar e Use Margin to offset the scroll bar and thumbnails e Use Padding to offset the thumbnails Image Image image 03 jpg image 04 jpg NeptuneLabs FSI Viewer 111 FSI Showcase Add on Using Offset values you can define small thumbnail bars that do not occupy the entire width or height of the e viewer The chapter Advanced Parameters provides a description of parameters which can be used to resize and or colorize all elements of the thumbnail framework If you just want to change the general color scheme you can use the parameter BaseColor instead You can rescale the thumbnail using the parameter BaseScale Thumbnail Framework Thumbnail Labels ImageMarginX ImageWidth ImageMarginX K eme ImageMarginY ImageBorder Image UT LabelMarginTop LabelTextSize imageMargint Sr bud LabelMarginBottom EdgeRadius LabelSpaceX LabelSpaceX 112 NeptuneLabs FSI Viewer FSI Showcase Add on Using FSI Showcase and FSI plug ins You can use additional plug ins just like with FSI Viewer There are some rules you should follow when working with additional plug ins e You can not add plug ins dynamically after FSI Showcase loaded You can on the other ha
123. ends on the skin Context Options Version 3 0 0 and above Specify the opacity of the area outside the selection frame of the navigator window Possible values are integer values from 0 invisible to 100 opaque I nitialView Description Initial image segment Syntax SceneSet Scene left top right bottom rotation Default 1 1 0 0 1 1 0 Context Options Image section and rotation to display on startup The first two parameters are required as they specify the scene set and the scene For 2D images both values default to 1 The other parameters are optional and specify the image segment and the rotation around the z axis Please use the plug in Se ectFrame to easily retrieve valid values for this parameter 28 NeptuneLabs FSI Viewer Configuration InitialView Options lt ni tia lNiew value RE 0 23 904 gt lt Options gt The example displays the above left quarter of the 5th scene in the 1st scene set rotated 90 to the right I nitialViewPersistent Description Keep the InitialView as default view Syntax Boolean Default false Context Options Version 2 0 0 or higher If this parameter is activated clicking the Reset button will display the image section defined by the InitialView parameter instead of the entire image If this parameter is set to false the initial view will be displayed on startup but pressing
124. ent code examples in this section refer to PHP but can be easily adapted to any other server side scripting language Steps to be taken when using large numbers of images 1 Defining default parameters Be sure to provide as many recurring parameters as possible in the _default fsi file This way you don t have to pass these parameters via query The most important parameter is FPXBase as this parameter enables you to subsequently define FPXSrc parameters using relative addressing If there are some images that require different parameter values than defined in the default fsi file you can still overwrite the default setting by passing the value via query 2 Creating image specific URLs Be sure to have image specific data available for server scripting by using a database your content management system or any other appropriate source You will at least need to provide the FPXSrc parameter from your data source After collecting the image specific data from your data source you have to build a standard HTTP query string RFC1738 containing the data using server side scripting Using HTTP Queries Generating FSI queries fetch_fpx_image php Retrieve FPX properties for picture 1 from table FPX Images result mysql query select FPXSrc FPXHeight FPXWidth TilesX TilesY from FPX Images where PicturelD 1 ia Sue E Fetch SOL data fpx parameter mysql fetch assoc result if Sfpx_parameter RFC1738 parameter
125. ers if set to 0 Defines the color of the page numbers in the Thumbbar Plugin TextColorHighlight Description Round corner size of active thumbnail Syntax Number Context PagesThumbBar Version 5 0 4 Defines the textcolor of the active thumbnail NeptuneLabs FSI Viewer 203 Plug ins Reference Plug in PrintSave Plug in Target User interface Print Please choose the image to print from the options below and click Print button to start printing Plug in Location plugins printsave plg Show Add printing and saving capabilities to FSI Viewer e ren Current View Current View Function Syntax Plugin src printsave gt Plug in Parameters ee MenuOffset Description Offset in pixel to previous menu elements Syntax Number Pixels Default Context PrintSave Version 5 0 0 Offset in pixel to previous menu elements Print Description Enable Disable printing Syntax Boolean Default Context PrintSave Version 5 0 0 If disabled the menu button is hidden PrintEffects Description eRez image effects Syntax String urlencoded Default Context PrintSave Version 5 0 0 Defines image modification parameters to apply to images used for printing The value of this parameter depends on the imaging server being used With eRez server you can sharpen the image and define the JPEG compressi
126. es not display an image you should be able to track down the error cause by determining the step where the initialization process stops For example if the last output is Loading Skin and Module the skin file is most likely missing or corrupt If the Viewer runs in evaluation mode you will be presented the reason why evaluating the licence key failed here Please refer to the plug in section for a list of active plug ins and to the Info section for the domain evaluated by FSI Viewer 48 NeptuneLabs FSI Viewer Debug Mode Config section Displays information on the configuration parsing process the resulting configuration and possible configuration errors If the viewer loads successfully but the configuration does not look as expected you should be able to track the reason in this section This section lists all recognized parameters resulting from the 3 different configuration methods default configuration configuration file and query and displays tips regarding false parameter values as well as unknown parameters Plug ins section Provides information on loaded FSI Plug ins and configuration errors related to plug ins Additionally you can review all configuration parameters of the active plug ins Info section Displays version and licence information general information related to the viewer instance and runtime information on the image being displayed Press i to refresh the image section being displayed after zooming pann
127. es the shadow color of the drag bar DragBarRoundBevel Description Use a round or small bevel for the drag bar Syntax Boolean Default true Context Showcase plug in node or HTTP query prefixed with showcase_ Version 3 5 0 or higher Use a large round bevel or a small rectangular bevel when drawing the drag bar I mageWidth and mageHeight Description Dimension of thumbnail images Syntax Pixel Default 45 Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the maximum physical dimension of thumbnail images in pixel The actual size of thumbnail images depends on the aspect ratio of an image ThumbspacingX and ThumbspacingY Description Space between thumbnails Syntax Pixel Default 4 Context Showcase plug in node or HTTP query prefixed with showcase The spacing between the thumbnails in the thumbnail bar in horizontal and vertical direction NeptuneLabs FSI Viewer 123 FSI Showcase Add on I mageMarginX and mageMarginY Description Space around thumbnail image Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ Space between image border and thumbnail border left right of the image ImageMarginX and above below the image ImageMarginY If you choose round edges parameter EdgeRadius this value will automatically be increased if required to en
128. es used to specify external documents related to a page You can replace any part of these URLs using the FSI Pages parameters LinkTemplates and LinkTemplateData Use the FSI Pages parameter LinkTemplateData to specify a comma separated list of values you want FSI Pages to replace the keywords with Usually you will provide the LinkTemplateData value by appending the parameter to the FSI Viewer query using server side script When specifying multiple LinkTemplates the number and sequence of the corresponding LinkTemplateData values must match to achieve correct replacement For example replacing the templates SESSION and DATE at runtime in all link URLs can be done like this Replacing parts of link URLs at runtime Configuration es Plugin src pages gt lt LinkTemplates value SESSION DATE gt lt Plugin gt lt Plugins gt ESTA e fsi swf LinkTemplateData somesession 01 01 2006 This will replace all instances of SESSION by somesession and all instances of DATE by 01 01 2006 in all link URLs Please note that LinkTemplateData values have to be provided url encoded if the values contain invalid HTML query characters like amp Besides using the LinkTemplates parameter to provide custom templates you can use the following predefined LinkTemplates without providing the corresponding LinkTemplateData Template Description FSI CURRENTPAGE 1 based index of the curre
129. escription Text color of thumbnail labels Syntax HexColor Default 000000 Context Showcase plug in node or HTTP query prefixed with showcase A 6 digit hexadecimal color value defining the text color of thumbnail labels This value has no effect if the contents of a label contains lt font color colorvalue gt lt font gt tags LabelMarginTop and LabelMarginBottom Description Margin above below the thumbnail text Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ You can use this value to add additional space above LabelMarginTop or below LabelMarginBottom the thumbnail text LabelOffsetTop Description Adjust vertical position of the thumbnail text Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase You can use this value to adjust the vertical position of the text area of the thumbnail Negative values move the text area up while positive values move the text area down LabelOnRight Description Display thumbnail labels right of the image Syntax Boolean Default false Context Showcase plug in node or HTTP query prefixed with showcase Version 4 1 3 Set this parameter to true to display thumbnail labels right of the images instead of below the thumbnail images NeptuneLabs FSI Viewer 131 FSI Showcase Add on LabelOffsetLeft
130. ests so that only exact matches will be returned Setting this parameter implicitly disables the SearchAutoWildCards parameter SearchParameters Description Adds parameters modifiers to the search query Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 4 1 5 or higher This parameter provides the possibility to add parameters to the search query within FSI Pages The parameters need to be provided in the regular HTTP request format param1 valuel amp param2 value2 SearchCustomURL Description URL to request the search result from Syntax URL Default Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or higher You can assign a custom URL to direct search requests to using this parameter For example you might want to use a database and server side script to return pages related to the search request This is the default way if you are not using eRez imaging server Please refer to the chapter Searching in FSI Pages for details NeptuneLabs FSI Viewer 105 FSI Pages Add on SearchCustomValue Description A custom value to pass with the search request Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or higher A custom string to pass to the server along with the search request This option is useful when using
131. ext Pages plug in node or HTTP query prefixed with pages Enable true or disable false zooming into pages with FSI Viewer when clicking on a page Zooms into the specified link area ShowLoadProgress Description Show hide the load progress display Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages Version 4 1 5 or above Show true or hide false the load progress display FSI Pages automatically sets this parameter to true if you specify a hyperlink for the entire FSI Pages instance see DemoURL AutoCropPages Description Crop images to fill entire page Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages Version 3 5 0 or higher Enable true this option to automatically crop images to fill the entire pages You need to specify an aspect ratio manually in this case 80 NeptuneLabs FSI Viewer FSI Pages Add on ClickPageToZoom Description Enable Disable zooming by clicking a page Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages Version 4 1 5 or higher Enabling true this option enables the user to zoom a page by clicking it ZoomAreaAnimationSpeedl n Description Defines the animation speed of in place maginifications initiated by zoomarea hyperlinks Syntax Number
132. ext Pages plug in node or HTTP query prefixed with pages_ Version 5 0 0 When enabled the image will scroll when the user moves the mouse pointer DoublePageZoom Description Enable or disable interactivity in double page zoom mode Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages_ Version 5 0 0 If enabled the zoom mode will display both pages at the given zoom level When disabled interactivity like clicking hyperlinks is disabled in double page zoom mode DoublePageZoomScale Description Defines the zoom level of double page zoom Syntax Number Default 1 1 Context Pages plug in node or HTTP query prefixed with pages_ Version 5 0 0 Default 1 1 zoom to original size a relative to source image resolution 1 1 1 5 1 1 2 b relative to current page size in percent 200 300 ForceXMLDataFiles Description Force XML data useage Default false Context Pages plug in Version 4 1 5 or higher If set to true the IPTC data from the image file is ignored and the links and overlay information is retrieved from the XML files If set to false XML data is used only if no IPTC data is present in the image 82 NeptuneLabs FSI Viewer Parameters for the Front and Backcover FSI Pages Add on FrontCover Description Enable disable the front cover Syntax Boolea
133. ext ShoppingList Version 5 0 0 Decimal delimeter DefaultUnit Description Default unit string Syntax String Default pce Context ShoppingList Version 5 0 0 Defines the default unit of items added to the shoppinglist 212 NeptuneLabs FSI Viewer Plug ins Reference Email Description Enable Disable sending list by email Default true Context ShoppingList Version 5 0 0 When enabled the user can email a shoppinglist to others MaxCountPerl tem Description Maximum Count per item Syntax Number Default 99 Context ShoppingList Version 5 0 0 Defines the maximum unit per item that can be added to the shoppinglist Minl temHeight Description Minimum Height of items in the list Syntax Number Default 64 Context ShoppingList Version 5 0 0 Defines the minimum height of each item in the list PersistentSorage Description Minimum Height of items in the list Default true Context ShoppingList Version 5 0 0 Enable or disable the caching of list data If disabled the list info is lost when the user leaves the FSI pages instance PersistentStorageExpiresAfter Description Expire list data Syntax Number Context ShoppingList Version 5 0 0 Defines after which period of time the shopping list data expires NeptuneLabs FSI Viewer 213 Plug ins Reference
134. extWidth and LabelTextHeight Description Horizontal or vertical space for thumbnail labels Syntax Pixel Default Context Showcase plug in node or HTTP query prefixed with showcase You can use this value to increase the horizontal or vertical space available for thumbnail labels In case the thumbnail label text does not fit into the available space the label will be displayed cropped but the entire lable is available in the thumbnail s tool tip LabelTextAlign Description Text alignment for all thumbnail labels Syntax left center or right Default left Context Showcase plug in node or HTTP query prefixed with showcase Align the thumbnail labels left centered or right in the availabel space for label texts This value has no effect if the contents of a label contains lt p align alignment gt lt p gt tags 130 NeptuneLabs FSI Viewer FSI Showcase Add on LabelTextFont Description Font used for thumbnail label texts Syntax String Default sans Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the font used to display thumbnail labels This value has no effect if the contents of a label contains lt font face fontname gt lt font gt tags Please note that the font will only be reflected if the font is available on the user s system Otherwise a similar font will be displayed LabelTextColor D
135. faultLinkTarget DefaultTarget Target Force avascriptTarget Default avascriptTarget Default avascriptTarget Target ForceLinkTip DefaultLinkTip DefaultTip a child node ForceLinkURLPrefix DefaultLinkURLPrefix URLPrefix n a ForceLinkURLSuffix DefaultLinkURLSuffix URLSuffix n a NeptuneLabs FSI Viewer 69 FSI Pages Add on Relative and Absolute Links FSI Pages does not add prefixes or suffixes to absolute link URLs In this case any prefixes and suffixes will be ignored Absolute Link URL lt Page gt lt Links gt lt Area URL http www fsi viewer com gt lt Area gt lt Links gt lt Page gt Resulting URL http www fsi viewer com The same applies to special URLs like javascript and mailto as well as FSI Pages command URLs beginning with bud For relative links FSI Pages adds the URLPrefix and or URLSuffix values if specified Relative Link URL Page Links URLPrefix http foo com URLSuffix amp test 1 Area URL products html id 123 gt lt Area gt lt Links gt lt Page gt Resulting URL http www foo com products himi id 1238test 1 Special URL Values For some special URL values FSI Pages ignores the URLPrefixes and URLSuffixes as well The following table lists these special URLs URL Description javascript foo Call the JavaScript function foo mailto email domain tld Send an email to email domain tld dinona Do nothing Handy if you j
136. frame has been specified in the page XML data Default avascriptTarget Description Default target frame for all javascript hyperlinks on all pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 4 1 1 or above Use this HTML target frame for javascript links if no target frame has been specified in the page data DefaultLinkUrlPrefix DefaultLinkUrlSuffix Description Default prefix suffix for link URLs on pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or above Use this prefix or suffix for all links on the pages if no prefix suffix has been specified in the page data NeptuneLabs FSI Viewer 93 FSI Pages Add on DefaultLinkTip Description Default tool tip for links on pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or above Use this tool tip for all links on the pages if no tool tip has been specified in the page data LinkTemplates Description Template identifiers for link URLs Syntax String s Default Context Pages plug in node or HTTP query prefixed with pages You can provide one or more identifiers that will be replaced in Link URLs The identifiers are case sensitive and must be separated by commas The values t
137. fter the user has chosen an option and clicks the Print button in the dialog FSI Pages downloads the required image data pixel data from the imaging server and opens the print dialog on the user s system once the download has finished You can limit the resolution used for printing using the FSI Pages parameter PrintResolution Lower resolution leads to faster downloads at the cost of decreased print quality Depending on the image server accessed you can additionally pass effect parameters PrintEffects to sharpen the image or to specify the image compression With eRez server the corresponding parameter value to sharpen the image by 60 NeptuneLabs FSI Viewer FSI Pages Add on 200 and set compression to 9096 is sharpen 2008quality 90 E g with eRez imaging server you might additionally want to use a specific real time template used to retrieve the image for printing Please use the FSI Pages parameter PrintTemplate in this case Saving Pages If you want to enable users to download a file related to the displayed page the current section or the entire document you can enable the save options by setting the FSI Pages parameter save to true Enabling Save Options lt Plugins gt Plugin src pages gt Save value true SaveAllowSavinglmages value true lt Plugin gt lt Plugins gt Without any additional preparation this allows users to download an image of the left or right page
138. g eRez server you can skip this chapter and continue reading the next chapter on Licencing As the URL to fsi swf file is part of each HTML code presenting FSI Viewer it is recommended to keep the path to the file fsi swf as short as possible by either a Creating a subdirectory for FSI Viewer in the root directory of you web server HTML code addressing FSI Viewer in root directory lt PARAM name Movie VALUE fsi fsi swf cfg foo gt This way the file can easily be addressed relatively from any location of your website b Creating a subdomain to access FSI Viewer absolutely HTML code addressing FSI Viewer by subdomain lt PARAM name Movie VALUE http fsi domain com fsi swf cfg foo gt Index structure of FSI Viewer Directory Content Description core Core components debug Debugging components o l This folder can safely be deleted if debugging is not required any more languages User interface language files plugins FSI Plug ins extending FSI Viewer at runtime skins FSI Skins containing the visible parts of the user interface Please Note You need to make sure that your web server properly serves files with the following extensions swf fsi xml nlm plg NeptuneLabs FSI Viewer 11 Setup Setting up FSI Viewer Step 1 Copy all FSI Viewer files using an FTP program to the corresponding directory on your web server Please note that all files have to be transfe
139. g on the desired area of the image NeptuneLabs FSI Viewer Using FSI Viewer Keyboard Shortcuts FSI Viewer FSI Pages and FSI Showcase can additionally be controlled using the keyboard The list below shows the key function assignments Key Num 5 spacebar Function Back to original view Num 4 left arrow Move to the left Num 6 right arrow Move to the right Num 8 up arrow Move up Num 2 down arrow Move down Num 1 Turn around the z axis to the left Num 3 Turn around the z axis to the right Num 7 Rotate around the y axis to the left 3D only Num 9 Rotate around the y axis to the right 3D only Num Rotate around the x axis 3D only or previous view Num Rotate around the x axis 3D only or previous view Num 0 Hide display user interface D If you have activated the debug mode you can hide or display the debug window using this key Refresh the image information in the debug window Pos 1 FSI Pages First Page Page Up FSI Pages Previous Page Page Down FSI Pages Next Page End FSI Pages Last Page 10 NeptuneLabs FSI Viewer Setup NeptuneLabs FSI Viewer Setup Setting up FSI Viewer is as easy as copying all FSI Viewer files to your web server The only file that will directly be accessed by the web browser is fsi swf located in the main index eRez server ships with a readily installed copy of FSI Viewer If you are usin
140. ge simply add the ImageWidth and the Suffix parameter to the plug in tag If the width of the entire image is 120 5 inches the corresponding plug in tag looks as follows plugin src measure ImageWidth 120 5 Suffix inches Please note You might as well define all plug in parameters via query or inside the options group by using the prefix measure E g cfg image amp Measure ImageWidth 120 5 amp Measure Suffix 20inches NeptuneLabs FSI Viewer 175 Plug ins Reference Example 2 If you know the width of a part of the image but you do not know the width of the entire image you should follow the steps below 1 Add the measure plug in without any parameters lt Plugin src measure gt 2 Open the image inside the FSI Viewer and choose the Measure mouse mode 3 Measure the part of the image you know the real width of The Measure plug in will display a decimal number n between 0 and 1 4 The value w for the ImageWidth parameter is w RealWidth n The Measure plug in displays n 20 The real length L of the bug is 53 mm ImageWidth w L n 50 20 2 65 The corresponding plug in tag is the following lt plugin src measure ImageWidth 2 65 Suffix mm gt Please note You might as well define all plug in parameters via query or inside the lt options gt group by using the prefix measure E g cfg engine amp Measure ImageWidth 2 65 amp Measure Suff
141. ges Description Define blank images place holders Syntax String Default Context Showcase plug in node or HTTP query prefixed with showcase_ Version 3 3 0 or higher Using this parameter you can add place holders to your image collection The value of the parameter must contain one or more image indices the place holders shall occupy E g EmptyImages value 2 10 gt adds place holders at position 2 and 10 Alternatively you can add image empty true gt nodes to your image collection NeptuneLabs FSI Viewer 121 FSI Showcase Add on Advanced Parameters The following parameters can be used to customize the appearance of the thumbnails and the thumbnail bar Please note that you can easily change the color scheme by defining a BaseColor rather than defining all colors individually To change the overall scale of thumbnails you can use the basic parameter BaseScale Background Description Color of the background of the thumbnail bar Syntax HexColor Default Defined by parameter BaseColor Context Showcase plug in node or HTTP query prefixed with showcase_ Color of the background of the thumbnail bar BackgroundAlpha Description Opacity of the background of the thumbnail bar Syntax Number Default 100 Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the opacity of the thumbnail bar background from 0 invisible to 100
142. ges Syntax Number Pixels Default 80 Context PagesThumbBar Version 5 0 0 Defines the height of the thumbnails in the thumbnail bar The width is derived from the image size 200 NeptuneLabs FSI Viewer Plug ins Reference HideOnZoom Description Hide thumbnails when zooming Syntax Boolean Default false Context PagesThumbBar Version 5 0 0 When enabled the thumbs will be hidden if an image is zoomed into MagnifyCurrentPages Description Size of thumbnail images Syntax Float Default 100 Context PagesThumbBar Version 5 0 0 Defines the magnification level of the current thumbnail Values greater than 100 will increase smaller values will decrase the thumbnail size MarginBottom Description Margin of the thumb bar Syntax Number Pixels Default 0 Context PagesThumbBar Version 5 0 0 Defines the bottom margin of the thumbnail bar MarginTop Description Margin of the thumb bar Syntax Number Pixels Default 8 Context PagesThumbBar Version 5 0 0 Defines the top margin of the thumbnail bar OffsetLeft Description Offset of thumbnail bar Syntax Number Pixels Default 0 Context PagesThumbBar Version 5 0 0 Defines the offset of the thumbnail bar NeptuneLabs FSI Viewer Plug ins Reference OffsetRight Description Offset of thumbnail
143. get Description HTML Target Frame to open the PageLogURL in Syntax String Default internal Context Pages plug in node or HTTP query prefixed with pages Version 4 1 3 or higher By default FSI Pages uses the special target internal which loads the URL from within the Flash plug in You can use this parameter to specify a different HTML target frame like self or top PageLogDelay Description Page View logging delay Syntax Number milliseconds Default 2000 Context Pages plug in node or HTTP query prefixed with pages Version 4 1 3 or higher Specifies a minimum period of time a page must be visible before loading the PageLogURL Use 0 to log each page access immediately The default value of 2000 ms ensures that a page has been viewed for at least 2 seconds NeptuneLabs FSI Viewer 97 FSI Pages Add on Advanced Parameters RememberLastViewedPage Description Store the most recently viewed page locally Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages_ Version 4 0 5 or above If you enable this parameter FSI Pages stores the page number of the most recently viewed page on the user s computer and displays this page on start up the next time the user views the same catalogue image collection again Note The parameter nitialPage has no effect if there is a valid value for the last viewed page You can use
144. ha sece 153 155 DefaultFillColor ssseseeee 154 Default avascriptTarget e 93 DefaultLinkTarget s e 93 DefaulELinkT Ip cotas tedden es 94 DefaultLinKURL cee eee eee eee ee eae ae nae 93 DefaultLinkUrlPrefix 00 0 93 DefaultLinkUrlSuffix 00 93 DetauhMove eenen 154 DefaultSkewW coi 154 DefaultTarget rererere 153 Bu 169 Demo UE 95 DemollHUTorget aieiai a aisea 96 DetailBuffer sse 27 DE Ha 75 120 DoublePageAllowl nteractivity 82 Doublebage Zoom n se 82 Doublebage Zoomtcale ER AA ATT 117 DragBarHighlight eee 123 DragobarboundBevel 123 DragBarShadow sssseseee 123 DragBarWidth eenen 117 DragMenu rente 118 DragMenuWidth neee 118 DropShadOW tot eet 86 200 DropShadowDistanCe oooococncciccccccccocinininnnnnns 86 EdgeRadius erreen 125 192 A ep PE ERE RES 34 134 Emptvlmades araia 78 121 EnableAddCustomBookmark 193 EnableAddFullBookmark 193 EnableAddLinkBookmark 193 Enablezend ookmarkz eee 193 EnableZooml nbanode 31 EnlargeBy AAA 207 EVENS vincia rra 107 153 180 210 ExpandSelectionTol mage sss 193 EXDlOE6 ciet t Ps 168 ExtendedViewport ereere 31 dl 157 Firstbagehumber eee cece eee 79 FlipCorrnierSize cenen ttes 107 Flptdoepize AA 107 Follow E Ip eege a 90 Forcelnittalbage ce a 78 Force avascriptTarget eee 92 Force m
145. he object tag lt PARAM name movie VALUE fsi swf cfg relative path to FSI file gt The following table lists FSI parameter value types referred to in this documentation Type Example Number 90 String Zooml n URL http www fsi viewer com Boolean 0 1 or true false HexColor FF0000 Using XML Configuration Files fsi FSI Viewer uses XML configuration files which can easily be edited with any text editor The default configuration file default fsi which is located in the same folder as the main viewer file fsi swf is the most important XML configuration file and will always be evaluated first To use FSI Viewer with additional configuration files you have to provide the name of the configuration file using the cfg parameter attached to the URL of the fsi swf file Specifying an XML configuration file for FSI Viewer PARAM name movie VALUE fsi fsi swf cfg foo Configuration files are structured into configuration groups XML nodes containing parameter names and values Only parameters in these groups will be recognized by FSI Viewer Configuration files do not need to contain all groups though Each parameter has to be provided as an individual XML child node of a group where the node name is the parameter name and the parameter value needs to be provided as value attribute of the node NeptuneLabs FSI Viewer 15 Configuration Structure of XM
146. her This parameter overrides the download URL specified in the file attribute of the page s XML data Specifying this parameter forces FSI Pages to use the same download URL for all pages Please refer to the chapter Printing and Saving Pages for details SaveAllowSavingl mages Description Add image download options to the Save dialog Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or higher Set this parameter to false if you want to prevent the user from downloading images of pages In this case the PDF download options will be displayed only Please refer to the chapter Printing and Saving Pages for details SaveResolution Description Max resolution for downloading images Syntax Number pixel Default 2000 Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or higher The maximum resolution for images the user can choose to download in the Save dialog Please note that the actual size of the image might be limited by the resolution of the source image or by an imaging server restriction Please refer to the chapter Printing and Saving Pages for details SaveEffects Description Image effects for the image to download Syntax String Default Context Pages plug in node or HTTP query prefixed with pages_ Version 4 0 0 or higher Define
147. ht or width of the viewer instance shrinking the viewer size by the initial size of the thumbnail bar The thumbnail bar will be placed above all viewer elements when enlarging the thumb bar by default Inside The showcase reduces the view port of the viewer by the initial size of the thumbnail bar leaving the menu elements unchanged The thumbnail bar will be placed below all viewer elements when enlarging the thumb bar by default Floating The showcase floats above the view port without modifying the viewer or the view port size The thumbnail bar will be placed below all viewer elements when enlarging the thumb bar by default Align Description Position of the thumbnail bar Syntax left top right bottom Default right Context Showcase plug in node or HTTP query prefixed with showcase Defines the position of the thumbnail bar Please note that the orientation of a possible scrollbar can be defined by the parameter HScroll 116 NeptuneLabs FSI Viewer FSI Showcase Add on I nitialSize Description Initial size of the thumbnail bar Syntax Size in pixel or percent or in number of items Default item Context Showcase plug in node or HTTP query prefixed with showcase Defines the initial size of the thumbnail bar You can define the size in absolute pixel values e g 120 in percent of the viewer size 50 or by the number of thumbnails being displayed h
148. humbnail No user interface zoom is disabled Pages flip automatically when idle You can specify a link for the entire viewer area so that you can use this template to publish a thumbnail of a catalog linking to the full size catalog See Parameters for FSI Pages Thumbnails for configuration details e Photo Album A simple photo album with photo corners and an emboss effect for each image e Photo Album with text A simple photo album with photo corners and an emboss effect for each image Additionally an optional text in IPTC CAPTION of the image will be displayed below the image Of course you can modify the FSI Pages configuration presets located in si config pages presets to your needs or add your own configuration files there Advanced users might as well want to modify the templates for image collections and configuration files These templates are located in the WEB INF templates fsi directory of your eRez server setup NeptuneLabs FSI Viewer 73 FSI Pages Add on Event Notifications and Actions When using JS Bridge plug in or FSI Viewer component you can use the following event notifications and actions to interact with FSI Pages Add on Please refer to JS Bridge plug in for details on how to setup communication between JavaScript and FSI Viewer Event Notifications Event ID Parameter Description A Called after the FSI Pages Add on is ready for use The parameter onPagesinitcompieke Integer p
149. ibute Defines the opacity of the mask of the select box 0 invisible NeptuneLabs FSI Viewer 209 Plug ins Reference AspectRatio Description Aspect ratio of the selection Syntax String Default Context Plug in attribute Defines an aspect ratio for the selection e g 320 200 Use SHIFT to lock or unlock the aspect ratio when resizing the selection InvertShift Description Inverts the function of the SHIFT key Syntax Boolean Default false Context Plug in attribute You can use this parameter to invert the function of the SHIFT key while dragging Callback Description JavaScript callback function Syntax String Default Context Plug in attribute Specify the name of a custom J avaScript function to call each time the selection changes The arguments passed to this function are SceneSet Scene Left Top Right Bottom Rotation Current View Example J avaScript callback function Funcion onselece ser seeme dy S lo HOE SEVEN Y doSomething Additionally you can as use the template selection s for the CustomButton plug in Events Description Send plug in event notifications Syntax Boolean Default false Context Plug in attribute Version 3 2 5 and above Specifies whether the plug in send plug in event notifications Plug in events can be handled when using J
150. ides the number of pages remaining in the load queue Called each time the user shows true or hides onPagesShowl ndex Boolean false the page index Called each time the user starts true or ends false onPagesShowZoom Boolean page zoom onPagesLinkClick URL Called each time the user clicks a link The parameter contains the URL Please note that some plug ins provide additional events Please refer to the events parameter of the corresponding plug in for details 166 NeptuneLabs FSI Viewer Plug ins Reference The recommended way to react to an event is to extend the switch case block of the fsiviewer_ DoFSCommand fsi event params callback function introduced in Step 3 Detailed Event Parameter Description INFO The Info event parameter provides attributes of the source image currently being displayed Example width 8000 height 6000 Tilesx 4 TilesY 3 SceneSets ImageIndex 4 The attribute Imagelndex applies to FSI Showcase or FSI Pages only and provides the 0 based index of the image currently selected I mageURL To receive this notification you have to set the ImageURLs parameter of the plug in to true Please refer to Plug in Parameters below for details The ImageURL event parameter provides an URL template that can be used to retrieve the image currently displayed in FSI Viewer Example http imageserver domain erez erez src images zoomimage fpx amp width width
151. ified in step 2 If you do not use the ID NAME fsiviewer you have to replace the corresponding script sections in the example below printed bold by your ID NAME parameter Example J avaScript Callback Function lt script language javascript type text javascript function fsiviewer DoFSCommand fsi event params switch fsi_event case LoadProgress break Hook for Internet Explorer if navigator appName amp amp navigator appName indexOf Microsoft 1 amp amp navigator userAgent indexOf Windows 1 amp amp navigator userAgent indexOf Windows Sel d 4 document write lt SCRIPT LANGUAGE VBScript gt n document write on error resume next n document write Sub fsiviewer FSCommand ByVal f l event ByVal params n document write call fsiviewer DoFSCommand fsi event params n document write end subin document write lt SCRIPT1 gt n Sese NeptuneLabs FSI Viewer 165 Plug ins Reference After following the 3 steps described before you will receive the following event notifications Event fsi_ event Parameter params Description u The viewer has finished parsing the configuration and income is about to start loading image data Imacelnfo Strin Provides concatenated image information e 9 See details below this table LoadingComplete The initial load progress of an image complet
152. ighlight 125 ThumbBorderActiveShadow 125 ThumbBorderActiveWidth 125 ThumbBorderHighlight s 125 ThumbBorderSelectedHighlight 125 ThumbBorderSelectedShadow 125 ThumbBorderSelectedWidth 125 ThumbBorderShadow c ccccceceeeeeeaaeees 125 ThumbBorderWidth eeeees 125 mh mbEffects cdta 119 ThiumbEa e EE 124 ThumbPadding seen 88 ThumbGelectedkace eee 124 d Bulle 88 NN eee te te teeeeeeeeeeeeeeeees 123 ThumbspacingY eee 123 TIleETfeCks iir tb ee eh edel 37 MA tee etat eet 39 A te ED NT 39 RI ERES 45 227 Tiles xit Ed eo RS 45 227 TiltModeRelative oooccccocccnncnccnnnncicnnoninnnns 38 MP IA HN CREE EH ERE RE 156 TOM TIPS 118 Hl wibchable cinta is 33 Unique Diada recien 40 190 Update aeaa o e atas 137 UR cd teca adi edo 157 UselnitialView oooocccnncccnnnncccnnocicnnnnccnnns 118 Usel ntermediateZoomL evels 40 UseRomanPageNumbersToPage 90 Valdatetiata eee 137 MI DIE 156 235 ViewerMarginBottom sse 88 SelectFrame sirenerne 208 ViewerMarginLeft cce 88 Software urept eeren 216 ViewerMarginRight ecr 88 StickyNotesS ooooococccocococononcnnononononnnnononnnnnnns 217 ViewerMarginTop eere 88 ek elt 220 Visible re 152 172 187 191 208 TextBOXx sic d esee dicta 222 Volume iie eps hans 186 198
153. igits preceded by a percent sign 96 are then used in place of the reserved character FSI Viewer transforms URL encoded values back to the original value How can URL encode a value Most scripting languages JavaScript ActionScript PHP and alike provide methods for this purpose Please note that FSI Viewer from version 4 requires Unicode safe encoding rather than non unicode safe encoding this is an escaped character meight be represented by one or more 2 digit numbers preceded by 96 Using JavaScript you therefore need to use the method encodeURIComponent instead of escape If you don t have a tool handy to URL encode a value you might want to use the tiny JavaScript based tool encoding urlencode html contained in the FSI Contrib package HTML Tags available in FSI Viewer FSI Viewer from version 4 supports basic HTML tags in various contexts like when entering custom tool tips texts for the LargeToolTips plug in search results and alike Whenever this documentation refers to Basic HTML formatting tags the following HTML tags can be used variable values printed bold italic lt b gt lt b gt lt i gt lt i gt lt u gt lt u gt lt br gt lt font color FF0000 size 12 face Arial gt lt font gt lt p align left center right gt lt p gt Please note that you need to use XML syntax in order to avoid XML syntax errors in configuration files this is e g using br instead of br
154. ill be extended by the path defined by FPXBase NeptuneLabs FSI Viewer Configuration FPXBase Parameter Definition of FPXBase within the _default fsi file lt FPX gt Base value http domain com erez src gt lt FPX gt Specification of the FPXSrc within configuration files 1 FPXBase parameter is used for relative addressing lt FPX gt lt SRC value folder image tif gt lt FPX gt The resulting address is http domain com erez src folder image tif 2 FPXBase is not used for absolute addressing lt FPX gt XSRC value http domain com erez src project image tif gt FPX Display a thin border around FSI Viewer The default value is false displaying no border Enter one 6 digit hexadecimal color e g FF0000 for a solid border If you specify two hexadecimal colors e g FF0000 OOFFOO the top left border will use the first color while the bottom left border uses the second color CropRect Description Defines a crop rectangle Default 0 0 1 1 Context Options Version 5 0 0 Crop rectangle left top right bottom as 0 1 floating point values Default 0 0 1 1 MenuAlign Description Alignment of the menu bar Syntax String Default version 1 4 TL from version 5 BC Context Options Version The center option C is available from version 5 0 0 Possible values TL top left TC top center
155. image specific parameter values automatically CFG Description Relative path to a configuration file Syntax fsi swf cfg FSI Name Default Context HTTP query A relative path to an XML based configuration file fsi The file extension fsi has to be omitted You can specify a default base path to all configuration files using the FS Base parameter Defining a configuration file In this case the FSI Viewer first searches for the default fsi file in the installation folder where the file fsi swf is located and evaluates the configuration parameters The optional parameter FSIBase from the default fsi file is then used as the path specification in order to search in the correct index for a FSI configuration file with the name foobar fsi DefaultCFG Description Relative path to an alternate default configuration file Syntax fsi swf defaultcfg filename Default default Context HTTP query only Relative path to an alternative default configuration file other than default fsi Only useful as part of an HTTP query The file extension fsi has to be omitted ServerType Description Image Server type Syntax String eRez ZIS TrueSpectra TrueSpectra Bridge Default Context FPX Query FPXServerType Please enter the value erez for YaWah eRez Imaging Server For the Zoom Image Server from iSeeMedia please enter the value
156. image without FPX data compression Please try converting your image to RGB color mode and remove all alpha channels prior to FPX conversion Error The Viewer displays multiple images at a time You might be using an FPX containing multiple images without defining the parameters TilesX and TilesY or these parameters have been defined incorrectly Please check the output of the Debug Window for the SceneSets setting Error Keyboard commands not working Using the keyboard commands require the FSI Viewer to have the input focus Click anywhere inside the Viewer to pass the focus to the FSI Viewer NeptuneLabs FSI Viewer 227 Appendix FSI Contrib Package The FSI Contrib package contains sample configuration files and Adobe Flash files you can use to customize FSI Viewer Please contact your FSI Viewer dealer if you did not receive the FSI Viewer Contrib package along with your copy of FSI Viewer Escaping or URL encoding parameter values In some situations you need to pass escaped URL encoded parameters values to FSI Viewer because using unescaped values would break the XML syntax or because you need to use characters prohibited in URLs In cases like this you can pass escaped values rather than passing the actual value What does escaping URL encoding mean URL encoding or percent encoding means converting the character to its corresponding value in ASCII and then representing that value as a pair of hexadecimal digits The d
157. imagel fsi gt Image label My Second Image file image2 fsi lt Images gt 108 NeptuneLabs FSI Viewer There are three different ways of defining image lists 1 Creating image nodes referencing external XML configuration files External XML configuration files lt Images gt Image label My First Image file imagel fsi lt Image label My Second Image file image2 fsi gt lt Images gt 2 Creating image nodes containing complete image configurations Complete XML configurations Images Image label My First Image gt lt FPX gt lt SRC value imagel fpx gt lt FPX gt lt Image gt label My Second Image gt lt FPX gt lt SRC value image2 fpx gt lt Width value 8096 gt lt Height value 12300 gt lt FPX gt Options lt NoNav value true lt Options gt lt Image gt lt Images gt 3 Retrieving automatically generated image lists from a server Complete XML configurations lt Plugins gt Plugin src showcase server dir lt Plugins gt FSI Showcase Add on Method 1 and Method 2 can be freely combined while Method 3 retrieves a complete image list ignoring previously defined lt images gt nodes Please note that the format of image lists is the same as for FSI Pages The chapter on FSI Pages contains more detailed information on creating and retrieving image lists NeptuneLabs FSI Viewer
158. include rect Square Rectangle circle Circle Ellipse star Star polygon Polygon of n straight lines HotSpot definition HotSpots seirele spor 1 0 95942 0 155653 0361261 0 420902 OY tip errcla gt rect spot 1 10 0 54314 0 68446 0 74036 0 88168 56 tip rectangle url rect zu gt polygon coords 0 5 0 1 0 1 0 5 0 5 0 5 gt lt text gt some lt b gt formatted lt b gt text lt text gt polygon lt HotSpots gt Please refer to the chapter HotSpot Authoring for useful tips on how to create HotSpots Please refer to the FS Contrib package for a sample and instructions how to add custom link shapes The contrib package contains sample HotSpot XML definitions as well HotSpot Parameters The following attributes can be assigned to each HotSpot Spot Description Position of the HotSpot Syntax String Default Context HotSpot tag Defines the position of the HotSpot It is recommended to use the plug in SelectFrame to obtain this value Please refer to the chapter HotSpot Authoring tips for more information on this parameter NeptuneLabs FSI Viewer 155 Plug ins Reference Coords Description Coordinates for polygon shapes Syntax String Default Context HotSpot tag Defines the coordinates of a polygon shape In contrast to predefined shapes polygons do not require the spot parameter Instead y
159. ing or rotating the image Debugging mage Access Problems You can configure the debug window to debug image access as well To do so you need to set the global parameter Debugl mageAccess to true When enabling the debug mode FSI Viewer outputs error information if problems retrieving images from the imaging server occur Please note that this feature requires the imaging server to reside in the same domain as FSI Viewer or using Flash plug in version 7 together with a valid crossdomain xml file copied to the imaging servers root directory NeptuneLabs FSI Viewer 49 Automation NeptuneLabs FSI Viewer Automated I mplementation of I mages Rather than creating individual configuration files for each image it is recommended to provide FSI parameters via HTTP queries appended to the FSI Viewer URL when implementing large numbers of images As some browsers require the obsolete lt embed gt tag queries have to be added to both the lt object gt and the lt embed gt tag HTML Source Code FSI Viewer is able to request image specific parameters like the source image dimension parameters FPXWidth and FPXHeight from your imaging server Retrieving Parameters Automatically Using this feature reduces the required work to dynamically providing the path to the source image parameter FPXSrc It is recommended to use server side script like ASP PHP SP Perl etc when implementing large numbers of images All subsequ
160. inimum required to view the entire image This option can be useful if you want the user to pan in one direction only because the image width matches the view port width or height e g when using FSI Pages with autozoom fitWidth option MagnifySmalll mages Description Magnify images smaller than the viewport Syntax boolean Default false Context Options Version 4 1 0 or above Usually FSI Pages 4 1 0 or above does not magnify small images to fit the view port You can enable this option in case you want small images to fit the view port even if the source image is smaller than the view port Animation Description Animation quality Syntax Boolean Default true Context Options Animate zoom and rotate actions true or zoom and rotate in a single step false AnimationType Description Defines type of zoom animation Syntax Number Default 3 Context Options Version 5 0 0 Defines the type of the zoom animation acceleration on start or end bounce etc Possible values are 0 to 6 AnimationSpeed Description Animation speed Syntax Number Default 50 Context Options Specifies the speed of the zoom and scene animations Possible values range from 1 very slow to 100 very fast See parameter Animation to disable animated motion 32 NeptuneLabs FSI Viewer Configuration HideUl Descr
161. ins Reference Plug in Parameters Layout and Appearance Visible Description Show or hide the notepad on startup Syntax Boolean Default false Context Plug in attribute Show true or hide false the notepad on startup Width Height Description Width and height of the notepad window Syntax Number pixels Default 320 width and 272 height Context Plug in attribute Width and height in pixels of the notepad window I mageWidth I mageHeight Description Max width and height of thumbnail images Syntax Number pixels Default 80 width and 66 height Context Plug in attribute The maximum width and height of thumbnail images in pixels BackgroundColor Description Max width and height of thumbnail images Syntax HexColor s Default FFFFFFDDDDDD Context Plug in attribute Version Obsolete from version 5 0 0 defined by FSI Viewer Skin Background color of the notepad window You can specify a solid color or use multiple hexadecimal color values concatenated by to specify a color gradient e g FF0000 00FF00 FF0000 BackgroundGradientAngle Description Angle of the background color gradient Syntax Number degrees Default 45 Context Plug in attribute Version Obsolete from version 5 0 0 defined by FSI Viewer Skin Angle of the background color gradient in degree The default value 45
162. intTemplate e 101 205 er 75 120 ebe A od tee ede ER 85 ROG occa socie rei ete uos Po e eod det veis 142 Reflections eee Pe ec eer enean 173 Rememberl astViewedbage 98 RememberLastViewedPageExpireAfter 98 Remove AGES isis ebat uet dents 78 ReversePageOrder cc nea 78 REVISION oe EAS o a pne d Pe YR 190 RomanbagehumbersCffset 90 A O 209 ROEaEIOTI aaa es 96 RoundedSkinCorners eese 33 SAVE native derer Dame dada 102 205 SaveAllowSavingl mages sssse 103 SaveDocumentfFile oooocccccccococccccononnnonnnnnns 102 SaveE eii 103 205 SaveOptiONS oocccccccccncnnoccnnnconononinonnnannnnnnss 104 SAVERESOIULION ceee 103 206 SaveTemplate cece 104 206 SaveURLPrefix AAA 102 SaveUrlSuffix sss 102 SaveURLTarDeE coso rennen 102 Sl i Nr eee 219 SceneEffects coccccccccnococccnnnononocncnnnonnanononononono 36 SCENEPrelOAd nnie 47 Sc neSets iee 46 47 227 NeptuneLabs FSI Viewer ScrollArrow eee 87 122 193 ScrollArrowColor ccccsececceesecsseeeeeeeeeeeaees 224 ScrollBaseColor 87 122 193 Scroll Tracks i eese 87 122 193 Sita did 104 GearchhutotxvactMatch 105 SGearch AutoW id arde 105 SearchCustOMURL seere 105 SearchCustomValue ee e 106 SearchDialogHeight sanee 104 SearchfDialoow dt 104 Gearchbarametere 105 GearchGortbesults 106 GearchllseetbhodtGet eere 106 Selectlmage e teen 158 SelectionBorde
163. ion Initial state of visibility Syntax Boolean Default false Context Plug in attribute Defines the initial visibility of the magnifier Size Description Size of magnifier Syntax Number Default 10 Context Plug in attribute Defines the overall size of the magnifier Possible values are between 4 and 16 Please note that greater values require more CPU power 172 NeptuneLabs FSI Viewer Plug ins Reference Magnification Description Level of magnification Syntax Number Default 2 Context Plug in attribute Defines the level of magnification where 1 means no magnification 2 means a magnification of 20096 and so on The maximum level of magnification is 8 Reflections Description Show or hide glass reflections Syntax Bool Default true Context Plug in attribute Show true or hide false glass reflections of the magnifier Handle Description Show or hide magnifier handle Syntax Bool Default true Context Plug in attribute Show true or hide the handle of the magnifier glass HandleSize Description Size of the handle in percent Syntax Number Default 100 Context Plug in attribute Size of the magnifier handle NeptuneLabs FSI Viewer 173 Plug ins Reference Plug in MaxZoom Plug in Target User interface Plug in Location plugins maxzoom plg Function Zoom to phy
164. iption Hide user interface Syntax Boolean Default false Context Options Hide the menu bar on startup The user has to click the Show Menu button to show the user interface This option is especially useful when an image is meant to look like an ordinary image or if there are many FSI Viewers on a single web page RoundedSkinCorners Description Defines round skin corners Default Context Options Version 5 0 0 Defines the radius of the rounded viewer corners Possible values range from 0 no rounded corners to 99 Ul Switchable Description Enable hiding showing the user interface Syntax Boolean Default true Context Options Version 3 2 2 and above Specifies whether the user is able to show or hide the user interface by clicking the corresponding button or pressing 0 on the num pad The Show Menu button is hidden if this option is set to false ViewerBorder Description Defines the color of the viewer borders Default Context lt Options gt Version 5 0 0 Color of the border as a hexadecimal color value e g FF0000 for red Use false for no border Nol mageBlend Description Subsequently loaded image details display without transition Syntax Boolean Default false Context Options Version 1 2 0 or higher If this parameter is activated subsequently loaded image details are displaye
165. isplay a border separating the text from the viewer s view port BorderColor Description Color of the border Syntax HexColor Default Context Plug in attribute Color of the border separating the text from the viewer s view port BorderWidth Description Width of the border Syntax Number Default 2 Context Plug in attribute Width of the border separating the text from the view port ScrollArrowColor Description Color of the arrows of the scroll bar Syntax HexColor Default Derived from BaseColor parameter Context Plug in attribute 6 digit hexadecimal color value for the arrows in the scroll bar 224 NeptuneLabs FSI Viewer Plug ins Reference Plug in ZoomMeter Plug in Target User interface Plug in Location plugins zoommeter plg Function Displays the current level of magnification Syntax Plugin src zoommeter color 000000 The ZoomMeter plug in extends the navigator window with a display of the current magnification Plug in Parameters Color Description Text color Syntax HexColor Default 000000 black Context Plug in attribute Text color of the zoom display The color has to be defined as a 6 digit hexadecimal number E g FFFFOO for yellow SrcRelative Description Display magnification relative to source image or viewer size Syntax Boolean Default false Co
166. isplayed The default is a single scene set containing all scenes image tiles from scene 1 to the last scene image The default sequence is left to right top to bottom in a tile image and the sequence of the lt image gt nodes for 3D views based on individual source images In the viewer scenes can be selected by moving the mouse horizontally and scene sets can be selected by moving the mouse vertically Syntax Individual sets have to be separated with semicolon Scenes within the sets are separated with comma and specify the 1 based index of the image from left to right top to bottom up to the total number of scenes TilesX x TilesY or individual source images Instead of individual scenes you can also specify scene ranges e g 5 10 If you leave out the start or the end of a scene range 1 or respectively the last scene will be assumed in this case If you specify a range using gt the scenes from the first number to the last scene image plus the first scene image up to the second number will be assumed The example below illustrates the syntax Definition of multiple scenes and scenesets Options lt SceneSets value 2 3 5 10 10 1 5 8 gt 3 gt lt Options gt The example defines 4 scene sets in total Assumption The source image is created from 10 individual images scenes 5 in a row two rows This leads to the following image order for the individual scenes Set 1 Scenes 2 3 5 6 7 8 9 1
167. ix e nnnnnnnraninnns 91 ForceLinkU rlSUffix ce eiat 91 ForceSaveURL 4 enitn ndr n nen anna i i nns 102 ForceXMLDataFiles mm 81 FrOMtCOVED occccccccccccnoninnnnnananaranr ran raro nan cnnnnnn ENNEN 82 FrontCoverConfig esee 83 FrontCoverl Mage me 82 FUIIBACKCOVER cocida ai 82 FullFrontCover ee enn 82 HaraPages ciao a 83 Helolmagellpl n 86 Ido Uat or eerta 94 IdleAutoTurnDelay e mm 94 IdleAutoTurnMaxPage RH 94 IdleAutoTurnMinPage ee HH 94 ImageAligri x 3 eot core bates 85 IND OX SE 78 InitialPage iu ree teg tet s 17 KeepIndex ec en eere 79 EinkFillAlpha uote ers 90 LUnkbGBAActhve enn 90 76 Lin kRGBALEOVer oe ter m rented qd 90 LINKRGBANOrMal nono nnnnnnnraranins 90 LinkTemplateData seen 93 LinkTemplateS AAA 93 Listlem OI 74 MarginBottom eseeem emn 87 Matgih Left bibe er cde 87 MarginRight 2er rente tei ite deere ds 87 Mardi 87 MOUs ck ON 93 MovePaggs irce enn ein edt eei reden 99 PageBackgroundIMage seerne 83 PageBackgroundlmageEffects AAA 83 PageBorderColor ssssss 86 PageCacheLitrit uiiieiuce im erre RE 98 PageCacheRemoveTiMe cenen 98 Page Color isi cates e ira 85 Neue EE 95 PagelogDelay 1 5 dep i eR aec 96 PageLogTarget mimica ie 96 Ne ele DEE 96 PageMarginOuter PageMarginTop PageMarginInner PageMarginBottom
168. ix 20mm Accuracy The plug in does not support any perspective correction This means that measuring scanned maps diagrams will be accurate measuring 3 dimensional objects is less accurate Plug in Parameters The following attributes can be assigned to the plugin tag You might as well define all plug in parameters via query or inside the options group by using the prefix measure with the parameter name e g measure ImageWidth MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attribute Specifies the space in pixels left of the menu button of the plug in 176 NeptuneLabs FSI Viewer Plug ins Reference I mageWidth Description Real width of the entire image Synta Floating Point Value Default 100 0 Context Plug in attribute Defines the real width of the entire image e g 120 inches Please see the explanation in the previous section Prefix Description Defines a prefix for the length value Syntax String Default Context Plug in attribute Defines the prefix for the length value e g length Suffix Description Defines a suffix for the length value Syntax String Default mm Context Plug in attribute Defines the suffix for the length value e g inches Usually this is a length unit Decimals Description Number of decimals of the leng
169. k identifier for details 168 NeptuneLabs FSI Viewer Plug ins Reference Plug in LargeToolTips Plug in Target User interface of FSI Pages Plug in Location Restaurant plugins largetooltips plg AB Outdoor or Celsius by candlelight Function NE Display multi line tool tips with HTML formatted text BEL iis Foods vegetables meat amp fish Syntax Plugin src largetooltips gt This plug in adds multi line tool tips displaying HTML formatted text to links in FSI Pages add on The following HTML tags can be used in the tool tip text data lt b gt lt b gt i i lt u gt lt u gt lt br gt lt font size n color RRGGBB gt lt font gt lt p align gt lt p gt lt img src width height gt Note Certain limitations apply when using the img tag The width and height attributes are mandatory and the URL in the src attribute must end width jpg or png If you are using a single source imaging server to provide these images then consider appending something like amp ext jpg to the src URL Furthermore images will always be inserted into the textflow if it is desired to continue the text below the inserted image extra O line breaks will be needed Plug in Parameters Width Description Width of the tool tip box Syntax Pixels Default 200 Context Plug in node or HTTP query prefixed with largetooltips
170. klarget 92 ForceLink Tico eet 93 ForceLinkURL ssee 92 Force Inkllrlbrett eee 92 ForceLinkUrlSuffix eee 92 ForceSaveURL ceceesecsseseeeeeeeeaeeeeeseeaes 103 ForcexzMl Datatiles ER A ER ERES See 25 FbyGerverfemplate n ER FPXServerType eseeen nn narnrnnnnns 22 EPXSIG iir ada 23 134 226 FbxTlebaddimg eee ceeeeeee cece eeeeee eee ae ae eaae ee 47 FPXTilePaddingY s a 47 FrameColor e 192 FrameWidt REP 192 NA eer ere tcn Waco 83 Front over ofge 84 Front overlmage AAA 83 ESB ata 25 FullBackCoOver n e teen 83 FullFrontCover seeeen 83 GIOWAIDN dicas 179 Le Yero oT iii di 179 Glowhange e 179 ea LEES 142 Hand ursor aa ia ai 31 dani 173 HandleSiZe narrioa aaan 173 HardPages aana aiaa 84 Height fui cn erre 23 191 200 223 HelplmageURL sssssssssisisrsrsrerereressrsrrrrrrerrna 87 NEIE 30 HelpUriTarget ccccceeeseseeeeeeeeeeneaeaaaaes 30 HideOnZoom occccccnnonocccnnnnnonococnnonononcnnnnnns 201 Hide Ult sn 33 HighlightColor eeren 170 HOVErROtAtION ne 128 HoverZoOom oir rd 128 HS croacia aii 117 Dial 220 LD Frame o orte eh orn rens 145 NeptuneLabs FSI Viewer ID LabelFrame eR 145 I dleAuto Turm iced tee dedi dens 95 IdleAutoTurnDelay eseen 95 IdleAutoTurnMaxPage s 95 IdleAUtOTUPNMINPAGe 0 eee cece ee ee eee eee 95 HDT Offset iat oa ati 144 D1 TOP aii 145 UDI URL oon rtr o tms 145 E A menn 37 IgnoreQueryParameter
171. le XML data for the Chapters plug in lt Indexdata gt lt Index label Firs lt Index label Chap t Page page 1 color FFFF00 gt Index lab ter 1 page 10 color 00FF00 1 Chapter 1 1 page 20 color 00FF00 Index lab Index lab 1 Chapter 1 2 page 30 color 00FF00 l 2 Chapter 1 3 page 40 color 00FF00 lt Index gt lt Index label Chap lt Index label Chap r 2 page 50 color 0000FF 2 3 arce 60 Color Mee ox lt Index label Chap lt Indexdata gt Plug in Parameters r 4 page 70 color FF0000 I ndexData Description XML document structure data Syntax XML Data Default Context Plug in attribute XML Data describing the document structure Add the XML data as a child node of the Chapters plug in node Alternatively you can specify the XML data using an external XML file IndexDataFile Description URL to an external XML file describing the document structure Syntax String Default Context Plug in attribute Alternatively to the IndexData parameter you can use an external XML file to provide the XML document structure data required for this plug in The XML file must be located in the same domain as FSI Viewer to avoid cross domain security restrictions If you enter a relative path FSI Viewer loads the file from the subdirectoy pages_url of your FSI Viewer configuration dir
172. lease previously pressed button Mouse_Mode_n Activate mouse mode n 0 Zoom 1 Pan 2 Rotate 3D 3 Rotate Z axis There might be more mouse modes available depending on loaded plug ins Tool_ Reset Reset button see command Reset Tool Zoomin Zoom In button see command Zoomin Tool ZoomOut Zoom Out button see command ZoomOut Tool SwitchUl Show Hide FSI Viewer user interface Plugin SwitchMusic Plugin ExtendedNavigation Plugin HistoryBack Toggle music on or off Toggle display of ExtendedNavigation plug in Click History Back button of the history plug in Plugin HistoryForward Click History Forward button of the history plug in NeptuneLabs FSI Viewer 163 Plug ins Reference Identifying commands of buttons not listed in the table There might be some button identifiers that are not listed below especially buttons integrated by other plug ins To obtain command identifiers of these buttons follow the steps below 1 Activate the debug window of the FSI viewer set parameter debug to true 2 Set the explore parameter of the jsbridge plug in to true 3 Click the desired button inside FSI Viewer and copy the identifier from the debug window 3 Navigating to image sections To navigate to a specific image section you simply use the Goto command followed by a valid image section parameter Please refer to the chapter Debug Mode fo
173. ly Alternatively you can add lt image empty t ru nodes to your image collection RemovePages Description Remove individual pages from the collection Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 5 5 or higher Using this parameter you can remove images from the image collection The behavior of FSI Pages is exactly as if the images would not be listed in the image collection E g EmptyImages value 1 3 4 removes the first third and fourth image in the collection Please note that removing images takes place before inserting blank pages using the Emptyl mages parameter ReversePageOrder Description Reverses the order of the individual pages in the collection Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages Version 4 1 5 or higher Set this parameter to true to reverse the page sequence of pages Please note that this parameter does not change the reading order Please see Page Reading Order to change the reading order of a document Basic Parameters I nitialPage Description Page to display on startup Syntax Number Default 1 Context Pages plug in node or HTTP query prefixed with pages Specifies the page to display on startup e g 1 for the front cover Note The parameter InitialPage has no effect if you are using the Re
174. memberLastViewedPage parameter to make the user to return to the last viewed page You can use ForcelInitialPage instead if you want FSI Pages to show a specific page independent of the last viewed page 78 NeptuneLabs FSI Viewer FSI Pages Add on PageOrderRTL Description Switch to right to left reading order Syntax Boolean Default False Context Pages plug in node or HTTP query prefixed with pages_ Version 4 1 5 or above By default FSI Pages uses the western page reading order left to right Enable this parameter to use right to left reading order e g for Arab documents FirstPageNumber Description Offset for page numbering Syntax Number Default 1 Context Pages plug in node or HTTP query prefixed with pages_ By default FirstPageNumber 1 the front cover is page number one You can specify an offset so that the page numbers start with a different value This parameter affects page numbers the index and the display of the current page number in the FSI Pages user interface Skin Description User interface skin for FSI Pages Syntax String Default silver Context Pages plug in node or HTTP query prefixed with pages Specifies the skin containing the user interface for FSI Pages Available skins are located in the directory skins pages of your FSI setup directory Please note that this does not affect the skin of FSI Viewer which can
175. n Default true Context Pages plug in node or HTTP query prefixed with pages_ Version 3 5 5 or higher Setting FrontCover parameter to false disables access to the front cover and forces FSI Pages to display the first image on the first inner left page BackCover Description Enable disable the back cover Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages_ Version 3 5 5 or higher Setting BackCover parameter to false disables access to the back cover and forces FSI Pages to add a blank content page if required BlankFrontCover and BlankBackCover Description Use a blank page for front and or back cover Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages_ Use a blank page as front and or back cover The cover page s will be added to images in the image list FullFrontCover and FullBackCover Description Fill entire front and or back cover with image Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages_ Fill the entire front and or back cover with the corresponding image This is Ignore page margins and do not use an overlay for the cover page specified FrontCoverl mage and BackCoverl mage Description Use the specified image for front or back cover Syntax String Default Context Pages plug in node
176. n JavaScript Bridges ias cent a decer ve t od enint e eo vase AAA 161 Plug in bargeToolTIDS cinese torte e o lee oc d cate Feci m sa ata P 169 Plug in AAA II eod aborda ea v e ot 172 PIU MAZO Mirna ls iio ed ite re AA te Fed ur ele odo ee 174 Pug n Measllle coute oa deis 175 Pl gesih MOUSE esc do lts 181 Plug in MousemodeSelect ica e 183 Pla MUSIC ld diia 185 Plain NavEXt nSiO EE 187 A ch rre bee a SH eu eva bct aa ee s 189 Plugs Eeer REENEN 197 Pl gsin PageSoundS EE 198 Plug in Eeer 199 A A E 204 Plugs RESIZE EE 207 Plug in Selec rra ME Eats roo deo dune us e atr rand td eit a 208 Plug in SHO PRISA PCR RE a rera Rt RAN 212 Pl gsin SortwareC UESOT nad cede v ds ced t Qe e nu a eit aT 216 Plug In Stc ele 217 lt at e Leite EE 220 AS ek EE 222 Plugin ZOOMMCISR NOS 225 Error MESSAGES ico 226 EE 228 Pol C ntrib Package eene e a ula dec cu alt eA O 228 Escaping or URL encoding parameter values nns 228 HTML Tags available in FSI Viewer 228 Example of a _default fsi Tile cadre tede Mets ai cul de eu dod rte eek du Du ad 229 Example of an image specific FSI configuration nie 229 EE 230 Introduction NeptuneLabs FSI Viewer Introduction FSI Viewer Flash based Single Source Image Viewer and the Add ons FSI Pages and FSI Showcase have been designed to display high resolution images on the internet requiring low bandwidth only Using the Adobe Flash browser plug in FSI Viewer requests image data from Single Source
177. n Removes the button for mouse mode n from the menu bar Syntax Boolean Default Context Plug in Tag Provides the possibility to hide specific mouse mode buttons Remove Drag Button Plugin src mousemodes Model false NeptuneLabs FSI Viewer 181 Plug ins Reference The example above shows how to hide the button for mouse mode 1 Drag Mode n Mouse Mode ModeO Zoom Model Pan Mode2 m Rotate 3D X Y Axis Mode3 Rotate 2D Z Axis Sequence Description Sequence of the buttons Syntax String Default 0 1 3 2 Context Plug in Tag Version 3 5 0 or higher You can alter the sequence of the buttons by providing the modes separated by commas see the table above Example 1 0 2 3 alters the sequence of the buttons to Pan Zoom Rotate 3D Rotate 2D 182 NeptuneLabs FSI Viewer Plug ins Reference Plug in MousemodeSelect Plug in Target User interface Plug in Location plugins mousemodeselect plg Function Integrates a button and a dropdown menu into the menu bar to select the mouse mode Syntax Plugin src mousemodeselect The Mousemode Select plug in adds a button and a dropdown menu to the menu bar to select the mouse mode Plug in Parameters MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in Tag Specifies the space in pixel left of the menu b
178. n lt tip gt lt tip id Downloading Data gt Downloading lt tip gt REECH lt Data gt You can duplicate existing language files or create new files as needed To use custom language files please use the Language parameter and set the parameter value to the filename without the xml extension NeptuneLabs FSI Viewer 41 3D Configuration NeptuneLabs FSI Viewer Virtual 3D Presentations Preparing 3D Presentations In addition to zoomable 2D images FSI Viewer can be used to display virtual 3D presentations of an object This way you can provide a photorealistic zoomable and rotateable view of an object Creating 3D views requires multiple images of the same object from different angles There are two different methods to setup virtual 3D views Using multiple source images Using a single tiled source image Method A Using Multiple Source I mages This is the recommended way to setup virtual 3D views Upload the images belonging to a 3D View to a subdirectory of your imaging server Create a configuration file e g my3dview fsi and add the list of source images belonging to this view like in the sample as shown Configuration for a 3D presentation as displayed in Figure A on page 53 lt xml version 1 0 encoding Scharset gt lt fsi_parameter gt lt images3d prefix my3Dimage image suffix tif gt lt image src 01 gt lt image src 02 gt image src 03 gt image src 04
179. n src CustomButton buttons btn1 btn2 The CustomButton plug in can be used to integrate one or more custom buttons into the menu bar of FSI viewer Clicking a button invokes the URL specified in the plug in parameter This way you can integrate buttons performing a JavaScript call or opening up a web page Plug in Parameters MenuOffset Description Offset in pixel to previous menu elements Syntax Number in pixel Default 0 Context Plug in tag Defines an offset of all custom buttons in pixels to elements of the menu bar Buttons Description Comma separated list of unique identifiers Syntax String Default Context Plug in tag Enter a list of unique identifiers separated by commas Each identifier represents a new button that can be configured using the parameters below E g btni btn2 adds two custom buttons To specify parameters for these buttons you have to prefix the parameters by the unique identifier plus e g btn1 Url defines the URL to use for the button named btn1 1D Offset Description Offset of the button in pixel to previous custom buttons Syntax Number in pixels Default 0 Context Plug in tag Specifies an offset for the button named ID in pixel to previous custom buttons 144 NeptuneLabs FSI Viewer Plug ins Reference ID URL Description Url to open on click Syntax String Default
180. n value Left gt lt Plugin gt lt Plugins gt c By HTTP query value prefixed with showcase_ Example Parameter provided by query lt Param name movie value fsi swf showcase layout Outside The following value types can be used Type Example Number 90 Pixel 90 String Zoomin URL http www neptunelabs com Bool either 0 1 or true false HexColor FFOOFF Color Transition FFOOFF FFFFFF 114 NeptuneLabs FSI Viewer FSI Showcase Add on Alphabetical I ndex of FSI Showcase Parameters Al E 114 Backgrounds isi maas e deed eder es 120 BackgroundAl pha issiria nrar r 120 AA a ea ene eres 114 EEEE Er 5 uoc eerie ned 114 CropThumbnails eee 130 bg 118 A A aa 115 Draobartiobliaht cece e 121 DragBarRoundBewvel sss 121 DragBarShadow sseeee cnn nnncnnran 121 DragBarWidth eseee nro ncrnnnran 115 Dr Mision rra Eer 116 DragMenuWidth ssee e 116 EdgeRadilis 1 rented oberen 123 EMPEY MAGES nni cc ici did 119 HOVerROtation varada na 126 HOVET ZOO E 126 H erolbh ada 115 mageBorderHighlight eenn 122 ImageBorderShadow eenn 122 ImageBorderWidth nesses 122 ImageMarginX and I mageMarginY 122 ImageWidth and ImageHeight ssssss 121 Iriitialimage xou oet e E artery 116 InitialSIZe s eae reso m e ceri
181. nd disable plug ins for individual images adding an options parameter with the name of the plug in to the corresponding image tags of the image list Example Disabling a plug in inside an image definition Defining FSI Showcase image nodes Images Image label No Magnifier gt lt FPX gt lt SRC value image2 fpx gt lt Width value 8096 gt lt Height value 12300 gt lt FPX gt lt Options gt lt Magnifier value false gt lt Options gt lt Image gt lt Images gt Plug in parameters defining the initial state of a plug in do only apply to the first image The initial state does not get restored when selecting an image in the thumbnail bar For example if you set the visible parameter of the Magnifier plug in to true it will be initially visible but it will not be displayed each time the user selects an image if the user disabled the magnifier glass by clicking the corresponding button NeptuneLabs FSI Viewer 113 FSI Showcase Add on Showcase Parameters The Showcase parameters described in the following can be provided in 3 different ways a Attributes of the plug in tag Example Parameter provided as attribute lt Plugins gt Plugin src showcase Layout Outside gt lt Plugins gt b Child nodes of the plug in node Example Parameter provided as child nodes Plugins Plugin src showcase gt lt Layout value Outside gt lt Alig
182. nsequences e Defining smaller image tiles reduces the overall viewer performance and increases the number of requests and thus the imaging server load e Defining larger image tiles might lead to increased traffic and decreased download performance as more image data than actually required for a certain image section will be loaded I nfoTemplate Description Configuration template to retrieve image info from server Syntax String Default fsi info xml Context FPX Version 4 0 0 or higher Specifies the configuration template used to retrieve image specific data from eRez imaging servers You might want to specify a custom template if you want to retrieve IPTC data for all images MetaDataQueryParameters Description HTTP Query to append to meta data requests Syntax Query Default Context Options Version 4 1 3 or higher An optional query string of the form a 1 amp b 2 amp c 3 to append to meta data request to eRez Imaging server These query parameters will be appended to info and list requests passed to eRez server NeptuneLabs FSI Viewer 39 Configuration Specifies the number of image details image tiles being requested simultaneously ConcurrentRequests Description Number of simultaneous image requests Syntax Number Default 2 Context lt Options gt Version 2 3 0 or higher Please do not change this value unless y
183. nt page 1 2 3 4 1 based index of the current double page 1 2 4 6 FSI CURRENTDOUBLEPAGE For inner pages this value represents the index of the left page For the front and back cover the value is the actual page index NeptuneLabs FSI Viewer 71 FSI Pages Add on Page Overlays Page overlays are compiled Flash movies clips that can be used as an overlay floating above a page in FSI Pages You have probably seen the Photo Album example created with FSI Pages at www fsi viewer com The small sticky photo corners come from an overlay file Using Overlays Overlay files have to reside in the plugins pages overlays directory of your FSI Viewer setup directory You can add a global overlay to appear on all pages and or specify an overlay file for specific pages Defining a global page overlay lt Plugins gt Plugin src pages gt lt PageOverlays gt Overlay default true file ov photo swf gt EAS lt PageOverlays gt lt Plugin gt lt Plugins gt The example above adds the sticky photo corners overlay to all pages like in the Photo Album sample Defining overlays for specific pages lt Plugins gt lt PageOverlayShowZoomed value true gt lt PageOverlays gt Overlay file myDefaultOverlay swf gt Overlay page 5 file myOverlayl swf gt Overlays page 10 gt Overlay file myOverlay2 swf x 0 5 y 0 5 gt Overlay file myOverlay
184. ntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or higher Enables or disables the search interface of FSI Pages Please refer to the chapter Searching in FSI Pages for details SearchDialogWidth and SearchDialogHeight Description Size of the search dialog Syntax Number pixel Default 400 width 300 height Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or higher The size of the search dialog in pixel Please refer to the chapter Searching in FSI Pages for details 104 NeptuneLabs FSI Viewer FSI Pages Add on SearchAutoWildCards Description Add wildcards to keywords automatically Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or higher By default FSI Pages adds wildcards to the keywords the user entered into the search input of the search dialog Set this parameter to false if you don t want FSI Pages to add wildcards automatically Please refer to the chapter Searching in FSI Pages for details SearchAutoExactMatch Description Add quotes to keywords automatically Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages Version 4 1 5 or higher Setting this parameter to true makes FSI Pages add quotes to search requ
185. ntext Plug in attribute Text size for the textual output in pixels 178 NeptuneLabs FSI Viewer Plug ins Reference BGColor Description Defines the color of the text background Syntax HexColor Default FFFFFF Context Plug in attribute 6 digit hexadecimal color value defining the background color of the text BGAlpha Description Defines the opacity of the text background Syntax Number Default 80 Context Plug in attribute Defines the opacity of the text background 0 100 GlowRange Description Size of the glow effect Syntax Number Default 4 Context Plug in attribute The glow range is a highlighted area surrounding the measure tool to improve it s visibility Using the GlowRange parameter you can define the size of the glowing area Use 0 to disable the glow range GlowAlpha Description Opacity of the glow range Syntax Number Default 25 Context Plug in attribute Opacity of the glow range surrounding the measure tool GlowColor Description Color of the glow range Syntax HexColor Default FFFFFF Context Plug in attribute 6 digit color defining the color of the glow range surrounding the measure tool NeptuneLabs FSI Viewer 179 Plug ins Reference Events Description Send plug in event notifications Syntax Boolean Default false
186. ntext Plug in attribute Version 3 0 0 or higher Display the current magnification in percent of the viewer size false or relative to the size of the source image NeptuneLabs FSI Viewer 225 Error Messages Error Messages Please make sure to enable the debug mode when experiencing problems or to check FSI Viewer configuration Usually it is easy to locate the reason for an error by examining the output in the debug window or the step of the initialization process where the FSI Viewer stops Warning ViewerWidth and ViewerHeight obsolete FSI Viewer version 4 determines the dimension of the viewer instance automatically Therefore specifying these values is not required any more Specifying the correct viewer dimension does on the other hand not have any negative influence Error FSI Viewer does not show up at all Please make sure to have Flash plug in 6 0 65 0 or above installed Please check the parameters of the object and embed tag Make sure that the HTML code lt PARAM NAME movie VALUE URL and parameter gt contains the correct URL to the FSI Viewer file fsi swf Please make sure that all required files have been transferred in binary mode to your web server If not adjust the corresponding configuration options of your FTP client accordingly and upload all FSI Viewer files once again Error Loading _default fsi failed Please make sure that the file default fsi resides in the setup directory of
187. o insert have to be defined by the parameter LinkTemplateData explained below Please refer to the chapter Modifying link values at runtime above for details LinkTemplateData Description Values to replace template identifiers in link URLs Syntax String s Default Context Pages plug in node or HTTP query prefixed with pages When defining LinkTemplates to replace place holders in Link URLs you can use this parameter to specify the values that shall be inserted The number and sequence of the values must match the number and sequence of the templates you defined using the LinkTemplates parameter Multiple values have to be separated by commas and the individual values have to be provided urlencoded Please refer to the chapter Modifying link values at runtime above for details Parameters for FSI Pages Thumbnails Due to the Single Source Imaging concept you can display a small flipping thumbnail of your catalog just by using a different configuration file and choosing a smaller dimension for the FSI Pages instance The parameters below focus on thumbnail pages Menu Description Show hide the user interface Syntax Bool Default true Context Pages plug in node or HTTP query prefixed with pages Show true or hide false the user interface of FSI Pages add on 94 NeptuneLabs FSI Viewer FSI Pages Add on IdleAutoTurn Description Turn pages automatically
188. on level e g sharpen 1008 quality 95 204 NeptuneLabs FSI Viewer Plug ins Reference PrintResolution Description Max size of image to print Syntax Number Pixels Default 2000 Context PrintSave Version 5 0 0 Defines the maximum size of the image in pixels to download for printing Please note that the actual size depends on the size of the image and with eRez server on the maximum size defined in the real time template used with FSI Viewer see parameter PrintTemplate PrintTemplate Description eRez image template to be used Syntax String Default Context PrintSave Version 5 0 0 Defines the eRez real time template used to load the print image Save Description Enable Disable saving Syntax Boolean Default true Context PrintSave Version 5 0 0 If disabled the menu button is hidden SaveEffects Description eRez image effects Syntax String urlencoded Default Context PrintSave Version 5 0 0 Defines image modification parameters to apply to images used for saving The value of this parameter depends on the imaging server being used With eRez server you can sharpen the image and define the JPEG compression level e g sharpen 100 amp quality 95 NeptuneLabs FSI Viewer 205 Plug ins Reference SaveResolution Description Max size of image to save Syntax
189. on of the notepad plug in in order to store the notepad data in a separate data set on the user s system Otherwise the user might see bookmarks for another image or catalog You can either use the global FSI Viewer parameter UniquelD or use the Notepad plug in parameter Please refer to the Uniquel D parameter description below for details Persistent Data Storage The notepad uses an internal Flash technique to permanently store the notepad data on the users system No server side script or cookies are required Please note that the notepad data does not store the thumbnail images but the URL to the thumbnail instead If you remove an image from your imaging server the user will not see the thumbnail any more when opening the notepad later on NeptuneLabs FSI Viewer 189 Plug ins Reference Posting and Loading data The notepad plug in provides the functionality to post bookmarks in XML format to a web server Additionally the plug in is capable of reading an XML data file from the server Web Server userl xml Using a little server side script you can this way setup a number of interesting communication systems For example a send bookmarks by email option In this case you store the XML data file received from User s notepad plug in on a web server and email a link to an FSI Viewer instance including the name of the stored XML file returned by the web server to User2 This way User2 can see the bookmarks
190. onding to the match Additionally each result item may contain HTML formatted text describing the match The sequence of the result item nodes specifies the sequence of the results displayed in FSI Pages search dialog You therefore might want to sort the items by relevance before writing the matches to the list Please use utf 8 encoding in case the result contains language specific special characters NeptuneLabs FSI Viewer 63 FSI Pages Add on Search Result XML lt xml version 1 0 encoding utf 8 Results Item page 10 gt Some lt b gt text lt b gt for this Item Item page 20 gt Some b text b for this Item Item page 30 gt Some b text b for this Item lt Results gt Adding Hyperlinks to Pages You can add interactive areas links on pages by providing XML data for each page specifying the coordinates the tool tip and the action to execute You might for example want to publish a PDF document containing links In this case you can use FSI Pages Converter to extract the links from the PDF document and create the required XML data for FSI Pages for you Publishing PDF Documents with Links using FSI Pages Converter and eRez Imaging Server The easiest way to add links to FSI Pages is using a source PDF document containing hyperlinks This way FSI Pages Converter prepares the required XML data by gathering the link information from the PDF document eRez subsequently
191. opaque ScrollBaseColor Description Base color of the scroll bar Syntax Default Context HexColor Derived from BaseColor Showcase plug in node or HTTP query prefixed with showcase Defines a color for the scroll bar ScrollTrack Description Color of the track bar of the scroll bar Syntax HexColor Default Derived from ScrollBaseColor Context Showcase plug in node or HTTP query prefixed with showcase Defines a color for the track area of the scroll bar ScrollArrow Description Color of the arrows of the scroll bar Syntax HexColor Default Derived from ScrollBaseColor Context Showcase plug in node or HTTP query prefixed with showcase Defines a color for the arrows on the buttons of the scroll bar Please note that the same color applies to the labels of the drag bar menu 122 NeptuneLabs FSI Viewer FSI Showcase Add on DragBarHighlight Description Highlight color of the drag bar Syntax HexColor Default Derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase_ Version 3 5 0 or higher Defines the highlight color of the drag bar DragBarShadow Description Shadow color of the drag bar Syntax HexColor Default Derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase_ Version 3 5 0 or higher Defin
192. or HTTP query prefixed with pages A path to an image to use for the front or back cover FSI Pages will use the FPXBase parameter of FSI Viewer for relative paths The cover page s will be added to the images in the image list NeptuneLabs FSI Viewer 83 FSI Pages Add on FrontCoverConfig and BackCoverConfig Description Use the specified image configuration file for front or back cover Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Specify a separate image configuration file fsi to be used for the front or back cover respectively The cover page s will be added to images in the image list HardPages Description Defines page flexibility Syntax Boolean Default false all cover Context Pages plug in node or HTTP query prefixed with pages Version 5 0 0 Defines wether the pages are flexible or inflexible e g like a book cover PageBackgroundl mage Description Relative path to the image on your imaging server Syntax Filename Default Context Pages plug in node or HTTP query prefixed with pages Version 5 0 0 The path to an image on your imaging server to be used as a background If you use a relative path recommended the FSIBase parameter will be used to get the absolute path to the image PageBackgroundl mageEffects Description Image effects for the b
193. or HTTP query prefixed with showcase_ Show tool tips when the mouse cursor hovers above a thumbnail The text presented in the tool tip is the text of the thumbnail This option can be useful if you choose to hide the text on the thumbnail or if the thumbnail label is too long to be entirely displayed on the thumbnail itself Multi line texts are being presented separated by commas 118 NeptuneLabs FSI Viewer FSI Showcase Add on MinimizeOnSelect Description Minimize the thumbnail bar on select Syntax Boolean Default true Context Showcase plug in node or HTTP query prefixed with showcase_ Minimize the thumbnail bar to the initial size when the user selects clicks a thumbnail TextOutsideFrame Description Display text outside thumbnail frame Syntax Boolean Default false Context Showcase plug in node or HTTP query prefixed with showcase Display the thumbnail label inside the thumbnail frame work false or outside the frame work true The option only applies to thumbnails in normal state it does not have an impact on active and selected thumbnails ThumbEffects Description Image manipulation parameters applied to thumbnail images Syntax String Default Context Options Version 3 1 1 or higher Applies image manipulation effects like sharpen or quality to all thumbnail images Please refer to the FS Viewer
194. or JavaScript you can build HTTP queries to pass parameters to FSI Viewer dynamically If you want to display an image with minimal variation in configuration it is recommended to reuse the same FSI configuration file and to provide varying parameters like the image path FPXSrc by HTTP query Try to provide only those parameters by HTTP query that don t apply to multiple instances of FSI Viewer Keep in mind that changing a single configuration file for multiple images later on will be far less work compared to editing multiple HTML codes later on Providing parameters by HTTP query View 1 lt PARAM name movie VALUE fsi swf cfg flowers amp FPXSrc rose fpx View 2 lt PARAM name movie VALUE fsi swf cfg flower amp FPXSrc rose fpx amp NoNav 1 gt NeptuneLabs FSI Viewer 19 Configuration Alphabetical I ndex of FSI Viewer Parameters ANIMACION drii a aid 32 AnimationSpeed 0 cece eects en 32 AnimationTyDe scc iia itn ina 32 BEE Bee 25 OS 22 ConcurrentRequests AAA 40 CroPR Ct she ood rei qe er n eve etr e 26 Debug inea deceat Ee Eu 24 DefaultCEG Iure cerit Papi Deis 22 DetailBuffer AAA 27 Effecto oaa rap eb rte tan 34 EnableZoomInPanMode 31 ExtendedViewport sse 31 JL PITE 25 HatidCursor x soe ties 31 Help R ee EE dereen EES AA 30 HelpURLTarg Ot coincide 30 A reet erre eese aed 33 Ignore QUe EE 37 IgnoreQueryParametelS ooccoccccnccccccnncnnnnnnnnnnnnnnnnnnnnnns 38
195. or even uneven pages 106 NeptuneLabs FSI Viewer FSI Pages Add on Crop nner CropOuter Description Crop page images Syntax Number in pixel or percent Default 0 Context Pages plug in node or HTTP query prefixed with pages_ Specify the amount in pixel e g 100 or in percent e g 10 to crop from the inner or outer side of the page image These parameters override the CropLeft and CropRight parameters CropInner is the right side for even pages and the left side for uneven pages CropOuter is the left side for even pages and the right side for uneven pages Events Description Enable plug in events Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages_ Using this parameter you can enable or disable plug in event notifications e g for the JS Bridge plug in Please see Event Notifications and Actions for details FlipCornerSize Description Size of interactive page corners Syntax Number Default 10 Context Pages plug in node or HTTP query prefixed with pages_ Version 3 5 5 or higher Specifies the size of the interactive page corners you can use to flip pages You can either specify the size in pixels or in percent of the page width Setting this parameter to 0 disables interactive page flipping by dragging the page corners FlipEdgeSize Description
196. orizontally Align left right or vertically Align top bottom If you set the Layout parameter to Outside or Inside this value additionally defines the minimum size of the thumbnail bar the user can achieve by dragging the thumbnail bar HScroll Description Display a horizontal scroll bar if required Syntax Boolean Default false Context Showcase plug in node or HTTP query prefixed with showcase e false Arrange thumbnails vertically and use a vertical scroll bar if required e true Arrange thumbnails horizontally and use a horizontal scroll bar if required DragBar Description Enable Disable dynamic resizing of the thumbnail bar Syntax Resizable Fixed or Hidden Default Resizable Context Showcase plug in node or HTTP query prefixed with showcase e Resizable The user is able to resize the thumbnail bar dynamically The width of the splitter bar of the showcase is increased e Fixed The user is not able to resize the thumbnail bar dynamically The width of the splitter bar of the showcase is normal e Hidden The user is not able to resize the thumbnail bar dynamically and the splitter bar of the showcase is invisible DragBarWidth Description Size of the drag bar Syntax Number Default 8 Context Showcase plug in node or HTTP query prefixed with showcase_ A floating point value defining the width of the drag bar of the thum
197. otes Version 5 0 0 Defines the opacity of the sticky notes from invisible 0 to opaque 100 Color Description Defines the color of the sticky notes Syntax Color Default FFFF55 Context StickyNotes Version 5 0 0 Defines the main color of the sticky notes NeptuneLabs FSI Viewer 217 Plug ins Reference ColorHighlight Description Color of lighter part Syntax Color Default FFFFEE Context StickyNotes Version 5 0 0 Defines the color of the light part of the sticky notes ColorShadow Description Defines the color of the dark part of the sticky notes Syntax Color Default CCCCOO0 Context StickyNotes Version 5 0 0 Defines the color of the dark part of the sticky notes NaturalRotation Description Enables slightly rotated sticky notes Syntax Boolean Default true Context StickyNotes Version 5 0 0 When this option is enabled the sticky notes will be rotated slightly to give a more natural look and feel PageNumbers Description Enable Disable Page numbers Default True Context StickyNotes Version 5 0 0 Display page numbers on the sticky notes PersistentStorage Description Cache notes inforation Default True Context StickyNotes Version 5 0 0 When disabled the sticky notes will be deleted when the user leaves the FSI Pages instance When en
198. otspot Open a HTML page Restart the Viewer with a different image configuration Adding Hotspot Functionality to your mages Integrating the Plug in To integrate the HotSpot plug in into the viewer you have to add the following line to the lt Plugins gt section of either the default fsi file or to an image specific fsi configuration file Plugin src hotspots gt Defining the HotSpots Section To define HotSpots for an image you have to add an XML section to your image specific fsi file The definition syntax is similar to image maps for static images inside a HTML page Each HotSpot is being defined by a single XML node inside the lt HotSpots gt group NeptuneLabs FSI Viewer 151 Plug ins Reference The basic structure of a HotSpot definition is the following HotSpot definition Plugin src hotspots visible true gt lt HotSpots gt circle spot tip url rect spot tip url lt HotSpots gt lt Plugin gt Alternatively to adding the hotspot XML section as a child node of the HotSpot lt plugin gt node you can add the XML section as a root child in the same level as lt FPX gt or Options in a configuration file Plug in Parameters Visible Description Initial visibility of the HotSpots Syntax Bool Default false Context Plug in attribute or HotSpots group tag Defines the initial visibility of HotSpots The HotSpot b
199. ou are certain that this is necessary and you are aware of possible consequences e Increasing this value might lead to increased imaging server load e Decreasing the value will decrease the download performance Usel ntermediateZoomLevels Description Use more zoom levels than contained in the source image Syntax Boolean Default true Context lt Options gt Version 4 0 0 or higher Images with resolution levels contain the same image in different resolutions The size of the next level is twice the size of the preceding level If you disable this option FSI Viewer accesses these resolution levels only Otherwise image data will be retrieved more often Uniquel D Description Unique Identifier for plug ins Syntax String see description Default Context Options Version 3 6 0 or higher A unique string identifying the image image collection displayed in FSI Viewer You can for example use the path of the image or the name of a catalog Do not use the following characters in UniqueIDs Space 96 amp V The Notepad plug in for example requires a UniquelD value 40 gt lt gt NeptuneLabs FSI Viewer Configuration MouseVelocity Description Continue mouse actions after mouse up Syntax Boolean Default false Context Options Version 5 0 0 or higher If you enable this parameter mouse actions like pan will be con
200. ou need to provide the x and y coordinates 0 1 for each point determining the polygon shape You might want to add the spot parameter to specify the scene and sceneset the polygon applies to with 3D presentations View Description Image section to display Syntax String Default Value of spot parameter Context HotSpot tag Version 3 2 3 and above Defines the position to display when move is set to true If this parameter is undefined the value of spot will be used instead Please refer to the chapter HotSpot Authoring tips for more information on this parameter Tip Description Tooltip Syntax String Default Context HotSpot tag Defines a string to be used for a tooltip when the user moves the cursor over the HotSpot For long texts or HTML formatted texts you can add a text child node to each hotspot node instead of using the Tip parameter HotSpot text definition HotSpots Circle spot 1 1 0 0 0 6 0 4 0 lt text gt lt b gt Headline lt b gt lt br gt Some text lt text gt EE lt HotSpots gt Move Description Zoom to HotSpot area on click Syntax Boolean Default false Context HotSpot tag Zoom to the image section covered by the HotSpot if the user clicks the HotSpot You can use the DefaultMove parameter to change the default behavior 156 NeptuneLabs FSI Viewer Plug ins Reference Skew Desc
201. ound UseRomanPageNumbersToPage Description Display Roman page numbers up to page number n Syntax Number Default 0 Context FSI Pages Version 5 0 4 Defines the page number up to which FSI Pages uses Roman page Numbers The default value of 0 forces FSI Pages to display Roman numbers for negative numbers and 0 If you set the value to 5 the display will be like this 1 11 111 14V 6 7 8 9 Note that you can use the Parameter FirstPageNumber to offset all page number values RomanPageNumbersOffset Description Offset Roman page numbers by given value Syntax Number Default 0 Context FSI Pages Version 5 0 4 Defines the value of the first Roman page number The default value of 0 means no offset so that the Roman numbers start with I Parameters for Links on Pages FollowLinks Description Enable or disable FSI Pages to open links Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or above Setting this parameter to false prevents FSI Pages from opening links on the pages Links and tool tips will nevertheless be displayed 90 NeptuneLabs FSI Viewer FSI Pages Add on ShowLinksWhileFlipping Description Show or hide links during flip animations Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or abo
202. overlays when zooming into a page MovePages Description Move pages when zooming Syntax Boolean Default true Context Pages plug in node or HTTP query prefixed with pages_ Move the pages when zooming to maximize the space available for FSI Viewer If set to false images will be zoomed in place XMLBase Description Path to XML page data Syntax String Default Context Pages plug in node or HTTP query prefixed with pages If you specify this parameter FSI Pages will try to load XML data for each page from the location specified The file path of the XML files must match XMLBase image filename xml 100 NeptuneLabs FSI Viewer FSI Pages Add on Print Description Enable printing of pages Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages_ Version 3 5 0 or higher Enable or disable the user to print the content of the current page Please refer to the chapter Printing and Saving Pages for details PrintResolution Description Max size of the image to print Syntax Number pixels Default 2000 Context Pages plug in node or HTTP query prefixed with pages_ Version 3 6 0 or higher Defines the maximum size of the image in pixels to download for printing Please note that the actual size depends on the size of the image and with eRez server on the maximum size d
203. own left in the thumbnail bar When disabled the thumbnail is shown in the center below the catalog Arrows Description Display scroll arrows Syntax Boolean Default true Context PagesThumbBar Version 5 0 4 If set to false the arrows for scrolling the thumbnailbar are hidden and the user needs to drag the thumbs to scroll ArrowAlphaActive Description Opacity of arrow Syntax Number Default 100 Context PagesThumbBar Version 5 0 0 Opacity of the arrows when mouse hovers over the thumbnail bar NeptuneLabs FSI Viewer 199 Plug ins Reference ArrowAlphaNormal Description Opacity of arrow Syntax Number Default 0 Context PagesThumbBar Version 5 0 0 Defines the opacity of the arrows in normal state ArrowFillColor Description Arrow fill color Syntax HexColor Default FFFFFF Context PagesThumbBar Version 5 0 0 The fill color of the arrows inside in the thumbnailbar ArrowLineColor Description Arrow line color Syntax HexColor Default FFFFFF Context PagesThumbBar Version 5 0 0 The fill color of the arrows inside in the thumbnailbar DropShadow Description Enable Thumbnail Shadows Syntax Boolean Default false Context PagesThumbBar Version 5 0 0 Enable Disable the drop shadow effect of the thumbnails Height Description Size of thumbnail ima
204. p From version 1 3 of the plug in you can additionally set the value to onLoad to start the sound after image data has been loaded completely Song Description Path to an MPEG3 audio file mp3 Syntax URL Default Context Plug in attribute Defines an absolute or relative path to an MPEG3 file mp3 If you specify a relative path instead http or https the path needs to be provided relative to the music subdirectory of the fsi folder NeptuneLabs FSI Viewer 185 Plug ins Reference Loop Description Loop Play the sound once Syntax Bool Default false Context Plug in attribute Defines if the sound will be played once or in a continuous loop PauseOnStop Description Pause music rather than stop when clicking the plug in button Syntax Boolean Default false Context Plug in attribute Version 4 0 7 By default pressing the plug in button stops plays the music Setting this parameter to true makes the plug in pause resume when clicking the plug in button so that the song does not restart from the beginning Volume Description Sound volume Syntax Number 0 100 Default Context Plug in attribute Defines the volume of the sound from 0 quiet to 100 maximum KeepState Description Keep Stop Play state when selecting images Syntax Boolean Default true Context Plug in at
205. parameter definitions This can be especially useful if you want to override parameters defined in external configuration files for example overriding the MenuAlign parameter 110 NeptuneLabs FSI Viewer FSI Showcase Add on FSI Showcase Layout The appearance of the Showcase Add on can be customized by a large number of configuration parameters The parameters will be described in detail in the sections Basic Parameters and Advanced Parameters This section describes general layout considerations and measures Parameter Layout Outside Inside Floating Shrinks the size of the image view port by the initial size of the thumbnail bar Floats above the viewer without modifying the viewer or image size Shrinks the size of the viewer by the initial size of the thumbnail bar Parameter Align Right Top Bottom b Lt tT tt E po The figures to the left show the alignment with Layout set to Outside and MenuAlign set to BL Bottom Left You can achieve various layouts by modifying the 2 Showcase parameters Layout and Align and the FSI Viewer parameter MenuAlign In addition to the layout parameters explained above you can define Offsets Margins and Paddings for each side of the Showcase If you use the Inside or Floating offset layout you will most likely have to define an offset to avoid parts of the Showcase margin being hidden below the menu bar mum A The actual values dep
206. parameters 56 NeptuneLabs FSI Viewer MarginLeft MarginTop Left Page FSI Pages Add on Right Page mr MarginBottom Using Margin parameters to define the position of the pages and to provide e wmm 7 hamamam is Space for the FSI Pages user interface Using ViewerMargin parameters to define the size and position of FSI Viewer inside FSI Pages Usually you only specify ViewerMarginBottom to provide space ViewerMarginBottom for the FSI Pages interface Additional layout parameters provide the possibility to adjust the layout of the individual pages For catalogs the layout is usually very simple as the images cover the entire page For other types of booklets like photo albums you can modify margins alignments and page numbers and add overlays for all pages The following illustration provides an overview on page layout parameters The Crop parameters are especially useful to remove crop marks from source images derived from print catalogs The left and right crop margins can be defined directly or alternating depending on even odd pages using CropInner and CropOuter parameters The crop amount can be specified in percent or in pixels A complete reference of all layout parameters can be found at the end of this chapter NeptuneLabs FSI Viewer Zoomed Image PageMarginTop CS T ie Keim PageMarginl nner CropLeft or CropInner MarginRight CC Pa igeMarginOuter 1
207. pecified image so that the entire area of FSI Viewer instance is filled with the background image Plug in Parameters The path to an image on your imaging server to be used as a background FPXSrc Description Relative path to the image on your imaging server Syntax String Default Context Plug in tag If you use a relative path recommended the FSIBase parameter will be used to get the absolute path to the image Effects Description Optional effect parameters to pass to the imaging server Syntax String Default Context Plug in tag Like with the Effects parameter for FSI Viewer itself you can optionally pass image effect parameters to your imaging server that affect the appearance of the background image 134 NeptuneLabs FSI Viewer Plug in Chapters Plug in Target User interface of FSI Pages Plug in Location plugins chapters plg Function Adds a select box to access parts of a catalog directly Syntax Plugin src chapters gt Plug ins Reference Select Amie Girls size 92 146 Girls Ami Boys size 922146 Boys Shoes Toys This plug in adds a select box to the user interface of FSI Pages The user can directly access sections of a catalog by selecting the corresponding item in the select box You can assign colors and different levels to each chapter using simple XML based data describing the document structures Examp
208. pening mages in the navigator window lt NaveEffects value sharpen 35 gt eRez Imaging Server NavEffects value ftr 5 gt Iseemedia Zoom Image Server NavEffects Description Image manipulation parameters applied to the navigator window Syntax String Default Context Options Version 3 1 1 or higher Applies image manipulation effects like sharpen or quality to all images inside the navigator window Please refer to effects parameter for a detailed description SceneEffects Description Image manipulation parameters applied to preview images Syntax String Default Context Options Version 3 1 1 or higher Applies image manipulation effects like sharpen or quality to all un tiled images in the viewer Please refer to effects parameter for a detailed description 36 NeptuneLabs FSI Viewer Configuration TileEffects Description Image manipulation parameters applied to image tiles Syntax String Default Context Options Version 3 1 1 or higher Applies image manipulation effects like sharpen or quality to all image tiles in the main view area Please refer to effects parameter for a detailed description ZoomCache Description URL of the ZoomCache Syntax URL Default Context Options If you use NeptuneLabs ZoomCache please specify the URL of the ZoomCache ser
209. ping before the first entry of the history list Providing the default value false the history will not be looped this is the history list stops at the first and the last position NeptuneLabs FSI Viewer 149 Plug ins Reference SmallButtons Description Size of menu buttons Syntax Boolean Default true Context Plug in tag If this value is set to false the buttons of this plug in will be displayed in the default button size Otherwise the buttons appear slightly smaller than other buttons 150 NeptuneLabs FSI Viewer Plug ins Reference Plug in HotSpots Plug in Target User Interface and Zoom Area Plug in Location plugins hotspots plg Function By defining clickable areas hotspots the user is able to interact with the image by clicking on areas inside the zoomable image Syntax Plugin src hotspots gt Enterprise editions of FSI Viewer contain this plug in by default For all other editions this plug in can be optionally obtained O The HotSpots plug in adds an image map like functionality to the FSI Viewer The plug in adds a button to the menu bar which allows the user to show or hide the HotSpots The clickable areas are defined via XML inside the image specific fsi file and enable an increased interaction with the Viewer There are 4 different combinable actions that can be assigned to each hotspot Display a tool tip Zoom to the area defined by the h
210. polygons will be drawn by FSI Viewer at runtime HotSpot Z Order When defining HotSpots that overlap each other you have to keep the z order of the HotSpots in mind The z order of HotSpots is determined by the sequence in which they are defined in the configuration file from bottom to top As a rule of thumb you should define big Hot Spot areas first to ensure that smaller Hot Spots are not completely hidden beneath 160 NeptuneLabs FSI Viewer Plug ins Reference Plug in JavaScript Bridge Ber lt scr Plug in Target Scripting Plug in Location plugins jsbridge plg Function Integrates a J avaScript interface to enable interaction between FSI Viewer and J avaScript contained in the hosting HTML page Syntax Plugin src jsbridge Requirements Browser supporting live connect between Flash and JavaScript Livewire This plug in can be optionally obtained Using the plug in without a valid licence key activates the evaluation mode O The J avaScript Bridge plug in provides a scripting interface to control FSI Viewer using J avaScript Using the J avaScript bridge you can control viewer functions like Zoomln and Reset you can remotely press release Buttons inside the FSI Viewer and you can zoom to specified image sections directly Additionally you can implement a JavaScript function receiving FSI event notifications Though the integration of the plug in is very easy basic knowledge of J avaSc
211. prefixed with pages_ 8 digit hexadecimal number specifying the color and opacity of links on the pages when the user clicks a link in the form RRGGBBAA E g FF0000FF for opaque red or 00FF0099 for semi transparent green NeptuneLabs FSI Viewer 91 FSI Pages Add on ForceLinkURL Description Force URL for all links on pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or above Force FSI Pages to use this URL for all links on all pages This overwrites any URLs specified in the page data ForceLinkTarget Description Force a target frame for all hyperlinks on all pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 3 6 0 or above Force FSI Pages to use this HTML target frame for all links on all pages This overwrites any target frames specified in the page XML data Note this parameter does not affect avascript and mailto links ForceJ avascriptTarget Description Force a target frame for all javascript links on pages Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 4 1 1 or above Force FSI Pages to use this HTML target frame for all javascript links on all pages This overwrites any target frames specified in the page XML data Note this parameter does not
212. r Defines wether the navigation buttons for jumping to the first or last page are shown 96 NeptuneLabs FSI Viewer FSI Pages Add on Parameters for Statistics Requires FSI Viewer 4 1 3 or above The following parameters can be used to measure the usage of FSI Pages instances by means of third party statistic tools Using these parameters you can define a template based URL to call each time the user flips to another page The templates in the URL will be replaced at runtime You can specify a minimum time a page is visible before the statistics URL will be loaded PageLogURL Description Template based URL for page view logging Syntax URL Default Context Pages plug in node or HTTP query prefixed with pages Version 4 1 3 or higher Template based URL to load each time the user flips to another page The following templates will be replaced at runtime pagenum The page number of the current left page totaltime Total seconds the FSI Pages instance is visible instanceid A unique number identifying the FSI Pages instance uniqueid The FSI Pages parameter value Uniquel D Example URL http foo com log php catalog foo amp page pagenum amp lid instanceid You can alternatively call a Javascript function using the javascript syntax In this case you need to define a valid HTML target frame using the PageLogTarget parameter PageLogTar
213. r details on how to obtain image section parameters Example Button Zoom to image section MSI E lt input type button value Zoom to section onClick document all fsiviewer SetVariable FSICMD Goto 1 3 0 0 0 gt Implementing J avaScript callbacks Using JavaScript callbacks enables you to react to FSI Viewer FSI Pages or FSI Showcase events by executing J avaScript code The J SBridge plug in calls a JavaScript function using the Flash FSCommand architecture providing an event identifier and a parameter Please follow the steps below to implement J avaScript callbacks from FSI Viewer Step 1 Enable J avaScript callbacks by setting the plug in parameter Callback to true e g Example Enabling JavaScript Callbacks plugin src jsbridge callback true Or alternatively via HTTP query vcofS SWwiZ2efg too5jslosunee celle Step 2 Add a unique identifier to the object and the embed tag of FSI Viewer FSI Showcase Example Adding ID NAME parameters object id fsiviewer classid lt Param name movie value gt lt embed NAME fsiviewer gt lt object gt Step 3 Add a JavaScript function to your HTML page receiving the event notifications via FSCommand like in the example below 164 NeptuneLabs FSI Viewer Plug ins Reference IMPORTANT The function name has to be exactly like in the example below and it has to start with the ID NAME parameter spec
214. r own server engine the following solutions apply e Setting up FSI Viewer to a web server on the same IP as the imaging server using a different port e g port 8080 e Using NeptuneLabs ZoomCache proxy to route FSI Viewer requests e Setting up FSI Viewer to a subdirectory of the imaging server that is able to deliver standard file types e g the servercode directory of Iseemedia Imaging server Preventing Security Popup with Flash MX 2004 plug ins or above From Flash MX 2004 Adobe modified the security model of Flash plug ins regarding the cross domain policy To avoid security messages popping up when FSI Viewer tries to retrieve data from the Imaging server you have to add an XML file to the root directory of the imaging server being requested The file contains information about domains that are allowed to retrieve data from the specific domain and has to be named crossdomain xml crossdomain xml lt xml version 1 0 encoding iso 8859 1 cross domain policy lt allow access from domain secure false cross domain policy Please refer to the Adobe Flash documentation for more information regarding cross domain security O NeptuneLabs FSI Viewer 21 Configuration Basic Parameters The following parameters are essential and usually need to be specified Please refer to the chapter Retrieving Parameters Automatically for information on how to enable FSI Viewer to retrieve
215. rWidth 202 SelectionColor cccccssececseeesecseeeeeeeeeseeaees 202 SelectionMarginBottom ssssss 202 SelectionRoundCorner sss 203 SGendVMlzGtorellpRt 195 SendXMLUrlFailed oooccccocccccocicicnnccnnnos 195 SendXMLUrlFailedTarget sss 196 SendXMLUrlSuccess cccoooccccoccccnnoonnnnnncnnnos 195 SendXMLUrlSuccessTarget 196 Maldad ER RR ad 75 120 ServerTemplate eee 23 A aio dnm ter er ea den 22 SGeiValuestortachlmage 142 AN A ees 170 Shadow Colo e aa al eaa aa a Ra et 170 Show ngle sse 178 ShowLinksWhileFlipping eeeessss 91 ShowLoadProgress n 80 SMON TEE aaa dol 177 SHOW Wy ii REED ets 142 SingleSided re 85 Sin 138 172 SKEW inca dz 157 e Al timado 24 79 A eset eoe 79 GmalButtons iiio eaa a E aT 150 NO 185 TEE 137 SIE Lei ie ON Rt eH Rua 219 POr Ep etd euet da es 155 siae eege 23 52 SrcRelative s ress ge et een met e 225 NeptuneLabs FSI Viewer StartAlplia ito Leere nee Ee 197 StrictView een ET 32 A A A 177 SyncMeasSure ENEE 221 SyncSoftwareCuUrSor eea 220 MO oa Ep E 158 ISA hue 178 TextColor 139 171 178 193 203 222 TextColorHighlight se 203 TextFODE eege tete e eta rs 171 TOXCERO Mists uii e NEE der RR 222 TexvtOutedetrame 119 E RE 171 178 223 ThumbActiveFace ccccoocccnnoccnccnoccnnnoncnnnnnnss 124 ThumbBorderActiveH
216. rameters for Virtual 3D Presentations The following FSI configuration parameters apply to virtual 3D presentations only Parameters for multiple source images Method A only Images3D Description Node containing the list of source images Syntax XML node Default Context ROOT node like FPX or Options Query n a Add this node to the top level of a configuration file to list the individual images for a 3D presentation You can add the attributes prefix and suffix instead of providing the complete path for each image individually 44 NeptuneLabs FSI Viewer 3D Configuration Configuration for a 3D presentation as displayed in Figure A lt xml version 1 0 encoding Scharset gt lt fsi_parameter gt Images3d prefix my3Dimage image suffix tif gt image src 01 gt lt image src 02 gt image src 03 gt image src 04 image src 05 gt lt image src 06 gt lt Images3d gt lt fsi_parameter gt I mages3DURL Description URL to an XML file containing a 3D image list Syntax URL Default Context options URL to an external XML file containing the image lists for 3D presentations as explained above You might want to use the parameter Images3DURLBase in your default fsi configuration file to specify the URL base for all 3D image list URLs Images3DPrefix Images3DSuffix Description Prefix
217. rce image with 12 image tiles The number of horizontal and vertical image tiles must be specified using the parameters TilesX and TilesY Figure A displays a source image containing 12 tiles representing a rotation of 360 around the Y axis in steps of 30 In this case you simply add the parameters TilesX 3 and TilesY 4 to your FSI configuration Fig A Rotation around Y axis in 30 steps Fig B Rotation around Y axis in 45 steps and 4x3 12 tiles partial rotation around X axis in 15 steps 6 x 4 24 tiles in 3 scene sets Example Configuration for a 3D presentation as displayed in Figure A lt xml version 1 0 encoding Scharset gt lt FPX gt TilesX value 3 gt TilesY value 4 gt lt FPX gt Figure B shows a more complex 3D view representing a rotation of 360 around the X axis in 45 steps and an additional rotation of 15 around the Y axis To present rotations around more than one axis or to present an object in different states you need to define SceneSets A Scene Set describes a sequence of individual images The user can select individual images of a scene set using the keys 7 or 9 in the num pad or using the mouse mode rotate moving the mouse horizontally The user can additionally select a scene set using the keys and in the num pad or using the mouse mode rotate moving the mouse vertically If the TilesX or TilesY parameters are defined for a sour
218. reated for e g images paintings Query Description Search query eRez server only Syntax String Default Context Showcase plug in node or HTTP query prefixed with showcase Specifies a search query to be used to generate the showcase e g foo Can be used alternatively to the dir parameter Server Description Path to imaging server eRez server only Syntax String Default Context Showcase plug in node or HTTP query prefixed with showcase Specifies the URL of the eRez imaging server to generate the configuration E g http mydomain com erez This parameter can be omitted if the Showcase has been installed to the default location on the eRez imaging server Please note Loading configurations across domain boundaries will fail due to a security restriction of the Adobe Flash plug in 120 NeptuneLabs FSI Viewer FSI Showcase Add on ListTemplate Description Template to retrieve image lists eRez server only Syntax String Default fsi image_list xml Context Showcase plug in node or HTTP query prefixed with showcase_ Version 3 2 6 Specifies the XML template to be used to retrieve the image list from eRez imaging server You can use custom list templates to retrieve image configurations files from eRez server e g to including HotSpot definitions contained in IPTC data of the images Emptyl ma
219. ript is required to use J SBridge plug in especially regarding browser dependent J avaScript implementations Implementing the J avaScript Bridge plug in 1 Add an ID attribute to your FSI Viewer Object and Embed tag object id fsiviewer classid gt embed NAME fsiviewer gt This way you are able to access the viewer object via J avascript 2 Provide the appropriate action via SetVariable command To control FSI Viewer from J avaScript you have to pass the appropriate command by setting the FSTCMD variable of the FSI Viewer movie clip using the SetVariable function Example Button Zoom In MSI E input type button value Zoom In onMouseDown document all fsiviewer SetVariable FSICMD ZoomIn onMouseUp document all fsiviewer SetVariable FSICMD gt NeptuneLabs FSI Viewer 161 Plug ins Reference Command Parameters There are 3 different command types you can pass to FSI Viewer FSI Pages or FSI Showcase 1 Initiate an action directly e g ZoomIn or Reset 2 Press and release of FSI Viewer buttons e g Button Mouse Mode OI 3 Zoom to a specified image section e g Goto 1 6 0 4 0 2 0 6 0 4 Please see the HotSpot Authoring section for details on how to obtain valid image section parameters The following table lists possible values you can pass to FSI Viewer Please note that especially regarding the Button command there might be more or not all commands listed availa
220. ription Allow skewing of the HotSpot area Syntax Boolean Default false Context HotSpot tag If this parameter is set to false the width of the hotspot area will equal the height of the HotSpot regardless of the values provided with the Spot parameter You might want to use this parameter to ensure that e g HotSpots defined with the circle tag look like circles instead of ellipses You can use the DefaultSkew parameter to change the default behavior Color Description Color of the HotSpot border Syntax HexColor Default FF0000 Context HotSpot tag Defines the color of the HotSpot border The value has to be a 6 digit hexadecimal number like FFFFOO for yellow or 0000FF for blue You can use the DefaultColor parameter to change the default border color Fill Description Fill the HotSpot area Syntax Bool Default false Context HotSpot tag If this value is set to false the HotSpot will by shown as an outline You can use the DefaultFill parameter to change the default behavior URL Description Hyperlink of the HotSpot Syntax URL Default Context HotSpot tag Defines a hyperlink to be opened if the user clicks the HotSpot The URL can be given relatively or absolutely The Target parameter or respectively the DefaultTarget parameter defines the targetframe for the hyperlink Please refer to the BaseURL parameter as well
221. ronize FSI Viewers you need to use this plug in in all instances of FSI Viewer you want to synchronize and assign the same unique ID parameter to the instances The plug in synchronizes the view 2D and 3D as well as the mouse cursor and the plug in measure The plug in does not synchronize add ons like FSI Showcase or FSIPages Plug in Parameters ID Description Unique identifier Syntax String Default Context Plug in attribute All FSI Viewer instances using this plug in with the same ID will be synchronized Please note that this will even be the case if the viewers reside in different browser windows SyncSoftwareCursor Description Synchronize SoftwareCursor plug in Syntax Boolean Default true Context Plug in attribute Version 4 1 5 or above Enable disable synchronizing the mouse cursor position among synchronized FSI Viewer instances Note that this parameter has no effect if you do not use the SoftwareCursor plug in 220 NeptuneLabs FSI Viewer Plug ins Reference SyncMeasure Description Synchronize the Measure plug in Syntax Boolean Default true Context Plug in attribute Version 4 1 5 or above Enable disable synchronizing the Measure plug in This parameter has no effect if you do not use the Measure plug in You might want to disable this parameter if you want to enable users to measure distances in synchronized FSI Viewer ins
222. roup by using the prefix select frame_ with the parameter name e g select frame_window MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attribute Specifies the space in pixels left of the menu button of the plug in Visible Description Show or hide the plug in on startup Syntax Boolean Default false Context Plug in attribute Show or hide the select box on startup 208 NeptuneLabs FSI Viewer Plug ins Reference Window Description Show or hide the output window Syntax Boolean Default true Context Plug in attribute Show or hide the output window of the plug in AnimatedRect Description Enable or Disable frame animation Syntax Boolean Default false Context Plug in attribute If enabled the frameborders will be animated Rotate Description Enable rotation of the selection Syntax Boolean Default true Context Plug in attribute Enable rotating the selection by pressing ALT key or ALT SHIFT keys and dragging the handles of the select box MaskColor Description Color of the mask Syntax HexColor Default FFFFFF Context Plug in attribute Define a 6 digit hexadecimal color value for the mask of the select box MaskAlpha Description Opacity of the mask Syntax Number Default 75 Context Plug in attr
223. rovides the total number of pages onPadescotoPaue int ger Called each time before the user goes to a different page The g g g parameter provides the target page number Called each time after the current page has changed The onbegestiogeChanged Integer parameter provides the index of the page currently visible Called each time the load progress of FSI Pages changes The onPagesProgress Integer parameter provides the number of pages remaining in the load queue onPagesShowl ndex Boolean a each time the user shows true or hides false the page onPagesShowZoom Boolean Called each time the user starts true or ends false page zoom a Called each time the user clicks a link orgedi URL The parameter contains the URL Commands for FSI Pages Add on Command Description empty string Stop current action FirstPage Go to first page LastPage Go to last page NextPage Go to next page PreviousPage Go to previous page Go to page n Important Use SetVariable newImagelndex n where n is 0 pages prior to sending this command GotoPage Alternatively you can specify a page relative to the current page To go to a page relatively you have to set newImagelndex to a number prefixed by or e g 1 is the same as NextPage Print Open or close the print dialog Save Open or close the save dialog Search Open or close the search dialog ZoomLeftPage Zoom the left page
224. rred in binary mode Step 2 Edit the default configuration file default fsi located in the main index of your setup directory using a text editor of your choice The most important modifications are FPXServerType Enter the type of your imaging server e g erez or ZIS FPXBase Request base of the imaging server e g http domain erez erez src or http zis domain com fif Additionally you can create configuration files for individual images or use HTTP queries to access different images Please refer to the chapter Automated Implementation of Images if you plan to use a large number of images with FSI Viewer Step 3 12 Add the HTML source for a Flash movie to your website and enter the path to the file fsi swf with the desired parameters as a HTTP query for the parameter Movie object tag and Src embed tag lt PARAM NAME movie VALUE fsi swf cfg foo amp debug 1 gt Please use the files in the samples folder of the installation archive as a guide line NeptuneLabs FSI Viewer Setup Licencing FSI Viewer You can use FSI Viewer without a licence key for evaluation purposes In this case the phrase Evaluation Copy appears on top of the image and the about box displays Unregistered Evaluation Copy in the Licenced to section After purchasing an FSI Viewer licence you will receive a licence key that removes the Evaluation Copy mark and the name of the licensee appears in the lic
225. s By default FSI Pages uses eRez imaging server to retrieve search results FSI Pages passes the term entered by the user to eRez server and receives an XML based list of matches Based on these matches FSI Pages presents a list of thumbnails of those pages matching the search criteria How does eRez determine matches eRez searches the file paths and the IPTC data of the images contained in FSI Pages If your images do not yet contain keywords you might want to add keywords to the IPTC data of your images using the eRez web interface choose Edit File in the file view of eRez web interface If you are using a PDF document as a source for your FSI Pages instance you can have FSI Pages Converter version 2 create IPTC keyword data for all pages based on the content of the PDF document Please refer to the Text Search section of FSI Pages Converter in this case Using external Severs to return Search Results Alternatively to using eRez server you might want to use an existing database on an external server to perform the search In this case FSI Pages provides a simple interface you can use to have FSI Pages direct the search to and retrieve the results from the external server This is by nature an advanced feature and requires some server side scripting and database knowledge The following section describes the required steps based on the assumption that your database contains a unique ID for each FSI Pages instance catalog and the required keywor
226. s s M Delgado Marc Delisle Daniel Hinostroza Linas J ankauskas Yukihiro Kawada Slawomir Kilanowski Hillar M eotsa Kristian Ottosen Ivo Teel Stas Ukolov Andri Viiand 230 NeptuneLabs FSI Viewer Index Absolute Addressing s see 23 AUTOMALION a iier ere ds 21 GEGEN E 22 ComboLabelBackgroundAlpha 136 Debug Mode eere ban 48 Embed EE 14 Error Messages eee tds 226 FSI Pages i cssc P erect dri en Pope 55 Defining Image Collections 58 FSI Pages Converter 56 Hyperlinks t etta 64 Page Overlays 4 eee ges 72 Printing Dages 60 Saving Pages eee re 61 A td Peau peint 62 FSI Pages Converter 56 FSI Pages Barameters 76 115 ESI ShOWcase ui an 108 FSI Showcase Parameters 115 FSU VIEW CF sch ania ene rada 15 Installation see 11 Menu Bar tree nas 8 Mouse Cursor iii e rn tte erre 30 Object E EE 14 FSI Viewer Parameters ccce 20 Parameter AddBUt EE 194 a E E A A 116 AllowDomains aea a a aaa 168 AlowMirroredNotes 217 APO et EE 138 152 217 Animatedbert AAA 209 ANIMAN EE 32 AnimationSpeed AAA 32 ArrowAlphaActive sse 199 ArrowAlphaNormal see 200 ArrowFillCOolor 200 Arrowt net olor nana 200 tte ntc e RR ERR E ERE T 199 AspectRatlo c n cedo i ds 210 Auto ropbages 80 AutoHideDialog errereen 141 AutoPlay E oe eI de Rech 185 AULOZOOIM errare bi 98 BackCov r eu e ER Eg 83 NeptuneLabs
227. s A 38 lrnageAIigri EE 86 mageBackgroundColor s 192 ImageBorderHighlight s 124 ImageBorderShadow 124 Imageborderw Oth 124 mageEffects sss 193 ImageHeight AA 123 191 ImageMarginX sss 124 ImageMarginY sss 124 ImagePanButtons coooccccnncccnnnoccnnnnnnnnnonannnnns 27 ltmages3D EE 44 Images3DPrefix nnee 45 Tmages3DSuffix cnn nano nonnnns 45 Images3DURL REENEN 45 Images 2DUDl Base cc 45 ImageUrlS coa 168 Image dh 123 177 191 O EN 79 IndexMargin Width seee 136 Info Template 39 A m 28 ul E el WEE 29 InitialActionDelay 29 InitialActionPersistent 30 Initiallmage renes 118 Initial MOUSEMOdE seee 30 initial Pagen 2 daa da 78 InitlalSize 5i d reete 117 InitalViewberslstent 29 AO E OE 24 Invertir cope edet 210 ItemButtonsBackgroundColor 192 Keepl mageSe ction ea 132 TS eo eo ES 80 KeepStat occurred t erc Dn eat 186 LabelContent be bote es 129 LabelMaroainbottom s e 131 NeptuneLabs FSI Viewer LabelMarginTop sereen 131 LabelMode eene tps 129 LabelOffsetLeft sss 132 LabelCteet Top AAA 131 EOI 131 E aeree tere E Vea eara us 130 LabelTemplates ssseseeeen 129 EabelTextAligni rat tts 130 LabelTextColor sse 131 LabelTextFont eeen 131 LabelTextHeight eeren 130 LabelTextSize aeren 129 LabeltevpWw dh 130 A irren EA EEN 27 LAYOUD e 116 A A n hs be
228. s Reference Y Description Initial Y position in pixel Syntax Number Default 0 Context Plug in Tag Initial vertical position of the control in pixels relative to the top left corner of the viewer 188 NeptuneLabs FSI Viewer Plug ins Reference Plug in Notepad Plug in Target User interface of FSI Pages Your Bookmarks Plug in Location Page 2 plugins notepad plg d Here are your comments Function x Creating and displaying bookmarks with text and image Page 4 Here are your comments Syntax Plugin src notepad gt Add or delete bookmarks Enterprise editions of FSI Viewer contain this plug in by default y For all other editions this plug in can be optionally obtained O The notepad plug in enables the user to create bookmarks for an image section with descriptive text The available bookmark buttons and options depend on the Add on you are using Add on Description Bookmark current page s FSI Pages Bookmark product link Bookmark image section Bookmark current image elle Bookmark image section of the current image Bookmark entire image None d Bookmark image section for bookmarks containing descriptive text lt text gt nodes in XML page data e g for the LargeToolTip plug in this text is being used as default text for the bookmark see image above Unique ID It s crucial to specify a unique ID for each applicati
229. s image modification parameters to apply to images used for downloading The value of this parameter depends on the imaging server being used With eRez server you can sharpen the image and define the JPEG compression level e g sharpen 100 amp quality 95 NeptuneLabs FSI Viewer 103 FSI Pages Add on SaveTemplate Description eRez template to use when downloading images Syntax String Default fsi Context Pages plug in node or HTTP query prefixed with pages_ Version 4 0 0 or higher The eRez real time template to use when downloading images in the Save dialog Please refer to the chapter Printing and Saving Pages for details SaveOptions Description Enable or disable options in the Save dialog Syntax String Default Context Pages plug in node or HTTP query prefixed with pages Version 4 0 0 or higher A comma separated list of options to be presented to the user in the Save dialog The default is presenting all options which corresponds to the following parameter value document chapters both left right Using the parameter value left right enables saving the left or right page only Please note that the options might as well not appear if there is no data available or specified to download for any of these options Please refer to the chapter Printing and Saving Pages for details Search Description Enable searching a catalog Sy
230. s the minimum time each page is being held in memory after it has been viewed the last time Set this parameter to 0 to remove pages exceeding the PageCacheLimit immediately PageOverlays Description Defining overlay s for all or a specific page Syntax XML Default Context Pages plug in node Version 4 0 0 or above Define a global page overlay for all pages and or for individual pages A page overlay is a movie clip that loads on top of a page To specify a default overlay for all pages except for those you specified an individual overlay for please add a default true attribute to the overlay node Please see chapter Page Overlays for details NeptuneLabs FSI Viewer 99 FSI Pages Add on Defining a global page overlay lt Plugins gt lt Plugin src pages gt PageOverlays Overlay default true file ov photo swf Overlay page 5 file myOverlayl swf posX 6 posY 12 gt Overlay page 21 file myOverlay2 swf posx 0 posY 98 gt lt PageOverlays gt lt Plugin gt lt Plugins gt The example defines the default overlay ov_photo swf and defines individual overlays for pages 5 and 21 PageOverlayShowZoomed Description Show overlays when zooming pages Syntax Boolean Default false Context Pages plug in node or HTTP query prefixed with pages_ Version 4 0 0 or above Defines whether to show or hide page
231. sed instead of the hand cursor when hovering over the image or the navigator window Defines the maximum magnification in percent relative to the source image ZoomLimit Description Maximum magnification Syntax Number Default 100 Context Options The default value 100 permits magnification to the physical resolution of the source image Possible values are 1 to 1000 ZoomLimitMin Description Minimum magnification Syntax Number Default 100 Context lt Options gt Defines the minimum magnification in percent relative to the initial image The default value 100 permits magnification to the size of the Viewer Smaller values permit magnifications smaller than the viewer size Possible values are 1 to 100 ExtendedViewport Description Extend the size of the viewport Syntax Boolean Default false Context Options With this option enabled you can pan the borders of the image to the center of the view port If you disable this option the panning range is smaller so that the user can not pan the image borders to the center of the view port NeptuneLabs FSI Viewer 3l Configuration StrictViewport Description Strict viewport allowing minimum image panning only Syntax Boolean Default false Context lt Options gt Version 4 1 0 or above With this option enabled the pan range for the image is limited to the m
232. sical resolution of the image Syntax Plugin src maxzoom gt The MaxZoom plug in expands the user interface by a button to quickly zoom to the physical resolution of the source image Plug in Parameters MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attribute Specifies the space in pixels left of the menu button of the plug in 174 NeptuneLabs FSI Viewer Plug ins Reference Plug in Measure 2 Plug in Target User interface Plug in Location plugins measure plg Function Provides distance and angle measuring Syntax lt Plugin src measure gt This plug in can be optionally obtained Using the plug in without a valid licence key activates the evaluation mode The Measure plug in provides an additional mouse mode which enables the user to measure distances and angles inside the FSI Viewer by clicking amp dragging Pressing SHIFT locks the angle to 45 degree steps Pressing CTRL moves the measurement line Mouse Mode The mouse mode id for the measuring mode is 100 You can use this id to set the InitialMouseMode parameter of the FSI Viewer e g lt InitialMouseMode value 100 or cfg foo amp InitialMouseMode 100 Setting up the Plug in The Measure Plug in requires the real width of the entire image to enable distance measuring Example 1 If you already know the entire width of the ima
233. siderations might be helpful when deciding which method to choose for a certain parameter Default Configuration You can easily change global parameters that apply to all FSI Viewer instances by editing a single file This is therefore the recommended configuration method for e Global parameters valid for all images in particular e FPXServerType e FPXBase e Licence Key e General configuration options like e Plug ins e MenuAlign AnimationSpeed and alike 18 NeptuneLabs FSI Viewer Configuration Configuration Files Separate configuration files should be used for parameters specific to a group of images You might for example want to setup individual configuration files for different types of FSI Viewer instances like small_no_interface fsi large_with_ hotspots fsi as an example Try to avoid adding global parameters like the base path to your imaging server FPXBase or alike in individual configuration files This way you will only need to change the default fsi configuration file once you need to change the address of your imaging server Usually you don t need to create a configuration file for an individual image as you can specify the image path or other unique parameters dynamically by HTTP query Passing Parameters by HTTP Query This method is recommended for parameters from databases parameters specific to an image or FSI Viewer instance or parameters related to user interaction Using server side script
234. sion 3 2 1 or higher By default FSI Viewer adds a zoom level for the maximum magnification this is FSI Viewer loads image details when reaching the maximum magnification For extremely high resolution 2D images exceeding 32 000 pixels in width or height you can set this value to false to prevent display problems at the maximum magnification TiltModeRelative Description Use absolute or relative tilt mode Syntax Boolean Default true Context Options Version 3 6 0 or higher True Rotate the image 2D around the center of the view port depending on the mouse position and distance to the center False Rotate the image 2D clockwise moving the mouse right and counterclockwise moving the mouse left 38 NeptuneLabs FSI Viewer Configuration TileSizeX and TileSizeY Description Size of image detail tiles Syntax Number in pixel or in percent of the viewer size Default 50 Context lt Options gt Version 2 3 0 or higher Specifies the size of image details image tiles The value can be defined relative to the viewer size e g 25 or using absolute pixel values e g 256 The default value of 50 means that each image tile is one quarter in size of the entire viewer This way a maximum of 9 image tiles is required to display the selected image section Please do not change this value unless you are certain that this is necessary and you are aware of possible co
235. sure that the image does not overlap the thumbnail edge I mageBorderWidth Description Thickness of the border around the thumbnail image Syntax Pixel Default 1 Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the thickness of the border around the thumbnail image Setting this parameter to 0 disables the image border I mageBorderHighlight Description Highlight color of the border around the thumbnail image Syntax HexColor Default Derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the color of the highlighted section of the image border left and top I mageBorderShadow Description Shadow color of the border around the thumbnail image Syntax HexColor Default Derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the color of the darkened section of the image border right and bottom ThumbFace Description Color of the thumbnail face Syntax HexColor or color transition Default Color transition derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase Defines the color of the thumb face This value can be either defined as a solid color e g 00FF00 or as a linear color transition from top left to bottom right by entering two color values separated by comma e g
236. t or photo album FSI Pages automatically creates a page index with thumbnails and provides interactive zooming using FSI Viewer The number of pages images has a very low impact on the loading time and performance You can therefore use FSI Pages with 1 000 and more images or pages Depending on the configuration FSI Pages can be used to display different types of booklets like catalogs EXE with or without links booklets photo albums and more CS 7 10 Using FSI Pages The integration of FSI Pages is very similar to an FSI plug in To enable FSI Pages you have to add a plug in node to your XML configuration file Integrating FSI Pages lt Plugins gt lt Plugin src pages skin silver gt lt Plugins gt Parameters for FSI Pages can be provided by adding parameters as attributes or child nodes of the FSI Pages plug in node As with all FSI plug ins you can additionally provide parameters by adding the parameter to the FSI Viewer query prefixed by pages Providing parameters as node attributes Plugins Plugin src pages MarginLeft 100 zoom false Plugins NeptuneLabs FSI Viewer 55 FSI Pages Add on Providing parameters as child nodes lt Plugins gt lt Plugin src pages MarginLeft 100 zoom false gt MarginLeft value 100 gt zoom value false Plugin Plugins Providing parameters using HTTP queries attached to the movie URL
237. tances independently NeptuneLabs FSI Viewer 221 Plug ins Reference Plug in TextBox Plug in Target User interface Plug in Location plugins textbox plg Function Adds a text box to display text related with the image below the viewer Syntax Plugin src textbox gt This text demonstats TextBox plug in This plug in adds a text box below the viewer to display text related with the image With eRez Imaging Server you can directly access IPTC data of the image to retrieve the text automatically without the need for a database When using FSI Showcase the text updates each time you select another image The following HTML tags can be used to format the text b u i i lt u gt lt u gt lt br gt font size n color RRGGBB gt lt font gt lt p align gt lt p gt a href gt lt a gt Plug in Parameters TextFrom Description Parameter containing the text data Syntax String Default IPTC Caption Context Plug in attribute Defines the name of the FSI Viewer parameter in the options section of FSI Viewer configuration containing the text to display You can specify short text as an attribute of this parameter e g IPTC Data value Some Text gt For multi line text or text containing HTML tags you can alternatively use a text node IPTC Data Text line 1 br Text line 2 IPTC Data Text
238. th FSI Viewer 4 1 or above you can additionally use the parameter values fitWidth or fitHeight to make FSI Viewer zoom a page to fit the entire width or height of a page If you do not specify this parameter FSI Viewer displays the entire image PreloadForward Description Number of pages to pre cache Syntax Number Default 4 Context Pages plug in node or HTTP query prefixed with pages Number of subsequent pages to load in advance 98 NeptuneLabs FSI Viewer FSI Pages Add on PreloadBackward Description Number of pages to pre cache Syntax Number Default 2 Context Pages plug in node or HTTP query prefixed with pages_ Number of preceding pages to load in advance PageCacheLimit Description Number of pages to hold in memory Syntax Number Default 8 Context Pages plug in node or HTTP query prefixed with pages_ Version 4 1 3 Defines the number of pages to hold in memory Using larger numbers will make FSI Pages consume more memory RAM and cached pages will be read from the browser s file cache less frequently Use false to hold all pages in memory once loaded This is the default behaviour of previous versions PageCacheRemoveTime Description Minimum time each page is being held in memory Syntax Number seconds Default 3 Context Pages plug in node or HTTP query prefixed with pages Version 4 1 3 Define
239. th value Syntax Number Default 1 Context Plug in attribute Defines the number of decimals of the length value ShowText Description Display the current measurement string Syntax Boolean Default true Context Plug in attribute Hides the text displaying the current measurement if set to false NeptuneLabs FSI Viewer 177 Plug ins Reference ShowAngle Description Display current angle Syntax Boolean Default true Context Plug in attribute If set to true the plug in appends a text representing the current angle in degrees to the text display E g 120 2 inches 43 29 LineColor Description Defines the color of the measure lines Syntax HexColor Default FF0000 Context Plug in attribute 6 digit hexadecimal color value defining the color of the measure lines TextColor Description Defines the color of the text Syntax HexColor Default 000000 Context Plug in attribute 6 digit hexadecimal color value defining the color of the text TextBorder Description Defines the color of the text border Syntax HexColor or false Default 000000 Context Plug in attribute Version 4 1 0 or above 6 digit hexadecimal color value defining the color of the text border Use false for no border TextSize Description Size of the text Syntax Number pixel Default 12 Co
240. the Selection window for the Spot parameter of the hotspot You can use the value displayed in the View window for the optional View parameter When modifying the select box please use SHIFT to lock the aspect ratio of the selection CTRL to resize the selection relative to the center ALT to rotate the selection ALT SHIFT to rotate the selection in steps of 5 degrees Defining Polygon HotSpots Besides using predefined shapes as hotspots you can additionally add polygons In this case you need to specify the X and Y coordinates for each point of the polygon using the coords attribute of the hotspot node HotSpot Polygon definition HotSpots Euler soi 1 1 eoorcds 0 5 0 1 0 1 0555 0 5 0 5 gt lt HotSpots gt Please note that the spot attribute is required only if you want to specify the target scene and or scene set for the hotspot when using a 3D image NeptuneLabs FSI Viewer 159 Plug ins Reference The coords attribute contains 0 1 floating point coordinates where 0 is left or top and 1 is right or bottom The coordinates for the polygon points defining the polygon shape need to be specified in the form x1 y1 x2 y2 X3 y3 Theoretically you can use any number of coordinates points but keep in mind that more coordinates and more polygons require more CPU power on the user s system Using very complex polygons with hundreds of coordinates will lead to poor performance as the
241. the Reset button will reset the view to the entire image I nitialAction Description Action on startup Syntax String Default Context Options Specifies an action to execute on startup The action is repeated until the user presses a button or key While the action is being executed no image details are loaded Possible values NextScene rotate around the y axis to the right 3D only PreviousScene rotate around the y axis to the left 3D only NextSceneSet rotate around the x axis to the right 3D only PreviousSceneSet rotate around the x axis to the left 3D only RotateRight rotate around the z axis to the right 3D only RotateLeft rotate around the z axis to the left 3D only ZoomIn zoom in ZoomOut zoom out I nitialActionDelay Description Speed of the initial action Syntax Number Default 3 Context Options Specifies the speed of the action specified by the InitialAction parameter Possible values are integer values greater than 0 0 highest speed gt 1 slower NeptuneLabs FSI Viewer 29 Configuration I nitialActionPersistent Description Repetition of initial action Syntax Boolean Default false Context lt Options gt Version 2 2 0 or higher Initial action restarts on each reset command button or keyboard if set to true Otherwise the action only performs on startup HelpURL Description
242. tinued depending on the speed you moved the mouse The higher the drag speed the longer the action will be continued This option is especially useful for 3D views With this parameter enabled and mouse mode set to rotate 3D the object will continue to spin rather than stopping immediately after mouse up Additionally a very fast spin of a 3D view will add a blur effect to the object Editing or Creating Language Files In case you want to edit tool tips for existing languages or add support for additional languages you can edit or create language files in the subdirectory languages of your FSI Viewer setup directory Each language file contains a list of phrases used in FSI Viewer user interface The language files are XML files and need to be saved in Unicode utf 8 format The attribute id specifies the context of each phrase Please note that you need to use XML entities for characters not allowed in XML files like e g amp amp for amp amp lt for amp gt for amp quot for amp apos for You can use basic HTML tags to apply text formatting to the tool tips Excerpt from a language file lt Dera lenquage smglisia color 000000 iemur seems ofisetTop 0 giiseutleit 0 offsetWidth 0 offsetHeight 0 gt lt tip id Zoom0ut gt lt b gt Zoom Out lt b gt lt br gt Click to decrease magnification lt tip gt lt tip id ZoomIn gt lt b gt Zoom In lt b gt lt br gt Click to increase magnificatio
243. tion Offset from the right of the viewer instance Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase This value defines the offset from the right of the viewer instance to the right of the thumbnail bar of the showcase Please see the Showcase measurements figures for details MarginTop Description Margin from the top of the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase This value defines the margin in pixels from the top of the thumbnail bar to the content and scrollbar of the thumbnail bar of the showcase Please see the Showcase measurements figures for details 126 NeptuneLabs FSI Viewer FSI Showcase Add on MarginBottom Description Margin from the bottom of the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the margin in pixels from the bottom of the thumbnail bar to the content and scrollbar of the thumbnail bar of the showcase Please see the Showcase measurements figures for details MarginLeft Description Margin from the left of the thumbnail bar Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the margin in pixels from the left of the thumbnail bar to the content and
244. tion Radius of rounded thumbnail edges Syntax Pixel Default 6 Context Showcase plug in node or HTTP query prefixed with showcase_ Defines a radius for drawing rounded edges of the thumbnail frame Use 0 for straight edges and positive values for rounded edges NeptuneLabs FSI Viewer 125 FSI Showcase Add on OffsetTop Description Offset from the top of the viewer instance Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase_ This value defines the offset from the top of the viewer instance to the top of the thumbnail bar of the showcase Please see the Showcase measurements figures for details OffsetBottom Description Offset from the bottom of the viewer instance Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase This value defines the offset from the bottom of the viewer instance to the bottom of the thumbnail bar of the showcase Please see the Showcase measurements figures for details OffsetLeft Description Offset from the left of the viewer instance Syntax Pixel Default 0 Context Showcase plug in node or HTTP query prefixed with showcase This value defines the offset from the left of the viewer instance to the left of the thumbnail bar of the showcase Please see the Showcase measurements figures for details OffsetRight Descrip
245. tire FSI Viewer URL http fsi swf to the clipboard e Paste the URL to the address bar of your browser appending amp debug 1 Using the Debug Window FSI Viewer debug window 8 89 After activating the debug mode an output window is available presenting information about the initialization progress configuration parameters plug ins and gt Search A image information Loading 3 Plug in s You can select different debug sections by clicking the corresponding tab at the 1 plugins filters plg ok bottom of the window Flash filters 5 0 0 ready 2 plugins pages plg ol i FSI Pages 5 0 0 ready The window can be moved by dragging the window title bar and you can show or 3 plugins mousemodes plg ok i i neu MouseModes 5 0 0 ready hide the window by pressing d T T CRE ie Plug ins The section All contains the entire debug output Please provide the content of this section when requesting support Enabling the debug mode additionally prevents the browser from caching FSI configuration files This allows you to easily test changes to your FSI configuration files without having to delete the browser cache each time You can search each section by entering a keyword to the search input at the top Pressing the search button multiple times will cycle through all matches General section Provides general information about the initialization progress If the viewer do
246. tory on your web server Finally you need to provide FSI Pages with the information where the XML files can be found on your web server Please add the Parameter XMLBase to your configuration for this purpose Say the XML files can be accessed via http www myserver com xmldata page01 tif xml http www myserver com xmldata page02 tif xml NeptuneLabs FSI Viewer 65 FSI Pages Add on The corresponding parameter for FSI pages looks as follows XML Page data provided by XML files Plugins Plugin src pages gt lt XMLBase value http www myserver com xmldata Plugin Plugins This way FSI Pages reads an XML file for each page from the location specified Please note that the XML files have to reside in the same domain as FSI Viewer O c Using lt pages gt nodes in configuration files The third method is adding a lt pages gt node to the configuration file used for a page Note that this method requires an individual configuration Image Image date file for each page ee The example below shows the structure of page data catalog Tei XML page data added to a configuration file XML Page data in configuration files lt fsi_parameter gt hb FPX Pages lt Page file page065 tif xml gt NS e s o ILU espe lt Page gt lt Pages gt lt fsi_parameter gt XML Data Format for Pages Usually you don t need to edit the XML data for FSI Pages m
247. tribute For viewers with multiple images only Keep the playing state and ignore the AutoPlay parameter when switching from one image to another This way AutoPlay true does not start the sound if the user switched the music off 186 NeptuneLabs FSI Viewer Plug in NavExtension Plug in Target User interface Plug in Location plugins navextension plg Function Additional navigation control Syntax Plugin src navextension visible true gt The NavExtension plug in adds a draggable navigation control to the FSI Viewer user interface that can be hidden and shown with a Plug ins Reference corresponding button in the menu bar The control automatically adds buttons for scenes and scene sets depending on the image configuration Plug in Parameters Specifies the space in pixels left of the menu button of the plug in MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attributes Visible Description Initial display state Syntax Boolean Default false Context Plug in attribute Defines the initial visibility state of the control X Description Initial X position in pixel Syntax Number Default 0 Context Plug in Tag Initial horizontal position of the control in pixels relative to the top left corner of the viewer NeptuneLabs FSI Viewer 187 Plug in
248. u isa a toro ceat epi bum abu ML Ove EA ose 19 Passing Parameters by HTTP Query occur Ee eet xe ce a t n a EE 19 Alphabetical Index of FSI Viewer barameters mn 20 Retrieving Parameters from Imaging Servers csessseeen m 21 Basic Parameters m nb xo aa 22 Applying Effects to Specific Images Only ssssssse mm 36 Editing or Creating Language Filesss oo oer D x c prid ee Ce ore cina 41 Virtual 3D Presentations se gp keggeeuen ek aga Ee V FEERK EYE ENS EEEFENEVEREENYEUVERV ENEE SNE EER RENTE 42 Parameters for Virtual 3D Presentations cccccssecseseceseeeeseceaueeeaeeeeaeeeeaeneeeaneeeanes 44 Debug H TEE 48 Enabling the Debug Mode ou oda niea desse dud tina O Oud ee Oats 48 Using the Debug WIDGOW sss adest ode a ed tu e alt a 48 Automated mplementation of mages eseeeeeee eee nee 50 e a IEN 52 Desctivatina P dd CG 53 Defining Plug in Parameters esessesseeeeeee eene nennen nnne nnn nnns nna 53 Defining Plug in Parameters dynamically eseeee m 54 FSI Pages O O 55 Using RSI Pade a dd 55 FSI Pages CONVE dE 56 LAYOUT e uc don ae A A AA ALCA 56 Defining Image Collections viii A dada 58 Page Reading Oe viii A A ed o A 60 SAPRISSA A diia 61 S arching IM FSI Pages rr a 62 Adding Hyperlinks to Page uc piu eue obse eei o Ex E Ee Ys RE eee ot viduus 64 Providing XML page data to FSI Pages memes 65 Link Parameters and Hierarchy of
249. uery prefixed with showcase Version 3 5 0 or higher Usually FSI Showcase displays the entire image or the image section specified by the parameter InitialView when selecting a thumbnail Set this parameter to true to if you want to preserve the image section you are currently viewing when selecting another image 132 NeptuneLabs FSI Viewer Plug in Reference Plug in Reference This part of the documentation lists all standard FSI Viewer plug ins The purpose of FSI Viewer plug ins is integrating functionality at runtime that might not be required in general This way users need to download only that part of FSI Viewer code necessary to provide the required functionality Additionally the plug in system provides the possibility to add functionality required by an individual customer or by a certain group of customers Please contact your FSI Viewer dealer in case you are missing any kind of functionality NeptuneLabs FSI Viewer 133 Plug ins Reference Plug in Backgroundl mage Plug in Target Viewer background Plug in Location plugins backgroundimage plg Function Adds a background image to FSI Viewer Syntax Plugin src backgroundimage FPXSrc images bgimage tif This plug in adds a background image to FSI Viewer Usually background images are used with FSI Pages only as with FSI Viewer and FSI Showcase most of the background image is covered by the zoomable image The plug in crops the s
250. ust want to display a tool tip Available in FSI Pages version 4 0 7 or above page n Forces FSI Pages to flip to page n showimage imageURL Displays the specified JPEG image zoom Forces FSI Pages to zoom to the area covered by the link s shape s zoomarea Magnifies the area covered by the link s shape s in place Display a custom J PEG image The value URL needs to be an absolute URL to a zoomimage J PEG image Forces FSI Pages to zoom to the image area following FOAM AOS See Parameter gt nitialView for format details Combination of page and zoom zoomonpage n strView This is first flip to page n then zoom to area strView Available in FSI Pages version 4 0 7 or above Please note that the special links starting with need to be provided exactly as listed in the table above Using e g zoomToPage or foo html zoom will link to the HTML anchor provided rather than executing an FSI Pages action 70 NeptuneLabs FSI Viewer FSI Pages Add on For mailto URLs the target frame is always _self except the XML lt area gt node specifies a different target Modifying Link Values at Runtime In some cases it might be necessary to replace parts of link URL values for links on the pages for example when using session variables or if you use the same catalog in HTTP and HTTPS environments Runtime link template replacement applies to links on pages as well as for SaveURL valu
251. utton Plugin src contextmenu gt lt Menultems gt ASS SPACES RONIN gt gt lt Item label First Page action FirstPage lt Item label Previous page action PreviousPage gt Item label Next page action NextPage lt Item label Last Page action LastPage lt Separator gt lt Item label Show Hide Index action ShowHidePagelndex gt Item label Zoom this Page action ZoomPage Separator lt FST SHOWGASE ONLY gt lt Item label Previous Image action PreviousImage gt lt Item label Next Image action NextImage gt lt Separator gt lt l SI Vania gt lt Item label Reset View action Reset gt lt Item label Zoom in action ZoomIn gt lt Item label Zoom out action Zoom0ut gt lt Menultems gt lt Plugin gt Plug in Parameters Menultems Description Refers to the XML describing the context menu entries Syntax String Default Context Plug in tag Version 5 0 0 Defines the XML snippet describing the context menu Please refer to the FS Contrib package if you want to modify or translate the context menu NeptuneLabs FSI Viewer 143 Plug ins Reference Plug in CustomButton Plug in Target User interface Plug in Location plugins custombutton plg Function Custom Button 1 d Custom Button 2 Adds custom buttons to the menu bar Syntax Plugi
252. utton of the plug in Mode n Description Removes the button for mouse mode n from the menu Syntax Boolean Default Context Plug in attributes Provides the possibility to hide specific mouse mode buttons in the dropdown menu Remove Drag Button Plugin src mousemodes Model false NeptuneLabs FSI Viewer 183 Plug ins Reference The example above shows how to hide the button for mouse mode 1 Drag Mode n Mouse Mode Mode0 Zoom Model Pan Mode2 Rotate 3D X Y Axis Mode3 Rotate 2D Z Axis 184 NeptuneLabs FSI Viewer Plug ins Reference Plug in Music Plug in Target User interface Plug in Location plugins music plg Function Adds streaming background music or sound to the FSI Viewer Syntax Plugin src music song music mp3 autoplay true gt The Music plug in adds a background sound or music to FSI Viewer Additionally a button will be added to the menu bar to switch the music on or off Plug in Parameters MenuOffset Description Indentation of the menu button Syntax Number Default 0 Context Plug in attribute Specifies the space in pixels left of the menu button of the plug in AutoPlay Description Start playing the sound on startup Syntax Boolean or String Default false Context Plug in attribute Set the value to Boolean true to make the sound play on startu
253. utton state will be set accordingly Alpha L Description Defines the opacity for all HotSpots Syntax Number between 0 100 Default 100 Context Plug in attribute or HotSpots tag Defines the opacity for all HotSpots from 0 invisible to 100 opaque BaseURL Description Prefix for relative HotSpot URLs Syntax String Default Context Plug in attribute or HotSpots group tag Defines a prefix that will be applied to all HotSpots containing relative URLs This way you can omit e g the domain in URL attributes of subsequent HotSpots 152 NeptuneLabs FSI Viewer Plug ins Reference Events Description Enable J SBridge events for HotSpots Syntax Boolean Default false Context HotSpots Version 5 0 4 Enable to fire event notifications for HotSpots via JSBridge The following events will be fired 1 hotspots_MouseOver 2 hotspots MouseOut 3 hotspots MousePress 4 hotspots MouseRelease The event value for event 1 3 is the hot spot s tool tip or if defined the hot spot node s id attribute The event value for event 4 depends on the hot spot action and can be the value of the URL attribute the area to zoom to the cfg parameter of a new configuration file to load the value of the Selectl mage attribute Library Description Default fill opacity for the HotSpot areas Syntax Number Default
254. ve Set this parameter to true if you want FSI Pages to display link shapes during flip animations Showing links decreases the performance of the flip animations LinkFillAlpha Description Opacity of the link area Syntax Number Default 0 Context Pages plug in node or HTTP query prefixed with pages Version 3 5 0 or higher Specify the opacity of the link areas from 0 no fill to 100 opaque The color corresponds to the color of the link area s border color LinkRGBANormal Description Color and opacity of links in normal state Syntax RGBA Default 0000FFFF Context Pages plug in node or HTTP query prefixed with pages 8 digit hexadecimal number specifying the color and opacity of links on the pages in normal state in the form RRGGBBAA E g FF0000FF for opaque red or 00FF0099 for semi transparent green LinkRGBAHover Description Color and opacity of links in hover state Syntax RGBA Default FFOOFFFF Context Pages plug in node or HTTP query prefixed with pages 8 digit hexadecimal number specifying the color and opacity of links on the pages when the user points at a link in the form RRGGBBAA E g FF0000FF for opaque red or OOFF0099 for semi transparent green LinkRGBAActive Description Color and opacity of links in active state Syntax RGBA Default FFOOOOFF Context Pages plug in node or HTTP query
255. vely you can click on the image without marking a segment The image will then be magnified in steps To zoom out in steps hold down the CTRL key and click on the image Mouse Pan Choose this function to pan the image using the mouse Click on the image and drag in the desired direction To return to the original view hold down the CTRL key and click on the image ete Mouse Turn Choose this function to rotate the image around the z axis Click on the image and drag in whatever direction you want to turn the object to the right or the left To reset the rotation hold down the CTRL key and click on the image ou Mouse Rotate only for 3D presentations Choose this function to rotate the object around the y axis or the x axis if available Click on the image and drag to the left or to the right Move the mouse up or down to rotate the object around the x axis To reset rotation hold down the CTRL key and click on the image Additional Buttons Hide Display menu Displays or hides the user interface Fs Viewer Information Displays information about the viewer and refers to a configurable help page Parameter HelpURL Using the navigator window In the navigator window you can see a miniature presentation of the entire image The segment which is currently viewed is framed in red In the navigator window you can change the current segment either by dragging the frame or by clickin
256. ver here You can receive this URL and a ZoomCache ID from your image hosting provider ZoomCachel D Description ID of the ZoomCache access profile Syntax String Default Context Options When using NeptuneLabs ZoomCache enter the name of the access profile for your images here You may have several profiles i e if you use watermarking or different imaging servers I gnoreQuery Description Ignore all parameters passed via query except cfg Syntax Boolean Default false Context Options Ignore all parameters passed via HTTP query except for the cfg parameter This way you can entirely disable modifications to the FSI configuration by query NeptuneLabs FSI Viewer 37 Configuration IgnoreQueryParameters Description List of parameters to ignore in queries Syntax String Default Context Options Version 5 0 4 or higher A comma separated list of parameter names that should be ignored if specified in the HTTP query Example IgnoreQueryParameters value language skin gt would prevent specifying the skin and language by HTTP query Please note DefaultCfg Cfg and Debug parameters cannot be disabled using this parameter this parameter itself cannot by specified by query MaxZoomLevel Description Load image details at maximum zoom Syntax Boolean Default true Context Options Ver
257. your FSI Viewer Check the default fsi file for XML syntax errors Error Loading fsi failed or Error FPXSrc undefined Please make sure that the configuration file defined by the CFG parameter is valid Please make sure that the FS Base parameter in the _default fsi file points to the correct directory Please check the XML syntax of the corresponding FSI file Error The Viewer stops displaying the message Loading Skin and FSI Module Please make sure that all files have been uploaded to the location provided when ordering your FSI product Check the skin parameter and make sure it contains an existing skin file name without any file extension Error The Viewer stops displaying the message Opening FPX Please check the given path to the source image file on the imaging server Adjust the parameters FPXSrc or FPXBase accordingly Error Viewer stops displaying the message Loading Plug in Please check the Src parameter of the specified plug in Make sure that the corresponding plug in file exists in the plugins subdirectory of your setup directory of your web server Error The image appears entirely black or distorted 226 NeptuneLabs FSI Viewer Error Messages This might happen due to an error during the conversion of your image to the FPX format Please make sure that the source image has not been saved in grayscale mode and that it does not contain multiple alpha channels Be sure to save the

FSI documentation - eRez Imaging Server Login

Contents

Download Pdf Manuals

Related Search

Related Contents