FlipViewer.com
  Technology Overview Products Services Support Devzone
 
OPF Attributes
This page lists attributes that are used in the FlipBook defination (.opf) file.

All book attributes are defined within the <x-metadata> tag.

You can edit FlipBook attributes by opening the .opf file with the windows Notepad program.

Guideline:. Attribute names should be lower case to be consistent with OPF convention and are case sensitive.

 
Latest OPF Attributes Documents: MS Word DOC & HTML version
 
Book Attributes
 
They are used for default values for all pages in the book and overwrites application settings. Individual pages may have Page Attributes that overwrite Book Attributes.
 
Book Attributes
Syntax
Effect
EbooksysVersion <meta name = "EbooksysVersion" content = "1.3"/> Indicates the Ebooksys version number.
centerfold <meta name = "centerfold" content = "<yes/no>"/> To determine if the book opens in the centerfold mode or not.
openbook <meta name = "openbook" content = "<yes(default)/no>"/>
Eg: <meta name = "openbook" content = "no"
To determine whether to leave the Flipbook closed or flipped to page 1 automatically when the Flipbook is opened.
page_inset <meta name = "page_inset" content = "top:<top> bottom:<bottom> inner:<inner> outer:<outer>:/>
(<top> <bottom> etc are all floats)
To determine the page margins.
book_background <meta name = "book_background" content = "color:<color-int>"/>
Eg: <meta name = "book_background" content = "color: 10066176"/>
or <meta name = "book_background" content = "texture: <filename>"/>
Eg: <meta name = "book_background" content = "texture: http://www.abc.com/bgd.jpg"/>
10066176 is an integer that was converted from hexadecimal (base16). It is defined as Blue-Green-Red instead of the typical Red-Green-Blue.
page_background <meta name = "page_background" content = "color:<color-int>"/> or
<meta name = "page_background" content = "texture: <filename> "/>
The page can have a coloured or textured background.
right_page_background <meta name="right_page_background" content="color: <color_value>"/> or
<meta name="right_page_background" content="texture: <filename>" />

<color_value> is an RGB value in one of the following formats:

a. decimal value in the order Blue-Green-Red, example “color: 16777134”

b. hex value ‘$BBGGRR’ in the order Blue-Green-Red, example “color: $FF0000”

c. hex value ‘#RRGGBB’ in the order Red-Green-Blue, example “color: #0000FF” (required FV 1.2)

The right-hand page can have a coloured or textured background.
centerfold_page_background
<meta name="centerfold_page_background" content="color: <color_value>"/> or
<meta name="centerfold_page_background" content="texture: <filename>" />

<color_value> is an RGB value in one of the following formats:

a. decimal value in the order Blue-Green-Red, example “color: 16777134”

b. hex value ‘$BBGGRR’ in the order Blue-Green-Red, example “color: $FF0000”

c. hex value ‘#RRGGBB’ in the order Red-Green-Blue, example “color: #0000FF” (required FV 1.2)

The centerfold pages can have a coloured or textured background.
background_music <meta name = "background_music" content = "<yes/no> <musicfilename:string>"/>

Eg: <meta name = "background_music" content = "yes c:/mymusic/oohlala.mp3"

To enable or disable the background music and define the music itself.
flipping_sound <meta name = "flipping_sound" content = "<yes/no>"/> To enable or disable the flipping sound.
book_binder <meta name = "book_binder" content = "numrings: <int> ringtype: <string>"/>

Eg: <meta name = "book_binder" content = "numrings: 3 ringtype: 3DBronze"/>
numring: number of rings. 0 - None, (-1) - Default, 3 - three ring
ringtype: filename of ring pattern

To determine the type and number of rings for the book binder.
flipping_speed <meta name = "flipping_speed" content = "<speed - int%>"/> Valid for registry only.
window_frame
(Required FV 1.2 or above)
<meta name="window_frame" content="<yes(default)/no>"/>  
autoflip
(Required FV 1.2 or above)
<meta name="autoflip" content="<yes/no(default)> [direction: flip_direction atend: action_at_end interval: milliseconds] "/>

where:

flip_direction = [forward | backward | manual]

action_at_end = [repeat | reverse | stop]

milliseconds = flipping interval in milliseconds (ends with ‘ms’)

Example: do not start with autoflip
<meta name=”autoflip” content=”no”/>

Example: open book with autoflip from front to back, repeat at end of book, with flipping interval of 3 seconds
<meta name=”autoflip” content=”yes direction:forward atend:repeat interval:3000ms”/>

 
bookmark
(Required FV 1.3 or FA 4.1 and above)
<meta name="bookmark" content="<pageno/text/pattern>"/>

where:
pageno = show as page number bookmark

text = show as text bookmark

pattern = show as pattern bookmark

This will display the different types of bookmark.
marker
(Required FV 2.2 or FA 5.0 and above)
<meta name="marker" content="type: <marker_type>"/>

where <marker_type> is one of the following:
flower
heart
stripe
star
leaf
pawprint
candle
candy
candycane
scroll
pencil
fishbone

Example: <meta name = "marker" content = "type: heart"/>
Meaning: Marking style.

This will determines the marker style.
file_name
(Required FV 1.3 or FA 4.1 and above)
<meta name="file_name" content=”no”/> or

<meta name="file_name" content="yes extension:<yes/no> transparent:<yes/no> > border:<yes/no> backcolor:<color_value> position: <top/bottom> alignment:<outside/center/inside> fontname:[<font_name>] fontsize:8 fontcolor:<color_value> fontstyle:[]"/>

where:
extension = show file extension

transparent = display as transparent text

border = display border around text

backcolor = background color of filename text

