General Parameters

false
Default

The debug mode can be enabled or disabled by passing the debug parameter either in the code snip or in an XML configuration file. Please use debug=1 or debug=true 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.

Defines the relative path to an XML configuration file in FSI Viewer format. When using a relative path the location specified by the FSI Viewer FSIBase parameter will be used, which is viewer/config/ by default.

auto
Default

Default is auto which automatically chooses the best format depending on the browser; alternatively you can choose WEBP, JPEG, PNG or GIF. Auto delivers the images adaptively as WEBP in supporting browsers, and switches to PNG or JPEG on browsers not supporting the format. If you would like to use WEBP, the best way would be to set auto as the format.

black
Default

FSI Pages comes with three default skins, black, white and silver.

Skins are defined via CSS and can be found here: /fsi/viewer/skins.

It is also possible to alter existing skins or to define custom skins in this location.

In order to use a custom skin, the easiest way would be to duplicate one of the default skin CSS files and adapt them to your liking. Make sure to use a custom class in front af ALL classes defined in the custom CSS, otherwise you will break other skins on the same HTML document.

To see an example file, please go to the Example File in the Appendix.

General appearance CSS rules, which are valid on an overall level, (e.g. the logo container, height of the menubar, etc.) are defined in the corresponding core CSS files, which can be found in /fsi/viewer/skins/resources. (fsi-core.css, fsi-viewer-core.css)

The viewer will load the list of images from the given directory.

Example: dir1/1.jpeg, dir1/2.jpeg, dir2/1.jpeg,...

The language parameter can be used to adapt the tooltips which are shown while hovering over a button to a certain language. The available languages can be found in the \languages folder of your FSI Viewer installation. (See Using Custom Language Files for more info).

It is also possible to map the available language files to the language of the browser (the file mapping.json in the \languages folder of your FSI Viewer installation can be adapted to your liking for that). In order to use the mapping defined in the JSON file, the parameter language needs to be set to auto.

true
Default

Prevents automatic initialisation when the instance has been attached to the DOM. Helpful e.g. when working with React.

true
Default

When set to true, the interface scales according to the zoom level.

info
Default

Enables or disables page zoom.

100
Default

Maximum zoom in percent of the source image.

false
Default

Enables zooming into the catalog with one click instead of the default double click setting.

PrintPage | FirstPage | PreviousPage | PageInputEnter | NextPage | LastPage | ToggleBookmarkList | ToggleBookmark | ToggleTableOfContents | ToggleFullScreen | ToggleFullScreen
Values

Determines the button order in the menu bar. Use the button ID which can be found in the respective skin.css (viewer\skins\resources\fsi-pages-core.css) for listing them.

Example: MenuButtonOrder="ToggleFullscreen, FirstPage, LastPage"

true
Default

When set to true, the buttons for directing to the first or the last page appear.

true
Default

Enables or disables the page index containing thumbnails of all pages.

Limits the image list to a certain amount of images within the directory. The parameter is used like this: 0,10 - the first value defines the starting image, the second the amount of images displayed. In this case it would start at the first image and show the first ten images. 5,5 would start the list with the fifth image and shows the fifth image plus the four images that are listed behind it.

filename | width | height | lastmodified | resolution | importstatus
Values

Sorts the image list with any valid sort item name for FSI Server.

asc | desc
Values

Defines the order of the image list sorting. Possible values: asc (Ascending) or desc (Descending).

Filters the image list to a certain amount of images within the directory using RegEx. If images match the Regular Expression, they will be included in the image list. If both ListFilterPositive and ListFilterNegative are used, ListFilterPositive is always used first. The filter will be applied before any other parameter is applied, i.e. if SceneSets is set, it only applies to the already filtered list.

Example: ListFilterPositive="/8.TIF$/i"

Filters the image list to a certain amount of images within the directory using RegEx. If images match the Regular Expression, they will be excluded of the image list. If both ListFilterPositive and ListFilterNegative are used, ListFilterPositive is always used first. The filter will be applied before any other parameter is applied, i.e. if SceneSets is set, it only applies to the already filtered list.

Example: ListFilterNegative="/8.TIF$/i"

true
Default

Specifies whether a text box for the page input is displayed in the menu bar.

true
Default

Specifies whether the enter button for the page input field is displayed in the menu bar.

image_list.xml
Default

The XML based template to use when retrieving image lists from the image server via dir or query parameters. Available templates are located in the WEB-INF/templates/fsi/ directory of your server setup.

The XML based template used for the Page Data.

URL | no action | enter fullscreen
Values

The URL to the website that should be opened while clicking on the demo thumbnail. 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 user clicks the viewer.

Alternatively:

• no action: the click will do nothing at all
• enter fullscreen: enter fullscreen and exit demo mode, returns into demo mode after leaving fullscreen mode

_self
Default

The target frame for DemoURL to open in. You can use default frame names like _self or _blank or use a custom frame of your HTML frame set.

true
Default

Hide UI elements (menu bar and alike) in demo mode.

Tool tip to show when in demo mode.

<DemoToolTip>
  <b>Demo Mode</b><br/>
  Click to view image in full screen mode
</DemoToolTip>

true
Default

Enable or disable the user to print current pages, the complete catalog or specific pages from the image collection shown with FSI Pages.

2000
Default

Specifies in which resolution the user is allowed to print the pages.

Defines image modification parameters to apply to images which are used for printing. You can sharpen the image and define the JPEG compression level, e.g. sharpen=100&quality=95.

false
Default

Enable or disable the download dialog where the user can save the current pages or the complete catalog, depending on the settings.

2000
Default

Specifies in which resolution the user is allowed to save the pages.

Defines image modification parameters to apply to images used for saving. You can sharpen the image and define the JPEG compression level, e.g. sharpen=100&quality=95.

If you want to enable the user to save the PDF of your catalog, you can link the URL to the PDF here. This enables the option complete document in the download dialog.

false
Default

Enables or disables the search interface of FSI Pages.

true
Default

Shows input for search.

simplesearch
Default

Using simplesearch makes FSI Server search in the data fields iptc.fsi_search_data and iptc.caption only by default rather than searching in all metadata fields.

iptc.fsi_search_data,iptc.caption, iptc.fsi_extra
Default

Comma separated list of metadata fields names to search in.FSI Server with FSI Viewer parameter SearchType="simplesearch" only.

false
Default

With this parameter, FSI Pages adds wildcards (*) to the keywords the user entered into the search input of the search dialog. Set this parameter to false if you don‘t want FSI Pages to add wildcards automatically.

flip | zoom
Values

flip: flip to result page (default) zoom: zoom the result page

Define a text to search for on start or an empty string (default) to not initiate a text search on start.

320
Default

Defines the size of the Search result thumbnails.

This parameter provides the possibility to add parameters to the search query within FSI Pages. The parameters need to be provided in the regular HTTP request format: param1=value1&param2=value2[…].

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.

false
Default

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.

true
Default

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.