Query String Parameters
Certain functions in Flipbooks can be invoked by including query string parameters in the Flipbook address. The following parameters are documented and supported. Any parameter not documented here is not supported and shold not be used and depended upon.
Say you have an international catalog with visitors from many nationalities. In iPaper CMS you can only define one language for the user interface (though this can be used to auto-detect the users language), but using the ForceLanguage parameter, you can override the normal user interface language. Example URL that forces the language to French:
Please refer to iPaper Support if you need a specific language code. If you link to a non-existing language code, the catalog default will be used instead.
If you do not want to link to a specific page number, but rather to the first page that contains a certain search term, the GoToFirstSearchResult parameter can be used. The following sample link would take the user to the first page containing the term “Century”:
If the search term is not found, the user will be sent to the first page.
GoToAndHighlightFirstSearchResultare specified in the URL, this query string value will be ignored.
This query performs the same operation as
GoToFirstSearchResultabove, but has the additional ability to highlight the term on the page itself.
GoToAndHighlightFirstSearchResultare specified in the URL, this query string value will take precedence.
Using this setting you can override the “Hide Navigation Bars” setting on Flipbooks:
Using this setting you can override the “Hide Standard UI” setting on Flipbooks:
The Page parameter is used when you want to deeplink to a certain page in the catalog. The following sample link would take the user directly to page 15:
Linking to a non-existing page number will take the user to the first page instead.
Once the above script is included you must add the polite parameter to the URL you are requesting.
The preload parameter can be used to ensure that a Flipbook only loads the visible pages initially. Standard behavior would also preload the next/previous pages. When preload=minimal is enabled the preloading will start loading once the user pages for the first time.
To forward query strings to links, you can prefix query strings with
ipforward_. We will strip the prefix and add your query strings to any outgoing links in the Flipbook.
As an example, the below URL:
Would result in external links getting decorated with your parameter:
You can use the
ipforward_prefix with any parameter you want. If someone follows a link within your Flipbook, the
ipforward_is stripped, so only your parameter is retained in the link. And you can of course add multiple parameters: