Home

PAGEFLIP4 - Pageflip 5

1. User can assign HotSpot XML files to each Page Any number of HotSpots can be defined in each HotSpot XML file The HotSpot XML file structure is as follows lt HotSpotData gt lt HotSpot gt lt Rectangle gt lt Rectangle gt lt HotSpot gt lt HotSpot gt lt RoundRectangle gt lt RoundRectangle gt lt HotSpot gt lt HotSpotData gt Each HotSpot is described in a lt HotSpot gt node Here User can specify the content of the Popup if necessary and what happens if clicked on Moreover there can be an optional number of shape definitions within this HotSpot node These shapes are the areas on the Page that activate when mouse hovers them The same HotSpot can contains multiple shape definitions Attributes of the HotSpot node User has to specify at least one of the following three attributes to have a Popup window if mouse hovers over that HotSpot PopupTitle TitLe PopupText MulLtiLineText PopupImageFi Le page popupimages popupimage jpg Example with full HotSpot XML lt HotSpotData gt lt HotSpot PopupTitle TitLe PopupText MuLtilineText PopupImageFile page popupimages popupimage jpg gt lt Rectangle gt Q 300 5 lt Rectangle gt lt HotSpot gt lt HotSpotData gt HotSpot Shapes User can specify the location of the HotSpots one or more by defining the follow ing shapes The coordinates align to the specified page size These nodes are sub nodes of the lt
2. FirstPageTooltip First page PreviousPageTooltip Previous page NextPageTooltip Next page LastPageTooltip Last page AutoFlipTooltip Autoflip On Off CA MuteTooltip Mute CM InfoTooltip About CShift I IndexTooltip Table Of Contents C I LanguageTooltip English ThumbnailTooltip Thumbnail View CT FullscreenTooltip Fullscreen On Off CShift F CloseTooltip Quit PageFlip CShift Q PDFDownloadTooltip Download PDF version i gt lt Language gt To be able to use more than one language User should create new lt Lang gt nodes within the lt Language gt node and enable the Language switch button on the ControlBar ButtonLanguageEnabled true hash mark within quotation marks indicates the page numbers to be inserted later to the given text Example book is opened at page 10 PagerPage Page results Page 10 11 PagerPage oldal results 10 11 oldal 3 14 PUBLICATION OF THE CREATED PAGEFLIP If the created Book is successfully tested User can save it to its final folder which can be located on a web server or offline If User followed the recommended file structure the following should be copied to the final folder index html the html file that embeds pageFlip swf pageFlip swf pageflipdata folder with all the external files for PageFlip css folder html and LightBox styling js folder LightBox and SWFobject JavaScrip
3. If transparent background is disabled in the html the default background is white or the color set in the SWFObject pa rameter params bgcolor FFFFFF Background color TransparentBackground false BackgroundCoLor 0x2A2A2A User can specify an optional background color see Appendix K Color codes Disable the transparency of the background default setting and set a background color Background image Regardless of the background color PageFlip4 loads the image from the given URL and places it in the background While the image is being loaded the set or default back ground color is displayed TransparentBackground false BackgroundImageFi Le backgrounds demoBack2 jpg THE LAYOUT OF THE PAGEFLIP4 ELEMENTS The order of the Preview the Book and the ControlBar can be set LayoutOrder PREVIEW CONTENT CONTROLBAR By default they appear from top to bottom in the following order Preview Content ControlBar User can freely modify the order for example CONTROLBAR CONTENT PREVIEW The Preview has to be enabled as it is turned off by default not available in personal version ContentPreviewEnabled true The Content can either be the Book the zoom or the thumbnail view Floating Win dows appear on this content area too When scaling the Screen the size of the con tent part changes the other features have fix sizes for more information see the configuration o
4. are listed here with default values indicated Settings node attributes of the XML configuration file contain the general settings Attribute name default value type short description StartPage 1 uint Start PageFlip with this page opened StartAutoF lip false Thumbnai LModeStart false Boolean Boolean MouseControl true Boolean Enable automatic flip activation at start Enable Thumbnail view when PageFlip4 starts Enable flipping with mouse Se Te e a KeyboardShortcutsEnabled true Boolean Enable keyboard control CopyrightMessage String Copyright Message encoded with XML Vali dator PageWidth 300 PageHeight 400 AutoSize true Boolean Resize to fit loaded content on the Page uint Page width in pixels PageScale true Boolean Scaling the Book to fit the Screen uint Page height in pixels MinScale 50 uint Minimum scale in MaxScale 200 uint Maximum scale in ViewAngle 0 int Tilting Book MinStageWidth 632 uint Minimum width of Screen in pixels MinStageHeight 580 uint Minimum height of Screen in pixels BookMarginHorizontal 32 uint Horizontal margins of the Book BookMarginVertical 32 uint Vertical margins of the Book RightToLeft false VerticalMode false Boolean Book written from right to left Boolean Vertical flippin
5. lt Button ID 1 Name LEFTPRINT Width 26 Height 26 HitAreaOffsetX Q HitArea0ffsety 0 HitAreaWidth 26 HitAreaHeight 26 CustomX 52 CustomY Rotation 0 OnTop true Align TOP CENTER gt lt CustomControlBarLayout gt Description of the attributes ID and the Name are fixed name is only used to identify the button by the User it is not used by the script Width Height are the size of the button usually the clickable size but it can be over written see below HitAreaOffsetX Y the position of the Hit rectangle relative to the buttons top left cor ner Set only if values are not 0 HitAreaWidth Height set only if different from the buttons size set in Width Height CustomX Y are the coordinates of the button on the screen depends on alignement Rotation set rotation for your button if needed OnTop set true if the buttons have to be over the Book Align set the reference point of the buttons position alignement is set as follows it is composed by verticalAlignement horizontalAligne ment they can be TOP MIDDLE BOTTOM and LEFT CENTER RIGHT examples Align TOP LEFT Align MIDDLE RIGHT User can make place for the buttons with the BookMarginVertical and BookMarginHor izontal attributes in config XML s lt settings gt node It is applied to the book and also to the thumbnails D FONT EMBEDDING User can embed fonts with Adobe F
6. or the Keyboard Pages can be flipped horizontally or vertically as a calendar The pages can have soft or hard The Cover pages can be larger than the pages inside 2 3 2 4 We can create HotSpots on the pages with the help of XML configurations HotSpots are areas created by the User on the screen that can open Popup windows if the mouse hovers over it and send User to another page if User clicks on them HotSpots can also open links or LighBox images POPUP IMAGE Popup with Image This HotSpot is invisible but interaci ie mouse and open a Popup Window with Image and texts PNG PAGE FILE WITH HOTSPOTS aak lt Page 12 13 gt Aa ae gt i EROX D BY PAGER POWERED BY PAGEFLIP4 2011 IPARIGRAFIKA PAGEFLIP HU INFO PAGEFLIP HU Figure 2 2 HotSpot hovered and a Popup window opens with image and texts PREVIEW Optionally User can have a series of thumbnails beside the Book that we can hover over with the mouse if cursor is moved to the edges it starts and accelerates and the Book flips to the page on which we clicked rI C BDE Ae I Figure 2 3 The Preview Bar CONTROLBAR By default below the Book we find the ControlBar that can be divided into three ar eas the loader status is visible optionally on the left side the middle section includes the flip zoom print buttons and the current page number where the book is open while the right side has all the other functions namely AutoFlip
7. test will be sent to it function hotSpotCallC msg String void if Cmsg test code here is executed h The same way User can call the hotSpotCall function in the External Script using this HotSpot attribute ESfunction test If this HotSpot is clicked then the hotSpotCall function will be called in your External Script file The String test and the internal page number of the Page containing that HotSpot will be sent to it function hotSpotCall msg String pIPN uint void if Cmsg test traceC HotSpot clicked on page pIPN code here is executed 3 12 TABLE OF CONTENTS amp INFO WINDOW The structure of the two Floating Windows is very similar the only difference is that the Info window does not contain links Structure of the Table of Contents XML lt TableOfContents gt lt Title gt lt Description gt lt Link gt lt TableOfContents gt Structure of the Info XML lt Info gt lt Title gt lt Description gt lt Info gt User can vary the number and order of the Title Description and Link nodes option ally in case of Info Link cannot be used Title s attribute Name Table of Content Text of the Title Description s attribute Text Description text Text of the Description Link attributes Name Description text Text of the Link Skip true Direct jump to page targetLabel PageLabel Jump to
8. HotSpot gt node as seen in the previous code example Rectangle Indicates a rectangle lt Rectangle gt x y w h lt Rectangle gt Where x and y x and y coordinates of the upper left corner of the rectangle w and h width and height of the rectangle RoundRectangle Indicates a rounded rectangle lt RoundRectangle gt x y w h r lt RoundRectangle gt Where x and y x and y coordinates of the upper left corner of the rectangle w and h width and height of the rectangle r radius of the rounding Circle Indicates a circle lt Circle gt x y r lt Circle gt Where x and y x and y coordinates of center of the circle r radius of the circle Star Indicates a star with optional number of arms lt Star gt x y p r1 r2 phase lt Star gt Where x and y x and y coordinates of center of the star p number of tips r1 r1 radius of the tips and pits phase rate of rotation between 0 1 where 1 is a turn of one tip in case of a 5 armed star 360 5 72 degrees Shape Indicates an optional shape with each point defined by User the last point is automatically connected to the first one Example lt Shape gt x1 y1 x2 y2 x3 y3 x4 y4 lt Shape gt The shape consists of 4 points in the example the last point is automati cally connected to the first to close the shape The shape of the HotSpot can be invisible or it can have any color and transparency User can define these with the fo
9. Sound download information table of contents thumbnails language full screen exit Page 1 JIQ E rw i zRo Figure 2 4 The ControlBar The ControlBar can be disabled if we want to view the Book only Each button of the control bar has a Key assigned so if the given button is active it can also be activated from the keyboard By clicking into the text box the cursor appears and User can specify the page num ber or name to jump to and by pushing ENTER the specified page opens if it exists If the mouse is over a button for more than 2 seconds the assigned ToolTip appears that can be configured in the language section 2 5 COPYRIGHT MESSAGE A one line message in small print indicating the owners of the document Page 1 gt r71 aa POWERED BY PAGEFLIP4 2011 IPARIGRAFIKA PAGEFLIP HU INFO PAGEFLIP HU Figure 2 5 The Copyright Message 2 6 ZOOM VIEW An enlarged area of a given page More than one zooming level can be specified depending on the configuration A separate file belongs to all levels of zooms which loads only if necessary except if User enables the immediate loading of all sizes INTRODUCING TRANSPARENCY PAGEFLIP4 THE LEVEL OF TRANSPA IS NOT LIMITED ANYMOR Q Zoom Page 20 Q Qi Canceled opening the page A Figure 2 6 The Zoom View If User clicks on Zoom in Book view the sign turns to with which the zoom view can be left or the view can be decreased User
10. buttons Symbol_LeftHorizontal Symbol_LeftMostHorizontal Symbol_Zoom Symbol_Zoom_In Symbol_Zoom_Out Symbol_Print 22 x 26 pixel buttons Symbol_AutoFlip_Pause Symbol_AutoF1lip_PLay Symbol_Close Symbol_Download Symbol_Fullscreen_Off Symbol_Index Symbol_Info Symbol_Language Symbol_Mute_AudioOff Symbol_Mute_AudioOn Symbol_Thumbnails With the reconstruction of the Symbol elements User can create the custom buttons User has to generate the swf file and save it to the right folder by default it is the pageflipdata folder CUSTOM CONTROLBAR BUTTON LAYOUT User can also design a custom button layout which means each buttons can be placed anywhere on the Screen and an additional 8 custom buttons can be added to the screen which function can be defined in the External Script User can define the button graphics in pageFlipControls fla just like as it is described in the previous section To enable Custom Button Layout set the following attribute in lt settings gt to true CustomControlBarLayout true Default buttons keeps their place until one is overwritten in the lt CustomControlBar Layout gt node For example lt CustomControlBarLayout gt lt Button ID 0 Name LOADERBAR Width 200 Height 26 HitAreaOffsetX HitAreaOffsety 0 HitAreaWidth 26 HitAreaHeight 26 CustomX 80 CustomY Rotation 0 OnTop false Align BOTTOM RIGHT gt
11. document createELement a objLink setAttribute href url objLink setAttribute rel Lightbox objLink setAttribute title caption Lightbox prototype start objLink lt script gt lt head gt When PageFlip displays an image with the help of LightBox it only needs its file name URL and image description and it automatically invites the LightboxDelegate JS function with the modified URL If User wants to use the LightBox group image groups then the group has to be de fined in the html first while reference has to be made to the image id at display Definition of a group also in the embedding html lt body gt lt a id pic1 href pageflipdata pages a png rel Lightbox group1 title caption1 gt lt a gt lt a id pic2 href pageflipdata pages b png rel Lightbox group1 title caption2 gt lt a gt lt a id pic3 href pageflipdata pages c png rel Lightbox group1 title caption3 gt lt a gt lt body gt For more information on customizing LightBox visit the developer s homepage http www huddletogether com projects lightbox2 K COLOR CODES Color codes are specified in Hexadecimal RRGGBB code For example the color white is RGB 255 255 255 in hexadecimal format FF FF FF which the User can specify as color attribute Color OxFFFFFF L PAGEFLIP4 FAQ Can PageFlip4 display PDF documents
12. in PageFlip4 PAGEFLIP4 API PageFlip4 can be controlled by the following functions each of them can be called from a Page script or External Script gotoPage pIPN uint pSkip Boolean Boolean gotoPageNumber pPageNumber String pSkip Boolean Boolean gotoPageNameC pPageName String pSkip Boolean Boolean gotoPageLabel pPageLabel String pSkip Boolean Boolean openURLC pURL String plargetWindow String void openLightBoxImage pURL String pCaption String void openLightBoxGroupC pGroupName String void setMainBGC pBGImage String pBGColor int void resetMainBGC void Only External Script can access the following functions and an Array gotoFirst void gotoPrev void gotoNext void gotoLast void zoomLeft void zoomRight void toggleMute void toggleFullscreen void toggleThumbnailView void closeWindow void toggleAutoFlip void kilL void getIPNQ uint getNumberByIPNC pIPN uint uint getNameByIPNC pIPN uint String getLabeLByIPNC pIPN uint String getIPNByNumber pPageNumber uint int getIPNByNameC pPageName String int getIPNByLabelC pPageLabel String int makeAutoPreflip void page Array pageScriptC pIPN uint Object setMouseControLC pMouseControl Boolean void Only Page Script can access the following function showZoom void Access External Script from a page by calling Container ES myExternalScriptFunction and access a Page Script from the
13. it should be refer enced in the XML Figure D 1 highlighted with red rectangle 9 Choose the Actionscript Tab Figure D 2 a Actonsennt Outline format Classic DF3 O TLF DF4 Linkage Mi Export for ActionScript Export in frame 1 Identifier Class DinBlack v 2 Base Class flash text Font L 2 Sharing Export for runtime sharing E import for runtime sharing URL Figure D 2 The Actionscript Tab 10 Select Export for Actionscript option and then press OK 11 Insert the following code on the first frame of the Flash timeline Figure D 3 Font registerFontC FontName Where the FontName is the custom name specified in step 4 Figure D 1 high lighted with orange ACTIONS FRAME RPV CATE OFC F 1 Font registerFont DinBlacK 2 Figure D 3 Registering new Font in ActionScript To embed further fonts repeat the process from step 2 When ready create an swf file and specify the URL of this swf file in the XML Set tings FontLibraryFile attribute FontLibraryFile pageFlipFonts swf Then User can refer to the newly embedded Fonts with their names noted down in step 8 To specify a custom font as PageFlip4 default Font configure the Settings Default Font attribute Example DefaultFont DINBLk_PFL Normal E XML SETTINGS REFERENCE All the XML configurations sorted in categories
14. margins of the Book uint Transparency of the emboss effect 0 100 Boolean Enable shadow effect while flipping uint Transparency of shadow effect 0 100 Boolean Display Page name instead of numbers uint Horizontal margins of the Controlbar uint Width of ControlBar pager in pixels Boolean Controlbar over the Book Boolean Enable keyboard control Boolean Enable pager text display Boolean Enable Custom buttons Boolean ButtonCustom3Enabled false ButtonCustom4Enabled false ButtonCustom5Enabled false ButtonCustom6Enabled false ButtonCustom7Enabled false ButtonToolTipDeLay 60 Zoom0OnPageCLlick false DragZoom false ZoomHotspot true PopupMaxWidth 200 ExternalScript Boolean Boolean Boolean uint uint String Tooltip display delay in frames Enable Zooming by mouse click Enable Zoom image dragging with mouse Enable HotSpots in Zoom mode Set the maximum width of popup window URL of the External Script file F HOTSPOT XML REFERENCE Structure of the HotSpot XML files The root node directly contains the HotSpot nodes that describe 1 1 active links A lt HotSpot gt node attribute PopupImageFile String URL of Popup window image PopupTitle String Title of Popup window PopupText String Text of Popup window If no value is speci
15. specified page by Label targetPage 5 Jump to specified page number User can specify the configuration parameters of the Title Description and Link nodes if they vary from the default Font FontName Custom embedded Font Color 0x000000 Text color Size 12 Size Align right Align User can use the following four alignments left Default value align left right Align right center Align center justify Justify The length of the Table of Contents is not limited if the content exceeds the size of the window scrolling helps navigation in the window 3 13 MENU LANGUAGE SETTINGS User can specify the menu language in the lt Language gt node By default the menu language is English so User has to define the lt Language gt node only to enable other languages If User enables more languages and wants to use English too then it has to be defined in a lt Lang gt node in the XML The default values and XML structure lt Language gt lt Lang Name English Loading LOADING PagerPage Page PagerThumbnailPopup Page PagerThumbnails Thumbnails PagerThumbnailPages Thumbs PagerZoomPage Zoom Page PrintLeftTooltip Print left side page PrintRightTooltip Print right side page ZoomLeftTooltip Zoom on left side page ZoomRightTooltip Zoom on right side page ZoomInTooltip Zoom In ZoomOutTooltip Zoom Out
16. 66666 Default color and transparency ButtonAlpha 100 ButtonOverColor 0xFQB400 MouseOver color and transparency ButtonOverALpha 100 3 7 ButtonPressColor 0x666666 Press color and transparency ButtonPressALpha 50 ButtonDisabledColor 0x666666 Inactive color and transparency ButtonDisabLedAlpha 15 For information on customizing the graphic elements of the buttons and or the layout of the controlbar buttons refer to Appendix C CUSTOMIZING THE BOOK The Book settings determine the layout and the handling of the Book and the layout of the pages Either they directly affect the Book or they concern all pages of the Book In order of significance This section includes several attributes already explained earlier PageWidth 300 Width of the page PageHeight 400 Height of the page AutoSize true Automatic resizing of the content loaded to fill the Page PageScale true Automatic scaling of the Book MinScale 50 Minimum and maximum scaling in percent MaxScale 200 MinStageWidth 700 Minimum Screen size MinStageHeight 620 ViewAngle 0 View angle 89 89 StartPage 1 Start at the specified page AlwaysOpened false Book always open Book ZeroPage false 0 page content ZeroPageALwaysVisible false 0 page content always visible CenterSinglePage false Single page in center Ri
17. External Script where pIPN is the internal page number Container pageScriptC pIPN myPageScriptFunction C CUSTOMIZING THE CONTROLBAR PageFlip4 allows User to customize the buttons of the ControlBar by loading an exter nal swf file The buttons can be modified easily with the use of the pageFlipControls fla given in the Package User has to configure two attributes in the XML Settings node CustomControlBarIcons true Enabling custom buttons CustomControlBarFile pageFlipControls swf File containing custom buttons To create custom Button graphics User have to edit the included pageflipcontrols fla file with Adobe Flash CS5 PAGEFLIPCONTROLS FLA FILE MODIFICATION The Customizable UI Elements folder in the library contains the elements that can be modified The first group is the Buttons with timeline with several layers in certain cases the structure of which cannot be modified controlBarButton_LeftHorizontal controlBarButton_LeftMostHorizontal controlBarButton_RightHorizontal controlBarButton_RightMostHorizontal controlBarButton_Zoom controLBarButton_Print controLBarButton_AutoF Lip controlBarButton_Close controlBarButton_FullScreen controlLBarButton_Index controlBarButton_Info controlLBarButton_Language controlBarButton_Mute controlLBarButton_PDFDownload controLBarButton_Thumbnails The second group contains the purely graphic elements that make up the visible parts of the buttons 26 x 26 pixel
18. JPG PNG GIF file or files which PageFlip will display 1 1 The rate of zooming depends on the resolution of the source images In the second case User enables zoom for every page for which at least one scaled version of the page has to be created If User wants multiple level of zooming on the page the required number of versions is needed User is recommended to refer to the of scaling in the name of the file The rate of the sides of the original and the enlarged pages has to be the same otherwise PageFlip will transform the page User should also pay attention to the aspect ratio of the page sides in case of Spreads BACKGROUND IMAGE The resolution of the background image should be at least the resolution of the Screen by default otherwise the blurred pixels due to the scaling can corrupt the overall look If the size of the Screen is smaller than that of the background image it is displayed 1 1 with no size reduction If the background image is smaller than the Screen PageFlip will scale it so it will fill the Screen keeping the original aspect ratio OTHER CONTENTS Images assigned to Popup windows or LightBox gallery images require thorough preparation refer to the Appendix J Use of LightBox 3 10 PAGES amp SPREADS Definition of the pages is in the XML configuration s lt PageOrder gt node All pages are described by a lt PageData gt node A simple example lt PageOrder gt lt PageData PageFile page
19. No it can only read and display formats directly supported by Flash PDF publica tions have to be converted page by page to the adequate format first and Page Flip can only load them afterwards Is there an admin or editor interface No the contents of the pages have to be prepared by the User the XML files have to be edited with text editor TextEdit TextWrangler NotePad Edit etc How the Copyright message can be removed from the bottom of rhe Screen First you have to uncheck the Copyright Message Always Visible checkbox in XML Validator then set the following attribute in lt Settings gt node CopyrightMessageDisplay false How to remove the Powered by PageFlip4 context menu Disable Context Menu by the following lt Settings gt attribute ContextMenu false
20. PAGEFLIP4 USER S MANUAL FOR VERSION 4 1 This document is the online user s manual of the lpariGrafika PageFlip version 4 1 IMPORTANT Unlike earlier versions PageFlip4 includes a basic level copy protection feature preventing unauthorized use of the book on homepages or publications This protection does not limit the License owner in any way the use of the created Book is limited by the License holder For more information on the configuration of copy protection refer to the Appendix A TABLE OF CONTENTS 1 INTRODUCTION 1 1 New features for users of the 3 6 version 1 2 New PageFlip4 features 1 3 Terms 2 OVERVIEW 2 1 The Screen 2 2 The Book 2 3 Preview 2 4 ControlBar 2 5 Copyright Message 2 6 Zoom View 2 7 Thumbnail View 2 8 Print 2 9 Sounds 2 10 Background music 2 11 Files 3 CONFIGURATION OF PAGEFLIP4 3 1 Creating test environment 3 2 Modification of the XML file 3 3 Use of the XML Validator 3 4 Sizes 3 5 Customizing the Screen and its structure 3 5 1 Default font 3 5 2 Popup and Tooltip settings 3 6 Customizing the ControlBar 3 7 Customizing the Book Hardcover hardpage largecover etc 3 8 PageOrder 3 9 Preparing the graphical content 3 10 Pages amp Spreads 3 11 Use of HotSpot 3 12 Table of Contents amp Info Floating window content 3 13 Configuring the Menu language s 3 14 Publication of the created PageFlip APPENDIX Copy Protection settings Interactivity Customizing ControlBar Skinning Fon
21. PageFlip frame rate Showing frame rate Set maximum frame rate If the animations of the PageFlip consume too much CPU resources decrease the frame rate down to 25 30 fps 3 7 1 3 7 2 CUSTOMIZING SOUNDS User has to enable Sounds so that flipping is accompanied by sound effects Settings node attribute SoundEnab1led true User can specify that PageFlip starts muted when loaded which can be toggled later with a controlbar button StartMute true If sounds are enabled PageFlip will search for the list of sound files in the Sounds node lt Sounds EffectVolume 10 gt lt HardPageClose SoundFile sounds sound1 mp3 gt lt Pul LOpenSoundFile sounds sound2 mp3 gt lt Pul1CloseSoundFile sounds sound3 mp3 gt lt PushOpenSoundFi Le sounds sound4 mp3 gt lt PushCLoseSoundFile sounds sound5 mp3 gt lt Sounds gt The global volume of the sound effects can be set in the Sounds EffectVolume attrib ute from 0 to 100 The various sound types are specified in separate nodes as Sounds node child nodes User can specify more than one sound clips from each type of sound so PageFlip can choose sounds randomly from the set The following 5 sound types exist HardPageClose Closing the Hard Cover PullOpen Start of flip type 1 PullClose End of flip type 1 PushOpen Start of flip type 2 PushClose End of flip type 2 There are two types of flipping Pu
22. Per Second Control Boolean Show Frame Per Second on Screen Number Maximum Frame Per Second setting Boolean Activate mute at start Boolean Enable sounds effects uint Volume of sound effects Settings Sounds HardPageClose node attribute SoundFile Settings Sounds PullOpen node attribute SoundFile Settings Sounds PullClose node attribute SoundFile Settings Sounds PushOpen node attribute SoundFile Settings Sounds PushClose node attribute SoundFile Settings Sounds PageTear node attribute SoundFile String Sound of Hard Cover flipping over String Sound of PullFlip flipping start String Sound of PullFlip flipping over String Sound of PushFlip flipping start String Sound of PushFlip flipping over String Sound of Page tear And finally there is a list of the new attributes added in version 4 1 CenterSinglePage false BookMarginHorizontal 32 BookMarginVertical 32 EmbossAlLpha 100 ShadowsEnabled true ShadowsA1pha 100 PageNameDisplay false ControlBarMargin 16 ControlBarPagerWidth 150 ControlBarOnTop false KeyboardShortcutsEnabled true PageDisplayEnabled true ButtonCustom Enabled false ButtonCustom1Enabled false ButtonCustom2Enabled false Boolean Center Book if only one Page is visible uint Horizontal margins of the Book uint Vertical
23. Screen INVALID LICENSE Wrong code has been given to the CopyrightMessage attribute See XML Validator Configuration of protection in Appendix A INVALID URL URL from where PageFlip has been loaded is unauthorized See URLs Configura tion of protection in Appendix A TRIAL LICENSE EXPIRED Time limited trial License Key expired OFFLINE USAGE NOT ALLOWED Offline run is unauthorized See URLs Configuration of protection in Appendix A XML ERROR Error during the loading of the XML configuration file It can be a wrong path to the file pointing to a non existent file lack or loss of Internet connection or other reasons due to which the file could not be loaded XML SYNTAX ERROR Specified data cannot be interpreted at the processing of the XML file due to syn tactic error H TIPS FOR OPTIMIZATION Optimization is important to maintain high fps Follow the instructions to avoid difficul ties with flipping the thoroughly prepared Book due to the accumulation of too com plex contents Make Pages the smallest possible the content loaded to the Pages should be im ages the same size as the page In case of vector based content avoid too com plex graphics similarly to text content which should be an image unless enabling selection When transparency is used make sure that the number of consecutive trans parent pages is not too great it increases the number of Pages PageFlip has to render simultaneously In case it
24. ault Font is not set in the XML the factory embedded font will be used Embedding custom font is only possible with the help of Adobe Flash CS5 For further information refer to Font Embedding in Appendix D From this on if no font attribute is set in the XML the default font will be used But User should only specify a value in a font attribute in case of custom embedded fonts POPUP AND TOOLTIP SETTINGS The Popup and the ToolTip floating windows are basically the same the only differ ence is that the ToolTip contains only a one line text and its width is adjusted to the length of the text PopupBackgroundColor xFFFFFF Background color PopupBackgroundOpacity 80 Transparency of the background 0 100 PopupBorderThickness 0 Width of background border PopupBorderColor 0x000000 Color of background border PopupRounded true Enable rounded border PopupRoundedRadius 8 Rate of rounded border PopupMargin 8 Margin PopupTitleFont Font of the title PopupTextFont Font of the text PopupTitleColor 0x333333 Color of the title PopupTextColLor 0x333333 Color of the text PopupSpace 8 Space between image title text PopupMouseFol LowSpeed 5 Mouse follow speed 3 6 CUSTOMIZING THE CONTROLBAR The ControlBar can be enabled disabled Enable it when customizing ControlBar true ControlBarHeight 55 Height of the ControlBar area Doesn
25. book allows no free scaling choose a page size that fits full screen at the minimum resolution The following size settings can be found in the Settings node of the XML configuration file PageWidth 300 PageHeight 400 The Width and Height of the pages If scaling of the pages Settings PageScale false is disabled the pages of the Book appear on the screen in this size If User loads content to a page that does not fit the specified page size and automatic scaling Settings AutoSize true is enabled then it will scale to this size When flipping Spreads if animation during flipping is enabled a Bitmap copy of the page is created in this size Coordinates of the loaded HotSpots have to match this page size thus User should configure HotSpots when the Book is done MinStageWidth MinStageHeight The minimum allowed size of the screen At the scaling of the Flash Player or Browser window PageFlip4 continuously adjusts its content to have everything in its right place and size on the Screen However if User wants the window to be smaller than the minimum possible size it is overruled avoiding the overlaying of various contents If the Book cannot be scaled then the minimum size should be enough to display the Book the ControlBar and the Preview if enabled LargeCover true LargeCoverHorizontalOversize 16 LargeCoverVerticalOversize 32 If User wants the cover to b
26. can further zoom in with the zoom button on the other side if more than one zoom sizes have been prepared Scroll with the help of the mouse if the zoom does not fit the screen 2 7 THUMBNAIL VIEW In this view PageFlip displays the small thumbnail images of the Book s pages in or der on one or more pages depending on the resolution of the screen If the cursor is moved over the pages a ToolTip appears with the page number of the current spread and the Book goes to the page by click Thumbnails i RPoox POWERED BY PAGEFLIP4 2011 IPARIGRAFIKA PAGEFLIP HU INFO PAGEFLIP HU Figure 2 7 The Thumbnail View 2 8 PRINT Each page of the Book if enabled can be printed but only one by one 2 9 SOUNDS The Book has several flip sounds that User can change or disable 2 10 BACKGROUND MUSIC User can specify one main background music track for PageFlip4 and sounds music can be assigned to each page separately which start to play only if the given page is visible In this case the main background music optionally fades out 2 11 FILES The PageFlip4 package includes 3 main folders obj Files of the PageFlip4 and the Book contents src Source files source files of the Page files utils location of the XML Validator obj css Styles belonging to the HTML embedding file obj js SWFobject and LightBox Javascript codes obj pageflipdata External files of PageFlip4 obj pageflipdata backgrounds Back
27. cannot be avoided try to load simple content to the Pages for example 32 bite png Page files To have all Pages rounded transparency is unnecessary as the visible page hides the one behind it Make sure to display videos on single Pages If possible try to avoid the use of Spreads as they require more resources espe cially when more Spreads follow each other In case more Spreads follow each other disable animation during flipping Create interactive pages in a way that when using the event handlers the anima tions scripts running on the page should stop until the page is displayed If the Book consists of a great number of pages or the Page files are too big en able Page Unloading so that unwanted pages get removed from the memory in case of pages running scripts removal has to be separately disabled not to lose data EMBEDDING PAGEFLIP4 PageFlip4 can be embedded in our homepage or any other html file in several ways To have all its functions fully working attach the swfobject js file to your html file as in the case of the original index html lt head gt lt script type text javascript src js swfobject js gt lt script gt lt head gt Make sure that the relative location of the html files the pageflip swf and the page flipdata folders are correct in the folder structure The file system root for the code running under PageFlip4 is the folder containing the html file which emb
28. e URL of the HotSpot XML file The relative URL of the streamed sound file The number of times the sound file is repeated Volume of the sound playback The sound of the main Background Music true if the Page is a Spread double page Before describing the available PageFlip4 APIs let s talk about ExternalScript which will also use the same APIs than the page files and in addition of that ExternalScript and the Page files can communicate with eachother directly EXTERNALSCRIPT PageFlip4 can load an external script file AS3 swf file which is created by the User and the scripts in that file can call PageFlip4 APIs and also recieves main flipping events A template script file obj pageflipdata externalScripts swf is part of the Page Flip4 package which source file src externalScripts fla is also included To load an external script just set its URL in the config XML s settings node ExternalScript externalScripts swf An empty externalscrips file for example with automatic registering and event han dlers defined like in the previously discussed page file script import flash display MovieClip import flash events Event var Container MovieCLlip addEventListenerC Event ADDED_TO_STAGE onAdded function onAdded e Event void Container MovieClip Cparent parent Container registerExternalScriptC this removeEventListenerC Event ADDED_TO_STAGE onAdded Event handlers functio
29. e larger than the inside pages LargeCover has to be enabled Settings LargeCover true The difference in size has to be specified horizontally and vertically If for example the Cover is larger around the edges by 16 pixels than the pages inside then the cover page will be 16 pixel larger horizontally Settings LargeCoverHorizontalOversize 16 while the difference vertically margin is added on the top and the bottom will be 32 pixels Settings LargeCoverVerticalO versize 32 If User creates a vertical Book than the horizontal size difference will be 32 pixels and the vertical will be 16 pixels Scaling by default concerns 4 pages the external and inside pages of the front and back Covers If User sets the Book to be open all the time Settings AlwaysOpened true or set odd page number Book then it is modified based on the variations of the settings 3 5 CUSTOMIZING THE SCREEN AND ITS STRUCTURE The Screen itself is an interface on which other elements of PageFlip4 can be found User can set a background and specify the layout of the displayed content User can choose from three types of backgrounds No background User can embed PageFlip4 over html content so that its background is transparent Transparent background has to be enabled in the XML TransparentBackground true and we have to enable the transparency of the Flash Movie at the embedding in the html params wmode transparent
30. e on the next page in accordance PageNumber 6 Each page can have a Label which User can refer to later for example in the Table of Contents or when creating HotSpots It provides more flexibility than the use of page numbers as it allows the reordering of the Pages PageLabel YourLabel Sometimes the automatic scaling of the Pages is not cor rect or User wants to publish content on the page that can not fit the frame If User loads SWF file in which the content exceeds the page border for example invisible part of the text box or the bleed of a graphics element the size data of the Page within the Flash can differ from the specified data so the User can modify them in the XML Real width height of the page and offset of page content horizontally vertically PageWidth 300 PageHeight 400 PageOf fsetX PageOffsetY BackgroundColor AutoFlipInterval If the default page background color does not fit the page User can modify the color BackgroundCoLlor 0x000000 Set the Auto Flip Interval at page level in milliseconds De fault it is unset the value defined in settings is used AutoFlipInterval 5000 3 11 USE OF HOTSPOTS User can create HotSpots on a page with XML configurations HotSpots are areas on the Page that can open Popup windows if the mouse hovers over it and can send User to other pages open new links or a LightBox image executes custom scripts etc
31. ear void function onTop void function onNotOnTop void function onFlipEnd Q void function onFlipStartQ void function onPageUnload void function hotSpotCallC msg String void User can access PageFlip4 services through the Container variable The first one is the registration of the Page by which the User s Page informs Page Flip4 that the code running on the Page is able to communicate This function call is done automatically by the ADDED_TO_STAGE event Container registerPage this It is enough for User to define the event hander function to be used This is a short description of the events when they are executed and what the code should do onAppear when a Page is displayed on the Screen even if covered If User wants an event for example animation to start on the page already when it is not completely visible during flipping to the Page or partial overlay of a trans parent page then it has to be authorized and launched here onDisappear when a Page is removed from the Screen If User wants to keep the activity until the disappearance of the Page then activity on the Page has to be disabled here If User works with a great number of coded pages in the book it is very important that invisible pages do not overload the CPU onTop when the page is completely visible without overlay it is the selected page Called only if there is no flipping Activate the content
32. eds PageFlip4 DataFolder which points at the pageflipdata subfolder by default is added to this and the URLs in the XML connect to this as well For example http pageflip hu pagefliptest index html let s assume that this is the html file em bedding PageFlip4 and that DatFolder has not been modified If User specifies the following path to a file in the XML configuration pages coverpage jpg it will be the following URL actually pageflipdata pages coverpage jpg Which in this case due to the index html file situation is similar to the following absolute URL http pageflip hu pagefliptest pageflipdata pages coverpage jpg If User wants to use absolute URLs to reach files then the DataFolder should be de leted with the help of the flashvars flashvars DataFolder Then be aware that all relative URLs change if User does not modify the location of the files start with the path of the XML flashvars XMLFileName pageflipdata pageflipdata xml The embedding Script is also in the lt head gt tag lt head gt lt script type text javascript gt var flashvars flashvars XMLFileName pageflipdata xml flashvars DataFolder pageflipdata flashvars StartPage 1 flashvars StartAutoFlip false var params params scale noscale params salign TL params wmode transparent params allowscriptaccess always params aLl
33. f the Preview and the ControlBar THUMBNAILS ThumbnailsEnabled true Enabling the use of the thumbnail view Set the Thumbnail view button as follows see 3 6 Customizing the ControlBar Thumbnai LModeStart false Start of the PageFlip in Thumbnail view Thumbnai LWidth 120 Size of pages in Thumbanil view Thumbnai LHeight 120 Thumbnai LDropShadow t rue Enable DropShadow Thumbnai LDropShadowSize 8 The rate of blur in pixels Thumbnai LDropShadow0ffset 2 Transparency of the shadow 0 100 The settings of the Thumbnail view also concern the Preview CONTROLBAR The ControlBar is enabled by default it is visible and can be used User should dis able the function if it is not wanted ControLBar false Read about the ControlBar customizing in Appendix C Customizing the ControlBar COPYRIGHT MESSAGE User can code the Copyright message with the XML Validator see Copyright Message setup in Appendix A and then User can customize it CopyrightMessage lt encoded message gt If it was enabled previously in the XML Validator User can disable the Copyright Mes sage displaying CopyrightMessageDispLlay false FULLSCREEN Enabling full screen view Full ScreenEnabled true Do not forget to enable it in the embed script in html arams allowfullscreen true S 3 5 1 3 5 2 DEFAULT FONT User can modify the default font If the def
34. fied for the tree attributes above the Popup window will not be displayed TargetLabel String Label of target page TargetName String Name of the target page TargetPage String Page number of target page Skip false Boolean Direct jump to target page Link String URL the User wants to open Target _blank String Link Target Window LightBoxImage String URL of image to be opened in LightBox and LightBoxCaption String image description LightBoxGroup String ID of the Image in the LightBox Group ESfunctions String Executes an External Script s function SWFfunctions String Executes a Page Script s function AutoFlip String Controls AutoFlipping start stop toggle Color 0x000000 uint Color of the area Opacity 0 uint Transparency 0 100 HoverOpacity 0 uint Transparency 0 100 if mouse hovers over User can configure Hotspot shapes with the following nodes one or more for each HotSpot lt Rectangle gt x y w h lt Rectangle gt lt RoundRectangle gt x y w h r lt RoundRectangle gt lt Circle gt x y r lt Circle gt lt Star gt x y p r1 r2 phase lt Star gt lt Shape gt x1 y1 x2 y2 x3 y3 x4 y4 lt Shape gt For information on the latter refer to section 3 11 3 G PAGEFLIP4 ERROR MESSAGES Error messages appears at the startup of PageFlip4 centered on the empty
35. g Of fsetX 0 uint Horizontal offset of the Book position Of fsetY 0 uint and vertical in pixels CenterSinglePage false boolean Center Book if only one Page is visible AlwaysOpened false Boolean Book always open can t close the covers ZeroPage false Boolean Enable page 0 a page in background ZeroPageAlwaysVisible false Boolean Enable 0 page always visible HardCover true Boolean Hard cover Book HardPage false Boolean Hard Pages LargeCover true Boolean Cover Pages larger than inside Pages LargeCoverVerticalOversize 10 uint Vertical oversize in pixels LargeCoverHorizontalOversize 10 uint Horizontal oversize in pixels EmbossedPages true Boolean Embossed pages with light shadow effect EmbossA1lpha 100 uint Transparency of the emboss effect 0 100 ShadowsEnab1led true boolean Enable shadow effect while flipping ShadowsA1pha 100 uint Transparency of shadow effect 0 100 DropShadow true Boolean Enable DropShadow of the Book DropShadowSize 30 uint Size of DropShadow blur in pixels DropShadow0f fset 10 int Vertical offset of DropShadow in pixels DropShadowA1Lpha 50 uint Transparency of DropShadow 0 100 PageLoaderBackColor 0x333333 uint Background color of pages without content TransparentBackground false Boolean Enable Transparent Screen bac
36. ghtToLeft false Book written right to left VerticalMode false Vertical flip mode Of fsetX 0 Offset of Book position Of fsetY 0 HardCover true Hard cover HardPage false Hard pages EmbossedPages true Embossing of pages with light shadow effect disabled for hard pages LargeCover true Larger cover LargeCoverVerticaLOversize 32 Vertical size difference LargeCoverHorizontalOversize 16 Horizontal size difference DropShadow true Enable DropShadow for Book DropShadowSize 20 Rate of DropShadow in pixels DropShadow0f fset 10 DropShadowA1pha 30 TransparencyEnabled true TransparencyAutoLevel true TransparencyMaxLevel 16 3 FlippingSpreadAnim true PageCache 5 UnloadPages false StartAutoFlip false AutoFlipDefaultInterval 5 AutoFlipLooping true FPSControlEnabled true ShowFPS false MaxFPS 60 Vertical offest of the DropShadow in pixels Transparency of the shadow 0 100 Enable transparency Automatic handling of transparency levels Maximum level of pages transparency Enable animations on a Spread during flipping Number of preloaded cached pages per direction Deleting pages from memory when not needed Starting automatic flipping after loading of Page Flip4 Default flip interval in seconds Flip looping at the end of the Book Handling
37. ground images obj pageflipdata BGM Background music obj pageflipdata hotspots HotSpot description xml files obj pageflipdata popupimages Images loaded by popup windows obj pageflipdata sounds Flipping sound files obj pageflipdata pages Page files obj pageflipdata pages thumbs Thumbnail views of pages obj pageflipdata pages zoom Enlarged views of the pages PageFlip4 can be started with the index html By default all files loaded by PageFlip are located in one given folder pageflipdata The configuration XML file is also saved in this folder pageflipdata xml 3 3 1 3 2 3 3 3 4 CONFIGURATION OF PAGEFLIP4 CREATING THE TEST ENVIRONMENT The downloaded PageFlip4 is ready for testing immediately after extraction Make sure to save the extracted folders with the PageFlip4 files to the right location and to place the later created contents within the original file structure for easier handling MODIFICATION OF THE XML FILE PATH the pageflipdata xml default file name configuration file is in the pageflipdata folder Both the name and the location of the file can be modified optionally in FlashVars vari ables flashvars XMLFileName pageflipdata xml flashvars DataFolder pageflipdata Edit the file with a simple Text Editor for example TextEdit in OS X or the Notepad in Windows if no dedicated XML editor is available but not with a word processor like MS Word Never format fon
38. icking on the HotSpot LightBoxImage pages images Lightboximage jpg LightBoxCaption Caption for LightBox Image Opening LightBox image group LightBox Group with the required JavaScript configurations can be opened with the following attributes LightBoxGroup image1 Where image1 is the id of the image to show first in the group An exam ple how a group is defined in html lt a id image1 href pageflipdata pages image1 png rel Lightbox Group1 title title1 gt lt a gt lt a id image2 href pageflipdata pages image2 png rel Lightbox Group1 title titLe2 gt lt a gt lt a id image3 href pageflipdata pages image3 png rel Lightbox Group1 title titLe3 gt lt a gt Start Stop Toggle Autoflip User can control Autoflip feature with a HotSpot by adding the AutoFlip attribute and specifying one of the following values to it start stop toggle Example AutoFlip start Executing custom functions With this feature by clicking on a HotSpot you can execute a function in a Page file s script or in the External Script refer to the section Interactivity in Appendix B Custom function call in the page scripts can be set up by setting the follow ing HotSpot attribute SWFfunction test If this HotSpot is clicked then the hotSpotCall function will be called in your Page file script and the String
39. ink Color of Table of Contents Link Size of Table of Contents Link font Align of Table of Contents Link Font of Table of Contents page number Color of Table of Contents page number Size of Table of Contents page number font Align of Table of Contents page number Page number first Width of page number in pixels Color of Table of Contents Link if mouse hov ers over Color of Table of Contents Link when pressed TOCLinkBackgroundColor x333333 uint TOCLinkBackgroundAlLpha Color of Table of Contents background uint Transparency of Table of Contents Link back ground TOCLinkBackgroundOverColLor x333333 uint Color of Table of Contents Link if mouse hov TOCLinkBackgroundOverAlpha 50 TOCDescriptionFont TOCDescriptionColor QxFFFFFF TOCDescriptionSize 11 TOCDescriptionAlLign LEFT 333 ExternalScript FPSControlEnabled true ShowFPS false MaxFPS 60 StartMute false SoundEnab1led false Settings Sounds node attribute Ef fectVoLume 10 ers over uint Transparency of Table of Contents Link back ground if mouse hovers over String Font of Table of Contents Description uint Color of Table of Contents Description Number Font Size of Table of Contents Description String Align of Table of Contents Description String URL of the External Script file Boolean Enable Frame
40. kground BackgroundColor QxFQFQFQ uint Background color of Screen BackgroundImageFile String URL of Screen background image LayoutOrder PREVIEW CONTENT CONTROLBAR String Order of layout elements ThumbnailsEnabled falae Boolean Enable Thumbnail view ContentPreviewEnabled false Boolean Enable Preview ControlBar true Boolean Enable ControlBar PageDisplayEnabled true Boolean Enable pager text display PageNameDisplay false Boolean Display Page name instead of numbers CopyrightMessageDispLay true Boolean Displaying Copyright Message ContentPreviewHeight 60 uint Preview height in pixels ControlBarHeight 55 uint ControlBar height in pixels ControlBarOf fset 15 uint Offset of ControlBar position in pixels ControlBarMargin 16 uint Horizontal margins of the Controlbar ControlBarScale 100 Number ControlBar scale in ControlBarFullScreenScale Number Scale of ControlBar in in Full Screen mode ControlBarPagerWidth 150 uint Width of ControlBar pager in pixels ControlBarOnTop false Boolean Controlbar over the Book ControlBarBackgroundColor Number Background color of ControlBar ControlBarBackgroundAlpha Number Transparency of ControlBar background 0 100 9999 CopyrightMessageBackgroundColor CopyrightMessageBackgroundALpha Number Copyright Message background co
41. lash CS5 by the following way 1 Open a new ActionScript3 FLA document 2 Right click on the list of the Library window then select New Font Paste New Symbol New Folder New Video Figure D 1 Adding New Font to the Library 3 The Options Tab is active Figure D 1 Font Embedding E Options m Font om 2 Name Cancel v T Albertus PFL Normal Font 1 Help v Tp Aberustt PFL family ons Normal Albertus Soh y T DINBIk_PFL ee Normal DinBlack Character ranges Yj All 246 93514 glyphs a Uppercase A Z 27 27 glyphs Lowercase a z 27 27 glyphs Numerals 0 9 11 11 glyphs Punctuation 51 52 glyphs Cl Rasic Latin 95 95 olynhs Also include these characters oOuUdOoOuUEEaAUUilaAaAcCANaAaAaAekeceEiliiloO GOGOUUGUCE he xAceEoGacetnszzACEtNSZZ Estimated glyphs 246 Font Name DINBIk_PFL Normal Copyright c ScanDer Ltd 1993 2001 All rights reserved More Font Info Figure D 1 The Option Tab 4 Add a custom name Figure D 1 highlighted with orange rectangle 5 Choose the Font from the Family drop down menu 6 Choose a Style if possible 7 Set the Character Range so it contains all the necessary special characters too 8 Note down the name of the Font following Font Name as
42. layed Book the main ingredient of PageFlip is the book with pages that can be flipped magazine newspaper any other publication with pages that can be flipped will be referred to as Book in this manual Content Preview Preview the series of thumbnails in a scrollable bar appearing simultaneously with the Book Thumbnails the view of PageFlip4 when all the pages of the Book appear in small preview images Page a page of the Book Page file The file specifying the content of the page 2 OVERVIEW 2 1 THE SCREEN The following elements can appear on the Screen of PageFlip4 depending on the configuration and the current view Preview Book ControlBar CopyrightMessage Zoom view Thumbnail View Floating Windows Table of Content Info Tooltips eoo PageFlip4 ale G O file Works IPG pageflip pageflip_v4 PageFlip4_CS5 obj index htmi Ka Coogle J TABLE OF CONTENT Thanks Giving go to the Back Cover K lt Page 4 5 gt gt pa i Heo a xX POWERED BY PAG 2011 IPARIGRAFIKA PAGEFLIP HU IN Canceled opening the Figure 2 1 The Book with Preview Table of Contents ControlBar and Copyright message 2 2 THE BOOK The Book includes all the pages of the document The pages of the Book can be flipped with the help of the mouse by drag n drop or by clicking on the corner of the pages User can navigate with the help of the ControlBar
43. ll when the page is pulled and Push when the page is pushed to which we can assign different sounds ADDING AND CUSTOMIZING THE BACKGROUND MUSIC We can customize Background music in the BackgroundMusic MusicData node lt BackgroundMusic gt lt MusicData StreamURL BGM mainBGM mp3 Loop 999 Volume 40 gt lt BackgroundMusi c gt Attributes of the MusicData node StreamURL URL of the sound file to be played Loop number of repeats Volume volume level of playback 0 100 The StartMute option and the mute button also apply to the background music This Background music can overwritten at page level see section 3 10 Pages amp Spreads 3 8 ORDER OF PAGES PAGEORDER The order of Pages determines the visible content of the Book User has to specify each page in the lt PageData gt nodes that load the book from the first to the last page Depending on the AlwaysOpened and the ZeroPage settings the Book starts from page 0 or 1 The following figure shows the connection between the spreads and the possible settings see Figure 3 8 If AlwaysOpened is enabled the Book starts open and User cannot flip back to page 1 The first two pages defined in the lt PageData gt nodes will be the first two pages of the open book laid out as spreads On the other hand if our Book starts closed with page 1 then the first lt PageData gt node contains the single Cover page and the next two will be
44. llowing attributes of the lt HotSpot gt node Color 0xFFFFQQ Color of the shape Opacity 20 Rate of transparency 0 100 HoverOpacity 50 Rate of transparency when mouse is over the HotSpot Events on clicking User can choose from the following events to happen when clicking on a HotSpot All of these are attributes of the lt HotSpot gt node like PopupTitle Jump to a Page based on a Label The use of Labels is the most preferable reference mode User can specify Labels for each page which can be referred to in HotSpots Attribute Skip determines that jumping to the page is direct true or flipping page by page false Example TargetLabel PageLabel Skip true Jump to a Page by Page number Page numbering by default starts with 1 and increases by one per page If User modifies the page number on a page PageFlip will reference to the modified page number Information on the Skip attribute is given in section Jump to a Page based on a Label TargetPage 5 Skip true Opening a URL in browser URL and target can be specified Target can be _self as custom win dow when the link opens in the PageFlip window closing PageFlip and _blank when the specified URL opens in a new window Tab Example Link http pageflip hu Target _blank Opening LightBox image The following attributes can be used for images to be displayed in LightBox when cl
45. lor and 9999 Number transparency of its background 0 100 FontLibraryFile String URL of file including embedded Fonts DefaultFont String Embedded font instead of default DragArea 64 uint Drag area width from outer side of the page AutoFlipArea 56 uint Width of rectangle indicating active corner FLlippingDuration 1000 uint Duration of flipping animation in milliseconds MouseFol LowSpeed 5 uint Mouse follow speed when flipping ZoomFol LowSpeed 5 uint Mouse follow speed in zoom Zoom0OnPageCLlick false Boolean Enable Zooming by mouse click DragZoom false Boolean Enable Zoom image dragging with mouse ZoomHotspot true Boolean Enable HotSpots in Zoom mode DefaultTransition 1 uint Default transition NONE FADE ZOOM BLUR DefaultTransitionDuration 250 uint Duration of Default transition in milliseconds FlippingSpreadActivity false Boolean Enable animation on Spreads during flipping AutoFlLipDefaultInterval 5 uint Interval of automatic flip in seconds AutoFLipLooping true Boolean Starts from beginning if reaching end Loop TransparencyEnabled true Boolean Enable transparent Pages TransparencyAutoLevel true TransparencyMaxLevel 1 CustomControlBarIcons false CustomControLBarFile CustomControlBarLayout false EnableButtonColoring true ButtonColor 0
46. n onAppear C pIPN uint void function onDisappear C pIPN uint void function onFlipEnd C pIPN uint void function onFlipStart C pIPN uint void function onTop C pIPN uint void function onNotOnTop C pIPN uint void function onPageUnload C pIPN uint void function onRegister O void function onPageRegister C pIPN uint SWF Object null void function hotSpotCallC msg String pIPN uint void Custom button functions function onCustomButtonExecuteC pID uint pButton MovieClip void In this code example there is four additional event handlers that is not available for the page file scripts onRegister when the external script file has successfully registered this event is recieved only once just after Container registerExternalScript this is executed onPageRegister when a Page is registered the extrnal script also knows that When this event is recieved the internal page number pIPN uint and a pointer SWF Object to the registered page is also recieved hotSpotCall when a Hotspot is set to execute custom script Each Hotspot can send a unique message to this event msg String and the internal page number is also recieved pIPN uint onCustomButtonExecute when a custom button is pressed on the Screen The serial of the custom button is also recieved pID uint 0 7 By using these event handlers User can set up a various custom functions depending on what s happening
47. only on the completely visible page after flipping is over For example buttons their event handlers etc function onTop void myButton enabled true onNotOnTop when the Page loses its onTop status that is it is overlaid due to a flip Disable the activities enabled by onTop function onNotOnTop void myButton enabled false onFlipEnd when the flip of the given Page is over Both pages that was part of the flip anima tion recieves this event onFlipStart when the flip of the given Page starts Both pages that makes part of the flip ani mation recieves this event onPageUnload when PageFlip removes the page from the memory User has to delete everything the code created during run time Display Objects Events etc so that Page content can be removed from the memory safely hotSpotCall when a Hotspot is set to execute custom function on a page Each Hotspot can send a unique message to this event msg String The Page code can access the following variables Container OnLeftSide Boolean Container IPN uint Container PageData PFPageData Container isReady Boolean Page has been registered Container SWF Object Root of the loaded Page file Container Pair PFPageContainer Container of the Page pair true if the Page is on the left side of the Book Internal Page Number of the Page All data information about the Page For communication with the Spread make sure that it i
48. or of floating window FloatingWindowBackgroundAlpha 50 uint FloatingWindowBorderThickness Q Number FloatingWindowBorderColor QxFFFFFF uint FloatingWindowBorderAlLpha 50 uint FloatingWindowCornerRadius 16 uint FloatingWindowFont String FloatingWindowColor QxFFFFFF uint FloatingWindowSize 11 Number FloatingWindowAlign LEFT String TOCTitleFont String TOCTitLeCoLor QxFFFFFF uint TOCTitleSize 19 Number TOCTitlLeALign LEFT String TOCLinkFont String TOCLinkCoLor QxFFFFFF uint TOCLinkSize 12 TOCLinkALign LEFT TOCLinkPageNumberFont TOCLinkPageNumberColor QxFFFFFF TOCLinkPageNumberSize 22 Number TOCLinkPageNumberAlign LEFT TOCPageNumberFirst false TOCPageNumberWidth 32 TOCLinkOverColor xFQ B400 TOCLinkPressColor QxFFFFFF uint Background transparency of floating window Thickness of floating window border Color of floating window border Transparency of floating window border Radius of floating window rounded corner Default font of floating window Color of floating window content Size of floating window text Align of floating window text Font of Table of Contents Title Color of Table of Contents Title Size of Table of Contents Title font Align of Table of Contents Title Font of Table of Contents L
49. owfullscreen true params menu true params bgcolor FFFFFF var attributes swfobject embedSWFC pageFlip swf pageflip 100 100 10 0 0 false flashvars params attributes lt script gt lt head gt The lt div gt tag is responsible for the display of PageFlip is in the lt body gt tag lt body gt lt div id pageflip style margin Q gt lt div gt lt body gt If PageFlip does not fit the browser completely then User should specify the width and height in pixels instead of 100 swfobject embedSWF The next section of the Appendix informs User about further preparations necessary for the support of LightBox functions J USE OF LIGHTBOX User has to attach the following css js files and a short script to the embedding html file for a functioning LightBox lt head gt lt link rel stylesheet href css lightbox css type text css media screen gt lt script src js prototype js type text javascript gt lt script gt lt script src js scriptaculous js load effects type text javas cript gt lt script gt lt script src js Lightbox js type text javascript gt lt script gt lt script type text javascript gt function GroupDelegateCid var objLink document getElementById id Lightbox prototype startCobjLink function LightboxDelegate url caption var objLink
50. ransparency level if not automatic Enable custom ControlBar buttons URL of swf file including custom buttons Enable custom ControlBar layout Enable coloring of the ControlBar buttons Base color of button and transparency 0 100 Button color when mouse hovers over and transparency 0 100 Color of button when pressed and transparency 0 100 Color of button when inactive and transparency 0 100 Enable Loaderbar on ControlBar Enable buttons flipping to First Last pages Enable buttons flipping Right Left Enable Zoom buttons Enable Print buttons Enable Automatic flipping button Enable pdf download button Enable Thumbnail button Enable Language switch button Enable Mute button Enable Info window Enable Table of Contents button Enable Full Screen button Enable Close button Enable Custom buttons pdf download button downloads this file Enable ToolTip if mouse hovers over button Tooltip display delay in frames Thumbnail view width and height Enable DropShadow of Thumbnail view Size of DropShadow blur in pixels Vertical offset of DropShadow in pixels Transparency of DropShadow 0 100 Set the maximum width of popup window PopupBackgroundCoLor x000000 uint PopupBackgroundOpacity 50 uint PopupBorderThickness Q uint PopupBorderColLor 0x000000 uint PopupRounded true Boolean PopupRoundedRadiu
51. rther modifications with less importance Transitions Embedded international fonts Latin 5 kinds of HotSpot shapes Popup windows with images headlines texts ToolTip Immediate menu language switch Copy protection NEW PAGEFLIP4 FEATURES PageFlip4 1 is the first update of PageFlip4 It includes some important new features and some bugfixes for more information see the version txt in the PageFlip4 package Here is the list of the major new features External Script allows User to executes custom AS3 scripts and access PageFlip4 APIs and recieves flipping events Execute custom function by HotSpot clicking Custom Controlbar Layout let User place the control bar elements on the Screen Click to Zoom and Drag Zoom access zoom image by simply clicking on the page and then move the Zoomed image by dragging it with the mouse Center Single Page centers the book when closed Controlling shadow visibility Page Name display 1 3 TERMS The following concepts need to be clarified for easier understanding PageFlip PageFlip4 the application itself User Publisher PageFlip4 License owner the person or company that edits pub lishes and uploads the Book to the Internet Do not mix up with the visitors who browse the Book with the help of PageFlip4 Screen The display interface of PageFlip4 the area where the elements of PageFlip4 the book itself the buttons the thumbnails etc are disp
52. s 8 uint PopupMargin 8 uint PopupTitLeFont String PopupTextFont String PopupTitlLeColor QxFFFFFF uint PopupTextCoLor QxFFFFFF uint PopupSpace 8 uint PopupMouseFol LowSpeed 5 Number InfoWindowWidth 300 uint FloatingWindowCoLumnWidth 200 uint FloatingWindowMargin 10 uint FloatingWindowHorizontalSpace 16 int FloatingWindowVerticalSpace 16 int FloatingWindowSeparator true Boolean Background color of Popup window and transparency 0 100 Thickness of Popup border 0 no border Border color Enable rounded border Radius of Popup rounding Margin of Popup content Title font Text font Title color Text color Space between content elements in pixels Mouse follow speed Width of Info window content Width of floating window column Margin of floating window content Floating window horizontal space Floating window vertical space Enable floating window separators FloatingWindowSeparatorColor xFFFFFF uint Color of floating window separators FloatingWindowSeparatorAlpha 50 uint FloatingWindowSeparatorHeight 1 Number FloatingWindowSeparatorOffset 6 Number Transparency of floating window separators Height of floating window separators Offset of floating window separators FLloatingWindowBackgroundColor 0x 00008 uint Background col
53. s demo_Largepage_316x432 png gt lt PageData PageFile pages demo_Largepage_316x432 png gt lt PageData PageFile pages demopage_script1 swf gt lt PageData PageFile pages demo_page4 png gt lt PageOrder gt The definition of Spreads is similar to that of single pages but an attribute indicates that it is a spread while User should also remember that a Spread is only one defini tion The following is a list of lt PageData gt attributes with value examples Spread Its default value is false It should only be set if defining a Spread Spread true PageFile URL of the Page file name of the file with its path It is a required attribute without which there is no content will be loaded on the given page PageFile pages pagefile jpg or PageFile pages pagefile swf SWFPageFileAsZoom The use of SWF Page file for the zoom view Its default value is false It should only be set if enabling the option SWFPageFi LeAsZoom true ZoomFiles There are two methods for the User to load images to the zoom view of the page In case of a single zoom image to the page ZoomFiles pages zoom zoomfile jpg More images can be loaded to the same page if User wants to use multiple zooming levels The example shows three images in 200 300 and 400 zoom ZoomFiLes pages zoom zoomfile200 jpgl200 pages zoom zoomfile3Q Q jpg 300 pages zoom zoomfil e400 jpgl400 Th
54. s ready The following example invites the body function of the spread ifCContainer Pair isReady Container Pair SWF testQ PageData Object data quick overview isCover Boolean renderWidth Number renderHeight Number if given Page is a Cover Rendered size without scaling the Book The following variable values are all from the XML lt PageData gt node these are Read Only datas PageName String PageNumber uint PageLabel String PageWidth uint PageHeight uint PageOffsetX int PageOffsetY int PageIsTrasnsparent Boolean HardPage Boolean DisableEmbossing Boolean BackgroundColor uint PageFile String SWFPageFileAsZoom Boolean ZoomFiles String ThumbnailFile String PrintFile String HotSpotFile String BackgroundMusicFile String BackgroundMusicLoop uint Volume Number MainBGMVolume Number Spread Boolean The name of the Page The displayed number of the Page The Label of the Page Width and Height of the Page The display Offsets of the Page if true the Page behind is also rendered if true the Page will animate like a hard cover if true no shadows highlights are applied The background color of the Page while loading The relative URL of the page If true the same swf Page file is used for zoom The relative URL of the Zoom image files The relative URL of the Thumbnail file The relative URL of the Print file The relativ
55. t affects the size of the control bar icons ControlBar position can be vertically modified ControlBarOf fset 15 Rate of downward offset in pixels Further general settings ControLBarScale 100 Size of the ControlBar ControlBarFullScreenScale 150 Full screen size ControlBarBackgroundColor 0x555555 Background color ControlBarBackgroundAl1pha 50 Transparency of background 0 100 If no color is specified the ControlBar does not have a background Enabling the LoaderBar ControLBarLoaderEnabLed true Navigation buttons can be enabled disabled based on their types ButtonFirstLastEnabled true First Last page buttons ButtonLeftRightEnabled true Previous Next page buttons ButtonZoomEnabled true Zoom buttons ButtonPrintEnabled true Print buttons Extra buttons can also be enabled disabled ButtonAutoFlipEnabled false Toggle Autoflip button ButtonPDFLinkEnab1ed false Download button ButtonLanguageEnabled true Menu Language button ButtonThumbnai LEnab1led true Thumbnail view button ButtonMuteEnabled true Mute button ButtonInfoEnabled true Info button ButtonIndexEnabled true Table of Contents button ButtonFullScreenEnabled true Full Screen button ButtonCloseEnabled true Close button Colors of the ControlBar EnableButtonColoring true Enable button coloring ButtonColor 0x6
56. t Embedding XML reference Hotspot XML reference PageFlip4 Error messages Tips for Optimization PageFlip4 Embedding Use of LightBox Color Codes mostFAQ 1 INTRODUCTION The main function of PageFlip4 is to display a document like a book with pages that can be flipped while all other features are subordinated to that With the help of Page Flip4 User can create a book from simple images or interactive flash movie files and flip its pages on the screen publish it on the Internet or on any kind of media PageFlip4 can load any flash compatible content so display and interactivity is not limited to printed publications or pdf Since PageFlip4 can be widely customized it can even serve as basis for homepages where the content is displayed on the pages PageFlip4 is recommended to everyone eager to share one or more of their docu ments in a stylish book like form and who has basic knowledge of image manipula tion scaling and XML file editing text file modification FROM SIMPLE TO ADVANCED While PageFlip4 has the simplest possible configuration it is also extremely custom izable to meet all the various needs The solution is to have most of the settings as default so the configuration file only needs to include the modified settings from the more than 200 attributes By default our book starts on the first page the pages can be flipped there are navi gation buttons thumbnail screen zooming printing and all we have
57. t library All of these files are inside the original obj folder APPENDIX A COPY PROTECTION The PageFlip4 protection prevents unauthorized use copying in similar format or reconfigured as a new publication of the Book created and published by the License owner User can protect the publication by entering a valid code sequence generated by the XML Validator in the CopyrightMessage in the XML file The true function of the Copy rightMessage is the configuration of the Copyright message displayed at the bottom of the PageFlip4 Screen where License owner publisher can display personal data and contact information the display of this line can be enabled disabled with a valid code B INTERACTIVITY This section includes all the available functions and variables that the loaded SWF Page codes can access In order to control SWF page file by PageFlip or control PageFlip by an SWF Page file User have to register the page file with the following short script Copy the follow ing code to the beginning of first frame s actionscript of that page file import flash display MovieClip import flash events Event var Container MovieCLip addEventListener Event ADDED_TO_STAGE onAdded function onAdded e Event void Container MovieClip parent parent parent parent parent parent Container registerPage this removeEventListenerC Event ADDED_TO_STAGE onAdded function onAppear void function onDisapp
58. the first spread in the Book If ZeroPage is enabled then a Page file is loaded to the empty area before the Cover which looks as if blending in the background lt PageData gt AlwaysOpened false AlLwaysOpened true AlwaysOpened false ZeroPage false ZeroPage false ZeroPage true Tst COVER COVER ZERO 1 9 PAGE 2nd COVER PAGE COVER 2 3 1 3rd PAGE PAGE COVER 3 4 2 Ath PAGE PAGE PAGE 4 5 3 Figure 3 8 Always keep in mind spreads when defining pages If defining a spread it can be done only as the 1st page of the current spread otherwise the Book cannot display it 3 9 3 9 1 3 9 2 PREPARING THE GRAPHICS CONTENT Save the files in the original structure or in the same folder as pageFlip swf or one of its subfolder PAGE FILES Prepare the content of the pages now that requirements are known The size of the Book pages is clear now User can create all the pages The following file formats are supported JPG JPEG The best choice if no animations interactions more complex than HotSpots or transparency is used It is the optimal choice from the aspects of rendering speed and file size Flash Player cannot handle Progressive JPG Tip When saving JPG do not save Preview in the file use sRGB color profile and at least 7 12 compression quality PNG It has similar characteristics as JPG but the image quality is better do to
59. the lossless compression and it also knows transparency up to 8 bit alpha channel but the file size is usually larger GIF The system can load them except for the AnimGIF but it is worse in file size and quality than the other formats Its use is not recommend ed only if on purpose SWF Use the Flash format when it is necessary for interaction or animation or if User wants text selection on the page It is important to know that too much text on the page can result in slower rendering Where User wants to use Spreads the specified width has to be doubled or the height where vertical mode is enabled Settings VerticalMode true Create all the Page files in the format most suitable in the size already specified in the XML If LargeCover is enabled do not forget to adjust their sizes THUMBNAIL FILES Thumbnail view images files has to be created based on the sizes given in the Set tings Thumbnai Width and Settings ThumbnailHeight attributes PageFlip4 scales images with other sizes to the specified size but for optimal quality previews should be created in the correct size In case preview is created to a Spread User should double the correct size 3 9 3 3 9 4 3 9 5 ZOOM FILES User can zoom in two ways Use the SWF file loaded on the page as source as it is evident in case of vector based content and other file does not have to be loaded again while the quality will be fine User can load
60. to do is prepare the contents to be loaded to the pages and adjust the size at the settings Or there is the advanced use where the interactive content takes the control over the book where every visible detail is customized where the sound material can be heard over the background music and so on And if we reach the limits of XML configura tion further possibilities are available with the help of the source codes in the Devel oper package 1 1 1 2 NEW FEATURES For USERS OF THE 3 6 VERSION This version is a completely new software It has only inherited the feature list of its predecessor not completely identical There are changes in the programming lan guage and structure PageFlip4 is an Object Oriented software written in AS3 From the outside speed can strike users while the inner improvements will be very useful during later developments which will hopefully be available for Users in the form of free updates However there are spectacular and exciting new features The most significant are the following Multiflip flipping simultaneously more than one pages Multi Level of Transparency optional number of consecutive transparent pages Real Spread real spreads working perfectly without tricks New perspective Hard Cover Tilted Book view Content Preview preview of the pages beside the Book Background image and background music Background image and background music assigned to pages Some fu
61. ts colors or sizes within the document as they save for matting information in the file and will break the XML structure and PageFlip will not be able to handle it When editing current attribute values can be modified in the quotation marks after the equal sign Regardless of the data type quotation marks can never be left out Add new attributes to the XML with extra care The simplest way is to push Enter after the existing attribute of the given category and add the new one after that in the next line THE USE OF THE XML VALIDATOR The XML Validator provides copy protection to our PageFlip4 Start the XML Valida tor before running PageFlip4 online or offline For further information on the use of the XML Validator refer to the Appendix A SIZES The preparation of the Book s pages depends on its final environment After specifying the resolution to optimize to User can calculate the Screen area in cluding the Book so that Preview if enabled and the ControlBar are also visible Consider the type of the Book Horizontal Vertical if Large Cover is preferred and the area designated for the Book and then calculate the ideal page size Also consider that in case of Full Screen view the graphic elements of the pages might need larger resolution For this reason and because the system automatically scales the Book default setting use the larger rather then smaller page size for cal culation If the content of the
62. umbnailFile They can only be image files JPG PNG GIF This image represents the page in the Preview or the Thumbnail view ThumbnailFile pages thumbs thumbnailfile jpg PrintFile User can enable printing of the page by specifying a print file that PageFlip loads and prints PrintFile pages print printfile jpg or PrintFile pages print printfile swf Pages can only be printed separately HotSpotFile PageIsTransparent HardPage BackgroundMusicFile BackgroundMusicLoop PageNumber PageLabel PageWidth PageHeight User can assign HotSpots to all pages For further informa tion on HotSpots refer to section 3 11 Use of HotSpots HotSpotFile pages hotspots pagehotspotfile xmL If transparent page is created showing the page behind User has to enable transparency the default value is false PagelIsTrasnsparent true This attribute can override the Book configuration with simi lar name concerning the whole book HardPage true User can assign music files to each page which PageFlip4 starts to play when the given page is opened and keeps it playing until User flips to another page BackgroundMusicFi Le pages bgm pagebgm mp3 If User wants to loop or repeat the music file several times the number of repeats can be specified by the following way BackgroundMusicLoop 100 User can customize the page numbering on any of the pages and the numbering will continu
63. x333333 ButtonAlLpha 100 ButtonOverColor Q0xFQB400 ButtonOverALpha 100 ButtonPressCoLor 0x333333 ButtonPressALpha 100 ButtonDisabLledColor xEEEEEE ButtonDisabLedAlpha 100 ControlBarLoaderEnabled true ButtonFirstLastEnabLled true ButtonLeftRightEnabled true ButtonZoomEnabled true ButtonPrintEnabled false ButtonAutoFlipEnabled false ButtonPDFLinkEnab1 ed true ButtonThumbnai LEnabled true ButtonLanguageEnabled false ButtonMuteEnabled true ButtonInfoEnabled false ButtonIndexEnabled false ButtonFullScreenEnabLled true ButtonCloseEnabled false ButtonCustom Enabled false ButtonCustom1Enabled false ButtonCustom2Enabled false ButtonCustom3Enabled false ButtonCustom4Enabled false ButtonCustom5Enabled false ButtonCustom6Enabled false ButtonCustom7Enabled false PDFlink ButtonToolTip true ButtonToolTipDeLay 60 Thumbnai LWidth 90 Thumbnai LHeight 120 Thumbnai LDropShadow true Thumbnai LDropShadowSize 8 Thumbnai LDropShadow0ffset 3 Thumbnai LDropShadowAlpha 50 PopupMaxWi dth 200 Boolean uint Boolean String Boolean String Boolean uint uint uint Boolean uint int uint uint Automatic adjustment of transparency level Maximum t

PAGEFLIP4 - Pageflip 5

Contents

Download Pdf Manuals

Related Search

Related Contents