What attributes can go in the <contents...> section of pages.xml?
The attributes and values which configure the Flash pageflip are case sensitive. Make sure you understand the structure of XML files.
Attributes are written as key value pairs: param="value". I've tried to group these sensibly below.
Attribute |
Default |
useage |
| width | 300 | width of your pages in pixels |
| height | 400 | height of your pages in pixels |
| hcover | false | Book has hard covers if set to true. |
| transparency | false | pages have transparency. |
| prepage | - | Value is the path to a page which is displayed to the left of the closed book - possibly for providing instructions to users. |
| background | - | value is the path to the initial background image which should be the same dimensions as the stage (default 800x600) to avoid odd resizing effects when the book is first opened. |
| fastflip | false | If set to true the gotoPage function jumps directly to the destination page, otherwise the pages are autoflipped. |
| autoflipspeed | 2 | Number of seconds to wait between autoflipping pages (when fastflip="false"). |
| scalemode | noScale | Read the Flash help for stage scaling. |
| dloading | false | Causes pageflip to unload/load pages dynamically - useful for large books. |
| pdfbutton | false | true makes the PDF button visible. Clicking it makes a browser window appear with the specified content. Not used from V1.41. |
| pdflink | - | path to pdf. Not used from V1.41. |
| pageanimrestart | false | when false animated pages are stopped/started - i.e. paused & resumed. When true pages are started from the beginning. (V1.41 onwards) |
| centrebook | false | When true the book is centered when it is closed. |
pageNav (V1.40 onwards) |
||
| pagenavy | BOTTOM | TOP, MIDDLE, BOTTOM |
| pagenavx | CENTER/CENTRE | LEFT,CENTER/CENTRE,RIGHT |
| pagenavskin | pageNav.swf | When customising the pagenav controls use the pageNav.FLA to assist - stick with the ActionsScript provided (scripts/pagNav.as) and keep button (etc) instance names the same. |
| pagenavcandrag | true | set to false if you don't want to allow people to move the page navigation interface around. |
Zoom sliders (from V1.40 these can be positioned & dragged) |
||
| hzoomcontrol | true (false from V1.41) | Set to false to hide & disable the zoom sliders. From V1.41 only one slider is allowed. |
| vzoomcontrol | true (false from V1.41) | |
| hzoomx & yzoomx | RIGHT | CENTER /CENTRE, LEFT or RIGHT. This is new in V1.41. |
| hzoomy & yzoomy | BOTTOM | TOP,MIDDLE or BOTTOM.This is new in V1.41. |
| vzoomcandrag & xzoomcandrag | true | Set to false if you don't want people dragging the zoom sliders around. This is new in V1.41. |
| vzoomskin | vZoomControl.swf | When customising the zoom controls use the vZoomControl.FLA to assist - stick with the ActionsScript provided (scripts/vZoomControl.as) and keep slider and slot instance names the same. |
| hzoomskin | hZoomControl.swf | When customising the zoom controls use the hZoomControl.FLA to assist - stick with the ActionsScript provided (scripts/hZoomControl.as) and keep slider and slot instance names the same. |
| maxzoom | 5 | Maximum page zoom when using the zoom sliders |
Magnifying Glass |
||
| magpower | 2 | Magnification factor of the magnifying glass. |
| magkey | NONE | Key which causes the on screen magnifying glass to appear. |
Page turning keys |
||
| prevkey | NONE | defines which keys can turn pages. Usually LEFT and RIGHT |
| nextkey | NONE | |
Where to open the book |
||
| startbackcover="true" | false | Set to true to start at the back cover |
| startpagenum | - | Which page number to initially open the book at |
| startpageid | - | Which page Id to initially open the book at. |
First and Last Page |
||
| firstpage | INSIDEFRONTCOVER | Set to FRONTCOVER if you want the book to close when you click the |< button. |
| lastpage | INSIDEREARCOVER | Set to REARCOVER if you want the book to close when you click the >| button. |
Page flip sounds |
||
flipsnd0 flipsnd1 flipsnd2 |
Sounds/FlipSound.mp3 | The sounds to use for each stage of the page turn. |
| flipSound | true | determines if page flip sounds are used (can be turned on/off) |
Page shading |
||
| pageshadealpha | 30 | Transparency of the page shading. |
| pageshadespeed | 0.5 | How quickly the shading fades in/out |
| pageshading | true | Set to false to turn page shading off. |
| notedragmargin | 10 | Margin around the edges of page notes where you can grab and drag the note. This leaves the central area of a note to be able to respond to clicking. |
Popups/Clickzoomed pages |
||
| popupentrance | Fade | A comma separated list of entrance transitions for page popups. |
| popupexit | Fade | A comma separated list of exit transitions for page popups. |
popupexitbutton |
false | If set to true causes an exit button to appear on all popups. |
| clickzoom | true | page zooms when clicked. This is a global control set to false to stop all pages from responding to clickzoom - unless your have set hires_src for that page. |
| clickzoommode | CENTREMOUSE | When you click on a page the point clicked follows the current mouse location. Set to CENTRESCREEN if you want the popup click point to start centred on the screen. |
| clickzoomscroll | SLIDE | SLIDE, NONE, SCROLL - scrolling behaviour for the zoomed page. |
| scrollboundary | 50 | The default is 50 pixels and provided a margin for stopping scrolling to keep the popup pages visible. Only applies when clickzoommode="SCROLL" |
| clickzonewidth | 50 | Use to create horizontal and vertical no slide bands for popup pages. Only applies when clickzoommode="SLIDE" |
popupexitbutton |
false | If set to true causes an exit button to appear on popups. |
| popupusehandcursor | true | If set to false the cursor used when the mouse is over a popup is the normal arrow cursor otherwise it is a hand cursor (you can supply your own by modifying the pageflip_BNN.FLA.) |
| scrollaccel | 0.05 | The acceleration rate of popups when they slide around. |
| popupfilter | - | Value is the id of a filter to apply to popups in general. |
Contents list generation |
||
| thumbscale | 40 | Contents thumbnail size is controlled by this scaling factor. The number represents the % scaling of the pages needed to produce the thumbnails. |
| thumbfilter | - | Value is the id of a filter to apply to contents thumbnails when they are drawn. |
| thumbrolloverscale | 1 | Scaling factor to apply to thumbnails when the mouse rolls over. The default value of 1 means no scaling. Use something like 1.5 to grow the thumbnail as the mouse rolls over it. |
| contentsentrance | Fade | The id of a transition to use when the contents appear on screen. |
| contentsexit | Fade | The id of a transition to use when the contents are removed from screen. |
| thumbwidth | - | if not specified width and height are calculated from the width and height of the pages using the thumbscale factor. |
| thumbheight | ||
| thumbscrollaccel | 0.1 | Speed of scrolling up/down of contents thumbnails. There is a band in the middle 5th of the screen where scrolling is halted. |
| thumbxstart,thumbystart | 10,10 | X,Y position to start drawing contents on screen |
| thumbxgap,thumbygap | 5,5 | set horiz & vert gaps betwen thumbnails |
| thumbfade | 30 | This value sets the alpha setting by which to dim the underlying pages whilst contents are on screen |
printtopmargin |
10 | top margin when printing contents |
| printleftmargin | 10 | left margin when printing contents |
Flip Control |
||
| clickarea_factor | 0.25 | Determines the width of the area along the edge of the page where the mouse can pick up the page for turning. The default value (0.25) with a default page width (300) gives a strip 0.25x300=75 pixels wide. |
| afa_factor | 0.2 | Determines the initial width of the autoflip page turn as a factor of page width |
| gs_factor | 2 | Goto page flip speed |
| ps_factor | 1 | Mouse pursuit speed (keeps mouse and flipping page together). With larger numbers I find the maouse lags behind the turning page. |
| es_factor | 3 | Flip speed after releasing the mouse. |
Page numbers |
addpagenumbers | false | Set to true to add page numbers to each page |
| valignpagenumbers | bottom | Positions page number at top, middle or bottom of page |
| halignpagenumbers | edge | Positions page numbers at the edge or inside |
Slideshows |
||
| slideshow | false | Set to true if you want the book pages to turn automatically. The slideshow will repeat indefinately. |
| slideshowspeed | 5000 | Number of milliseconds to pause between page turns. |
| slideShowDirection | fwd | Set to rev to make the show run from back to front. |
Tooltips |
||
| tthmargin | 10 | Position of tooltip text in relation to tooltip background |
| ttvmargin | 2 | |
| ttvspace | 10 | space between cursor and tooltip |
| tooltipfade | 0.3 | Tooltip fade in/out speed |
Book page loading progress indicator |
||
| loadindicator | percent | Choose which load indicator you want. You can select either percent or navbar |
What can be put between the <content>..</content> tags?
| Definition | Comment |
| <background> | declares a background image |
<filter>...</filter> |
declares a filter |
| <tooltip>...</tooltip> | declares a tooltip |
| <transition>...</transition> | declares a transition |
| <page>...</page> | declares a page |
Note that from V1.41 only <page> containers are supported. All other sections have been moed to their own files to keep the pages.xml simple.