flexpaper Plugin

Compatible with DokuWiki

Weatherwax, Binky, Ponder Stibbons, Hrun

Flexpaper, like flashpaper, the open source web based document viewer.

Last updated on: 2014-12-21
Provides: Syntax
Repository: Source

This extension is marked as obsoleted. Therefore it is hidden in the Extension Manager and the extension listing. Furthermore, it is candidate for removal.

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Tagged with !obsolete, embed, flash

By ethenguo

Flash is not available anymore in browsers.

Installation

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

External requirements: This plugin requires the following additional components that must be installed separately:

https://flowpaper.com/download Download Web Server Package

And then copy below files to plugin folder “dokuwiki/lib/plugins/flexpaper/FlexPaper”:

FlexPaper_*.*.*.zip
|-FlexPaperViewer.swf
|-js
  |-expressInstall.swf
  |-flexpaper.js
  |-flexpaper_handlers.js

Please make sure these files path are:

dokuwiki/lib/plugins/flexpaper
|-FlexPaper
  |-FlexPaperViewer.swf
  |-js
    |-expressInstall.swf
    |-flexpaper.js
    |-flexpaper_handlers.js

Or the plugin will NOT WORK!!!!

Examples/Usage

See the examples in here.

Usage:

{{flexpaper>namespace:sample.swf}}
{{flexpaper>namespace:sample.swf?width:600px}}
{{flexpaper>namespace:sample.swf?height:480px}}
{{flexpaper>namespace:sample.swf?start:3}}
{{flexpaper>namespace:sample.swf?width:600px;height:480px;start:3}}

Syntax

Basic syntax:

{{flexpaper>namespace:sample.swf}}
{{flexpaper>namespace:sample.swf?width:600px;height:480px;start:3}}

Opinion Parameters

Parameters	Default	Description
`width`	100%	Width of flexpaper
`height`	588px	Height of flexpaper
`start`		(Number) Instructs the viewer to start at a specific page

Configuration and Settings

Parameters	Default	Description
Scale	0.6	The initial zoom factor that should be used. Should be a number above 0 (1=100%)
ZoomTransition	'easeOut'	The zoom transition that should be used when zooming in FlexPaper. It uses the same Transition modes as the Tweener. The default value is easeOut. Some examples: easenone, easeout, linear, easeoutquad
ZoomTime	0.5	The time it should take for the zoom to reach the new zoom factor. Should be 0 or greater.
ZoomInterval	0.1	The interval which the zoom slider should be using. Basically how big the “step” should be between each zoom factor. The default value is 0.1. Should be a positive number.
FitPageOnLoad	true	Fits the page on initial load. Same effect as using the fit-page button in the toolbar.
FitWidthOnLoad	false	Fits the width on initial load. Same effect as using the fit-width button in the toolbar.
FullScreenAsMaxWindow	false	With this set to true, clicking on fullscreen will open a new browser window with FlexPaper maximized instead of using true fullscreen. This is a preferred setting when using FlexPaper as flash standalone as the security limitations of the Flash player disables (for security reasons) most of the input controls in true fullscreen.
MaxZoomSize	5	Sets the maximum allowed zoom level
MinZoomSize	0.2	Sets the minimum allowed zoom level
SearchMatchAll	false	When set to true, the viewer highlights all matches when performing searches in a document.
InitViewMode	'Portrait'	Sets the start-up view mode. For example “Portrait” or “TwoPage”.
PrintPaperAsBitmap	false	When set to true, the viewer will print the document as a bitmap as opposed to vectorized
ViewModeToolsVisible	true	Shows or hides view modes from the tool bar
ZoomToolsVisible	true	Shows or hides zoom tools from the tool bar
NavToolsVisible	true	Shows or hides nav tools from the tool bar
CursorToolsVisible	true	Shows or hides cursor tools from the tool bar
SearchToolsVisible	true	Shows or hides search tools from the tool bar
localeChain	'zh_CN'	Sets the locale (language) to use. The following languages are currently supported: en_US (English) fr_FR (French) zh_CN (Chinese, Simple) es_ES (Spanish) pt_BR (Brazilian Portugese) ru_RU (Russian) fi_FN (Finnish) de_DE (German) nl_NL (Netherlands) tr_TR (Turkish) se_SE (Swedish) pt_PT (Portugese) el_EL (Greek) dn_DN (Danish) cz_CS (Czech) it_IT (Italian) pl_PL (Polish) pv_FN (Finnish) hu_HU (Hungarian)

Development

Change Log

2014-12-21
- fixed small bug
2014-09-07
- Initial release

Table of Contents