Layout/Appearance Parameters

scroll | flip
Values

Defines the animation when moving to another page. scroll slides the pages as if they were positioned next to each other (like in FSI Pages mobile). flip shows a page turn effect.

Defines if edge flip is turned off below a certain site width. Example: If set to 400, the edge flip is turned off when the page is displayed below 400px. Helpful if you have links to articles on a page near to the edges and want to make sure they can be clicked on smartphones, where usually the edge flip action overlaps.

75
Default

Defines the size of the draggable corner of each page that automatically bends (in px). Use 0 to entirely disable the bending corner.

50
Default

Defines the width of the draggable edge of each page to flip to another page (in px). Use 0 to entirely disable the draggable edge.

true
Default

Adds a drop shadow underneath double pages. Only applies if PageLayout is set to flip.

info
Default

Defines the drop shadow opacity. Default is 0.3 from the style sheet class .fsi-pages-root .fsi-page-drop-shadow. Any value between 0.0 and 1.0 can be set.

50
Default

Defines the distance of the drop shadow. Default is 50. Any value between 0.0 and 100.0 can be set.

1
Default

Specifies the page to display on startup, e.g. 1 for the front cover.

1:1
Default

The aspect ratio of pages displayed in FSI Pages.

You can specify any aspect ratio (e.g. 320:240 or 1:2) or specify auto to use the aspect ratio of the second image in the image collection.

0,0,1,1
Default

Crop rectangle (left, top, right, bottom) as 0.0..1.0. Floating point values to display a given section of an image only.

Default: 0,0,1,1

true
Default

If this parameter is enabled, the right page uses a horizontally flipped crop rect. If it is set to false, both pages use the same crop rect.

0,0,0,0
Default

Defines the amount that should be cut off the image from each side. Values can be provided as pixel (e.g. 20px) or percent (e.g. 10%) or floating point numbers (e.g. 0.25).

The effects parameter can be used to pass image manipulation parameters to the imaging server. Typical manipulation parameters include the image saturation (saturation) and image sharpening (sharpen). If no effect is specified, the default settings of the server (profile) apply.

In contrast to all other parameters, defining the parameter effect adds(!) the string to the existing effects parameter. E.g. if your configuration file contains: <effects value="blur(10)" /> and you add to your fsi-viewer tag effects="sepia()", the resulting effects parameter value is: blur(10),sepia().

If you want to overwrite existing effects values, you can start the effects parameter with ClearEffects().

In the example above, if you add effects="ClearEffects(),sepia()" to your fsi-viewer tag, the resulting effects parameter value is sepia() only.

true
Default

Defines if navigation with the mousewheel is possible. If activated, you can turn pages while scrolling with the mousewheel.

160
Default

The maximum size of thumbnails displayed in the index. The actual width and height depend on the aspect ratio of the pages.

Parameters only valid if PageLayout is set to scroll.

false
Default

When set to true, the pages scroll in the vertical direction instead of the usual horizontal. Note: only valid if PageLayout is set to scroll!

false
Default

Note: only valid if PageLayout is set to scroll!

true
Default

If set to false, the pages will not be displayed as coherent double pages.

true
Default

If set to true, the double page mode automatically activated.

glossy
Default

Defines if the pages are shown with a bend effect. none disables the effect.

true
Default

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.

true
Default

Setting BackCover parameter to false disables access to the back cover and forces FSI Pages to add a blank content page if required.

A path to an image to use for the front cover. FSI Pages will use the ImageServer parameter of FSI Viewer for relative paths. The cover page(s) will be added to the images in the image list.

A path to an image to use for the back cover. FSI Pages will use the ImageServer parameter of FSI Viewer for relative paths. The cover page(s) will be added to the images in the image list.

true
Default

Use a blank page as back cover.

Using this parameter you can add blank pages. The value of the parameter must contain one or more image page numbers of the blank pages to be inserted.

E.g. <EmptyImages value="2,10" /> adds two blank pages at page 2 and page 10, moving the other images in your collection correspondingly.

Alternatively you can add <image empty="true" /> nodes to your image collection.

Using this parameter you can remove images from the image collection. The behavior of FSI Pages is exactly as if the images would not be listed in the image collection.

E.g. <EmptyImages value="1,3,4" /> removes the first, third and fourth image in the collection. Please note that removing images takes place before inserting blank pages using the "EmptyImages" parameter.

false
Default

Run the FSI Pages in demonstration mode and turn pages automatically when the user does not interact (= moves the mouse) for 2 seconds.

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.

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.

2
Default

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.

false
Default

Show or hide page numbers on pages.

1
Default

Defines with which page number the catalog starts. 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.

0
Default

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.

Use CustomPageNumbers to specify custom page numbers as a comma separated string. Items starting with underscore ("_") will not be displayed. Pages without a custom page number will use the ordinary page numbering.

<CustomPageNumbers value="_cover1,_cover2,3,4,5,_" />

In this case the cover page and the first left page will have no page number. The first right page will start with page number 3. The sixth page again has no page number and the seventh and following page will be numbered as usual.

Same as CustomPageNumbers, but the page number values will be loaded from an XML file. You can either define a path relative to the fsi/config/pages_xml/ directory or an absolute URL. The required format of the XML file is as follows:

<fsi>
    <pagenumbers>3,6,7</pagenumbers>
</fsi>