Dynamic PageFlip 3.4 - Using XML
Iparigrafika Desktop

The Dynamic PageFlip 3.4 uses an XML configuration file to store preferences and content informations. This XML file can be edited with a text editor (not word processor!) like TextEdit/TextWrangler/NotePad or can be generated by a server-side script.

To create your own book, first you need to make every page one by one, then edit the XML file. Page files can be either in jpeg/gif/png or in swf format. Animated gifs are not supported by the Flash Player.

How to use the XML file?

Here is a short description of the XML file's attributes, the way you can edit it...

Settings

the first part of the XML configuration file, used to configure the book.

PageWidth="330"
PageHeight="380"
AutoSize="true"
Set the page size in pixel. AutoSize is an option if you don't want to resize page files to the same size as it is defined with PageWidth/PageHeight. If you set it "true" it will resize the page file, if "false" it leave as it is.
StartPage="3"
Sets the starting page number. At the start the book will be opened at this page. This value is overwritten by directlink if it is defined at html's embed level.
Hardcover="true"
Hardpage="false"
PageFlip can handle two type of pages, "hard" and "soft", If you set Hardcover to "true" the covers will be hard, if "false" they will be soft. Hardpage do the same with the inside pages.
EmbossedPages="true"
Enables or disables the shine/shadow effect at the center of the book.
LargeCover="true"
LargeCoverTopOversize="10"
LargeCoverSideOversize="10"
With this option set to "true" you can use larger cover pages as the inside pages. Oversize values tells the script how many the cover pages are larger.
HcoverAngle="-30"
ClickArea="64"
AutoFlipArea="56"
GotoPageSpeed="2"
MousePursuitSpeed="5"
OnReleaseSpeed="5"
TearDistance="80"
Please modify these variables carfully, they affect page fliping animation control. HcoverAngle set the angle of the opened hard pages.
ClickArea is the shape width at the outer side of each page, where you can drag to begin flip that page.
AutoFlipArea is the box size at the page corners where you can flip a page by simply clicking on it, and it also used for curl the page corner at mousover.
Speed values controls animation speed at different events. 1 is the fastest, and as you increment this value the animation is slower.
TearDistance defines how far you need to drag a page to tear it off.
FlippingEnabled="true"
Simply enables/disables the ability to flip pages.
startAutoFlip="false"
As the book is loaded, it starts fliping automatically through the whole book.
PageCache="3"
Defines the number of pages (back and forward) to be preloaded from the actual page.
PageLoaderBackColor="0x333333"
PageLoaderColor="0x666666"
Defines the colors used on the empty page that is only visible before the page file was loaded or in case of that file is not accessible. It uses Hexadecimal RGB values.
TransparencyEnabled="true"
TransparencyActivePage="true"
Enables/disables the 1 leve transparency in the book. If you don't use transparent pages, set both value to "false" to use less CPU. Set TransparencyActivePage to "true" if you want active animations on the page covered by the transparent page.
PDFlink="test.pdf"
Links the defined file to the Book button on the control bar.
ButtonHelp="true"
If "true" it shows a little help message when a button is hovered.
ZoomAreaWidth="680"
ZoomAreaHeight="440"
ZoomFollowSpeed="5"
ZoomActivePage="true"
Controls the zoom environement's window size, mouse follow speed. If ZoomActivePage is "true", animations on the zoomed page will be active.
ThumbnailsEnabled="true"
ThumbnailsActivePages="true"
ThumbnailsOnEachSide="false"
ThumbnailsFacingPages="true"
ThumbnailMargin="0"
ThumbnailPadding="20"
ThumbnailBorderWidth="0"
ThumbnailBorderColor="0x000000"
ThumbnailBorderHoverColor="0x000000"
Set up of the Thumbnail view layout.
MouseControl="true"
Enables/disables mouse control of the book.

PageOrder

the second part of the XML configuration file. Pages are defined in this section. Each page is defined in a pagedata tag, and have the following attributes:

PageFile="path/pagefile.jpg"
Defines the path and the file to be loaded for that page. PageFlip supports JPGs, non-animated GIFs, PNGs and SWF file formats.
LargeFile="path/pagefile.jpg"
Optional. Defines the zoomed page file, it is loaded when you click on the magnifier button, or when you print that page. If you don't define this attribute the zoom/print buttons will be inactive.
Label="pagelabel"
Optional. It is used by the table of contents. You can refer to that page in the table of content.
TearOff="true"
Optional. Default it is false. If you set it to true, you will be able to tear out that page.

TableOfContents

this part is optional, it can build you a table of content, that can be accessed from any page of the book. Each TOC item is defined in a Link tag, and have the following attributes:

Name="Name of TOC item"
The name of that TOC item, as it will appear on the page.
TargetLabel="pagelabel"
TOC item target page is identified by the label set in pageorder.
TargetPage="1"
TOC item target page is identified by its number. If you set it to 9999, the link will open the thumbnail view.
Skip="true"
Optional. Default is "false". If you set it to true, you will go directly to the target page without flipping through the book.

Need more information?

If you still need help on PageFlip setup, or you think this page is not informative enough, please contact us.