This document defines E-Book Systems extension to the OPF storage structure.
All book attributes are defined within the <x-metadata> tag.
Guidelines:
a. Attribute names should be lower case to be consistent with OPF convention (case sensitive).
Book Attributes 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.
|
Attribute |
Syntax |
|
EbooksysVersion |
<meta name="EbooksysVersion"
content="1.3"/> |
|
centerfold |
<meta
name="centerfold" content="<yes/no>"/> Example:
<meta name=”centerfold” content=”yes”/> Meaning:
Default to view pages in centerfold view. Note that page level centerfold
setting takes precedence. |
|
openbook |
<meta
name="openbook" content="<yes/no(default)>"/> Example:
<meta name=”openbook” content=”yes”/> Meaning:
Whether to leave book closed or flip to page 1 when book is opened. |
|
page_inset |
<meta
name="page_inset" content="top:<top>
bottom:<bottom> inner:<inner> outer:<outer>"/> (<top> <bottom> etc. are integers of
percentage values. For example, 5 means 5%. Required FV 1.3) (For backward compatibility, decimal numbers are
also accepted. For example, 0.05 also means 5%. Note that this is not a
portable format.) Meaning:
Defines page margins. |
|
book_background |
<meta
name="book_background" content="color:
<color_value>"/> or <meta
name="book_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) Meaning:
Defines book background image or color. |
|
page_background |
<meta
name="page_background" content="color:
<color_value>"/> or <meta
name="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) Meaning:
Defines default page background image or color. |
|
right_page_background (required FV 1.3 or FA 4.1 and above) |
<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) Meaning:
Defines default page background for right-hand pages. If not defined,
“page_background” will be used. |
|
centerfold_page_background (required FV 1.3 or FA 4.1 and above) |
<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) Meaning:
Defines default page background for centerfold pages. If not defined, “page_background”
will be used. |
|
background_music |
<meta
name="background_music" content="<yes/no>
<musicfilename : string>"/> Example:
<meta name=”background_music” content=”yes c:\my music\abc.mp3”/> Meaning:
Whether background music is enabled and the music |
|
flipping_sound |
<meta
name="flipping_sound" content="<yes/no>"/> Meaning:
Whether flipping sound is enabled. |
|
book_binder |
<meta
name="book_binder" content = "numrings: <int> ringtype:
<string>"/> Example:
<meta name=”book_binder” content=”numrings: -1 ringtype: 3DBronze”/> NumRing:
number of rings. 0 – None, (-1) – default, 3 – three ring RingType:
filename of ring pattern (less br prefix) |
|
flipping_speed (valid for
registry only) |
<meta
name="flipping_speed" content="<speed – int
%>"/> |
|
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 Meaning:
Bookmark display type. Default style is pageno. |
|
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"/> |
|
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) Meaning:
Option to display filename on album page. Default is no. |
|
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) Meaning:
Option to display page number on album page. Default is no. |
|
page_content_size (required
FV 2.2 or FA 5.0 or above) |
<meta name="page_content_size"
content="<width height>"/> Meaning:
Defines 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>"/> Meaning:
Window launch position and size. If x, y = -1,
the position remains unchanged. Width and height are specified in pixels. |
|
resize (required FV
1.21 or above) |
<meta name="resize"
content="<yes(default)/no> "/> Meaning: Whether
the book (application window) can be resized. Default is yes.
|
All page attributes are defined in the <itemref> tag
|
Attribute |
Values |
|
centerfold |
“yes” or “no” Example:
<itemref idref="item1" centerfold="yes"/> Default
depends on content type (HTML - yes, FLP - no) |
|
index |
“yes”
(default) or “no” Example:
<itemref idref="cover" index="no"/> Meaning:
Whether this page should be included in TOC or thumbnail pages. |
|
pageside |
"left",
"right" or "any" (default) Example:
<itemref idref="item1" pageside="right"/> Meaning:
Preferred page side. |
|
page_background (required FV
1.0.6 or above) |
"texture:
<filename>"/> Example:
<itemref idref="cover" index="no"
page_background=”texture: http://www.fliplibrary.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. |
|
music (required FV
1.1 or above) |
"<filename>"/> Example:
<itemref idref="cover" index="no"
music=”http://www.fliplibrary.com/mysong.mp3”/> |
All OPF pages are defined within the <manifest> section tag
|
Page Type |
Example |
|
FLP Page: application/x-flp |
<item
id = “item1”http://www.flipviewer.com/images/page_r1_c1.gif
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” http://www.fliplibrary.com/index.htm
media-type = “test/html”/> |
|
Common Resources: application/x-resource |
<item
id = “resource_1" href="http://www.flipviewer.com/images/page_r1_c1.gif">"
media-type = "application/x-resource"/> |
|
Contents Page: application/x-toc (required FV
1.0.6 or above) |
<item id =
“table_of_contents” href = “” media-type = “application/x-toc”/> Contents page
is generated according to items listed in the <spine> section. Example for
<spine>: <itemref
index = "no" centerfold = "no" idref =
“table_of_contents"/> |
|
Overview Page: application/x-tmb (required FV
1.0.6 or above) |
<item id =
“overview” href = “http://www.abc.com/myalbum/overview.tmb” media-type =
“application/x-tmb”/> Overview HREF
may refer to a remote TMB file. TMB file is created by FlipViewer Plus 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
<spine> section. Note that
generation of overview page works for local image files only. Remote images
will appear as blank images. Example for
<spine>: <itemref
index = "no" centerfold = "no" idref =
“overview"/> |
|
Index Page: application/x-idx (required FV
1.2 or above) |
<item id =
“index_page” href = “” media-type = “application/x-idx”/> Index page is
generated according to items listed in the <spine> section. Example for
<spine>: <itemref
index = "no" centerfold = "no" idref =
“index_page"/> |