position = top: display on header of album page (default)
bottom: display on footer of album page

alignment = outside: align to outer page margin
center: align to center of page
inside: align to inner page margin

fontname = display font name to use <font_name>

fontsize = display font size

fontcolor = display font color

fontstyle = display font style separated by commas; for example [bold,italic,underline,strikeout]
<color_value> is an RGB value in one of the following formats:

a. decimal value in the order Blue-Green-Red, example “color: 16777134”
b. hex value ‘$BBGGRR’ in the order Blue-Green-Red, example “color: $FF0000”
c. hex value ‘#RRGGBB’ in the order Red-Green-Blue, example “color: #0000FF” (required FV 1.2)

This will display the filename on the album page.
page_number
(Required FV 1.3 or FA 4.1 and above)
<meta name="page_number" content=”no”/>

or
<meta name="page_number" content="yes extension:<yes/no> transparent:<yes/no> > border:<yes/no> backcolor:<color_value> position: <top/bottom> alignment:<outside/center/inside> fontname:[<font_name>] fontsize:8 fontcolor:<color_value> fontstyle:[]"/>

where:

extension = show file extension

transparent = display as transparent text

border = display border around text

backcolor = background color of filename text

position = top: display on header of album page

bottom: display on footer of album page (default)

alignment = outside: align to outer page margin
center: align to center of page
inside: align to inner page margin

fontname = display font name to use <font_name>

fontsize = display font size

fontcolor = display font color

fontstyle = display font style separated by commas; for example [bold,italic,underline,strikeout]

<color_value> is an RGB value in one of the following formats:

a. decimal value in the order Blue-Green-Red, example “color: 16777134”

b. hex value ‘$BBGGRR’ in the order Blue-Green-Red, example “color: $FF0000”

c. hex value ‘#RRGGBB’ in the order Red-Green-Blue, example “color: #0000FF” (required FV 1.2)

This will display the page number on album page.
page_content_size
(required FV 2.2 or FA 5.0 or above)
<meta name="page_content_size" content="<width height>"/> This will determines the size of the page content area (excluding page margins) in pixels
window
(Required FV 1.21 or above)
<meta name="window" content="<x> <y> <width> <height>"/>

If x, y = -1, the position remains unchanged. Width and height are specified in pixels.

This will determines the position and size of when Window launch.
resize
(Required FV 1.21 or above)
<meta name="resize" content="<yes(default)/no>"/> This will determine whether the book (application window) can be resized.

Page Attributes
(All page attributes are defined in the <itemref> tag)
Syntax
Effect
centerfold
yes" or "no"
Eg: <itemref idref = "item1" centerfold = "yes"/>
Default depends on content type (HTML - yes, FLP - no)
This will enable the page setting of the page that contains item1 to change to centerfold.
index "yes" (default) or "no"
Eg: <itemref idref = "cover" index = "no"/>
This will determine if this cover page will be included in the Table of Contents or thumbnail pages.
pageside "left", "right" or "any" (default)
Eg: <itemref idref = "item8" pageside = "right"
This will determine the preferred page side for the assigned item.
page_background
(requires FV 1.0.6 or above)
"color: <color - int>"/> or "texture: <filename>"/>
Eg: <itemref idref = "cover" index = "no" page_background = "texture: http://www.abc.com/front.jpg"/>
When specified, this page background will be used instead of the book's default page background. Texture may refer to online or local image file.
Color number is an Blue-Green-Red number

Page Types
(All OPF pages are defined within the <manifest> section tag)
Syntax
Effect
FLP Page: application/x-flp <item id = "item1" href = "http://www.abc.com/page1.jpg" media-type = "application/x-flp"/> FLP page may refer to E-Book Systems' FLP file or any of the supported image file types. Blank page is represented by an empty HREF.
HTML Page: text/html <item id = "item2" href = "http://www.abc.com/index.htm" media-type = "text/html"/>  
Common Resource:
application/x-resource
<item id = "resource_1" href = "http://www.FlipViewer.com/images/page_r1_c1.gif" media-type = "application/x-resource"/>

Defines a resource URL for use in <spine> section such as 'pagebackground'.

 
Contents Page: application/x-toc
(requires FV 1.0.6 or above)
<item id = "table_of_contents" href = "" media type = "application/x-toc"/>
Example for : <spine>
<itemref index = "no" centerfold = "no" idref = "table_of_contents"/>
Contents page is generated according to items listed in the section.
Overview Page: application/x-tmb
(requires FV 1.0.6 or above)
<item id = "overview" href = "http://www.abc.com/myalbum/overview.tmb" media-type = "application/x-tmb"
Eg: for <spine>
<itemref index = "no" centerfold = "no" idref = "overview"/>
Overview HREF may refer to a remote TMB file. TMB file is created by FlipBrowser Gold or FlipAlbum® 4.0 products using Save As Complete function. It contains thumbnail bitmaps of the pages.
If HREF is empty, the overview pages are generated according to items listed in the section. Note that generation of overview page works for local image files only. Remote images will appear as blank images.
 
>> Back to Content
"We wanted to offer something different to our readers, and putting the magazine online in this format enabled us to provide them with a multimedia experience unlike any other paintball magazine...

We chose E-Book Systems' technology because of all the extra elements it has allowed us to incorporate into publishing our digital issues...

Since introducing the digital issues, the reader response has been overwhelmingly positive...

We've seen the numbers for our online subscriptions growing steadily, with a 100% increase in online subscriptions ..."
- Cheryl Amaya,
   Publisher of Paintball 2Xtremes

  Home Site Map Terms of Use Privacy Policy (Updated 27 Oct 2005)