Home

Viewer - ViewFX

1. 94 NeptuneLabs FSI Viewer FSI Pages Add on DefaultLinkTip Default tool tip for links on pages Use this tool tip for all links on the pages if no tool tip has been specified in the page data LinkTemplates Template identifiers for link URLs strings 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 to 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 Values to replace template identifiers in link URLs String s Context 1 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 smal
2. Plug in attribute If enabled the frameborders will be animated peut re SSS contea nemme OOO Enable rotating the selection by pressing ALT key or ALT SHIFT keys and dragging the handles of the select box masco OOOO pe mm Coen nengen Define a 6 digit hexadecimal color value for the mask of the select box MaskAlpha pe mn Defines the opacity of the mask of the select box 0 invisible NeptuneLabs FSI Viewer 211 Plug ins Reference AspectRatio Aspect ratio of the selection Defines an aspect ratio for the selection e g 320 200 Use SHIFT to lock or unlock the aspect ratio when resizing the selection emm OOOO pe ne context parmi SOSCSC S S S S You can use this parameter to invert the function of the SHIFT key while dragging JavaScript callback function Specify the name of a custom JavaScript 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 JavaScript callback function function onSelect set scene l strView doSomething Additionally you can as use the template selections s for the CustomButton plug in Send plug in event notifications Get Ines Specifies whether the plug in send plug in event notifications Plug in events can be handled when u
3. 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 does 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 NeptuneLabs FSI Viewer 49 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 fal
4. 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 290 Context Pages plug in node or HTTP query prefixed with pages_ 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 defined in the real time template used with FSI Viewer see parameter PrintTemplate Description Image effects for the image to print Contest Pages plug in node or HTTP query prefixed with pages Defines image modification parameters to apply to images used for printing The value of this parameter depends on the imaging server being used With FSI Server you can sharpen the image and define the JPEG compression level e g ef fects sharpen 230 amp quality 95 PrintTemplate Real time template for the image to print FSI Server and eRez only peut Defines the FSI Server profile or eRez real time template used to load the print image By default FSI Pages uses the default real time template fsi 102 NeptuneLabs FSI Viewer FSI Pages Add on Description Enable disable saving of pages Pages plug in node or HTTP query prefixed wi
5. cdocumenia alu nomvwiie wer oct faneiclodken i TCMD te i NeptuneLabs FSI Viewer 163 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 0 3 Zoom to a specified image section eg 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 available 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 et ResetVewer Zemin Lnaman SSS Zomo Lnatmast SSCS E Gem Start panning downwards SSS Right Startpanming tothe night rNextscene Startrotatng dockwise Vax SSS __DebugWindow Show Hide the debug window if available Show Hide the about window if available NextImage Select next Image Select image n Important Use SetVariable newImageIndex n
6. gt lt LinkTemplates value SESSION DATE gt lt lt 2 Leia EE St 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 ur 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 _FSI_CURRENTPAGE_ 1 based index of the current 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 72 NeptuneLabs FSI Viewer 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 viewercom 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 Plug
7. lt Plugin src notepad gt Add or delete bookmarks ii m Enterprise editions of FSI Viewer contain this plug in by default 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 Bookmark current page s FSI Pages Bookmark product link Bookmark image section Bookmark current image Bookmark image section of the current image Bookmark entire image 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 application 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 UniqueID or use the Notepad plug in parameter Please refer to the UniqueID 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 bu
8. 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 NeptuneLabs FSI Viewer 93 FSI Pages Add on ForceLinkTip Description Force a tool tip for all links on pages 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 Context 1 Pages plug in node or HTTP query prefixed with pages_ 3 6 0 or above Use this URL for links if no URL has been specified in the page data DefaultLinkTarget Default target frame for all hyperlinks on all pages Use this HTML target frame for links if no target frame has been specified in the page XML data DefaultJavascriptTarget Default target frame for all javascript hyperlinks on all pages Content Pages plug in node or HTTP query prefixed with Dages Use this HTML target frame for javascript links if no target frame has been specified in the page data DefaultLinkUriPrefix DefaultLinkUrlSuffix Default prefix suffix for link URLs on pages Use this prefix or suffix for all links on the pages if no prefix suffix has been specified in the page data
9. EID The resulting address 1 gt http domaim com fs server7source tolder image t if 2 PeEXBase 1s moe Used for absolute addressing lt FPX gt lt SROC value http domairn com tsil server eour ce pro o image L T lt FPX gt Display a thin border around FSI Viewer The default value is false displaying no border Enter one 6 digit hexadecimal color e g FFOO00 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 Defines a crop rectangle Coen pm Crop rectangle left top right bottom as 0 1 floating point values Default 0 0 1 1 26 NeptuneLabs FSI Viewer Configuration Description Alignment of the menu bar version 1 4 TL from version 5 BC Context ges The center option C is available from version 5 0 0 Possible values TL top left TC top center TR top right BL bottom left BC bottom center BR bottom right Language EE emeng kom 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 pe fee Coen mee Show or hide the optional pan buttons on the ima
10. Viewer 5 5 Let your website visitors have a closer look User Manual FSI Viewer e Pages Add on Showcase Add on e Plug ins FSI Viewer FSI Plug ins FSI Pages Add on FSI Showcase Add on Developed by NeptuneLabs GmbH Detmolder Str 210a D 32791 Lage Germany 2003 2009 NeptuneLabs All rights reserved Last updated July 2009 FSI Viewer Version 5 5 FSI Pages 5 5 FSI Showcase Version 5 5 Manual Revision 044 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 lg ee Te Lei o Le RE 7 Compatibility and User System Requirements cccsececeeseeeeeeeeeeeeesesseeesenseaeseteeeeseness 7 STING Fey NN WC lea eeads haseeceeress E a EE E 8 Te ie Gi TEE 8 VOUS lee 9 Additonal Claren EE 9 Using THE navigator WINGOW EE 9 KEV DOIG ION ei zirra E 10 SO CUD EE 11 Index Structure of FSI ENEE 11 SEEING UD Sls VIGW EE 12 Licencing FSE VIEW CL xsziveteuusesoesedwatiecs vetemuasin somone ce sivesieaeewhesantonmaueeeedanedunaeoveseusnednseees 13 Integration Into HTML PaGeS iissiicacsvccinsevinavcncnvsdeenenncwnsdeensscecusesuanspseansenacewduinnewas 14 Required Fl MIs ere ee EE 14 Belle e d e TB 15 Using XML Configuration Fles EN 15 USMO AFIP CCIE E 17 Hierarchy of Configuration Parameters cccscsscessesrcessenreereenseeseeuecereenecusneneansneneanss 18 Connoura
11. lt Plugin sre jsbridge gt EE E 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 QD The JavaScript Bridge plug in provides a scripting interface to control FSI Viewer using JavaScript Using the JavaScript bridge you can control viewer functions like ZoomIn 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 JavaScript is required to use JSBridge plug in especially regarding browser dependent JavaScript implementations Implementing the JavaScript Bridge plug in 1 Add an ID attribute to your FSI Viewer Object and Embed tag lt object id fsiviewer classid gt lt embed NAME fsiviewer gt This way you are able to access the viewer object via Javascript 2 Provide the appropriate action via SetVariable command To control FSI Viewer from JavaScript you have to pass the appropriate command by setting the FSICMD variable of the FSI Viewer movie clip using the SetVariable function Example Button Zoom In MSIE SE ype Sli Eent ni onMouseDown document all fsiviewer SetVariable FSICMD ZoomiIn onMouseclper
12. PUGIN MUSI G a a A ATA ba nc saan ad asap eae ate 187 SIE Ki WV EVTL EE 189 lie ki lei dee 191 PIUG Ihi PaGeSMIMOF EE 199 Plug in GE lee e 200 PIUG In Pages TNUMPBSP EE 201 Ile Et Ri lie 206 WI le bat H GK 209 Ile Kal RE eg FANG EE 210 Ile Et Binet ell Le UE 214 Ile Kale Reine El Te EE 218 le Elo Bleu e 219 PUG Etoile rte TEE 222 Hl Le Gol WC 10 EE 224 Ile kel BE OOM IMGUSN EE 227 Error EL E 228 vie ET EE 230 FO CONID PACK AGC EE 230 Escaping or URL encoding parameter values NENNEN 230 HTML Tags available in FSI VieWer ccccscscsccsersccsecneceeeuecuseenscrsueuecrsueueersesueansnsness 230 Example ofa default TSI il E 231 Example of an image specific FSI configuration file ENNEN 231 e EE 232 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 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 A
13. This chapter describes how FSI Pages assembles link URLs and the hierarchy of link parameters in general Example Hierarchy of LinkKURL parameters and attributes Parameter XMLAttribute Location Description East FSi Pages parameter Force this URL Tor ALL inks um aroe rs Ooo oo beru Late Default URL for al hid Tinks Gerten FS Pages parameter Default URL forns 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 lt area gt node does not contain an URL attribute FSI Pages uses the DefaultURL attribute of the parent lt links gt node If this attribute is undefined FSI Pages uses the global FSI Pages Parameter DefaultLinkURL tip The same process applies to the target prefix suffix and javascripttarget parameters ForceLinkTip DefaultLinkTip DefaultTip or a child node ForceLinkKURLPrefix DefaultLinkURLPrefix URLPrefix ForceLinkURLSuffix DefaultLinkURLSuffix URLSuffix we 70 NeptuneLabs FSI Viewer 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 I joule lt Area URL http www fsi viewer com gt lt Area gt EE lt Page gt Resulting URL http www fsi viewer com The same applies to special URLs like javascript
14. 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 Description Offset from the right of the viewer instance 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 Margin from the top of the thumbnail bar Contest 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 128 NeptuneLabs FSI Viewer FSI Showcase Add on MarginBottom Description Margin from the bottom of the thumbnail bar 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 Description Margin from the left of the thumbnail bar 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 scrollbar of the thumbnail bar
15. This way you can omit e g the domain in URL attributes of subsequent HotSpots 154 NeptuneLabs FSI Viewer Plug ins Reference Enable JSBridge events for HotSpots pe ne 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 SelectImage attribute Library Default fill opacity for the HotSpot areas Debt 1 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 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 Default target for hyperlinks String Default blame o O Context Plug in attribute or lt HotSpots gt group
16. 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 EE iSO soo 2 lt Cross EE EE EA RE EEE lt CxrOss clomeaio oo licy 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 image specific parameter values automatically Relative path to a configuration file fsi swf cfg FSI_Name Context HTTP query A relative path to an XML based configuration file fsi The file extension Te has to be omitted You can specify a default base path to all configuration files using the FS Base parameter Defining a configuration file lt PARAM name movie VALUE fsi swf cfg foobar g
17. navigator userAgent indexOf Windows 1 amp amp navigator userAgent indexOf Windows Sl ale document write lt SCRIPT LANGUAGE VBScript gt n docum ne write on error resume merce an E De vri e Ent tsiviewec E oona Era a eea ByVal Eet ue Cocumen ewi e Call reiia DOr E EE document nrile lend subni document vrir e CRIPT onn lt 7 Semi NeptuneLabs FSI Viewer 167 Plug ins Reference After following the 3 steps described before you will receive the following event notifications Event fsi_event Parameter params The viewer has finished parsing the configuration and InitComplete a is about to start loading image data Imaqelnfo Strin Provides concatenated image information g g See details below this table LoadingComplete PS The initial load progress of an image completed LoadProgress Number percent else corresponding to the progress bar inside FSI Button ID The button ID has been pressed Button ID The button ID has been released The tool tip String is about to be displayed Teale string escaped See details below this table l The image section currently displayed Moge Serugn Can be used with the Goto command Provides a template that can be used to build an image URL corresponding to the image being URE EmpialE displayed in FSI Viewer See details below this table Achen Action ID The action ID is currently being executed The viewer enters a passive t
18. onMeasure String The parameter provides the current distance and angle as displayed in the measure tool The user stopped measuring onMeasureStop The parameter provides the current distance and angle as displayed in the measure tool 182 NeptuneLabs FSI Viewer Plug ins Reference Plug in Mousemodes Plug in Target User interface Q W y 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 Indentation of the menu buttons Plug in Tag Specifies the space in pixels left of the menu button s of the plug in Removes the button for mouse mode n from the menu bar Boolean Plug in Tag Provides the possibility to hide specific mouse mode buttons Remove Drag Button lt Plugin src mousemodes Model false gt NeptuneLabs FSI Viewer 183 Plug ins Reference The example above shows how to hide the button for mouse mode 1 Drag Rotate 3D X Y Axis Rotate 2D Z Axis Sequence Description Sequence of the buttons Syntax String 0 1 3 2 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 th
19. 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 Indentation of the menu button Specifies the space in pixels left of the menu button of the plug in pe fee Coen Pugna Defines the initial visibility of the magnifier beaut Jo oa Defines the overall size of the magnifier Possible values are between 4 and 16 Please note that greater values require more CPU power 174 NeptuneLabs FSI Viewer Plug ins Reference Magnification Level of magnification Plug in attribute Defines the level of magnification where 1 means no magnification 2 means a magnification of 200 and so on The maximum level of magnification is 8 Show true or hide the handle of the magnifier glass HandleSize Size of the handle in percent pe mm Size of the magnifier handle NeptuneLabs FSI Viewer 175 Plug ins Reference Plug in MaxZoom Plug in Target User interface Plug in Location plugins maxzoom plg Function Zoom to physical resolution of the image Syntax lt Plugin src maxzoom gt The MaxZoom plug in expands the user interface by
20. tags 132 NeptuneLabs FSI Viewer FSI Showcase Add on LabelTextFont Font used for thumbnail label texts pe em 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 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 Margin above below the thumbnail text 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 Adjust vertical position of the thumbnail text Content 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 Display thumbnail labels right of the image Contest Showcase plug in node or HTTP query prefixed with showcase_
21. the user s system LoadXMLPrefix Prefix to use for the LoadXML parameter You can use this value e g in the _default fsi configuration file to specify the server address and folder to load XML notepad data files from Example http foo com notepaddata SendXMLStoreURL URL to post notepad data to URL of a web server receiving the notepad data in XML format See Loading and Posting Data on the preceding page for details SendXMLUrlSuccess URL to open if sending XML data succeeded Url to open if sending the XML data to the web server specified by SendXMLStoreURL parameter succeeded SendXMLUrlFailed URL to open if sending XML data failed URL to open if sending the XML data to the web server specified by SendXMLStoreURL parameter failed NeptuneLabs FSI Viewer 197 Plug ins Reference SendXMLUrlSuccessTarget SendXMLUrlFailedTarget HTML target frame to open the URL in Get mn O HTML target frame to open the SendXMLUrlSuccess or the SendXMLUrlFailed page in Plug in Parameters Advanced Customization_Customizing Image 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 The syntax of these parameters therefore corresponds to the FPXSrc parameter If you specified the FPXBase parameter you only need to provide the pa
22. where n is 0 images prior to sending this command SelectImage Alternatively you can select an image relatively from the currently selected image To select an image relatively you have to set newImagelIndex to a number prefixed by or e g 1 selects the next image SwitchThumbs Show Hide Thumb bar 164 NeptuneLabs FSI Viewer Plug ins Reference Go to page n Important Use SetVariable newImageIndex n where nis 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 newImagelIndex to a number prefixed by or e g 1 is the same as NextPage Print L asgeeienmgea SSS save Open or dose the save dag SSCS eg open or dose the searching SSC S 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 empty string Release previously pressed button Activate mouse mode n 0 Zoom 1 Pan 2 Rotate 3D 3 Rotate Z axis Mouse_Mode_n There might be more mouse modes available depending on loaded plug ins Re
23. BE 45 mages3DURLBASE EE 45 Une EE 168 ImageWidth ak 123 177 191 JING E 79 IndexMarginWidth Ak NN 136 TAO TOI ei EL 39 WaN ICW ee 28 ee Le d e EE 29 InitialACtionDelay cccscsceeseceeeesereeeeenseneeass 29 Intial AcHonbereistent uk 30 Initiallmage ee 118 Initial MOUSEMOde ak 30 INI AIP AGC E 78 Uwe EEN 117 InmtalViewbersistent E 29 ig e DE 24 TW GF ES gege 210 ItemButtonsBackgroundColor cccseeeees 192 Keep ut let ge BEE 132 della EE 80 KCC SUGGS ege 186 Klees 129 LabelMargGinBottOM ccsccscsceeseseeeeeseeeeens 131 NeptuneLabs FSI Viewer LabelMarGinTOp sccccssaressecurersseseararseseeaes 131 ADE glel el 129 LabelOffSetLlett cccccsccsecseeseecesenssneseeees 132 aaen geed 131 LADEIONRION EE 131 leie enei neeaT 130 LabelTemplates cccccssesesneceseesesneneeneates 129 Biet ug We IEN 130 PADCITEXTC OlOlesicaticciacincsinaca cet tenteeetandens 131 Biel e lt E 131 LabelTextHeigGht cccsccscsessecesnesssneassneanes 130 Kee Eege eegene Eeer 129 Belle Le BEE 130 Rief Lat 27 OH sssrinin a E 116 B ll EE 149 LDV ALY EE 198 216 LNECOIO Paaa a 139 178 Line wiat VE 171 Ri ell el EE 91 LINKRGBAACIVG E 91 LINKRGBAHOVER E 91 LINKRGBANOSrM dl uh 91 LinkTemplateData ccccssessesceseureeeeenearenees 94 LINKTEMPIAteS cssecscereesecseceseeseaveesecuearenees 94 Bogis EI EE 75 121 LoadXA ML BEE 195 LOAGXKML GE 195 LOOD 232 Ss ecpssa dance assent a 149 186 MaAGAINGCA B
24. BaCkCOVerConnd WEE 84 Back overlmage cscsssseeeseeacseeenseecesneensees 83 BACKOrOUNO EE 122dasd BackoroundAlphba uk 122 170 BackgroundColor s ssssssssesssssnsrsrrennn 170 191 BackgroundGradientAngle ccceeeeeeeeeees 191 BaSeCOlOr een 223 BASCCOION eegene 116 BaSCOCAl EE 116 BaseUR EE 152 Scene GE 85 BendEffectIntensity ccscsscsessreseceeseeneeeeaes 85 SET le E EE E 179 223 SEI e Lee 179 223 BIANKBACKCOVES sccscersessesveuseeseaneeeecuearenses 83 BIANKEFONTCOVER vcisiericiiseviescrcidirmesichivaaneaveain 83 SIE 141 UE Eege 197 BOGE e 224 BOrdel e e EE 224 BORGER VVIGEN SE 224 BIGNESS sin vasa N 141 BUROS aeaa 144 ButtonsFirstLastPage ccceccecseeeeeeeeeeeeeees 96 CAND ACK EE 168 210 CVG EEN 22 Ke 158 ClICKPAGETOZOOM NEE 81 E ee 157 217 225 Ge 6 e D 139 ele le 139 Colored ING OX E 136 COlOrHIONNONE corneas 218 elle lee ee TEE 218 Conc rrentReqUEStS iisen iriiri naiai 40 COOrdS E 156 Belt e UE EE 171 CTODBOUOM EE 106 CODING EE 107 Srel 106 n ele EI TE 107 COD RE Cl E 26 CEODRIOMIE Ee EN 106 Crp aile VE 132 COD TOD E 106 233 234 DECIMAIS soa E 177 BISITE a C E A E E 22 DetautColo esa 154 Default sarii 154 DefaultFillAlpha ANNER 153 155 Default ee ee 154 DefaultJavascriptTarGet E 93 DefaultLinkTarQet ccscsscssceeserseecesateeeeeeaes 93 PSTAUIELINIKAAD WEE 94 Baeifilebiv NC E 93 DefaultLinkUrIPrefix AANEREN 93 DefaultLinkUrISUfPix icara 93 DefaUltMOVE
25. Content 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 118 NeptuneLabs FSI Viewer FSI Showcase Add on Initial size of the thumbnail bar Size in pixel or percent or in number of items 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 horizontally 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 Display a horizontal scroll bar if required Deut feas OOS 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 Resizable Fixed or Hidden Detam reann OOO 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 res
26. FORCEX MED ataFileS EE 82 FrONICOVO eegen 83 Steiler Seine DH 84 FrontCover Image NK NEKNKSERKE NENNEN ERKENNEN NN NK NN RE SE SEIT e Ae EE 83 FUIFFONECOV EF rana AT 83 Far PAGES E 84 wll Le CB 87 el Deen VU DEE 95 TdI AUtTOTUPNDelay csccecsecsecseseccesersnsensenseesasonsans 95 TdI AUTOTUPMMaXxPaGe cccseceeceeencoesarsneonsensatsnseneans 95 IdleAutofurnMmbage EE 95 neet le EE 86 TMG OX EE 79 Ileal PAGS EE 78 KEG INGO EEN 80 Biel NEE 91 Alves eg UE 91 NeptuneLabs FSI Viewer Biver e TEE 91 LINKRGBANOSMadl ea a 91 LINKTemplateData ccccscceecesseseeceseesarensenearsueeneatens 94 LINK TEMP IAS sanira a a tuys 94 HSE LEMIDIALG E 75 Mile ei lu EE 88 Mardin e 88 MarginRIONU EES 88 Miel TOD WEE 88 DT LEE 94 Die at 100 PageBackgroundI mage EEN 84 PageBackgroundIMagGeEffects ANN 84 PageBorderColor csccssecssesccseccreceusnenevereeeuseesavenseeses 87 PagecacheliMit assier E 99 DaoeC achebemove mme ANNER 99 Elei 86 Page IN DU E 96 PageLogDEla VE 97 PagekogTarget asrar e a a 97 Sie Ee e YURE EE 97 PageMarGiINBottOmM ccceccceceseeeeeeeeeeeeeeeeeeeeeeeeeeseees 88 leie ele ln EE 88 PageMarGinOuterr EE 88 PAGE lal GIN OD EE 88 Biel Din ee 89 Klein CERN 90 K iel I iu L ele 89 George dee tate aetna 89 PAGENUMPOS EN 89 PAGE NUIMISI ZG EE 89 PAaGeGOrderR Ta EE 79 PAGEOV CUIAYS ia n NA Ni 99 PageOverlayShowzoomed NEE 100 Pa Qe UNS Pee EE 80 PreloadBaCkward scsscscsscecceseeeee
27. Pan 2 Rotate 3D 3 Rotate 2D Some plug ins provide additional mouse modes Please refer to the corresponding plug in reference for details pe ne Goen m SSCSC S S S S SC S S S s S S Set this parameter to true if you want to enable the user to zoom by clicking the image while mouse mode pan is enabled ament OOOO pe me Coen pm OOO If you set this parameter to false the default arrow cursor will be used instead of the hand cursor when hovering over the image or the navigator window Maximum magnification pe me Coen m CCSC S S SC S S Defines the maximum magnification in percent relative to the source image The default value 100 permits magnification to the physical resolution of the source image Possible values are 1 to 1000 NeptuneLabs FSI Viewer 31 Configuration Minimum magnification 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 pe ne context lt optonss SSCSC S S S SC SSSSSS 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
28. Reference Information Close Resize or Restore ema me You can add your own graphics to be used as a label for custom buttons Please refer to the FSI 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 JavaScript function or a server side script Templates in CustomButton URLs Plugin Sre CUS ombron i soulLeons bre prnl EE Ee EE e The example above outputs the size of the source image via JavaScript 148 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 fg N Be cede Name le server using this template as well E g SScfg FPXWidth returns the size of the source image whether specified manually or retrieved from the imaging server A string representing the current image section in FSI Viewer see Parameter NEMS ETS InitialView
29. Set this parameter to true to display thumbnail labels right of the images instead of below the thumbnail images NeptuneLabs FSI Viewer 133 FSI Showcase Add on LabelOffsetLeft Adjust horizontal position of thumbnail text Default 10 Contest Showcase plug in node or HTTP query prefixed with showcase_ 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 Load all thumbnail images on startup 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 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 KeepImageSection Description Preserve the view when selecting thumbnails Deut me Content Showcase plug in node or HTTP query prefixed with showcase_ Usually FSI Showcase displays the entire image or the image section specified by the parameter InitialView when selecting
30. 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 UniqueID Example URL http foo com log php catalog foo amp page pagenum amp iid 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 PageLogTarget Description HTML Target Frame to open the PageLogURL in Default interno o Context 1 Pages plug in node or HTTP query prefixed with pages_ 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 Page View logging delay Number milliseconds Pages plug in node or HTTP query prefixed with pages_ 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 98 NeptuneLabs FSI Viewer FSI Pages Add on Advanced Parameters RememberLastViewedPage Store the most
31. a button to quickly zoom to the physical resolution of the source image Plug in Parameters Specifies the space in pixels left of the menu button of the plug in 176 NeptuneLabs FSI Viewer Plug ins Reference Plug in Measure 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 GER value 100 gt ee 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 image 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 lt plugin src measure ImageWidth 120 5 Suffix inches gt Please note You might as well define all plug in parameters via query or insid
32. a thumbnail Set this parameter to true to if you want to preserve the image section you are currently viewing when selecting another image 134 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 135 Plug ins Reference Plug in BackgroundImage Plug in Target Viewer background Plug in Location plugins backgroundimage plg Function Adds a background image to FSI Viewer Syntax lt Plugin src backgroundimage FPXSrc images bgimage tif gt 0 4 4M MEO p gt ZZ 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 specified image so that the entire area of FSI Viewer instance is filled with the background image Plug in Parameters Relative path to the image on your imaging serv
33. 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 Default Defined by parameter BaseColor Contest Showcase plug in node or HTTP query prefixed with showcase_ Color of the background of the thumbnail bar BackgroundAlpha Get me context Sous DE node or HTTP query prefixed wih showcase Defines the opacity of the thumbnail bar background from 0 invisible to 100 opaque Base color of the scroll bar Default Derived rom Baseolor SSS S S Context Showcase plug in node or HTTP query prefixed with showcase_ Defines a color for the scroll bar Color of the track bar of the scroll bar Default 1 Derived from Seolas OSS Context Showcase plug in node or HTTP query prefixed with showcase_ Defines a color for the track area of the scroll bar Color of the arrows of the scroll bar Default Derived from ScrollBaseColor 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 124 NeptuneLabs FSI Viewer FSI Showcase Add on DragBarHighlight Highlight color of the drag bar Default Derived from BaseColor Context Showcase plug in node or HTTP query prefixed with showcase_ Defines the highlight c
34. at a link in the form RRGGBBAA E g FFOOOOFF for opaque red or OOFFO099 for semi transparent green LinkRGBAActive Color and opacity of links in active state 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 clicks a link in the form RRGGBBAA E g FFOOOOFF for opaque red or OOFF0099 for semi transparent green 92 NeptuneLabs FSI Viewer FSI Pages Add on ForceLinkURL Force URL for all links on pages Force FSI Pages to use this URL for all links on all pages This overwrites any URLs specified in the page data ForceLinkTarget Force a target frame for all hyperlinks on all pages Content Pages plug in node or HTTP query prefixed with pages_ 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 javascript and mailto links ForceJavascriptTarget Force a target frame for all javascript links on pages 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 affect URL and mailto links ForceLinkUrlPrefix ForceLinkUrlSuffix Force a link prefix suffix for all links on pages Context Pages plug in node or HTTP query prefixed with pages_
35. 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 NeptuneLabs FSI Viewer 71 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 values 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 Commgurarom Plugim lt Plugin src pages
36. color of the arrows inside in the thumbnailbar ArrowLineColor pe fee Coen reng The fill color of the arrows inside in the thumbnailbar DropShadow Default ne contee Pagesos OO Enable Disable the drop shadow effect of the thumbnails Size of thumbnail images Defines the height of the thumbnails in the thumbnail bar The width is derived from the image size 202 NeptuneLabs FSI Viewer Plug ins Reference HideOnZoom Description Hide thumbnails when zooming Pages ThumbBar When enabled the thumbs will be hidden if an image is zoomed into MagnifyCurrentPages Description Size of thumbnail images Default 100 Pages ThumbBar Version 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 PagesThumbBar Defines the bottom margin of the thumbnail bar MarginTop Margin of the thumb bar Defines the top margin of the thumbnail bar Offset of thumbnail bar Defines the offset of the thumbnail bar NeptuneLabs FSI Viewer 203 Plug ins Reference OffsetRight Description Offset of thumbnail bar Syntax Number Pixels Pages ThumbBar Defines the offset of the thumbnail bar Padding Thumbnail Padding Default Im Defines the distance between the thumbnails SelectionBorderWidth Border of th
37. display The color has to be defined as a 6 digit hexadecimal number E g FFFFOO for yellow Display the current magnification in percent of the viewer size false or relative to the size of the source image NeptuneLabs FSI Viewer 227 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 lt object gt and lt embed gt 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
38. fversiton 6 0 765 0 width Waidth herght 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 EMBED name application x shockwave flash PLUGINSPAGE http www macromedia Coll SMOC kuon e dowmload mdex eq NE rod erst om shockwave a lash Soke EE and Parameter WLDEH Wadih EE Heaghe BGCOLOR Background color MENU ralse ALLOWSCRIPTACCESS always ALLOWFULLSCREEN true QUALITY high gt lt EMBED gt SS Ob gece 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
39. 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 O image extra line breaks will be needed Plug in Parameters wan OOOO Delay before displaying a tool tip Number milliseconds 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 171 Plug ins Reference Description Display a drop shadow S Boolean true Plug in node or HTTP query prefixed with largetooltips_ Display true or hide false a drop shadow for the tool tip box Background color of the tool tip box BackgroundAlpha Description Opacity of the background of the tool tip box Plug in node or HTTP query prefixed with largetooltips_ Defines the opacity of the tool tip background from 0 invisible to 100 opaque 6 digit hexadecimal color value specifying the highlighted top left part of the tip box border ShadowColor Border shadow color 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 172 NeptuneLabs FSI Viewer Plug ins Reference Description Thickness of the tip
40. might lead to increased traffic and decreased download performance as more image data than actually required for a certain image section will be loaded InfoTemplate Get min SSSCSC S SsSSSSS contea Leer raias zm OOOO Specifies the configuration template used to retrieve image specific data from FSI or eRez imaging servers You might want to specify a custom template if you want to retrieve IPTC data for all images MetaDataQueryParameters HTTP Query to append to meta data requests Coen zo OO An optional query string of the form a 1 amp b 2 amp c 3 to append to meta data request to FSI or eRez Imaging server These query parameters will be appended to info and list requests passed to FSI or eRez server NeptuneLabs FSI Viewer 39 Configuration ConcurrentRequests Number of simultaneous image requests C en me Specifies the number of image details image tiles being requested simultaneously Please do not change this value unless you 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 EE EE 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 d
41. mme o e e e d mme e e mme ves e ERC mage Collectns vs 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 FPXTilesxX 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 FSI or eRez server you don t need to care about the requirements below as the default setup of FSI Viewer in imaging server ensures communication between server 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 FSI server 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 their 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
42. not defined separately see Advanced Parameters BaseScale Description Scale of thumbnail images Number 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 Defines the way FSI Showcase integrates into the viewer outside inside or floating Default outside Showcase plug in node or HTTP query prefixed with showcase_ e Outside default The showcase occupies the entire height 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 e 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 e 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 Position of the thumbnail bar left top right bottom Befaute rh
43. 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 Opie lons lt SceneSets value 2 3 5 10 10 1 5 8 gt 3 gt Opt items 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 10 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 Load scenes in high resolution 3D pen Im eent om 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 scen
44. of the showcase Please see the Showcase measurements figures for details MarginRight Description Margin from the right of the thumbnail bar 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 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 Padding of thumbnails inside the thumbnail bar Contest 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 129 FSI Showcase Add on PaddingLeft Padding of thumbnails inside the thumbnail bar Showcase plug in node or HTTP query prefixed with showcase_ This value defines the left padding of thumbnails inside the thumbnail bar of the showcase Please see the Showcase measurements figures for details PaddingRight Padding of thumbnails inside the thumbnail bar Showcase plug in node or HTTP query prefixed with showcase_ Thi
45. recently viewed page locally o fe 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 Jnitia Page has no effect if there is a valid value for the last viewed page You can use ForcelnitialPage if you want FSI Pages to show a specific page independent of the last viewed page Note When using image collections retrieved from FSI 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 UniquelID so that the last viewed page can be assigned to this image collection Default unaefnea qn O context Pages plugin node or HTTP query prefed with pages UO 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 Initial magnification in FSI Viewer Number in percent of the source image or fitWidth or fitHeight 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
46. the file _default fsi resides in the setup directory of 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 FSIBase 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 TT 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 228 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 co
47. 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 Plugini lt Plugin src pages gt lt Print value true gt lt Prin Resolution value O24 7 gt lt Plugin gt Pinoi 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 After 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
48. user clicks the viewer 96 NeptuneLabs FSI Viewer FSI Pages Add on DemoURLTarget Global link when clicking FSI Pages 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 Rotation in degrees of the thumbnail Context Pages plug in node or HTTP query prefixed with pages_ 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 pe fe Coen regen Defines wether the input form for page numbers is shown ButtonsFirstLastPage Show or hide First Last Page buttons Get re Defines wether the navigation buttons for jumping to the first or last page are shown NeptuneLabs FSI Viewer 97 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 Template based URL for page view logging
49. 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 NeptuneLabs FSI Viewer 61 FSI Pages Add on 200 and set compression to 90 is sharpen 200 quality 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 i Leners EE SE EE EE lt SaveAllowSavingImages value true gt lt 2 Leia lt 2 trends gt Without any additional preparation this allows users to download an image of the left or right page 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 onl
50. 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 fi Petrie Pe OeOOSIcieSs LO jlecueS 1 iicom calle EEX lmeces Scesulle myecll eMmemy Seilece Bereet PEN Les H eent Een T where PictureID 1 LE result sete sOmdata SiO Peveme SEH rb assoc See Lit ijk ee RFC1738 parameter encoding EE EE jOeuccMiNSitSie Els Sito Key BE wel SE een re gt Gites Ike Eemeren 6 itor erte Make one large query string SES cileiey unllocde e scuery collection 5 Add Query to FSI Viewer URL EE NeptuneLabs FSI Viewer 51 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 1 GC ICES Sr er e EE EE Sai url fsi fsi swf FPXSrc image fpx amp FPXTilesx 4 amp FPXTilesY 3 EE ERR shemgnt 00 Sbgcolor FFFFFEF Stemplate lt Object classid clsid D27CDB6E AE6D 11cf 96B8 444553540000 codebase http download macromedia com pub shockwave cabs flash swflash
51. 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 The following table lists FSI parameter value types referred to in this documentation String Zoomi ure htp wwfs viewer com Boolean 0 1 or true false 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 gt 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
52. 17 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 lt 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 File name of an SWF containing cursor graphics EE 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 218 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 lt Plugin src stickynotes gt Plug in Parameters AllowMirroredNotes pe ne Coen soos version au When enabled the notes text will be mirrored when the page is turned otherwise it will not be displayed Opacity of the sticky notes Default 1 Defines the opacity of the sticky notes from invisible 0 to opaque 100 Defines the color of the sticky notes FFFF55 Defines the main color of the sticky notes NeptuneLabs FSI Viewer 219 Plug ins Reference ColorHighlight Color of lighter part Defines the color o
53. 18 UseIntermediateZOOMLevells cscecsecereeeeees 40 UseRomanPageNumberSTOPage cscsceceeees 90 Validate EE 137 ENEE 156 237 ViewerMarombottom uk 88 SEICCEFFAME aordi aaa 208 ViewerMarGinLeft sccscsscsecsessteneetsateneeeeas 88 SoftWaleCUrSO EE 216 ViewerMarGinRIGht cccscscsscsesseseseeeesseeetess 88 ge Ak leie 217 ViewerMaroinm Top NNN 88 SERIES eege Ee 220 VIISIDE sinnon 152 172 187 191 208 EE 222 el fun 186 198 ZOOM MELE euer Eege 225 e NEE 23 136 169 191 Relative Addressing NNN 23 24 elle UE 209 Leg len EE 9 10 Eeer 187 EE 46 47 227 XMEBASC ereinen 100 Thumbnail Effects E 119 GE 188 ZOOM D 80 ZOOMAreaAnNiMationSPeedIN ccccceeeeeeeees 81 ZoomAreaAnimationSpeedOut s sssssssserensn 81 ZOOrm reahnimation Tvpe uk 81 ZOOMArea TarGetScale NEE 81 ZOOM CACC see iecties deterrent dey acteesvesiecentoen tes 37 ZOOMCACNE Ds nunnan ie aes 37 Geier IS 31 ZOOM Bug TEE 31 PIUGIN REFEFENCE ccecsecseceestceeeeeneatsereneensass 133 Be E 133 Plugins Backoroundlmage EE 134 Ela E 135 CIOCKPFOGIESS eebe DEE 138 Beleg el RE 141 Bel E 143 CUSTOMBUULON arses 144 S e ge WEE 148 FISCO GE 149 PIOUS DOL EE 151 JSBHGGS eanna EE T 161 LargeToolTipS ccceceneseeecseeneereeceeencareneaees 169 Magnier enee 172 lee EIERE ee eebe 174 M TT 175 MOUSE le 181 Mouse Mode Select csccscseserseesesrsneates 183 Kl Ors neta rire nan ern EIS ric ore SEES ars Per nee 185 NavExtension WEE 187
54. 6 ue UE 115 KeepImageSection ccccccceceeeceeeetenseeeeseeenceeeesees 130 Felen 127 LabelMarginTop and LabelMarginBottom c00 85 129 L aDG IMG naicen naor a a a a bent 127 iso 130 LADEIOMSEETOD WEE 129 Eelere ER 129 Belt sa avcawiavntadesssae A 128 Riet EI 127 LAD TEXCAN GM E 128 Panel TEXECOIOR end ee eu 129 Ei aM RT aian aa 129 NeptuneLabs FSI Viewer Big EE 127 LabelTextWidth and LabelTextHeight cccscceeees 128 Be tonmasseessiadnentin E E A T TS 114 Listem plate E 119 Melle WEE 125 Nie 125 Misler 125 MARGIN OD DEE 124 gll e 117 OH SEULBOUOM EE 124 EISE EE 124 ORMSECRIQMIG EE 124 BE Le EE 124 Padding BOOM NEE 125 PAC GING EE 126 Padding Le e 126 Padding VOD EE 125 PFEIOAGT MUMS eaaa aaa aA AEEA 130 EEN 118 gell ne EE 120 SCrONBaSeC OlON ee ee 120 Solhac K EE 120 E A EE 118 SROWCONTOI S orisa 117 TexXtO tsideFraMe dee 117 ThumbBorderHighlight cccccccseeecseseeeeeeeeeeaeeaeees 123 ThumbBorderShadowW uk 123 ThumbBorderWidth ua 123 POUMDEW CCS ursa a A 117 TAUMDFACE EE 122 ThumbspacingX and ThumbspacingY csceeceeeeeees 121 TOOM PS EE 116 BS E 116 117 FSI Showcase Add on Basic Parameters BaseColor Base color of the thumbnail bar 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
55. Add on NeptuneLabs FSI Viewer FSI Pages Add on Using FSI Pages you can present image collections on line simulating a printed catalog booklet 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 with or without links booklets photo albums and more SS 77 eae 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 ie LUG alias lt Plugin src pages skin silver gt Plugins 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 lt 2 keete lt Plugin src pages MarginLeft 100 zoom false gt EE 56 NeptuneLabs FSI Viewer FSI Pages Add on Providing parameters as child nodes EE lt Plugin src pages MarginLeft 100 zoom false gt lt MarginLeft value 100 gt lt z
56. EE 173 MagnifyCurrentPages csccecsseseeeeeeeseeeees 201 MagnifySmalllMaGes cccccscssesecseeeeeeeseeaes 32 MarginBOottom sicisacvivenscsistaveteineateas 88 127 201 MarOIn BC e 88 127 MAFGINRIGIE EE 88 127 Marom Top NEE 88 126 201 M Ali 209 MEA le 209 M del Tel e 207 MWA EE 207 MaxZoomLevel WEE 38 Mi EE 94 M EL We ln DE 26 Deet Eege 143 MenuOffset 142 144 149 172 174 176 183 185 1 87 194 204 208 MetaDataQueryParaMeters cccsceceeeeeeeeeeeees 39 235 lte Lee 207 MinimizeOnSelect cccseesscseuversseuearerseeseans 119 MAWA BEE 207 Hl CR E 183 MouseVelocity ccccecceseeereneenseeeesesenseeensaes 41 le 156 M vePagE S een 100 VE Ia 218 NaV EI CCIS nacii ccsiistcatannaacraiuaee iced iwsacnneans 36 NEUSS e lee 28 NAVIN ania 28 NavhMackAloha AE 28 NavVMaSKCOIOF EE 28 NAVWICCtN ccceceesscseeeeseeeeseeeeeeseeaesseeesesensess 28 NOIMAGEBIEN cccccesesesecuseeueersesecurareeses 33 Va EVA 27 NOSceneAniMation csscccsesesescsserevsecnseseenes 47 NOSCEMCLOOD E 47 NOS CUEOOD EE 47 EISE 197 OMMSEEBOU OM EE 126 OMSCTECT EEN 126 201 lg le ln EE 126 202 ln Te EE 126 Se elle Le 202 Padding BOROM EEN 127 PACCINGLEPL cccsecsessceessceeseceuseeerseeereenenes 128 PACIGINGRIQIM oesreste a a 128 Padding Rei SE 127 PageBackground mage NNN 84 PageBackgroundImageEffects csscecseeeeeees 84 PagGeBorderColor ccssesssssecveesseuversesscurarseses 87 PaGeCache Limit css
57. FSI Pages to use the same download URL for all pages Please refer to the chapter Printing and Saving Pages for details Add image download options to the Save dialog EC Context Pages plug in node or HTTP query prefixed with pages_ 4 0 0 oF 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 bea Im Contest Pages plug in node or HTTP query prefixed with Dages 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 Image effects for the image to download Context 1 Pages plug in node or HTTP query prefixed with pages_ 4 0 0 or higher Defines image modification parameters to apply to images used for downloading The value of this parameter depends on the imaging server being used With FSI Server you can sharpen the image and define the JPEG compression level e g effects sharpen 230 kou ality o5 104 NeptuneLabs FSI Viewer FSI Pages Add on SaveTemplate FSI Server profile or eRez template to use when downloading images bea a o The FSI Server profile or eRez real time template t
58. HOW Eege Eeer 177 SHOW EE 142 SingleSided EEN 85 e KEE 138 172 EE 157 SK E 24 79 SO E EE 79 SINAN Hi ge EE 150 OMG sees shinee cnc el ei tae et iets 185 SOM EE 137 SPACING E 219 LEE 155 EE 23 52 be ageet Set EE See ee 225 NeptuneLabs FSI Viewer e ag le aarti cea iene eke 197 Igel GH 32 SC EE 177 SV MCMECAS EEN 221 GavpcCoftwaret ureor 220 ET e LE 158 BIS age el EE EEN 178 TextColor ccavessenseenee 139 171 178 193 203 222 TextColorHighlight uk 203 HE A e e EE 171 TEXTOM E 222 TEXtOUTSIGEFAME cccecseuserescseureeeseuearenees 119 TOXUSIZO ee E 171 178 223 ThumbActiveFace ccccceeecueeeevevavereusueenenens 124 ThumbBorderActiveHighlight NN 125 ThumbBorderActiveShadow sscscseceseeeees 125 ThumbBorderActiveWidth ccscsessssssseeeeens 125 ThumbBorderHIghlight csscscecsesseeeeeeeees 125 ThumbBorderSelectedHighlight 00 125 ThumbBorderSelectedShadowW sesessssenenn 125 ThumbBorderSelectedWidth cecsecscseeeees 125 ThumbBorderShadow NNN 125 ThumbBorderWidth NNN RANNER 125 TAUMBEMECIS EE 119 TNUMDFACE EE 124 THUMPPAGGING EE 88 ThUMbSeleCteGFace ccscssevssescureessenearenees 124 TAUMDO ZE esia ea 88 THUMBS PAGING X EE 123 TAUMDSHACNO GE 123 US ee ER WHESIZOX GEN 20 BIS EE 20 IMCS EE 45 227 TGS EE 45 227 TiltModeRelative ak 38 Kl VE 156 MOGUL le E 118 Beie un ER Bilie IER EE 40 190 Beef 137 UR ain 157 UselnitialView ccccccccseveseecesessseeeeeeaeeravares 1
59. Hews EES 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 161 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 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 162 NeptuneLabs FSI Viewer Plug ins Reference Plug in JavaScript Bridge Plug in Target Scripting Plug in Location plugins jsbridge plg Function Integrates a JavaScript interface to enable interaction between FSI Viewer and JavaScript contained in the hosting HTML page Syntax o ee be Bagio
60. NOLEN OG D 189 bagechiirror xx NEE RSNENNENNNK NENNEN 197 PAGCSOUNGS E 198 PagesThumbBar uk 199 PINES AVG seraa a 204 EELER ee 207 238 NeptuneLabs FSI Viewer FSI Viewer FSI Pages FSI Showcase Flash based Single Source Image Viewer NeptuneLabs GmbH Detmolder Str 210a 32791 Lage Germany Fon 49 0 5232 9999 7 0 Fax 49 0 5232 9999 7 29 eMail info neptunelabs 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 TSi viewercom Neptune a E NeptuneLabs GmbH Detmolder Str 210a 32791 Lage Germany fon 49 5232 99997 0 fax 49 5232 99997 29 info neptunelabs com www neptunelabs com
61. P query prefixed with pages_ Color of the page borders specified as 6 digit web color Use false for no border at all HelpImageURL Description Help image to be displayed left of the first page 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 ScroliBaseColor Get Joe CSC s S S S S SC s S sS s S s S S Context res plug in node or HTTP query prened with pages OO 6 digit hex color for the scroll bar in the page index ScrollArrow Default mm S S Contest Pages plug in node or HTTP query prefixed with pages_ 6 digit hex color for the arrows of the scroll bar in the page index ScrollTrack Color for the scroll bar s track bar DDDDDD 6 digit hex color for the track bar of the scroll bar in the page index 88 NeptuneLabs FSI Viewer FSI Pages Add on MarginLeft MarginTop MarginRight MarginBottom Description Margin of the turning pages Syntax Number in pixel 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 PageMarginInner PageMar
62. SaveURLPrefix value http www foo com downloads catalogl gt Ee EE EE Note for users of imaging servers other than FSI or eRez Imaging Server If you are using an imaging server other than FSI or 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 lt Index page 1 label Chapter 1 file chapterl pdf gt lt Index page 20 label Chapter 2 file chapter2 pdf gt lt Index page 30 label Chapter 3 file chapter3 pdf gt lt Indezxzdata gt Please note If you use the FSI Pages parameters SaveUrlPrefix and or Sav
63. VEOPUOINS ee EES 104 SaVERESOIUION oinean 103 206 SaveTeMplate cscsscsececsesecsteneaeenenees 104 206 SAVEURUPRETN EE 102 SaveUri SUf EE 102 SEAN e aa aa 102 SCAER E Ar 219 SceneEffetts enee 36 KREIEN 47 le CHE 46 47 227 NeptuneLabs FSI Viewer ScrollArrOW deen 87 122 193 SCLOMAFFOWCOIOF wncisidinniaticctdicdeateamaiadenis 224 ScrolIBASe COlOr ccccecececusuavevevavaees 87 122 193 SCP OM le le EE 87 122 193 Sear E 104 SearchAUutoEXxXactMatch ccscsesscseeeseeseereees 105 SearchAUtoWildCards cscscsessceeeesenseeeeees 105 Seil feel UC 105 SearchCusStOMValUe NNN 106 SearchDialoGHeiGht uk 104 SearchDialogGwidth uh 104 SearchParamMeters cscssessscseersessccveusensensense 105 SearchSortResults cccsssscsssrersscseersensesseeee 106 SearchUseMethodGe cccecsesseseeeenseereees 106 il EN Ile TE 158 SelectiONBorderWidth ccccscsscseeeserseereees 202 Selen ll EE 202 SelectionMarginBottOM uk 202 Gelechopnboundt oner 203 SeENGXMLStOreURL NNN 195 SendXMLUrlFailed EE 195 SendXMLUrIFailedTarget cccscscseeeeeeeeees 196 SENAXMLUTISUCCESS NNN 195 SendXMLUrlSuccesSsTarGet ccscscssceeeeeeeees 196 DLV Clicaducnsinacae Eege 75 120 ServerTemplate cscsccsesecseeecsecesnecnsneesens 23 SEENEN ER SetValueSForEachIMagGe ANN 142 SIT Ile 170 SHAGOW COlOMs eana eee beiei aes 170 SNOWANOI EE 178 ShowLinksWhileFlipping ANNE 91 ShowLoadProgressS ccceeeecseeecseeesneencneasens 80 S
64. a directory or search query in plain text if you are using eRez and 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 Image Collections from eRez Imaging Server Plugin lt lt rassin a dare e Ee ae plan eee lt Plugin src pages server dir images flowers gt lt Passing an encrypted string representing a directory gt lt Pilugim sre pages Sexver dr xXzPZhUPVSoHtmeerxOvONUUO 7 EE NeptuneLabs FSI Viewer 59 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 LE PXS lt oRC ve lue Vimagel e S EE lt Image gt made acela auy seeomel teure gt I eC lt SRC value image2 fpx gt lt Width value 8096 gt lt Height value 12300 gt KEK EE lt NoNav value true gt Op lons lt Image gt lt Images gt Method 2 and Method 3 can be freely com
65. age contains XML data in the IPTC_FSI data field links will be presented on the page e Hard cover Book First an dlast page of the catalog have a inflexible appearance e Teaser Thumbnail 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 74 NeptuneLabs FSI Viewer 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 EventID Parameter_ Description Called after the FSI Pages Add on is ready for use The parameter Ueleg les provides the total number of pages Called each time before the user goes to a different page The onPagesGotoPage Integer parameter provides the target page number Called each time after the current page has changed The BEER 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 numbe
66. aining hyperlinks This way FSI Pages Converter prepares the required XML data by gathering the link information from the PDF document FSI Server subsequently serves the XML data to FSI Pages Image date PDF Tiff with with links gt leo tr vert data XML paae data 1 Convert the source PDF document using FSI Pages Converter Make sure to check the Include 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 FSI Server 3 Go to FSI Server Interface 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 NeptuneLabs FSI Viewer 65 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 FSI Server and IPTC data fields FSI Server is capable of serving the IPTC data contained in an image file to FSI Viewer FSI Pages G5 Server By default FSI Pages Converter adds the required IPTC data to the output TIFF files The IPTC data for Image date each page can then automatically be retrieve
67. and mailto as well as FSI Pages command URLs beginning with S For relative links FSI Pages adds the URLPrefix and or URLSuffix values if specified Relative Link URL lt Page gt lt Links URLPrefix http foo com URLSuffix amp test 1 gt lt Area URL products html id 123 gt lt Area gt Links lt Page gt Resulting URL http www foo com products html id 123 amp test 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 um Description javascript foo Call the JavaScript function foo mailto email domain tld Send an email to email domain tld Do nothing Handy if you just want to display a tool tip Available in FSI Pages version 4 0 7 or above Forces FSI Pages to flip to page n showimage imageURL Displays the specified JPEG image Forces FSI Pages to zoom to the area covered by the link s shape s Magnifies the area covered by the link s shape s in place Display a custom JPEG image The value URL needs to be an absolute URL to a zoomimage JPEG image _ Forces FSI Pages to zoom to the image area following EE See Parameter gt Jnitia View 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
68. apter 3 page 60 color CCCCCC gt lt Index label Chapter 4 page 70 color FFO000 gt lt Indexdata gt Plug in Parameters IndexData XML document structure data 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 URL to an external XML file describing the document structure 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 directory FSIBase NeptuneLabs FSI Viewer 137 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 Display a starting and ending pages of chapters betae ne Add the starting and ending page of a chapter to the chapter label pe mn Coen nem O Opacity of the select box background from 0 transparent to 100 opaque pe fe Coen nem O Display the color sp
69. as Each identifier represents a new button that can be configured using the parameters below E g btn1 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 Offset of the button in pixel to previous custom buttons Specifies an offset for the button named ID in pixel to previous custom buttons 146 NeptuneLabs FSI Viewer Plug ins Reference Url to open on click 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 Diren OOO pe Ia eeng nen OOO 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 ID ToolTip Specifies the tool tip to be displayed when the user places the cursor above the custom button named ID ID LabelFrame Symbol displayed on the button pe 1 Specifies the symbol to be displayed on top of the custom button named ID The predefined symbols are NeptuneLabs FSI Viewer 147 Plug ins
70. as lt FPX gt 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 Context lt Image gt or alias lt FPX gt 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 tTLlesx Ee ER 7h lt FPX gt Options lt SceneSets value 1 8 9 16 17 24 gt lt 7 Coelonca Parameters for all 3D presentations Method A or Method B Scene sequence definition 3D EE Coen om OO Using this parameter you can define scene sets for 3D views Scene sets define the order of scenes to be displayed 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
71. as value attribute of the node NeptuneLabs FSI Viewer 15 Configuration Structure of XML configuration files Hei EE Be 1a lt Viewer gt lt parameter value lt Viewer gt LE PXS lt parameter value lt FPX gt lt Plugins lt parameter value lt Plugins gt lt Opr loons lt parameter value OPE TONS Sioi parame ei Simple XML configuration file E e lt FPX gt lt 50e value image fox gt sy ED lt Opr mons lt Debug value 1 gt Ocetons EE 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 The following section willbe ignored 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 Viewe
72. ase 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 lt amp gt for gt 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 Bece languaco eng lasiiy coloe JOU0UOY Borie Sens e O c 0 offsetWidth 0 offsetHeight 0 gt SS 1d ZOomOur lt b gt Zoom Out lt b gt lt br Click to decresse maqgnitication lt tip Cap aad 4Aoomin lt b Zoom im lt b gt lt br Clck to Imerease Maguimical on Hip ci ps EA Downloading Dara Downloading tio Kee 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 NeptuneLlabs 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 Images This is t
73. ata will be retrieved more often Description Unique Identifier for plug ins String see description EE 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 e amp j lt gt The Notepad plug in for example requires a UniqueID value MouseVelocity Description Continue mouse actions after mouse up Deut me EE If you enable this parameter mouse actions like pan will be continued depending on the speed you moved the mouse 40 NeptuneLabs FSI Viewer Configuration 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 Ple
74. ault 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 68 NeptuneLabs FSI Viewer FSI Pages Add on lt links gt node lt Page gt lt Links URLE cenix hurp too com DeraultTip No loo lt area gt lt l area gt naa 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 O OOOO mm URL open whenthe sercidstheling Tip Tool tpt display when the userpontsattheln OO lt area gt node lt Page gt EE SE DS tg opt LEET o a Eeer Ek e TNE EE 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 x2 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 us
75. bined 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 EmptyImages to pass the page numbers to insert blank pages before seperated by commas This is especially useful if you retrieve the image collection from FSI Server Method 1 Removing certain Images 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 FSI Server Method 1 60 NeptuneLabs FSI Viewer 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 PageOrderRTL Defning Right To Left reading order lt P Lernen SEET lt PageOrderRTL value true gt lt Plugin gt lt Pings Changing the page order
76. blank content page if required BlankFrontCover and BlankBackCover Deut fae OOo 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 Fill entire front and or back cover with image ot se 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 FrontCoverImage and BackCoverImage Use the specified image for front or back cover 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 84 NeptuneLabs FSI Viewer FSI Pages Add on FrontCoverConfig and BackCoverConfig Use the specified image configuration file for front or back cover 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 Defa mei ise context 1 Pages plugin node or HTTP query prefed with pages UO Defines wether the pages are flexible or inflexible e g like a book cover PageBackgroundImage 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 a
77. box border Plug in node or HTTP query prefixed with largetooltips_ Thickness of the tip box border in pixels 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 _ typewriter TextColor Description Default text color HexColor 000000 Plug in node or HTTP query prefixed with largetooltips_ Syntax Default text color of text in the tip box To use different colors in a tool tip you can use the HTML tag lt font color RRGGBB gt in the tool tip text data TextSize Description Default text size Syntax Number Plug in node or HTTP query prefixed with largetooltips_ Koch Kach Default text size of text in the tip box To use different sizes in a tool tip you can use the HTML tag lt font size n gt in the tool tip text data CornerRadius Radius of box corners 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 173 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 lt Plugin sro Magniller visible true size 10 gt The Magnifier
78. bsolute path to the image PageBackgroundImageEffects Image effects for the background image Defines image modification parameters to apply to images used The value of this parameter depends on the imaging server being used With FSI Server you can sharpen the image and define the JPEG compression level e g effects sharpen 230 amp quality 95 NeptuneLabs FSI Viewer 85 FSI Pages Add on Parameters defining the Layout and Appearance 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 false even uneven Context 1 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 Syntax Glossy or Matte The effect Glossy adds highlights and shadows while Matte adds shadows only like with FSI Pages version 3 Please use BendEffectIntensity parameter to modify the effect level or disable the visual effect BendEffectIntensity Descri
79. cab version 6 0 65 0 width Swidth height Sheight gt lt PARAM name movie VALUE Sfsi_ 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 guality value high gt lt EMBED TYPE application x shockwave flash PLUGINSPAGE http www macromedia com shockwave download index cgi Pl Prod Von LOW Roe kwaa asin a SINC EE EE EE BGCOLOR Sbgcolor MENU false ALLOWSCRIPTACCESS always ALLOWFULLSCREEN true QUALITY high gt lt EMBED gt e EE echo Stemplate a lt BODY gt lt HTML gt 52 NeptuneLabs FSI Viewer FSI Plug ins NeptuneLlabs 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 Us
80. cccecscseceeseceeeeserseeeeseteenenaees 154 RI Iech TE 154 Default Target EE 153 DELIV oiiire tasers 169 DEMOUWR GE 95 DEMOWR LIAR CE rn a teruatens 96 Detail BUE crrr 27 Di esseen 75 120 DoublePageAllowInteractivity ccccccceeeeeees 82 Doublebage Zoom csceeceeeeseearseeenseeeneneensues 82 DoublePagGeZOOMS Cale scecsesseseeeseeereeeeees 82 DragBa Ie EE 117 DragGBarHighlight uk 123 DragBarROUNdBevel csccscseeseseeereesenseass 123 DraGBarSNad OW inwiwsccsvavccutecverndeicecberbesdvavnent 123 DragBa del 117 Neie EE 118 DraGMeNUVVIGUN geen 118 DFOPSNAG OW ciesevicsescatenstensminenevereiee 86 200 DropShadowDistance NNN 86 ECGCRAGIUS rauc anani 125 192 Ee 34 134 EmptyImageS ENNEN 78 121 EnableAddCustomBookmark AN 193 EnableAddFullBookmark scscsecssseeeseeeeens 193 EnableAddLinkBookmark NNN 193 EnableSendBookmarkS vu 193 Enable ZoomlnbanhMode uk 31 Enlarge By enra 207 STEE 107 153 180 210 ExpandSelectionTOIMage NN 193 EXDIO Corna 168 ExtendedViewport ccccscecsseseseeansseensneenenes 31 WI 157 FIFSEPAGENUMDEN sessserssssosonnenensensononnenesnenre 79 FID COMNGE SIZES EE 107 Seite Lee KEEN 107 Salle Bi 90 FOrcelnitialPagGe ccscsssssscscsressscavcesenseareeeeens 78 ForceJavascriptTarget ccccscseseeeeeeeeeeeeeeees 92 FORCCL AK largeta 92 FORCCLINK IMD EE 93 FOrCELMNKURE irienn 92 Salyez Bi alle EE 92 FOrCeLinkUrlSuffix c ccsscsesscseeseseeseeeserensess 92 FORCES aVCURL sia
81. cssconesesesecnecesesuensaveeauaas 99 PageCacheRemovefime NN 99 leie e 86 len EE 96 PaGeLogDelay csccsccrssssesreuseeueerseseeuraneenes 97 PAGCLOG Tal Gl nsina a 97 Klee e UI 97 PageMarginBottom ak 88 PageMardin INNE WEE 88 PageMargGinOuter cccsscscsesesssusvenevevsnsesesess 88 PageMargiN Tei DEE 88 PAGENUMDES cccccsesrersscseersuseenes 89 136 218 PAGENUMBGCOIOF ccseceeeeeeecseeeeeeseareeeeees 90 Bee UE tege 89 PageNumI ndent ak NN 89 236 PAGE NUMPOS a cxciveerstreascisdinte tuba aaertiest 89 Bleu 89 PageOrderRTL EE 79 Wiele 99 PageOverlayShOWZOOMEG NN 100 PAGETUINS POO cccccescsrsssvscecssesevsescsecvesenucnes 80 PAUSGONSOD EE 186 PEFSISLENUS LOMA EE 218 PersistentStorageExpiresAfter uh 219 Bee ln E 219 DO Aoo 139 DOS GE 140 Den 177 PreloadBackward E 99 PrelOAdFOrwal ninnan 98 PreloOadTNUMDS sex kk NK N KKK RENE K KEREN KNK Nu 132 BEIEN deeg 101 204 Biet Sne EE 101 204 PrintReESOlUtion ANEREN 101 205 give ell Ee 101 205 KEE eene 75 120 PAO EE 85 DEE 142 Uer 173 RememberLastViewedPage sscscsseseeseeeeees 98 RememberLastViewedPageExpireAfter 98 REMOVEP AO E 78 ReverSePageOrder cccesssssesseucesseureesecuearenees 78 REVISION DEEN 190 RomanPageNumbersOffset sscscsscseseseeeess 90 egw 209 Der gel EE 96 ROUNGECSKINCOMNETS cceceeeeeeceeeeeeeeeeneneenes 33 EE 102 205 SaveAllOwSaVINGIMAGES ccscecceeeeeeeaeeeaes 103 SaveDocumentFile NNN 102 EE 103 205 SA
82. d by FSI Tiff with Pages using the FSI Server template system This is the way it works when using Publish as FSI Pages IPTC data with links in FSI Server 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 XML page data b Using individual XML files An alternative way to provide XML page data is using external XML files Image date With this method each image requires Image ae a related XML file containing the page page xml XML page data data stored in a directory on your web server The XML files have to be named after the related images with the additional suffix xml 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 catalog1 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 page0001 tif page0001 tif xml page0002 tif page0002 tif xml Now you need to upload the images to your imaging server and upload the XML files to a directory on your web
83. e end of this chapter TEE P tten 1 PageNumPos PageNUmSize etc 58 NeptuneLabs FSI Viewer 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 FSI 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 FSI Server The most convenient way to create image collections is using the template system of FSI Server You can either do so by using the Publish to Web option in FSI Server web interface or by specifying the server address and a directory or search query manually Retrieving Directory based Image Collections from FSI Server EE Plug sre sages EE EE EE Retrieving Search based Image Collections from eRez Imaging Server lt P lugins lt Plugin src pages server query gt lt lt 2 uve iais This way FSI Server uses an image ist template to return the matching images in XML format Depending on the list template FSI Server serves IPTC data belonging to an image e g for links as well Please note that you can only specify
84. e active thumbnail Syntax Number Width of the border around the active thumbnail contee rung OOO O Defines the backgroundcolor of the active pages in the thumbnail bar SelectionMarginBottom Bottom margin of the active thumbnail Defines the bottom margin of the active thumbnail 204 NeptuneLabs FSI Viewer Plug ins Reference SelectionRoundCorner Round corner size of active thumbnail Get ne o Defines the rounded corner effect for the active thumbnail Straight corners if set to 0 Defines the rounded corner effect for the active thumbnail Straight corners if set to 0 Defines the color of the page numbers in the Thumbbar Plugin TextColorHighlight Round corner size of active thumbnail Defines the textcolor of the active thumbnail NeptuneLabs FSI Viewer 205 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 Function Add printing and saving capabilities to FSI Viewer SL BEER Syntax lt Plugin src printsave gt Plug in Parameters Description Offset in pixel to previous menu elements Syntax Number Pixels Version Offset in pixel to previous menu elements Description Enable Disable printing If disabled the menu button is hidden String urlencoded Coen re O Def
85. e buttons to Pan Zoom Rotate 3D Rotate 2D 184 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 lt Plugin src mousemodeselect gt The Mousemode Select plug in adds a button and a dropdown menu to the menu bar to select the mouse mode Plug in Parameters Indentation of the menu button Provides the possibility to hide specific mouse mode buttons in the dropdown menu Remove Drag Button lt Plugin src mousemodes Model false gt NeptuneLabs FSI Viewer 185 Plug ins Reference The example above shows how to hide the button for mouse mode 1 Drag Zoom Rotate 3D X Y Axis Rotate 2D Z Axis 186 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 lt Plugin src music song music mpS 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 Description Indentation of the menu button Syntax Number Plug in attribute Specifies the space in pixels left of the menu but
86. e images will be loaded as soon as they need to be displayed OO 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 Get ne emeng m SSCSC s s S S S SC lt S S S Disable animations between scenes and scene sets This can be useful if different scenes represent different states of an object instead of a rotation NoSetLoop No 360 rotation around the y axis 3D pe fee emeng mme SC s S S The first and the last scene set will be considered ending points E g for partial rotations lt 360 Please note The blur animation is turned off if NoSetLoop is activated NeptuneLabs FSI Viewer 47 3D Configuration NoSceneLoop No 360 rotation around the x axis 3D pe Im eent om The first and last scene in the each scene set will be considered ending points E g for partial rotations lt 360 Please note The blur animation is turned off if NoSceneLoop is activated 48 NeptuneLabs FSI Viewer 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 a
87. e manipulation effects like sharpen or quality to all image tiles in the main view area Please refer to effects parameter for a detailed description URL of the ZoomCache Contee kows OSS If you use NeptuneLabs ZoomCache please specify the URL of the ZoomCache server here You can receive this URL and a ZoomCache ID from your image hosting provider ZoomCacheID ID of the ZoomCache access profile Contee ges 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 IgnoreQuery Ignore all parameters passed via query except cfg Get ae emeng mm 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 List of parameters to ignore in queries Coen zo OO A comma separated list of parameter names that should be ignored if specified in the HTTP query Example lt IgnoreQueryParameters value language skin gt would prevent specifying the skin and language by HTTP query Please note e DefaultCfg Cfg and Debug parameters cannot be disabled using this parameter e this parameter itself cannot by specified by query MaxZoomLevel Deut re SSCS emeng komm OOO By default FSI Viewe
88. e multiple lt shape gt nodes in an lt area gt node if you want to specify multiple shapes for the same link attribute Description Comma separated coordinates describing the link shape see above lt shape gt node lt Page gt Clinics lt Area gt Snape Coord leede lt Area gt ke 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 NeptuneLabs FSI Viewer 69 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 lt shape gt node lt Page gt lt Links gt lt Area gt el EEN GE SEET deseripiive text lt b gt lt lext lt Area gt SEO 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
89. e object tag Entering greater numbers forces the viewer to resize by the number of pixels specified Using values gt 1 increases the chance of imaging server cache hits and might thus reduce server load NeptuneLabs FSI Viewer 209 Plug ins Reference Plug in SelectFrame Plug in Target User interface Plug in Location plugins selectframe plg Fu ncti O n E View amp Selection Provides a resizable select frame Se 0 68200862 0 80817611 0 Syntax lt Plugin src selectframe gt Viewer 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 group by using the prefix selectframe_ with the parameter name e g selectframe window Indentation of the menu button Specifies the space in pixels left of the menu button of the plug in Show or hide the plug in on startup pe ne Show or hide the select box on startup 210 NeptuneLabs FSI Viewer Plug ins Reference Show or hide the output window true Show or hide the output window of the plug in pe ne Coen
90. e see Event Notifications and Actions for details 108 NeptuneLabs FSI Viewer FSI Pages Add on FlipCornerSize Description Size of interactive page corners 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 Size of interactive page edges Defaut mm Context Pages plug in node or HTTP query prefixed with pages 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 109 FSI Showcase Add on NeptuneLlabs 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 nod
91. e the lt options gt group by using the prefix measure_ E g Ere Eer eeh E EE 2 0 1ielies NeptuneLabs FSI Viewer 177 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 DEER Msi Snne eit Z OS ANSE SUIS SU gan 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 lt plugin gt tag You might as well define all plug in parameters via query or inside the lt options gt group by using the
92. e to your default XML configuration file Integrating FSI Showcase SE lt Plugin src showcase basecolor 58A8FF gt lt olives 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 lt Images gt lt Image label My First Image file imagel fsi gt lt Image label My Second Image file image2 fsi gt lt Images gt 110 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 lt Image label My First Image file imagel fsi gt lt Image label M Second Image file image2 fsi gt lt Images gt 2 Creating image nodes containing complete image configurations Complete XML configurations lt Images gt lt Image label My First Image gt lt P PXS lt SRC valuo image tox EE lt Image gt mae aoe EA Seeomel Ilinece gt leek lt SRC value image Tp e gt lt Width value 8096 gt lt Height value 12300 gt lt EPX gt Op ipuens lt NoNav value true gt Op ions lt Image gt lt Images gt 3 Retrieving automatically generated image lists from a server Complete XML con
93. e volume to play the flip sounds at from 0 off to 100 maximum volume Library File name of the sound library to use 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 200 NeptuneLabs FSI Viewer Plug ins Reference Plug in Pages ThumbBar Plug in Target Viewport of FSI Pages Plug in Location plugins thumbbar plg Function Displays a bar with thumbnail images Syntax D Ze Te Sek lt Plugin src thumbbar gt S g ZER Plug in Parameters pe ne Coen reng version s0 When enabled the thumbnail of the currently active image is shown left in the thumbnail bar When disabled the thumbnail is shown in the center below the catalog Display scroll arrows Pages ThumbBar If set to false the arrows for scrolling the thumbnailbar are hidden and the user needs to drag the thumbs to scroll ArrowAlphaActive Opacity of the arrows when mouse hovers over the thumbnail bar NeptuneLabs FSI Viewer 201 Plug ins Reference ArrowAlphaNormal Description Opacity of arrow Pages ThumbBar Version Defines the opacity of the arrows in normal state ArrowFillColor Description Arrow fill color Syntax HexColor The fill
94. eUrlSuffix 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 FSI 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 NeptuneLabs FSI Viewer 63 FSI Pages Add on Using FSI Server to return Search Results By default FSI Pages uses FSI Server to retrieve search results FSI Pages passes the term entered by the user to FSI Server and receives an XML based list of matches Based on these matches FSI Pages presents a list of thumbnails
95. ecified in the document structure XML data in front of the chapter labels IndexMarginWidth Width of the colored page index Floating point value specifying the width of the colored index located on the outer page margin in percent of the page width Enter 0 to disable the colored page margin Please note This value requires setting ColoredIndex to true as well Width of the select box Default 200 depending on skin 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 138 NeptuneLabs FSI Viewer Plug ins Reference Description Sort index items by page number 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 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 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 Each lt index gt node represents an item in t
96. ecified using the parameters Ti esX 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 ve rsion 1 Eeer EE EE LEF PX gt lt Tilesx value oe gt lt tLlesi values 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 source image but no scene set is defined a scene set containing all the scenes from left to right top to botto
97. ectangle 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 Se ectFrame to obtain this value Obtaining Hot Spot positions Include the plug in SelectFrame by adding the following parameters to the default Tei or any other configuration file Including the SelectFrame plug in EE lt Plugin src SelectFrame visible 1 window 1 rotate 1 AspectRatio 1 1 gt lt 2 lives gt After including the plug in you will be able to author hotspots directly in FSI Viewer e You can use the value displayed in the Selection window for the Spot parameter of the hotspot e 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 HOES DOES Polygon spor l l Scoords 0e 5 Or kOe Ons O25 055 7
98. ed this is the history list stops at the first and the last position NeptuneLabs FSI Viewer 151 Plug ins Reference SmallButtons Size of menu buttons eft me 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 152 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 ES e lt Plugin sre 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 hotspot Open a HTML page Restart the Viewer with a different image configuration Adding Hotspot Functionality to your Images Integrating the Plug in To integrate the HotSpot plug i
99. ed 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 Parameter jvaluel raremeter2 val ve 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 SelectImage Select another image FSI Showcase only 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 160 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 r
100. eed the FSI Pages instance size 82 NeptuneLabs FSI Viewer FSI Pages Add on DoublePageAllow Interactivity Enables the interactive zoom mode o fe When enabled the image will scroll when the user moves the mouse pointer pe fee contet 1 Pages pugin node or HTTP query prefed with pages UUO 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 pe In contet Pages plugin node or HTTP query prefed with pages UUO 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 Force XML data useage EC 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 NeptuneLabs FSI Viewer 83 FSI Pages Add on Parameters for the Front and Backcover Description Enable disable the front cover 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 pe me contet 1 Pages pugin node or HTTP query prefed with pages UO Setting BackCover parameter to false disables access to the back cover and forces FSI Pages to add a
101. eenesaneeness 71 P g Overlays EE 73 Event Notifications and ACtiONns cccccccsessceceeeeeeseneeseeeeeeeeeneeeeaeaeeesesenstaeatereesenstareees 75 Parameters to retrieve Image Collections NENNEN ENN 76 Alphabetical Index of FSI Pages Parameters uk ENN 77 Basie un 79 Parameters for the Front and BACKCOVEL cccccecesecuaueeeeuauaeeuueuavaneuvavaneneeuareeeneavanenes 84 Parameters defining the Layout and Appearance ENEE 86 Parameters for FSI Pages Thumbnails ccccsecccsecsecccrerseseeceueararsesecseueurersuseseeueanereuse 95 Parameters ale e 97 FSI SNOW CASS AGG ON EE 110 USINO FSi ie UE 110 DOT FING HVAC RER 110 FS SNOW CASS AVOUT EEN 113 Using FSI Showcase and FSI oiug Jme NENNEN 115 Showcase ParaMeterS sceveccecseneevcuseceeceuscucuseseeeeasareususeeceueararseseeseueneneseeneararsusenes 116 Alphabetical Index of FSI Showcase Parameters uk 117 Kr eben EE 118 IMAGES Par Ee EE 122 Advanced Para Meter E 124 IT RI Referen Ce EN 135 PUGIN BACKGFOUNG un Le EE 136 PUGIN CENIDE S niini aa 137 PLUG IN CIOCKPTOOTESS TEE 140 PIUGQ I11 eege ME 143 lf le le CONECXEMECNIG E 145 Slfle Kl GUSTOMBUULON EE 146 PUGIN FUSC OG EE 150 PUG IM RISTO EE 151 PUGIN TOES POLS EE 153 PIUG IN JavaScript Ce e CT 163 PIUG IT LargeToolTiDS EE 171 BI le ki WE ele ET EEN 174 BU le Ki WE OOM EE 176 Plug in Measure sactinictskncassemaaceenies ot eerisbleccatubcatiuiiniat a aioe taeda 177 Se G t RGTR II OG EE 183 Plug in MousemodeSelect dE 185
102. ek 27 ite d nl EE 39 FRACTION BEE 29 wie a lei EU 29 InitialACtionPerSiStent cccccsceeeeceeeeeeeeeeeeeseeaeeaeeaes 30 Initial MOUSEMOCE csccecsecseceecnenererenececersersnseenans 30 REENEN 28 Initial ViewPersiStent ccscsecsecsesecsererenececeesersnecesans 29 Und e EE 24 Eiere 27 Magonifvmallmages NEEN 32 20 MaxZO0MLCVEl EE 38 Miel D Us IEN 26 MetaDataQueryParaMeters uk 20 leif Elei WEE VE oson a a e E 36 Nav lu e e EE 28 NaVIMASKAIDITe RE 28 VIE e e LEE 28 NavWidth and NavHeight uk 28 NOIMAGEBICNG WEE 33 NG NAV ess eextoeie cas idad a boncuenaetan toed aweueaumnana 27 RoundedSkinCorners EE 33 Scene EEES EEN 36 Server Template ccscsccsesscsecseceeceeseceesnececnesersnsensers 23 ENEE 22 Eege 24 Ree 23 SUICVIEWDOI SE 32 THEE CCUG EE 37 TileSizeX and TileSizeY EE 39 TiltModeRelative ANNE 38 BR e El e E E E T 33 uniguelD EE 40 UseIntermediateZOOMLevelS 40 VAN Ee TEE E 33 Width and Height EE 23 ZOOMIE ACMI C vss E E A E E A E E 37 Keier L en IR EE 37 FOO AU EE EE 31 deii Biel Vu II EE 31 NeptuneLabs FSI Viewer Configuration Retrieving Parameters from Imaging Servers Depending on the type of imaging server 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 True Spectra Imaging Server Imaging Server Imaging Server EREECHEN
103. elivered by the imaging server Practical values range from 50 to max 90 quality 5 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 af GEES 3 e e Lu ebe EE l i E Lu Ee e ef Pe oe BB ae lt effects value Sharpen 300 gt lt effects value sharpen 150 gt Other effects change for example the color saturation hue or contrast Please refer to your imaging server documentation for a complete description of available image effect commands brightness 10 lt effects value brightness 10 gt 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 lt effects value quality 65 amp sharpen 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 26 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
104. embed gt tag H7ML 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 JSP Perl etc when implementing large numbers of images All subsequent 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
105. ent identifier and a parameter Please follow the steps below to implement JavaScript callbacks from FSI Viewer Step 1 Enable JavaScript callbacks by setting the plug in parameter Callback to true e g Example Enabling JavaScript Callbacks lt plugin src jsbridge callback true gt Or alternatively via HTTP query SSeS 6 Se Sr C EE El lee Cail liste lt Step 2 Add a unique identifier to the lt object gt and the lt embed gt tag of FSI Viewer FSI Showcase Example Adding ID NAME parameters lt object id fsiviewer classid lt Param name movie value gt lt emoec NAME LSLVLEWELCY o o o 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 166 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 specified 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 JavaScript Callback Function lt script language jJavascript type text javascript gt Mic MiOimis 7ewera RVOl OMMlameh Gone a E E case LoadProgress break Hook for Internet Explorer if navigator appName amp amp navigator appName indexOf Microsoft 1 amp amp
106. ent Parameter Description 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 ImageIndex applies to FSI Showcase or FSI Pages only and provides the 0 based index of the image currently selected ImageURL 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 fsi server source images zoomimage fpx amp width width amp height height amp left 0 top 0 right 1 amp bottom 1 amp template 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 FSI 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 decodeURIComponent before displaying this parameter NeptuneLabs FSI Viewer 169 Plug ins Reference JSBridge Plug in Parameters AllowDomains Sub domains allowed to acces the JSBridge i
107. eparator gt lt Item label Show Hide Index action ShowHidePageIndex gt lt Item label Zoom this Page action ZoomPage gt lt Separator gt lt l FSI SHOWCASE ONLY gt lt Item label Previous Image action PreviousImage gt lt Item label Next Image action NextImage gt lt Separator gt lt l FSI YVYIEWER gt lt Item label Reset View action Reset gt lt Item label Zoom in action ZoomIn gt lt Item label Zoom out action ZoomOut gt lt Menultems gt lt Plugin gt Plug in Parameters Refers to the XML describing the context menu entries Defines the XML snippet describing the context menu Please refer to the FSI Contrib package if you want to modify or translate the context menu NeptuneLabs FSI Viewer 145 Plug ins Reference Plug in CustomButton Plug in Target User interface Custom Button 1 Custom Button 2 Plug in Location plugins custombutton plg Function Adds custom buttons to the menu bar Syntax lt Plugin src CustomButton buttons bitni btn gt 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 Offset in pixel to previous menu elements Enter a list of unique identifiers separated by comm
108. equired steps based on the assumption that your database contains a unique ID for each FSI Pages instance catalog and the required keywords 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 lt Plugin sre pages gt lt SearchCustomURi value htp To0 Com search php gt lt SearchCustomValue value 12345 gt EE EE Plugins 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 chi
109. er 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 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 136 NeptuneLabs FSI Viewer Plug ins Reference Plug in Chapters Plug in Target User interface of FSI Pages Plug in Location plugins chapters plg ail Girls size 92 146 Iris Ami Boys size 922146 Boys Shoes Toys Function Adds a select box to access parts of a catalog directly Syntax lt Plugin src chapters gt 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 Example XML data for the Chapters plug in lt Indexdata gt lt Index label First Page page 1 color FFFFO00 gt lt Index label Chapter 1 page 10 color 00FFOO0O gt lt Index label Chapter 1 1 page 20 color 00FF00 gt lt Index label Chapter 1 2 page 30 color 00FF00 gt lt Index label Chapter 1 3 page 40 color 00FF00 gt Tade lt Index label Chapter 2 page 50 color 0000FF gt lt Index label Ch
110. er Skin Angle of the background color gradient in degree The default value 45 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 193 Plug ins Reference Width of the window frame Floating Point Number pixels EE Obsolete from version 5 0 0 defined by FSI Viewer Skin Width of the window border pen mm SSS Coen nengen OOOO Color of the window border EdgeRadius Radius of the window corners Obsolete from version 5 0 0 defined by FSI Viewer Skin Radius of the window corners Use 0 for straight edges Default mm context nemme Color of the background behind the thumbnails ItemButtonsBackgroundColor Color of the background behind the item buttons Color of the background behind the items buttons right of the bookmarks 194 NeptuneLabs FSI Viewer Plug ins Reference TextColor Color of the hints tool tips displayed below the list Color of the help texts below the bookmark list ScrollBaseColor ScrollArrow ScrollTrack Colors for the scroll bar 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 EnableAddFullBookmark EnableAddLinkBookmark EnableAddCustomBookmark EnableSendBookmarks Default Depending on loaded ade on SendBookmari
111. er 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 InitialPage Page to display on startup Defaut Jt O 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 RememberLastViewedPage 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 NeptuneLabs FSI Viewer 79 FSI Pages Add on PageOrderRTL Switch to right to left reading order o fe 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 Offset for page numbering 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 User interface skin for FSI Pages EE Pages plug in node or HTTP query prefixed with pages_ Specifies the skin containing the user interface for FSI Pages Available skin
112. erver or 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 list directory of your FSI Server Filename pesgi S image_list xml Creates the lt Images gt 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 Image server Base directory Showcase plug in node or HTTP query prefixed with showcase_ Specifies the image directory on the imaging Server the lt Images gt section will be created for e g images paintings Search query eRez server only 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 Path to imaging server Showcase plug in node or HTTP query prefixed with showcase_ Specifies the URL of the imaging server to generate the configuration E g http mydomain com fs
113. es for 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 follow
114. eseseeaeeeeeeseterenseeees 99 Bieser e BEE 98 Del EE 101 Bei mee 101 PrINtRESOIUTION ccccvescsvecsuearscecusesavencereesuseeneeaueesaes 101 lu give Ee EE 101 CUO aioe eee at cadena A 75 RAO EE 85 RememberLastVieWedPaGe NNN 98 RememberLastViewedPageExpireAfter un 98 Dune let 78 ReVersePageOIrdelr sscsscseeecsstcesceearssecesenearseseneanens 78 RomanPageNumbersOffset cccscscsesseeesseeeseseeseteeees 90 FROLAUIOM orerar a E A 96 SE 102 SaveAllOwSavinGIMaGES E 103 SAVEDOCUMENTFIIE cscceseceuseesenecereeeuenenerenseeaenesenes 102 EELER 103 SAVCOPULONS eege 104 SAVERESOIUTION cscersscceeecaveeeseceeeeausecsueeeaesenerenseeas 103 le EE 104 SaVvVeURE PRET EE 102 Save VN SU EE 102 SAVCURL E lee E 102 SCLOMAI OW E 87 SCLONBASECOION EE 87 SLOW aC EE 87 77 FSI Pages Add on S CGC DEE 104 SearchAutoEXxactMatch kA NENNEN ANN 105 SearchAutoWildCards ANNER ANERER 105 SearchCustOMURL NNN aa 105 SearchCustOMValue NNN NNN 106 SearchDialoGHeigGht NNN 104 SearcA Dialog Width EE 104 SearchParameters EE 105 SearchQuery Template csecsessesscsecersnececseseesneeees 106 SGal CNSOMRESUILS EE 107 SearchUseMethodGet ccccecevevevevevevevevevauevauevauees 106 SETA EE 75 ShowLinksWhileFlipping uk 91 ShowLoadProgresS NEE 80 SIMGICSIGSG siraan A 85 ge 79 78 SUIS EE 79 Bt Duve PAGING WE 88 WIG Ek 88 LUsebomanbagehumbere Tobage NNN 90 ViewerMarGiInBoOtlom ssasisissssnnsnnnnnnnnnnnsannnnnnnnnnnnnnna 88 Vi
115. ewerMar Gin Left cccceceessesneceteesarenscesarsussaseneans 88 ViewerMarginRight ccccecsseseeseeeesersesseearserenseneass 88 Viewerhklaroin TOD sissciciteveedssecssetvstveaseewveeesssnewweweveceees 88 AE estan ucnadoueaauoeias 100 OOM ME 80 ZoomAreaAnimationSpeedIn cccecseceeceeeeeseeeeeeees 81 ZOOMAreaANiMatiONSPCeCOUt ceceeeeecseeeeeeeeeeeees 81 ZoomAreaAnimationType NENNEN 81 ZoomAreaTargetScale E 81 NeptuneLabs FSI Viewer FSI Pages Add on EmptyImages Contest Pages plug in node or HTTP query prefixed with pages_ 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 lt EmptyImages value 2 10 gt adds two blank pages at page 2 and page 10 moving the other images in your collection correspondingly Alternatively you can add lt image empty true gt nodes to your image collection Remove individual pages from the collection Content Pages plug in node or HTTP query prefixed with pages_ 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 lt EmptyImages value 1 3 4 gt removes the first third and fourth image in the collection Please note that removing images takes place before inserting blank pages using the EmptyImages parameter Set this paramet
116. f the light part of the sticky notes pe Joen Coen oos SSSCSC lt S Defines the color of the dark part of the sticky notes peut re SSOSSSCS SsSSS emeng Joe When this option is enabled the sticky notes will be rotated slightly to give a more natural look and feel Deta fme contea ss O Display page numbers on the sticky notes PersistentStorage Cache notes inforation peut me When disabled the sticky notes will be deleted when the user leaves the FSI Pages instance When enabled the data will be cached for the given time defined by PersistentStorageExpiresAfter 220 NeptuneLabs FSI Viewer Plug ins Reference PersistentStorageExpiresAfter Keep note data for given time Defines after which period of time the cached note data expires Position beta o o contea sos Sticky notes position on the page top bottom or right Sale pen Im Coen mmm OOO Defines the size of the sticky notes Defines the distance between the sticky notes Defines the distance between the sticky notes NeptuneLabs FSI Viewer 221 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 lt Plugin src synchronize ID UNIQUE STRING gt Enterprise editions of FSI Viewer contain this plug in by default O For al
117. fer to the section Implementing JavaScript Callbacks for details Provide ImageUrl templates with JavaScript callbacks Geh ae 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 callback identifier for details 170 NeptuneLabs FSI Viewer Plug ins Reference Plug in LargeloolTips Plug in Target User interface of FSI Pages Plug in Location Restaurant plugins largetooltips plg SJ Outdoor or Celsius by candlelight Function ge cinshine Zeite Display multi line tool tips with HTML formatted text Ne Foods e vegetables e meat amp fish Sy ntax P desserts lt 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 LBs be lt 1 gt 5 1 gt lt US 4 05 lt Dr gt lt font size n color RRGGBB gt lt font gt lt p align vi gt lt p gt lt img SCS WLOEN RH EE ow e 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
118. ference Description Color of the area representing the amount of pending data 000000 Plug in attributes A 6 digit hexadecimal number defining the color of the area representing the amount of pending data eiert OOO A 6 digit hexadecimal number defining the color of the area representing the amount of data already loaded Description Line color 000000 Plug in attribute A 6 digit hexadecimal number defining the color of the lines A 6 digit hexadecimal number defining the color of the text POX Default Seenen MenwAlgn parameter S emeng Punai SSS Defines the horizontal position of the progress indicator Possible values Centered horizontally Offset from left Offset from right NeptuneLabs FSI Viewer 141 Plug ins Reference Vertical position Default Depends on MenuAlign parameter Defines the vertical position of the progress indicator Possible values Centered vertically Number gt 0 Offset from top Number lt 0 Offset from bottom 142 NeptuneLabs FSI Viewer Plug ins Reference Plug in ColorAdjust Plug in Target User interface Color Adjustments Drag teh sliders to modify the color balance or brightness of the image Plug in Location plugins coloradjust plg Function Adjusts the color level of images Syntax lt Plugin src coloradjust gt Plug in Parameters AutoHideDialog pe me Coen renge S Hides the interface dialog w
119. figurations lt Plugins lt Plugin sro showcase sgerver 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 111 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 UselInitialView 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 Co
120. for details The complete URL to the image currently displayed in FSI Viewer The resulting string contains the templates SSwidth SSheight and S template FSI Server and eRez only which need to be replaced in JavaScript or server side script SSURLScene Same as above but representing the entire scene image i Aspect ratio representing the factor width heigth EE 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 SEIS SCTE requires plug in SelectFrame Measuress A string representing the current measurement requires plug in Measure SSURLViewS NeptuneLabs FSI Viewer 149 Plug ins Reference Plug in Fullscreen Plug in Target User interface Plug in Location plugins fullscreen plg Function switch to fullscreen mode Syntax lt 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 Obg cee classid Telid D2 CDBOE AnOD ler Jobpe 444553 540000 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 g
121. ge 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 Enable or disable the detail buffer EE 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 NeptuneLabs FSI Viewer 27 Configuration Description Hide the navigator window Show or hide the navigator window displaying the miniature image and the current image section NavWidth and NavHeight Description Maximum size of the navigator window Syntax Number in percent or pixel 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 VoWNav to hide the navigator window Specify a 6 digit HexColor to change the color of the selection frame inside the navigator window e g OOOOFF for blue 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 Opacity of the area around the selection frame of the navigator window Number 0 100 Default depends on the skin Contee kopos OOOO Specify the opacity of the area outside t
122. ginBottom Description Margin of the page content Syntax Number in percent of the page width height Pages plug in node or HTTP query prefixed with pages_ 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 Number in pixel 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 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 Padding between thumbnails in the index peut The padding between thumbnails displayed in the page index in pixel NeptuneLabs FSI Viewer 89 FSI Pages Add on PageNumbers Display page numbers on pages pe fe Pages plug in node or HTTP query prefixed with pages_ Show or hide page numbers on pages oeae e a Coen 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 r
123. h 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 Runtime Templates for thumbnail labels Content 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 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 gt NeptuneLabs FSI Viewer 131 FSI Showcase Add on Thumbnail labels with runtime templates lt P lugin src showcase lt LabelContent b ITmagelndeax Imag label e bD br oize FPW 2 ar PX hemor px lt LabelContent gt lt LabelTemplates value FPXWidth FPxXHeight gt SEET The resulting label with this configuration looks like th
124. ha 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 include rect Square Rectangle circle Circle Ellipse star Star polygon Polygon of n straight lines HotSpot definition SIO Si OLS lt ennccike sjooes ly se SSA On ISS Se Ooi 0 OO OM etic Vonks lke 3 lt srect SOOt 10 0 54314 0768446 0 71030 0 282103 506 Eap rectangle uril rece EE EE ll EE EE lt polygon gt lt 7 HOw pers Please refer to the chapter HotSpot Authoring for useful tips on how to create HotSpots Please refer to the FSI 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 Position of the HotSpot Defines the position of the HotSpot It is recommended to use the plug in Se ectFrame to obtain this value Please refer to the chapter HotSpot Authoring tips for more information on this parameter NeptuneLabs FSI Viewer 157 Plug ins Reference Coordinates for polygon shapes Defines the coordinates of a polygon shape In contrast to predefined shapes p
125. he chapters drop down referring the user to a page in your document The following attributes need to or can be added to each lt index gt item Attribute Description OOOO Index of the page to refer to required abe Title for a chapter required File to download for a chapter from version 4 0 0 See chapter Saving Pages for details color si 6 digit hexcolor for use with ColoredIndex parameter An absolute or relative URL to an MP3 file to play for this chapter from version 4 0 7 Please note that you need to add the plug in music as well in this case NeptuneLabs FSI Viewer 139 Plug ins Reference Plug in ClockProgress Plug in Target User interface Plug in Location plugins clockprogress plg Function Replacement for default progress bar Syntax lt Plugin src clockprogress gt 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 lt plugin gt tag E g lt Plugin src clockprogress alpha 20 gt The following attributes can be used to customize the clockprogress plug in Ape pe mn Coen nemme O Defines the opacity of the progress indicator Possible values range from 0 to 100 0 transparent 100 Opaque Size of progress indicator Defines the overall size of the progress indicator in pixel 140 NeptuneLabs FSI Viewer Plug ins Re
126. he 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 vyersron iQ encoding o cCharset gt SES eile cee gt wages SC prei Ee ee SRY ee lt image src 01 gt lt image src 02 gt Magen spe RE lt image src 04 gt Mace s se 050 ay mae Ge 0G my lt images3d gt EE 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 FSI Server Users If you are using Imag
127. he selection frame of the navigator window Possible values are integer values from 0 invisible to 100 opaque 28 NeptuneLabs FSI Viewer Configuration InitialView Initial image segment SceneSet Scene left top right bottom rotation comtea ges 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 Initial View Comlems lt lntetal lew wyjelue ly EE Options The example displays the above left quarter of the 5th scene in the 1st scene set rotated 90 to the right Initial ViewPersistent Keep the InitialView as default view Set me Context s 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 the Reset button will reset the view to the entire image InitialAction Description Action on startup String 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
128. hen changing values ColorAdjust Amount of blue Brightness Brightness of image The image brightness NeptuneLabs FSI Viewer 143 Plug ins Reference ColorAdjust Amount of green Defines the menu offset Amount of red Default ae contea reng OOO If enabled the color values can be set for each image If disabled default the values are used for all images If disabled the user interface will be hidden enabling the effects 144 NeptuneLabs FSI Viewer Plug ins Reference Plug in ContextMenu Plug in Target User interface First Page Previous page Plug in Location 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 an Flash player 7 or above out FSI Viewer Syntax lt Plugin src contextmenu gt 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 Button lt Plugin src contextmenu gt lt Menu Items gt lt l FSI PAGES ONLY gt lt Item label First Page action FirstPage gt lt Item label Previous page action PreviousPage gt lt Item label Next page action NextPage gt lt Item label Last Page action LastPage gt lt S
129. her than FSI Server or eRez to return search results Please refer to the chapter Searching in FSI Pages for details SearchQueryTemplate Template for the search value Default See description below Content Pages plug in node or HTTP query prefixed with pages_ Specifies the template to create the search query value When using FSI Server the default templates is iptc caption sSsearchtext s20iptc fsi_ search data searchtext This limits the search result to matches in the IPTC Caption and the special IPTC field fsi_search_data These are the places FSI Pages Converter adds the search keywords to In order to search all text meta data fields available you can specify the following template instead s searchtext Please refer to the FSI Server documentation for additional search options When using eRez or another server parameter SearchCustomURL the default SearchQueryTemplate is S searchtext the text the user entered Please refer to the chapter Searching in FSI Pages for further details SearchUseMethodGet Use HTTP GET method to request search results Syntax Boolean Default false o O Context 1 Pages plug in node or HTTP query prefixed with pages_ 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 i
130. i This parameter can be omitted if the Showcase has been installed to the default location on the imaging server Please note Loading configurations across domain boundaries will fail due to a security restriction of the Adobe Flash plug in 122 NeptuneLabs FSI Viewer FSI Showcase Add on ListTemplate Description Template to retrieve image lists fsi image_list xml Showcase plug in node or HTTP query prefixed with showcase_ Specifies the XML template to be used to retrieve the image list from imaging server You can use custom list templates to retrieve image configurations files from imaging server e g to including HotSpot definitions contained in IPTC data of the images EmptyImages Description Define blank images place holders Content Showcase plug in node or HTTP query prefixed with showcase_ 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 lt EmptyImages value 2 10 gt adds place holders at position 2 and 10 Alternatively you can add lt image empty true gt nodes to your image collection NeptuneLabs FSI Viewer 123 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
131. ight pages will be aligned correspondingly Possibly values are any combination of T Top L Left C Center and C Center B Bottom R Right PageNumIndent Indentation of page numbers Number in percent of the page width Deut me 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 Size of page numbers Number in percent of the page height Deut fa OC Pages plug in node or HTTP query prefixed with pages_ Size of page numbers in percent of the page height PageNumColor Color of page numbers Pages plug in node or HTTP query prefixed with pages_ 6 digit hex color of page numbers 90 NeptuneLabs FSI Viewer FSI Pages Add on PageNumBGColor Background color of page numbers pen Im Pages plug in node or HTTP query prefixed with pages_ 6 digit hex color of page numbers or false for no background UseRomanPageNumbersToPage Display Roman page numbers up to page number n 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 LILIILIV V 6 7 8 9 Note that you can use the Parameter FirstPageNumber to offset all page number values RomanPageNumbersOffset Off
132. iles this is e g using lt br gt instead of lt br gt 230 NeptuneLabs FSI Viewer Example of a _default fsi file ESL Oe aie as 6 lt 1 This mle contains default parameters All parameters will be overwritten by additional fs1 tiles or query OEWUC CINE C SIGS E lt E PX gt lt ServerType value fsi gt lt Base value http fsi neptunelabs com fsi server source gt lt FPX gt lt P Lucaliag lt Plugins src mousemodes gt lt PLUGIN src zoommeter SrcRelative 1 gt lt Plugins gt SEET ons lt FSIBase value config gt lt ScenePreload value true gt lt MenuAlign value BR gt OPET SE Example of an image specific FSI configuration file eS EISES lt E PX gt See EE e E Ci Eeer ii Loro EE lt Width value 8128 gt SE value 9168 gt SE value 4 gt lt TilesY value 3 gt lt EPX gt lt Optlons lt InitialAction value NextScene lt InitialActionDelay value 3 gt lt MenuAlign value TL gt lt NoNav value true gt EE EE NeptuneLabs FSI Viewer 231 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 Marton Balazs Radu Basca Radoslav Bielik Simone Chiaretta Maciej Chojnacki Jacky Choy Petr Cihar Jesus M Delgado Marc Delisle Daniel Hino
133. im lt Plugin sre pages a lt PageOverlays gt lt Overcley Ee emt Det keen jolie Suni 7 Iesse lt PageOverlays gt lt Plugin gt lt Plugins The example above adds the sticky photo corners overlay to all pages like in the Photo Album sample Defining overlays for specific pages Plugin lt PageOverlayShowZoomed value true gt lt PageOverlays gt lt Overlay file myDefaultOverlay swf gt lt Overlay page 5 file myOverlayl swf gt lt Overlays page 10 gt lt Overlay file myOverlay2 swf x 0 5 y 0 5 gt lt Overlay file myOverlay3 swf gt lt Overlays gt lt PageOverlays gt lt Plugins 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 FSI Contrib package if you want to modify or create custom page overlay files NeptuneLabs FSI Viewer 73 FSI Pages Add on FSI Pages Presets in FSI Server Interface Publish to Web Using FSI Pages with FSI Server imaging server you can choose from the following presets when using the Publish as FSI Pages option e Catalog with links Each image represents a page no page margins no overlays If the im
134. in parameters The following illustrations show the use of these parameters NeptuneLabs FSI Viewer 57 FSI Pages Add on MarginLeft MarginRight i MarginTop Left Page Right Page MarginBottom Using Margin parameters to define the Kack position of the pages and to provide Sak GD NK ES space for the FSI Pages user interface Zoomed Image Using ViewerMargin parameters to define the size and position of FSI Viewer inside FSI Pages Usually you only specify emm ViewerMarginBottom to provide space viewertarginsottom KSC s ore for the FSI Pages interface 33 3 Additional layout parameters provide the possibility to adjust the ere SET 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 EE fr page numbers and add overlays for all pages The following Cropinner 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 CropTop CropBottom CropRight or CropOuter A complete reference of all ayout parameters can be found at th
135. in Parameters Plug in parameters are usually defined as attributes of the lt Plugin gt tag Please note that some plug ins might require specific attributes or even entire XML sections in the configuration file to work properly For information on a specific plug in please refer to the Plug in Reference Defining plug in parameters Se LUG pains lt Plugin src navextension MenuOffset 10 visible true gt lt Pl gin snec Z0emmerer lt SRCRelative value true gt lt 2 Leia EE 54 NeptuneLabs FSI Viewer 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 lt fsi swf navextension visible trueshistory 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 SE EES daienemy E a 7 gt Oormoms NeptuneLabs FSI Viewer 55 FSI Pages
136. in percent of the source image e g 100 zooms to the physical resolution of the source image default maximum magnification With 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 Number of pages to pre cache peut 4 Number of subsequent pages to load in advance NeptuneLabs FSI Viewer 99 FSI Pages Add on PreloadBackward Description Number of pages to pre cache Syntax 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 Pages plug in node or HTTP query prefixed with pages_ 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 Defines 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 Define a global page overlay for all pages and or for individual
137. ines image modification parameters to apply to images used for printing The value of this parameter depends on the imaging server being used With FSI Server you can sharpen the image and define the JPEG compression level e g effects sharpen 230 amp quality 95 206 NeptuneLabs FSI Viewer Plug ins Reference PrintResolution Max size of image to print Coen re O 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 FSI server on the maximum size defined in the real time template used with FSI Viewer See parameter PrintTemplate PrintTemplate Image template to be used Context Pints SSCS Defines the FSI Server profile or eRez real time template used to load the print image Enable Disable saving true Coen re If disabled the menu button is hidden String urlencoded Gemeng mes OOO Defines image modification parameters to apply to images used for saving The value of this parameter depends on the imaging server being used With FSI server you can sharpen the image and define the JPEG compression level e g effects sharpen 230 amp quality 95 NeptuneLabs FSI Viewer 207 Plug ins Reference SaveResolution Max size of image to save Coen re O 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 i
138. ing FSI Plug ins lt i Sil Oe Celine eS ce SEET lt Plugin src mousemodes gt lt Plugin sie history lengun 10 gt S nS EISE EE The Src attribute which applies to all plug ins specifies the plug in to be included 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 lt Plugin src mousemodes MenuOffset 10 gt 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 NeptuneLabs FSI Viewer 53 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 lt Options lt History value false gt Coemons or by HTTP query Using a Query to disable History Plug in lt Object lt PARAM NAME movie VALUE fsi swf cfg image fsig amp history false gt lt Object gt Defining Plug
139. ing considerations 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
140. ing server you can have FSI Server setup the image list for you automatically based on a directory In this case you can choose Publish as FSI Viewer 3D from a directory In this case the resulting code snip will contain the parameter Images3DUrl with the value of the directory path e g amp images3durl images 2Fmy3DImages For code snips created for eRez server including the eRez commands FSI Viewer Version 5 5 and above extracts the folder path from the images3durl parameter value to make the parameter work with FSI Server 42 NeptuneLabs FSI Viewer 3D Configuration Note for eRez Users If you are using 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 In this case the resulting code snip will contain the parameter mages3DUrl with parameters to retrieve the image list e g amp images3durl 3Fcmds3Dlist 26src s3Dimagess2Fmy3dIimages s26vtls3Dfsis2Fimage list3d xml 62opages3D1s26rows 3D16 626co1S 3D16 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 source image with 12 image tiles The number of horizontal and vertical image tiles must be sp
141. ing 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 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 lt result success true gt filename xml lt result gt if the server succeeded in saving the file OR lt result success false gt 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 OOOO O datafile The file name of the stored XML file returned by the server error Error description Fei Ui The URL of the calling FSI Viewer instance FSI_notepad_id The unique id of the notepad UniqueID 196 NeptuneLabs FSI Viewer Plug ins Reference URL or file name of an XML data file to load 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
142. is 1 SomeImageName tif Size 2048 x 1024 px The two templates lt ImageIndex gt and lt ImageLabel gt are built in templates containing the numeric index of an image and the label attribute of the lt image gt 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 Prefix applied to thumbnail texts Contest Showcase plug in node or HTTP query prefixed with showcase_ A prefix string applied to all thumbnail labels or false for no prefix LabelTextWidth and LabelTextHeight Horizontal or vertical space for thumbnail labels Contest 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 Text alignment for all thumbnail labels left center or right ER Contest 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
143. ize 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 Size of the drag bar Showcase plug in node or HTTP query prefixed with showcase_ A floating point value defining the width of the drag bar of the thumbnail bar NeptuneLabs FSI Viewer 119 FSI Showcase Add on Show Hide the buttons in the thumbnail bar eft me 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 Size of the menu of the drag bar Showcase plug in node or HTTP query prefixed with showcase_ A floating point value defining the size of the menu inside the drag bar Deut me 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 pe 1 Context Showcase plugin 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 Show tool tips when hovering above a thumbnail pen me Showcase plug in node or HTTP q
144. ke lt FPX gt or lt Options gt 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 encodung scharser 7 gt lt a EISES gt EE lt image src 01 gt lt image ore O gt meee gt lt image src 04 gt SIMs EE OS gt SSES E EE lt Images3d gt lt iLei a Images 2DURL URL to an XML file containing a 3D image list 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 Prefix Suffix to add to 3D image URLs contee zos OO Prefix or suffix to add to the lt 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 lt images3d gt node Parameters for tiled source images Method B only TilesX and TilesY Number of individual images for 3D presentations Query ImageTilesX and ImageTilesY or alias FPXTilesX and FPXTilesY 5 5 0 or higher 2 1 0 or higher for ali
145. l other editions this plug in can be optionally obtained Using the Synchronize plug in you can synchronize multiple instances of FSI Viewer To synchronize 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 Unique identifier 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 Get re 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 222 NeptuneLabs FSI Viewer Plug ins Reference Synchronize the Measure plug in peut we 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 instances independently NeptuneLabs FSI Viewer 223 Plug ins Reference Plug in TextBox Plug in Target User interface Plug in L
146. ld node of the root node lt result gt see example below Each result item must at least contain the page number corresponding 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 64 NeptuneLabs FSI Viewer FSI Pages Add on Search Result XML lt xml version 1 0 encoding utf 8 gt lt Results gt lt Item page 10 gt Some lt b text b gt for this resuli lt Item gt lt Item page 20 gt Some lt b Eott D for this lt Item gt lt Item page 30 gt Some lt b gt text lt b gt for this result lt Item gt 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 FSI Server The easiest way to add links to FSI Pages is using a source PDF document cont
147. ler dimension for the FSI Pages instance The parameters below focus on thumbnail pages Show hide the user interface pe me Pages plug in node or HTTP query prefixed with pages Show true or hide false the user interface of FSI Pages add on NeptuneLabs FSI Viewer 95 FSI Pages Add on IdleAutoTurn Description Turn pages automatically 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 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 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 Context Pages plug in node or HTTP query prefixed with pages_ 3 5 5 or higher Specifies a link to open when the user clicks anywhere on the FSI Pages instance This parameter is especially useful 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
148. m will be created by default Referring to Figure B this would be NeptuneLabs FSI Viewer 43 3D Configuration lt SceneSets value 1 24 gt 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 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 lt tLlLesx EE SE Et lt FPX gt Oormems lt SceneSets value 1 8 9 162 17 24 gt OEO 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 Parameters for Virtual 3D Presentations The following FSI configuration parameters apply to virtual 3D presentations only Parameters for multiple source images Method A only Images3D Node containing the list of source images Contest ROOT node li
149. mage and with FSI server on the maximum size defined in the real time template used with FSI Viewer See parameter PrintTemplate SaveTemplate Image template to be used Gemeng mes OOO Defines the FSI Server profile or eRez real time template used to download an image 208 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 lt 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 Maximum width and height FSI Viewer can not be resized to a dimension greater than specified by these values MinWidth and MinHeight Minimum width and height FSI Viewer can not be resized to a dimension smaller than specified by these values EnlargeBy Resize viewer in steps of n pixels peut SSS Specifies the steps FSI Viewer will be resized by Entering 1 means that the viewer resizes exactly according to the size of th
150. n FSI Pages for details NeptuneLabs FSI Viewer 107 FSI Pages Add on SearchSortResults Sort search results o we 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 Number in pixel or percent 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 for even uneven pages Pages plug in node or HTTP query prefixed with pages_ CropInner CropOuter Number in pixel or percent 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 Enable plug in events Boolean false 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 Pleas
151. n 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 entire 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 After activating the debug mode an output window is available presenting information about the initialization progress configuration parameters plug ins and image information FSI Viewer Debug window ei E EN gt A Loading 3 Plug in s You can select different debug sections by clicking the corresponding tab at the bottom of the window 1 plugins filters plg ok Flash filters 5 0 0 ready i i i 2 plugins pages plg ok The window can be moved by dragging the window title bar and you can show or FSI Pages 5 0 0 ready Wan 3 plugins mousemodes plg ok hide the window by pressing d MouseMades 5 0 0 ready l General SALE Plug ins The section All contains the entire debug output Please provide the content of this section when requesting support
152. n 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 lt 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 153 Plug ins Reference The basic structure of a HotSpot definition is the following HotSpot definition REENEN lt HotSpots gt Gi rele o pot Eip eo e lt rect SOO te ip M ur o s EE EE 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 lt Options gt in a configuration file Plug in Parameters Initial visibility of the HotSpots Defines the initial visibility of HotSpots The HotSpot button state will be set accordingly Defines the opacity for all HotSpots Number between 0 100 Plug in attribute or lt HotSpots gt tag Defines the opacity for all HotSpots from 0 invisible to 100 opaque BaseURL Prefix for relative HotSpot URLs Plug in attribute or lt HotSpots gt group tag Defines a prefix that will be applied to all HotSpots containing relative URLs
153. nTop LabelTextSize ImageMarginY LabelSpaceY Thumblabel _ N EdgeRadius LabelSpaceX LabelSpaceX 114 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 hand disable plug ins for individual images adding an lt options gt parameter with the name of the plug in to the corresponding lt image gt tags of the image list Example Disabling a plug in inside an lt image gt definition Defining FSI Showcase image nodes lt Images gt lt Image label No Magnifier gt LE PXS SEET o lt Width value 8096 gt lt Height value 12300 gt lt FPX gt Oormons lt Magnifier value false gt SE EES lt Image gt lt Images gt e 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 115 FSI Showcase Add on Showcase Parameters The Showcase pa
154. nfiguration File Image Configuration File Image Node HTTP Query Cae a a 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 parameter definitions This can be especially useful if you want to override parameters defined in external configuration files for example overriding the MenuAlign parameter 112 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 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 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 Sh
155. nformation in the debug window 2 window 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 FSI Server ships with a readily installed copy of FSI Viewer If you are using FSI 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 Content Description Debugging components debug This folder can safely be deleted if debugging is not required any more User interface language files plugins FSI Plug ins extending FSI Viewer at runtime FSI Skins containing the visible parts of the user interface Please Note You need to make sure that your web se
156. ntain multiple alpha channels Be sure to save the 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 229 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 represen
157. nterface Domain list separated by Default Subdomain of FSI Viewer www domain tld domain tld domain tld Plug in attribute With Adobe Flash version 8 an additional limitation regarding Javascript to Flash access has been introduced Starting with version 8 only a script from the same subdomain as the Flash movie e g fsi domain com is allowed to access Flash the JSBridge interface With FSI Viewer and FSI server it is very likely that you use FSI Viewer from fsi yourdomain tld while your HTML document resides in the subdomain www yourdomain tld Therefore JSBridge plug in allows script access from the Subdomain www yourdomain tid and from the main domain yourdomain tid 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 lt allowdomains value Wwww domain com www domain2 com gt Description Activate debug output of Button IDs 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 Description Enable JavaScript callbacks Plug in attribute If enabled the events of FSI Viewer FSI Pages or FSI Showcase will be forwarded to a specific JavaScript function Please re
158. o UniqueID 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 UniqueIDs Space e amp j lt gt Alternatively to the plug in parameter you can use the global FSI Parameter UniqueID to specify a unique identifier Revision of the notepad data pe 1 You can use different revisions for the same UniquelID Changing the revision invalidates all bookmarks for a given UniquelID You might for example change the revision if you change add or remove pages in an FSI Pages catalog 192 NeptuneLabs FSI Viewer Plug ins Reference Plug in Parameters Layout and Appearance Show or hide the notepad on startup pe ne Show true or hide false the notepad on startup Default 320 wisth and 270 hegh O emeng Pugna Width and height in pixels of the notepad window Default mine context nemmen SSS The maximum width and height of thumbnail images in pixels Max width and height of thumbnail images Default mme SSS Context namen OOS 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 Angle of the background color gradient Default 5 Obsolete from version 5 0 0 defined by FSI View
159. o use when downloading images in the Save dialog Please refer to the chapter Printing and Saving Pages for details SaveOptions Enable or disable options in the Save dialog Context Pages plug in node or HTTP query prefixed with pages 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 eng OOOO pe fe contet Pages plugin node or HTTP query prefed with pages UUO Enables or disables the search interface of FSI Pages Please refer to the chapter Searching in FSI Pages for details SearchDialogWidth and SearchDialogHeight Size of the search dialog Number pied Defaut 400 with 300 regno The size of the search dialog in pixel Please refer to the chapter Searching in FSI Pages for details NeptuneLabs FSI Viewer 105 FSI Pages Add on SearchAutoWildCards Add wildcards to keywords automatically peut me By default FSI Pages adds wildcards to the keywords the user entered into the search input of the search dialog Set thi
160. ocation plugins textbox plg Function Adds a text box to display text related with the image below the viewer Syntax FSi Viewer lt 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 FSI Server or 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 el e E 70 gt lt i gt lt i gt lt u gt lt u gt Aone Be lt font Ssize n cGolor RRGCES gt lt font gt ao EE EE lt a E Plug in Parameters Default mme context nemmen Defines the name of the FSI Viewer parameter in the lt options gt section of FSI Viewer configuration containing the text to display You can specify short text as an attribute of this parameter e g lt IPTC_Data value Some Text gt For multi line text or text containing HTML tags you can alternatively use a text node lt IPTC_Data gt Text line 1 lt br gt Text line 2 lt IPTC_Data gt TextColor Default text color Default text color To use different text colors you can use the HTML tag lt font color RRGGBB gt 224 NeptuneLabs FSI Viewer Plug ins Reference TextSize Default text size Get nu Default text size To use different
161. of those pages matching the search criteria How does FSI Server determine matches By default FSI Server searches the IPTC data sets that FSI Pages Converter stores the keywords in only iptc caption and iptc fsi_search_data If your images do not yet contain keywords you might want to add keywords to the corresponding IPTC data sets of your images 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 In case you want FSI Pages to search all or other IPTC data sets please use the FSI Pages parameter nwoearchQueryTemplate The default value when using FSI Server is iptc caption ssearchtext 20iptc fsi_ search datatcossarchtexts s which limits the search to the two given IPTC sets To search in all data sets available modify the parameter value to Sosearchtext Using external Severs to return Search Results Alternatively to using imaging 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 r
162. olor of the drag bar Default reese S O Context Showcase plug in node or HTTP query preved wit srona 3 5 0 or higher Defines the shadow color of the drag bar pe me Context Showcase plugin node or HTTP query prefixed there Use a large round bevel or a small rectangular bevel when drawing the drag bar ImageWidth and ImageHeight Dimension of thumbnail images 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 Space between thumbnails The spacing between the thumbnails in the thumbnail bar in horizontal and vertical direction NeptuneLabs FSI Viewer 125 FSI Showcase Add on ImageMarginX and ImageMarginY Space around thumbnail image 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 ensure that the image does not overlap the thumbnail edge Defines the thickness of the border around the thumbnail image Setting this parameter to 0 disables the image border ImageBorderHighlight Description Highlight color of the border around the thumbnail image Derived fr
163. olygons do not require the spot parameter Instead you 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 Default Value ofspotperameter SSCS context nam SS CC CS S CNSCNC SC NSC S 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 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 lt text gt child node to each hotspot node instead of using the Tip parameter HotSpot text definition HOES DOES Circles spor as il OOF 06 0 4 Oy lt text gt lt b gt Headline lt b gt lt br gt Some text lt text gt lt CLrele gt le EES Moe Default ue emeng nen OOO 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 158 NeptuneLabs FSI Viewer Plug ins Reference Allow skewing of the HotSpot area pe ne 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 Yo
164. om BaseColor Showcase plug in node or HTTP query prefixed with showcase_ Defines the color of the highlighted section of the image border left and top 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 Color of the thumbnail face 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 OOFFOO or as a linear color transition from top left to bottom right by entering two color values separated by comma e g FF0000 00FF00 The corresponding parameters for active and selected state are ThumbActiveFace and ThumbSelectedFace 126 NeptuneLabs FSI Viewer FSI Showcase Add on ThumbBorderWidth Thickness of the thumbnail border beaut Ee 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 Default cor derved rom Baseco Coen 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 fo
165. on startup omit the file extension FSI Viewer ships with a default start animation Custom intros are available on demand Please note that using an unregistered intro activates the evaluation mode 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 FSIBase Path to FSI configuration files lt Options gt _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 SE EE lt FSIBase value config gt lt Options NeptuneLabs FSI Viewer 25 Configuration Specifying FSI files using the CFG parameter lt Olsig Sei ee 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 image1 fsi FPXBase Parameter Definition of FPXBase within the _default fsi file lt FPX gt lt Base value http domain com fsi server source gt lt FPX gt Specification of the FPXSrce within configuration files 1 FPXBase parameter is used for relative addressing LP PX gt lt SRC value folder image tif gt lt lt
166. oom value false gt lt Plugin gt EE Providing parameters using HTTP queries attached to the movie URL RRE FSI Pages Converter FSI Pages Converter is a Java based conversion tool to split PDF documents into separate TIFF files optimized for use with FSI and 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 lt Plugim Src pages ratio 1 2 gt or lt Plugin are Dages ratio 640 480 gt 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 lt 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 ViewerMarg
167. or 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 NeptuneLabs FSI Viewer 67 FSI Pages Add on XML Page data with 2 links lt Page file pagel6 pdt gt lt Links urlprefix http somesite com product php id gt lt Area tip Some Tip url 599 gt Sheeeucoocds 5040 0 ea 2a Oro On a Oke m0 27 Oe ay hane 1eOORGS Ors EE lt Text gt Some long descriptive text lt Text gt lt Area gt lt Area tip Another Tip url 210 gt lt o hare GOOndS Un ZU 0G RE lt Area gt EE RE 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 OOOO URL or file name to use for the 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 OOOO 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 Def
168. owcase 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 layout you will most likely have to define an offset to avoid parts of the Showcase being hidden below the menu bar The actual values depend 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 image_01 jpg image_02 jpg 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 113 FSI Showcase Add on Using Offset values you can define small thumbnail bars that do not occupy the entire width or height of the O 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 ImageMarginxX _ lt 2 eee E S ImageMarginY ImageBorder Image e LabelMargi
169. 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 lt overlay gt node Please see chapter Page Overlays for details 100 NeptuneLabs FSI Viewer FSI Pages Add on Defining a global page overlay lt lt 12 LUG faline gt lt Plugin src pages gt lt PageOverlays gt lt Owecley keet Deet t dee jolmomo Swi 72 lt Overlay page o file myOverlayl swf posxX 6 posY 12 gt lt Overlay page 21 file myOverlay2 swf posxX 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 pe fee context Pages pugin node or HTTP query prefed with pages UUO Defines whether to show or hide page overlays when zooming into a page Deae e ooo eent 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 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 NeptuneLabs FSI Viewer 101 FSI Pages Add on Description Enable printing of pages Boolean
170. prefix measure with the parameter name e g measure ImageWidth Description Indentation of the menu button Plug in attribute Specifies the space in pixels left of the menu button of the plug in 178 NeptuneLabs FSI Viewer Plug ins Reference ImageWidth Real width of the entire image Floating Point Value Defines the real width of the entire image e g 120 inches Please see the explanation in the previous section Defines a prefix for the length value Defines the prefix for the length value e g length Sue pe mm Coen nemme Defines the suffix for the length value e g inches Usually this is a length unit Bee OOOO pe 1 Coen neun Defines the number of decimals of the length value ShowText Display the current measurement string true Hides the text displaying the current measurement if set to false NeptuneLabs FSI Viewer 179 Plug ins Reference ShowAngle Display current angle pe me 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 neco SSS S Defa mm context nau 6 digit hexadecimal color value defining the color of the measure lines Defa mm Coen nemme 6 digit hexadecimal color value defining the color of the text context nemme 6 digit hexadecimal color value defining the color of the text border Use false for no border TextSize N
171. ption Level of visual 3D effects 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 86 NeptuneLabs FSI Viewer FSI Pages Add on DropShadow Description Enable or diable the dropshadow effect for the pages 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 Get In Context Les plug in node or HTTP query prened with pages Distance of the pages drop shadow in percent where 100 is the greatest possible distance ImageAlign pe Im contet Pages pugin node or HTTP query prefed with pages O OUO 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 Page background color Default Jm Context 1 Pages plug in node or HTTP query prefixed with ege Background color of the pages specified as 6 digit web color NeptuneLabs FSI Viewer 87 FSI Pages Add on PageBorderColor Description Color of page borders CCCCCC Pages plug in node or HTT
172. r query parameters Available templates are located in the WEB INF templates fsi directory of your imaging server setup 76 NeptuneLabs FSI Viewer FSI Pages Add on Alphabetical Index of FSI Pages Parameters EE EE nese 80 AUOZOOM EE 98 BACK TEE 83 BaCKCOVErCOMMG EE 84 Back COVE LIMAGS E 83 BendE eC e 85 BendEffectIntensity EE 85 SEIL lee TE 83 SEIL Gleef e EE 83 ButtonsFirstLastPage NNN ENN 96 ClICKPAGEIOZOOIM EE 81 ie elei eine EE 107 Bi elei E 107 Brei BEE 107 CIODOUUEE EE 107 COPRINT ge Ee ee 107 COD TOP EE 107 DefaultJavascriptTargGet cccccscsecseeeeeeeseeseeeeseeaeeaeees 93 Bizet le EE 93 M r dl ale DEE 94 DeTAUIFEINKURE EE 93 DefaultLinkKUrIPrefix AANEREN 93 Mal Aller E EE 93 POMOR vognene aa 95 DemoYRLTarget crise ii e an a ae A ews ine 96 RI 75 DoublePageAllowInteractivity ccccccseseeeeeeeeeeaeeaeees 82 DOUDIGPAGEZOOM c0cceceeececeesateesnearseseaseneatenseneatens 82 DoublePageZOOMSCale cecsscsseeeearsseceeeeeateneeneatens 82 Maisy 86 DropShadOwDIstance cccccccseceeseeseeeeseeaeeseseeaeeaeees 86 Emp Mages ae a even aaa 78 EV GIVES ee EEN 107 FirStPAGENUMDET cccccressceccesersessucersuscusceearsessuserens 79 FIIDCOMMEISIZE E 108 FIIDEEGQCSIZE arier evs a a 108 Seille All 90 ForceJavascriptTarGet NNN ENN 92 Kelte Bil aleet 92 FOrCeLINK UID ninn anaa a 93 FOrCeLNKUR lnvicias sovsuinathan orien ANS 92 Site A uk EE 92 FOFGELIN KU nk EE 92 ForceSaveUR EE 103
173. r active and selected state are ThumbBorderActiveHighlight and ThumbBorderSelectedHighlight Default coor derved rom Baseco Coen 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 Radius of rounded thumbnail edges 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 127 FSI Showcase Add on OffsetTop Description Offset from the top of the viewer instance 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 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 Description Offset from the left of the viewer instance Showcase plug in node or HTTP query prefixed with showcase_
174. r 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 eon O pe me Coen mme 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 Coen mme 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 consequences 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
175. r movie clip In this case parameters have to be provided in the following form Parameter1 Value1 amp Parameter2 Valuez Characters that are not URL compatible such as 7 and amp within the values need to be URL encoded O Providing parameters by HTTP query lt 0DJect classid clsld D2 CPRGh An OD Iver Vobe 4445535 40000 codebase http download macromedia com pub shockwave cabs flash swflash GCabtvenrsivon o 0 65 0 widea 370 height 240 lt PARAM NAME movie VALUE fsi fsi swf cfg foo debug 1 amp MenuAlign TL gt 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 SE EE El EE Sa lt ServerType value fsi gt EP Eg ivaleni HITE OLET 2PRXSre foo I AE oer yer e a 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 LOPE One lt Debug value true gt lt MenuAlign value TL gt Op One HTTP Query equivalent debug true 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 nam
176. r of pages remaining in the load queue onPagesShowIndex GER each time the user shows true or hides false the page onPagesShowZoom Called each time the user starts true or ends false page zoom S Called each time the user clicks a link SE The parameter contains the URL Commands for FSI Pages Add on 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 newImageIndex n where nis 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 newImagelIndex to a number prefixed by or e g 1 is the same as NextPage NeptuneLabs FSI Viewer 75 FSI Pages Add on Parameters to retrieve Image Collections Address of imaging server The URL of the setup path of imaging server to be used when retrieving image collections Image directory The directory on imaging server containing the images to use for FSI Pages Pages plug in node or HTTP query prefixed with pages_ A search query to collect images from imaging server to be used for FSI Pages ListTemplate Template used to retrieve image list from imaging server fsi image_list xml The XML based template to use when retrieving image lists from imaging server via dir o
177. raivietnmisiian vetoes 103 FOrCeEXMLDataFiles ccscsscrssssesecusesseaneeeeens 82 EE e Ee 25 FPXServerTemplate cscscsresssssecesesseareeseens 23 ERXSCRV ER TY DG eege ee 22 EPXSEC aiaa decay eeuetene 23 134 226 NAH Tele le KEE 47 FPX Tile PAGGInGY EE 47 SIN E 192 Frame WICK enestitescetanteaweignetaitonesetasseiaannts 192 FROMECOVER stages eterna ite es 83 FFONTCOVEr CONG E 84 FrOMCCOVEFIMAGE anionen O 83 SC 25 FUIBACK COV EE 83 PUUFTONCGOVO E SE GIOWAID EE 179 alen 179 GIOW RAMOS penin a a eased 179 GEO E 142 PANG e 31 ale UE 173 ale EE 173 FlavG PAGES E 84 Height E 23 191 200 223 HelpImageURL E 87 EE 30 zl El EE 30 FIGCO ee EE 201 acti aesa 33 RIOANONECOIOF seirian a 170 la EN ee EE 128 lege EE 128 Eeer 117 ILR BE 220 IIe CITE 145 NeptuneLabs FSI Viewer HEET gees 145 el 7 Oe A ln ME 95 TdleAuto TUrnDelay a 95 IdleAutoTurnMaxPage uk 95 IdleAutoTurnMinPage uk 95 PED er CT iee ervereniansanaaiads 144 HDI TOONID EE 145 HOLUR Gira 145 IG MOT CO WGI aonne ce beter eaeice bet keane 37 IgnoreQueryParameters NNN 38 me E Le EE 86 TmageBackgGroundColor csccscecssceeeeeeeees 192 TImageBorderHighlight scscsesecseeeserseers 124 TmageBorderShadow NN 124 TmaGeBorderWidth Ak 124 IMAJ EMEC E 193 Us Ei le ln sirenerne aiai 123 191 E Let Ela EH 124 IMAGE EL ell EE 124 E lee GIE te ieran 27 IMAGES KN 44 TMagGeS3DPrefix cccssessccusersuecneausuesuraccavseranes 45 TMG eS SDSUMX E 45 TmagessDUR
178. rameters described in the following can be provided in 3 different ways a Attributes of the plug in tag Example Parameter provided as attribute prett lt Plugin src showcase Layout Outside gt EE EE b Child nodes of the plug in node Example Parameter provided as child nodes Plugins lt Plugin src Showcase gt lt Layout value Outside gt lt Align value Left gt lt Pilugin 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 gt The following value types can be used Type Example S EE mm neies O either 0 1 or true false fHexcolor Im 116 NeptuneLabs FSI Viewer FSI Showcase Add on Alphabetical Index of FSI Showcase Parameters PIG VEH 114 SI ele Te 120 BackgroundAlpha DEE 120 DEE Eeer 114 BASE SCall EE 114 Breis vlf luet 130 EE 118 Bea EE 115 Weiel ici e ein len EE 121 DragBarROUNCBevel cccccccscsseseeeeeeeeeeeeeeeseeseeaeeaes 121 DAG aS aGOW Aerst iini aut 121 D FAG BSE dien RE 115 Recul 116 DragMenuWidth uk 116 ECGER le TC 123 EmpyimageS ri en a e r 119 la Deel EE 126 FIOVOFZOOM E 126 Seel aen 115 ImageBorderHighlight cccsccseseeeseeeeeeeeeeeeeeeess 122 ImageBorderShadow EE 122 ImageBorderWidth uk 122 ImageMarginX and ImageMarGINY uk 122 ImageWidth and ImageHeigGht uk 121 PIU ru AGS EE 11
179. rue or an active false state Mouse Mode ID The mouse mode ID has been activated Magnification percent The magnification has changed ImageSelected Image index 0 nImages e Ve Ge selected FSI Pages only Called after the FSI Pages Add on is ready for use The parameter provides the total number of pages true false onPagesInitComplete Integer Called each time before the user goes to a different page The parameter provides the target page number onPagesGotoPage Integer Called each time after the current page has changed The parameter provides the index of the page currently visible onPagesPageChanged Integer Called each time the load progress of FSI Pages changes The parameter provides the number of pages remaining in the load queue onPagesShowIndex Boolean Called each time the user shows true or hides false the page index onPagesShowZoom Boolean Called each time the user starts true or ends false page zoom Called each time the user clicks a link BEE ge The parameter contains the URL onPagesProgress Integer Please note that some plug ins provide additional events Please refer to the events parameter of the corresponding plug in for details 168 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 Ev
180. rver 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 transferred 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 e FPXServerType Enter the type of your imaging server e g fsi or erez e FPXBase Request base of the imaging server e g http domain fsi server source or http zis domain com ftif 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 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 12 NeptuneLabs FSI Viewer Setup Licencing FSI Viewer You can use FSI Viewer without a licence key for evaluation purposes In thi
181. s lt FPX gt ImageServerType alias FPXServerType 5 5 0 or higher 2 1 0 or higher for alias lt FPX gt Please enter the value fsi for FSI Server Please enter the value erez for YaWah eRez Imaging Server For the Zoom Image Server from iSeeMedia please enter the value 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 ServerTemplate peut SSCS context ng me OOOO This parameter applies to FSI Server and 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 ImagePath Path of the image to display Coen ege The path to the image on your FSI Server including the profile name e g lt ImagePath value images samples foo jpg gt NeptuneLabs FSI Viewer 23 Configuration URL of the source image to be displayed URL Obsolete Please use ImagePath instead 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 FSI Imaging Servers lt FPX gt lt Sre value http w
182. s 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 be specified separately using the skin parameter of FSI Viewer Show hide the page slider Deut me Pages plug in node or HTTP query prefixed with pages_ Show true or hide false the slider to select pages Enable disable table of contents true Enable true or disable false the user to show the page index containing thumbnails of all pages 80 NeptuneLabs FSI Viewer FSI Pages Add on KeepIndex Description Keep index data when hiding the index 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 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 Description Enable disable zooming into pages 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 Show true or hide false the load progress display FSI Pages automatically sets this parameter
183. s 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 licenced 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 Open the file configuration file _default fsi using a text editor Copy the licence key you received Paste the licence key including the lt licence gt tag Save the modified file e Licence key added to the _default fsi file imal Oel Cae eS EE Licence key goes here lt licence gt lt p LoL Secamener 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
184. s 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 Add quotes to keywords automatically Deut Tee OoOO Context Pages plug in node or HTTP query prefixed with pages_ Setting this parameter to true makes FSI Pages add quotes to search requests 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 Context 1 Pages plug in node or HTTP query prefixed with pages 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 paraml valuel amp param2 value SearchCustomURL URL to request the search result from 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 imaging server Please refer to the chapter Searching in FSI Pages for details 106 NeptuneLabs FSI Viewer FSI Pages Add on SearchCustomValue A custom value to pass with the search request A custom string to pass to the server along with the search request This option is useful when using a server ot
185. s 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 FSI Server from version 1 0 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 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 22 87 FSI Server 1 0 YaWah eRez Imaging Server 2 5 4 5 6 16 iSeeMedia ZoomImageServer 4 0 4 6 TrueSpectra Image Server 4 1 1 Service Patch 3 NeptuneLabs FSI Viewer 7 Using FSI Viewer U
186. s value defines the right padding of thumbnails inside the thumbnail bar of the showcase Please see the Showcase measurements figures for details Zoom thumbnails onMouseOver Number Defauit 100 disabled O O O 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 Rotate thumbnails onMouseOver Default 0 asabed 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 0 degree to 360 degree 130 NeptuneLabs FSI Viewer FSI Showcase Add on The following parameters can be used to customize the text displayed on the thumbnails LabelTextSize Text size of the thumbnail labels Default 0 no tet Showcase plug in node or HTTP query prefixed 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 Content of the thumbnail labels Showcase plug in node or HTTP query prefixed with showcase_ Obsolete Please use LabelContent and LabelTemplates parameters described below instead LabelContent Content of thumbnail labels Contest Showcase plug in node or HTTP query prefixed wit
187. script 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 dont 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 gt 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 Index of FSI Viewer Parameters ANIMAUON EE ER AMiMatlOnSPCOG BEE 32 AIIM AUON A OG EE 32 SE 25 eet 22 ConcurrentRequests 5 eeeENERN KREE NK ENNEN ERNK NENNEN KEREN 40 CODROCE an E 26 DEDU nena a E aE 24 DefaultCFG iine a nd 22 EE de eege 27 TEE 34 EnableZoomInPanMode uk NENNEN 31 Extended Viewport ccccscsscceccesersnecesarsnscesensatsnseneanens 31 Seil 25 Handerson 31 lef GE 30 HelpURLTarQetviccssiscissidavistensteissanastnavieeiasiecienisaimasns 30 alle MES 33 IGHOPEQUENY E 37 IgnoreQueryParameters cccscceceeeeeeeeecseeeseesneeeeeeees 38 IMAGEPAN EE ege teuer gekeee acti K eiehege kee
188. scription Defines round skin corners Version Defines the radius of the rounded viewer corners Possible values range from 0 no rounded corners to 99 UISwitchable Description Enable hiding showing the user interface pe me Coen m SCC SS 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 NeptuneLabs FSI Viewer 33 Configuration Defines the color of the viewer borders Coen mme Version ep Color of the border as a hexadecimal color value e g FF0000 for red Use false for no border pe me contee If this parameter is activated subsequently loaded image details are displayed abruptly without transition Image manipulation parameters for all images 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 TL 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 d
189. se 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 panning or rotating the image Debugging Image Access Problems You can configure the debug window to debug image access as well To do so you need to set the global parameter DebugImageAccess 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 50 NeptuneLabs FSI Viewer Automation NeptuneLabs FSI Viewer Automated Implementation of Images 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
190. se 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 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 Hide Display menu Displays or hides the user interface Information E Displays information about the viewer and refers to a configurable help page Parameter He pURL 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 clicking on the desired area of the image NeptuneLabs FSI Viewer 9 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 e Function Rotate around the x axis 3D only or previous view If you have activated the debug mode you can hide or display the debug window a this key Refresh the image information in the Refresh the image i
191. sending list by email ShoppingList When enabled the user can email a shoppinglist to others MaxCountPerlItem Description Maximum Count per item Defines the maximum unit per item that can be added to the shoppinglist MinItemHeight pen In Defines the minimum height of each item in the list peut me context sro Enable or disable the caching of list data If disabled the list info is lost when the user leaves the FSI pages instance PersistentStorageExpiresAfter Defines after which period of time the shopping list data expires NeptuneLabs FSI Viewer 215 Plug ins Reference Minimum Height of items in the list peut me Enable Disable printing EC eent mo OOOO Defines wether the shoppinglist is displayed after an item has been added TargetURL Defines the target for shoppinglist Defines the target URL of the servlet the shoppinglist data is send to Template context srog O Defines the HTML templates to be used for rendering the pages ShowListOnAddItem Show shoppinglist behaviour E Description of the template 216 NeptuneLabs FSI Viewer Plug ins Reference DialogHeight Defines the height of the shoppinglist dialog window pen mm Defines the height of the shoppinglist dialog window DialogWidth Defines the width of the shoppinglist dialog window Defines the width of the shoppinglist dialog window NeptuneLabs FSI Viewer 2
192. 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 66 NeptuneLabs FSI Viewer FSI Pages Add on The corresponding parameter for FSI pages looks as follows XML Page data provided by XML files SEELEN lt Plugin src pages gt lt XMLBase value http www myserver com xmldata gt lt Plugin gt EE 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 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 file for each page The example below shows the structure of page data added to a configuration file XML Page data in configuration files SES Cel Canna ES ex lt FPX gt lt Pages gt lt Page ke page0 6s tif m Lainke e EE lt Page gt lt Pages gt S S parane ei XML Data Format for Pages OSS catalog fsi yy page data Usually you don t need to edit the XML data for FSI Pages manually as FSI Pages Converter creates the XML data f
193. set button see command Reset Zoom In button see command ZoomIn Zoom Out button see command ZoomOut Plugin SwitchMusic regensreag SSS Click History Back button of the history plug in Click History Forward button of the history plug in NeptuneLabs FSI Viewer 165 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 mue 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 for details on how to obtain image section parameters Example Button Zoom to image section MSIE Input ype bubcon i value T Zoom CO SeCcEe on onClick Yocum nc ache Eere wer Seu Vcr able TES MP em EE Implementing JavaScript callbacks Using JavaScript callbacks enables you to react to FSI Viewer FSI Pages or FSI Showcase events by executing JavaScript code The JSBridge plug in calls a JavaScript function using the Flash FSCommand architecture providing an ev
194. set Roman page numbers by given value 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 Enable or disable FSI Pages to open links Default ee Context 1 Pages plug in node or HTTP query prefixed with pages_ 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 NeptuneLabs FSI Viewer 91 FSI Pages Add on ShowLinksWhileFlipping Show or hide links during flip animations o fe 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 Opacity of the link area Content Pages plug in node or HTTP query prefixed with pages_ 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 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 FFOOOOFF for opaque red or OOFF0099 for semi transparent green pe mmm eent 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
195. sifale context nemmen O Use these parameters to enable or disable the buttons below the bookmark list e EnableAddFullBookmark Enable bookmarking of entire images or pages e EnableAddLinkBookmark Enable bookmarking of links e EnableAddCustomBookmark Enable bookmarking of custom areas e EnableSendBookmarks Enable sending bookmark data ImageEffects Image modification parameters Optional parameter to add image parameters for the thumbnail images For FSI Server you can for example sharpen an image or adjust the image compression level e g effects sharpen 230 amp quality 95 ExpandSelectionToImage Expand image selections to fill entire thumbnail pe me 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 195 Plug ins Reference AddButton Add notepad button to menu bar Default true FSI Pages false 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 Offset of the notepad button 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 specify
196. sing 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 D wiper 2 a Viewer The Menu Bar 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 Ber 8 NeptuneLabs FSI Viewer Using FSI Viewer Mouse Modes The Mousemodes or MousemodeSelect plug in is required to display the following mouse mode buttons Mouse Zoom In Choose this function to enlarge segments using the mouse Click on the image and drag the frame over the desired segment Alternatively 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 Mouse Turn Choo
197. sing JSBridge plug in or FSI Component 212 NeptuneLabs FSI Viewer Plug ins Reference The following events apply to this plug in EventID Parameter_ Description onSelectFrameEnable The select has been enabled or disabled onSelectFrameStart ST The user starts selecting EE Strin The user modifies the select frame g The parameter provides a string representing the current selection l The user stopped modifying the selection OEA EEIT The parameter provides a string representing the current selection NeptuneLabs FSI Viewer 213 Plug ins Reference Plug in ShoppingList Plug in Target Shopping List User interface of FSI Pages 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 S 2 pce Plug in Location SS Dee plugins shoppinglist plg l ek pce 9 00 Function K i i Zur Website Unit Price 9 00 Add shopping cart functionality to FSI Pages F Syntax lt Plugin src shoppinglist gt EEE Delete Selected Show Page Send by email Delete All Plug in Parameters Defines the currency Defines the currency inside the shoppinglist DecimalCharacter Decimal delimeter Decimal delimeter Default unit string pe fe Defines the default unit of items added to the shoppinglist 214 NeptuneLabs FSI Viewer Plug ins Reference Description Enable Disable
198. sizes in the text you can use the HTML tag lt font size n gt Height of the text box Height of the text box in pixels peut Jm emeng nemme O Background color of the text box pe fo Coen Pugna Opacity of the background from 0 invisible to 100 opaque Base color for the interface parts Base color to use for the interface parts of the plug in e g the scroll bar and the border NeptuneLabs FSI Viewer 225 Plug ins Reference Display a border to separate the text from the view port true Display a border separating the text from the viewer s view port BorderColor Color of the border Plug in attribute Color of the border separating the text from the viewer s view port E contea nemme OO Width of the border separating the text from the view port ScrollArrowColor Color of the arrows of the scroll bar Default Derived from BaseColor parameter 6 digit hexadecimal color value for the arrows in the scroll bar 226 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 lt Plugin src zoommeter color 000000 gt The ZoomMeter plug in extends the navigator window with a display of the current magnification Plug in Parameters Text color Default mere Context nes OSS Text color of the zoom
199. stroza Linas Jankauskas Yukihiro Kawada Slawomir Kilanowski Hillar M eotsa Kristian Ottosen Ivo Teel Stas Ukolov Andri Viiand 232 NeptuneLabs FSI Viewer Index Absolute Addressing ccccscsccseceseessensseeesseensees 23 ele Le EE 21 A E 22 ComboLabelBackgroundAl pha ccsceceeeeeees 136 DEDUG lee 48 Embed Tag RE 14 Error Messages iuas as 226 FSU le E 55 Defining Image Collections ccsececeeeeeees 58 FSi Pages Converte E 56 FLY DENI E 64 Bien 72 PINUNO ie 60 SAVING PAGES eassa ate red eee Bed de 61 SCA CHING eege 62 PSI Pages CONVGMer wicitescceteeicecte ieee Aibieat 56 FSI Pages Parameter Socinano 76 115 FOL SHOWCASE wi utile oti eine ie etek te 108 FSI Showcase Parameters NN 115 FOL VICWER E 15 TAS ta UO MN E 11 Menu EE 8 MOUSE ee 30 ODI CCE TAG EE EEN 14 FSI Viewer Parameters cccsscscssssusesecenensnenenees 20 Parameter EIERE aa 194 PICA Zeeche ee E 116 LO e UR ei ENEE 168 AIIOWMirroOredNotes scscecsecseeeeeeseereeeeees 217 PID EE 138 152 217 ANIMated Rect EE 209 TIET 32 AnimationSpeed csceecsececseeecseeeceeenensensees 32 ArrowAlphaActive NNN 199 Arrow lobahormal uk 200 AFFOW FING OIOK sce xcctevstattnwsidesvesteresiacsudiacines 200 ArrowLineColor s ssssesssssnunnsnununnnnnnnnnnnnnnnnns 200 EINEN 199 Ee en LEE 210 AUTOCFODP ee 80 AULORIGEDIGIOG ET 141 EE 185 AUTO ZOOM KEE 98 BaCK COVEN onia elites tate taee eee ee ahcng 83 NeptuneLabs FSI Viewer
200. t 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 Description Relative path to an alternate default configuration file fsi swf defaultcfg filename _ default 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 URL to your FSI Server Default See description below lt Image gt The UTL to your FSI Server including the servlet name e g lt ImageServer value http mydomain tld fsi server gt If you do not specify this parameter FSI Viewer will try to determine the URL based on it s own URL and the default location of the viewer folder in the FSI Server setup 22 NeptuneLabs FSI Viewer Configuration Description Image Server URL eent um Obsolete Please use parameter ImageServer instead Domain and path to the imaging server All FPXSrc parameters containing relative paths without http will be extended by the path defined by FPXBase ServerType String FSI eRez ZIS TrueSpectra TrueSpectra Bridge Context lt Image gt or alia
201. t lt PARAM name menu VALUE false gt lt PARAM name allowfullsreen VALUE true gt lt Object gt Please note that when using fullscreen the plugin the Adobe Flash Player prohibits keyboard entries 150 NeptuneLabs FSI Viewer Plug ins Reference Plug in History Plug in Target User interface History Back History Forward Plug in Location plugins history plg wy m CH lt 4 gt Function History functionality to jump to previously viewed image sections Syntax lt Plugin src history length 25 gt 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 Indentation of the menu buttons Plug in Tag Specifies the space in pixels left of the menu button s of the plug in Lem OO Get me emeng nen OO 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 the history list Default Im 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 stepping before the first entry of the history list Providing the default value false the history will not be loop
202. t 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 191 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 User ml 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 User1 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 and remarks created by User 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 Unique String used to store notepad data locally String see description A unique string identifying the notepad data Using the same or n
203. 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 155 Plug ins Reference DefaultMove Zoom to HotSpot area by default Defines the default value for all subsequent HotSpots that do not contain the Move attribute betae ne contea Pugin atbute or lt HotSpots gt tag OO Defines the default value for all subsequent HotSpots that do not contain the Skew attribute Default color of HotSpot borders Default mm Context Plug in attribute or lt HotSpots gt tag Defines the default color of HotSpot borders Fill the HotSpot area by default Boolean Plug in attribute or lt HotSpots gt 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 Default fill color for the HotSpot areas FFFFFF white Contest Plug in attribute or lt HotSpots gt group tag Defines the default fill color for HotSpots that do not contain the FillColor attribute 156 NeptuneLabs FSI Viewer Plug ins Reference DefaultFillAlpha Default fill opacity for the HotSpot areas Default 1 Contest Plug in attribute or lt HotSpots gt group tag Defines the default fill opacity for HotSpots that do not contain the FillAlp
204. th 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 a PDF document containing all pages Context Pages plug in node or HTTP query prefixed with pages 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 SaveUrISuffix Prefix or suffix for page download URLs Syntax String 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 Target frame for downloading a file related to a page EC HTML frame to open page related files SaveURL in Please refer to the chapter Printing and Saving Pages for details NeptuneLabs FSI Viewer 103 FSI Pages Add on ForceSaveURL URL to use for downloading a file related to a page This parameter overrides the download URL specified in the file attribute of the page s XML data Specifying this parameter forces
205. th 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 198 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 y y PET OS mie KT KE lt Plugin src pagesmirror gt Plug in Parameters Defines the blur effect of pages Contee Paes Defines the blur factor of the mirrored images Defines distance between the pages and the mrror effect Contee leae OOOO Defines the distance of the mirror effect and the pages Coen rgi O Defines the mirror effects opacity on the near end NeptuneLabs FSI Viewer 199 Plug ins Reference Plug in PageSounds D Plug in Target FSI Pages ane Zu Plug in Location plugins pagesounds plg H Scbit fl KE E ae oad dag H Se Function Adds page flip sounds to FSI Pages nee aie al i Syntax lt 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 Get In emeng nenn OO Th
206. the image borders to the center of the view port Default Im Coen mme With this option enabled the pan range for the image is limited to the minimum 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 Default Im Coen mme 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 pe me Coen Tommes Animate zoom and rotate actions true or zoom and rotate in a single step false 32 NeptuneLabs FSI Viewer Configuration AnimationType Description Defines type of zoom animation Version Defines the type of the zoom animation acceleration on start or end bounce etc Possible values are 0 to 6 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 Description Hide user interface 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 De
207. ting that value as a pair of hexadecimal digits The digits preceded by a percent sign are then used in place of the reserved character FSI Viewer transforms URL encoded values back to the original value How can I 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 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 FFO000 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 f
208. to true if you specify a hyperlink for the entire FSI Pages instance see DemoURL AutoCropPages Crop images to fill entire page o fe Enable true this option to automatically crop images to fill the entire pages You need to specify an aspect ratio manually in this case NeptuneLabs FSI Viewer 81 FSI Pages Add on ClickPageToZoom Enable Disable zooming by clicking a page o me Enabling true this option enables the user to zoom a page by clicking it Defines the animation speed of in place maginifications initiated by Zoomarea hyperlinks bewe oo Context Pages plug in node or HTTP query prefixed with paget Defines the speed of the zoom animation when zooming in Defines the animation speed of in place maginifications initiated by zoomarea hyperlinks Seat Im Context Pages pugin node or HTTP query prefixed with pages Defines the speed of the zoom animation when zooming out ZoomAreaAnimationType Defines the animation type of in place maginifications initiated by zZoomarea hyperlinks eae eent Pages plugin node or HTTP query prened with pages Defines the animation type of the zoom animation ZoomAreaTargetScale Magnification level of in place maginifications initiated by zZoomarea hyperlinks Gei 2 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 exc
209. ton of the plug in AutoPlay contee nengen OOOO Set the value to Boolean true to make the sound play on startup 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 Path to an MPEG3 audio file mp3 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 187 Plug ins Reference Loop Play the sound once pe fee Defines if the sound will be played once or in a continuous loop pe fee Coen nem SOSCS C S S S S S S S S 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 Number 0 100 Defines the volume of the sound from 0 quiet to 100 maximum KeepState Keep Stop Play state when selecting images pe lm Plug in attribute 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 188 NeptuneLabs FSI Vie
210. u might want to use this parameter to ensure that e g HotSpots defined with the lt circle gt tag look like circles instead of ellipses You can use the DefaultSkew parameter to change the default behavior ei pe f0 Coen nam Defines the color of the HotSpot border The value has to be a 6 digit hexadecimal number like FFFFOO for yellow or OOOOFF for blue You can use the DefaultColor parameter to change the default border color PO pe ne Coen nmn SSSSSCSC lt s S s S S 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 Hyperlink of the HotSpot 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 NeptuneLabs FSI Viewer 159 Plug ins Reference Target frame for hyperlinks pe fo Defines the targetframe for HotSpot hyperlinks Valid parameters include _ blank _self op _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 FSI parameters to be used on click sing query If you define a CFG parameter for a HotSpot the viewer will be reinitializ
211. uery 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 120 NeptuneLabs FSI Viewer FSI Showcase Add on MinimizeOnSelect Minimize the thumbnail bar on select pen me 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 pe fee Coen 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 Image manipulation parameters applied to thumbnail images Coen zo OO Applies image manipulation effects like sharpen or quality to all thumbnail images Please refer to the FSI Viewer effects parameter for a detailed description Show or hide image changing buttons pe me eent opges If set to false the buttons to switch to the next or previous iages are hidden NeptuneLabs FSI Viewer 121 FSI Showcase Add on ImageList Parameters If you are using FSI S
212. umber oe Get nm Text size for the textual output in pixels 180 NeptuneLabs FSI Viewer Plug ins Reference BGColor Defines the color of the text background 6 digit hexadecimal color value defining the background color of the text BGAlpha Defines the opacity of the text background Defines the opacity of the text background 0 100 ea 4 OSOS SSSCSCSC C sSsSS context neun O 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 pe s o contea Pugna O Opacity of the glow range surrounding the measure tool Description Color of the glow range FFFFFF 6 digit color defining the color of the glow range surrounding the measure tool NeptuneLabs FSI Viewer 181 Plug ins Reference Send plug in event notifications Syntax Boolean false 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 Event1D Parameter Description onMeasureEnable The measure tool gets enabled or disabled The user starts measuring onMeasureStart The parameter provides the current distance and angle as displayed in the measure tool The user drags the measure tool
213. uoN SE 19 Passing Parameters el WE QUEIV geseet eer 19 Alphabetical Index of FSI Viewer ParaMeters cccccccecscsesecessteeseeeeenensnseaeeneusenenetaeans 20 Retrieving Parameters from IMAGING Servers ENEE 21 BASIC ee 22 Applying Effects to Specific Images Only NNN 36 Editing or Creating Language Fil S ccccsccscscsccsecvcececavsesuesecnsueseersueuesrseeussuseensaneass 41 Virtual SD Presentations sirian 42 Parameters for Virtual 3D Presentations ENNEN NNN 44 Debug Mode sorain inana aA ANKENN AANA ONEEN ANKANA NANE 49 E abling the DeDug Mode EE 49 using tne Depug WINGOW EE 49 Automated Implementation Of IMageS ssss2ss 51 GIL Kl CR 53 Riede tel le Kn EE 54 Defining Plug in Parameters cccccscsecsecccecsecccececcececueneceseesesrsuesesrsucussrsecuensensenneeass 54 Defining Plug in Parameters dynamically NENNEN 55 ESL PAGES AGG ON EE 56 USING rol le EE 56 Forages el EE 57 Eayout and l EE 57 penning Bi E IeER ae ege E 59 Page Reading OFGEN EE 61 SVING PAG CS eaceennecagtecacacdencast sienna se EE saat cece ee nanea 62 Searching ID FSL PAGES EE 63 Adding Hyperlinks to 8 LE 65 Publishing PDF Documents with Links using FSI Pages Converter and FSI Server 65 Providing XML page data to FSI Pages NENNEN 66 Link Parameters and Hierarchy of Link Parametere uk NNN 70 Relative and Absolute LINKS cccceceeseeeeeeeceeeeseeeeseeeteeaesenseausenetaesenstareenen
214. 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 NeptuneLabs FSI Viewer 29 Configuration Specifies the speed of the action specified by the InitialAction parameter Possible values are integer values greater than 0 0 highest speed gt slower 1 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 Description URL of custom help page http help fsi viewer com 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 Get mn emeng ko 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 30 NeptuneLabs FSI Viewer Configuration Initial MouseMode Mouse mode on startup Context Tommes Specifies the selected mouse mode on startup Possible values 0 Zoom 1
215. wer Plug ins Reference Plug in NavExtension Plug in Target User interface Plug in Location plugins navextension plg Function Additional navigation control Syntax lt Plugin src navextension visible true gt l Ch FSI E 33 3 The NavExtension plug in adds a draggable navigation control to the FSI Viewer user interface that can be hidden and shown with a corresponding button in the menu bar The control automatically adds buttons for scenes and scene sets depending on the image configuration Plug in Parameters Indentation of the menu button Content Plug in attributes Specifies the space in pixels left of the menu button of the plug in peut ne Coen nemme Defines the initial visibility state of the control Initial X position in pixel Initial horizontal position of the control in pixels relative to the top left corner of the viewer NeptuneLabs FSI Viewer 189 Plug ins Reference Description Initial Y position in pixel Syntax Number Initial vertical position of the control in pixels relative to the top left corner of the viewer 190 NeptuneLabs FSI Viewer Plug ins Reference Plug in Notepad Plug in Target User interface of FSI Pages Your Bookmarks Plug in Location o Page 2 luains notepad pl Fes Here are your comments plugins Ppad pig Function Creating and displaying bookmarks with text and image Page 4 Here are your comments Syntax
216. 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 tag 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 lt Object classid clsid D27CDB6E AE6D 11lcf 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 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 lt Obj7ece Cillassid clsird D27 CDBGE ARGD ller IJ6be 444553540000 codebase http download macromedia com pub shockwave cabs flash swflash Cabf
217. 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 NaveEffects parameter Sharpening Images in the navigator window lt NavEffects value effects Sharpen 30 gt FSI Server lt NavEffects value sharpen 35 gt eRez Imaging Server lt NavEffects value ftr 5 gt Iseemedia Zoom Image Server Image manipulation parameters applied to the navigator window Coen mme Applies image manipulation effects like sharpen or quality to all images inside the navigator window Please refer to effects parameter for a detailed description Image manipulation parameters applied to preview images context m CSC s S 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 Image manipulation parameters applied to image tiles Coen zo OO Applies imag
218. ww domain com EE EE EE foo CnN e gt lt EPX gt Absolute addressing Iseemedia Imaging Servers lt FPX gt lt Sre value http www domain com fif project foo fpx gt lt EPX gt Partial relative addressing lt FPX gt lt oro value project foobar fpx gt lt FPX gt Default J o O Context lt Image gt or alias 91 Version 5 5 0 or higher 2 1 0 or higher for alias lt FPX gt 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 Width and height specifications for a source image Wa EIERE lt Height value 4660 gt lt FPX gt 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 24 NeptuneLabs FSI Viewer Configuration Filename of FSI Skin to use without extension eent om 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 Filename of start animation to use without extension Filename of animation to display
219. y 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 lt SaveDocumentFile value http foo com somepdf pdf gt 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 62 NeptuneLabs FSI Viewer FSI Pages Add on For this example your configuration should look like this Enabling Save Options prett lt Plugin src pages gt lt Save value true gt lt SaveDocumentFile value http www foo com downloads catalogl all pdf gt lt

Viewer - ViewFX

Contents

Download Pdf Manuals

Related Search

Related Contents