Configuration manual
For a detailed list of configuration settings please access the FVXCreator Command Line Tool settings PDF
Configuration options: http://digitalflip.de/a4/software/cltool_manual.pdf
Before you start preparing Configuration File, please read and understand the below definitions. It defines the parameters required for executing Command Line FV Xpress Tool, including FlipBook customization and permissions.
Definition of Configuration File:
[Book]
This section contains parameters related to input.
Opf=
[Compulsory]
The parameter specifies:
a. Path of the OPF of a FlipBook
You must have prepared the FlipBook beforehand through FlipBook Creator or batch generation by scripts. The FlipBook must contain an OPF file and a resource folder. The files in the resource folder must be PDFs, images or HTMLs (each embeds a SWF only).
Example in the configuration file:
Opf=C:\fvxtool\MyFlipBook.opf
b. Path of a PDF document, containing multiple pages within;
Example in the configuration file:
Opf= C:\fvxtool\srcpdf\bettersoftwarepdf1_opt.pdf
c. Path of the CSV file (filename must be “pdfs.csv”), listing the documents according to the sequence they will be shown in the FlipBook in the following format:
The document could be JPEG, PNG, GIF or PDF.
The width and height of the first PDF in the CSV file will be used for defining the page content size of the FlipBook.
Example of a CSV file contents:
Page1.pdf Page2.pdf,1 Page3.pdf Page4.pdf Page5.pdf,1 Page6.pdf
Example in the configuration file: Opf= C:\fvxtool\srcpdf\pdfs.csv
Resource= [Optional]
Please skip this parameter if you specify path of a PDF document or a CSV file for the “opf=” parameter.
This parameter specifies the path of the resource folder of the FlipBook. E.g. Resource=C:\fvxtool\MyFlipBook_opf_files
If this parameter is not specified, please make sure resource folder has same name with the OPF file, with additional suffix “_opf_files”. E.g. If the OPF filename is “MyFlipBook.opf”, resource folder name should be “MyFlipBook_opf_files”
License= [Optional]
Please skip this parameter if your input FlipBook is using Embedded License OR you specify path of a PDF document or a CSV file for the “opf=” parameter.
This parameter specifies the path of the FlipBook license. E.g. License=C:\fvxtool\MyFlipBook.xml
[Output]
This section contains parameters related to output.
Folder= [Optional]
This parameter specifies the path of the output folder, where FV Xpress FlipBook will be stored.
E.g. Folder=C:\fvxtool\output
If this parameter is not specified, the default output folder is “My Documents\EBookSys\XpressTool”.
Log= [Optional]
This parameter specifies the path of the log file, which will be generated if the operation is not successful.
E.g. Log=C:\fvxtool\log.txt
If this parameter is not specified, the default log file will be here “My Documents\EBookSys\XpressTool_Log_
Bookname= [Optional]
This parameter specifies the FlipBook name if PDF or a CSV file is used as an input.
E.g. Bookname=My Book
Offline= [Optional]
This parameter specifies whether to create downloadable packages. Specify “1” for creating downloadable packages in exe format or “0” (default value) for not creating them.
E.g. Offline=1
Language=
This parameter specifies the language of the FV Xpress.
E.g. Language=ENG
To switch to other languages: English: Language=ENG Simplified Chinese: Language=CHS Traditional Chinese: Language=CHT German: Language=DEU Japanese: Language=JPN French: Language=FRA Italy: Language=ITA Czech: Language=CSY
[Offline] [Optional]
This section contains parameters related to downloadable packages. Please skip this parameter if you specify “0” for “Offline” parameter in [Output] section.
Zip=
This parameter specifies whether to create zip file as downloadable packages. Specify “1” for creating zip file or “0” (default value) for not creating it.
E.g. Zip=1
[Customize] [Optional]
This section contains parameters related to customizations.
Aboutbox=
This parameter specifies whether to show “About Us” button. Specify “1” (default value) to show the button. Customize the About Us information at [Aboutbox] section. Specify “0” to hide the button.
E.g. Aboutbox=1
ibutton=
This parameter specifies whether to show the “Information” button. Specify “1” (default value) to show the button. Customize the URL of Info button at [iButton] section. Specify “0” to hide the button.
E.g. ibutton=1
Email=
This parameter specifies whether to show the “Share this FlipBook” button. Specify “1” (default value) to show the button. Specify “0” to hide the button.
E.g. Email=1
Shadow=
This parameter specifies whether to show the shadow effect at the FlipBook. Specify “1” (default value) to show the shadow effect at the FlipBook. Specify “0” to hide the effect.
E.g. Shadow=1
Thumbnail=
This parameter specifies whether to show the “Thumbnail View” button. Specify “1” (default value) to show the shadow effect at the FlipBook. Specify “0” to hide the button.
E.g. Thumbnail=1
Toc=
This parameter specifies whether to show the “Table of Contents” button. Specify “1” (default value) to show the button. Specify “0” to hide the button.
E.g. Toc=1
Toolbartips=
This parameter specifies whether to show the toolbar tooltips. Specify “1” (default value) to show the toolbar tooltips. Specify “0” to hide the toolbar tooltips.
E.g. Toolbartips=1
Pagetips=
This parameter specifies whether to show the page tooltips. Specify “1” (default value) to show the page tooltips. Specify “0” to hide the page tooltips.
E.g. Pagetips=1
Flipindicator=
This parameter specifies whether to show the flipping-area indicator, i.e. the corner of the pages will be curled up when users mouse-over them. Specify “1” to show the flipping page indicator. Specify “0” (default value) to hide the flipping page indicator.
E.g. Flipindicator=1
Advertisingpage=
This parameter specifies whether to show the advertising page beside front and back covers. Specify “1” (default value) to show the advertising pages. Customize the path of advertising pages at [Advertisingpage] section. Specify “0” to hide the advertising page.
E.g. Advertisingpage=0
Advertisingserver=
This parameter specifies whether to show the advertising page beside front and back covers. Specify “1” (default value) to show the advertising pages. Customize the URL of advertising server at [Advertisingserver] section. Specify “0” to hide the advertising page.
E.g. Advertisingserver=1
Saveaspdf=
This parameter specifies whether to show the “Save as PDF” button. Specify “1” to show the button. Specify “0” (default value) to hide the button.
E.g. Saveaspdf=1
Notes=
This parameter specifies whether to show the Notes button. Specify “1” to show the button. Specify “0” (default value) to hide the button.
E.g. Notes=1
Bookmark=
This parameter specifies whether to show the Bookmark button. Specify “1” to show the button. Specify “0” (default value) to hide the button.
E.g. Bookmark=1
Search=
This parameter specifies whether to show the Search button. Specify “1” (default value) to show the button. Specify “0” to hide the button.
E.g. Search=1
Help=
This parameter specifies whether to show the Help button. Specify “1” (default value) to show the button. Specify “0” to hide the button.
E.g. Help=1
Branding=
This parameter specifies whether to customize the Branding logo and URL. Specify “1” (default value) to customize the Branding logo and URL. Specify them at [Branding] section. Specify “0” to show the default Branding logo and URL.
E.g. Branding=1
Winframe= [available for FV Xpress 1.8 or above] This parameter specifies whether to show the Full Screen button. Specify “1” to show the button. Specify “0” (default value) to hide the button.
E.g. Winframe=1
LogoURL= [available for FV Xpress 1.8 or above] This parameter specifies the Launching Page Logo that will appear at the pre-loader page while waiting for the downloadable package of FV Xpress FlipBook to be opened.
Specify the image (.JPEG, .PNG, .GIF) path at the parameter.
E.g. LogoURL="C:\fvxtool\images\logo.jpg"
Iframelinks= [available for FV Xpress 1.8 or above] This parameter specifies the path of “links.csv” that contains the links definition. To learn more how to prepare this CSV file, please refer to section 3.1 below.
E.g. Iframelinks="C:\fvxtool\csv\links.csv"
[Aboutbox] [Optional] This section contains parameter related to About Us dialog box. Please skip this parameter if you specify “0” for “Aboutbox” parameter in [Customize] section.
Url= This parameter specifies URL to be shown at the About Us dialog box of FV Xpress FlipBook.
E.g. Url=http://www.flipviewer.com
Title=
This parameter specifies the title of the FV Xpress FlipBook to be shown at the About Us dialog box.
E.g. Title=Title of FlipBook
Name=
This parameter specifies the company name to be shown at the About Us dialog box.
E.g. Name=Company Name
Author=
This parameter specifies the author name to be shown at the About Us dialog box.
E.g. Author=The Author of this FlipBook
Logo=
This parameter specifies the path of the logo image (.JPEG or .GIF or .PNG) of the company to be shown at the About Us dialog box.
E.g. Logo=C:\fvxtool\images\logo.jpg
[ibutton] This section contains parameters related to “Information” button. Please skip this section if you specify “0” to parameter “ibutton” at [Customize] section.
Url=
This parameter specifies the URL of the website that will be opened when "Information" button is clicked.
E.g. Url=http://www.flipviewer.com
[Branding] This section specifies parameters related to Branding. Please skip this section if you specify “0” to parameter “Branding” at [Customize] section.
Url=
This parameter specifies the Branding URL that will be opened when the Branding logo is clicked.
E.g. Url=http://www.flipviewer.com
Logo=
This parameter specifies the path of the Branding image (.JPEG or .GIF or .PNG) to be shown at the top-right hand corner of the book background.
E.g. Logo=C:\fvxtool\images\branding.gif
[Advertisingpage] This section contains parameters related to Flash advertisements to be added to the book background beside the front and back covers. Please skip this section if you specify “0” for parameter “Advertisingpage” at [Customize] section.
Fronturl=
This parameter specifies the path of the Flash file (.SWF) to be shown beside the front cover of the FlipBook.
E.g. Fronturl=C:\fvxtool\branding\demo1.swf
Frontkeepsize= Specify “0” for stretching the Flash file (specified by “Fronturl” parameter) keeping aspect ratio when the FlipBook is enlarged.
Specify “1” (default value) for keeping its original size when the FlipBook is enlarged.
E.g. Frontkeepsize=1
Backurl=
This parameter specifies the path of the Flash file (.SWF) to be shown beside the back cover of the FlipBook.
E.g. Backurl=C:\fvxtool\branding\demo2.swf
Backkeepsize Specify “0” for stretching the Flash file (specified by “Fronturl” parameter) keeping aspect ratio when the FlipBook is enlarged.
Specify “1” (default value) for keeping its original size when the FlipBook is enlarged.
E.g. Backkeepsize=0
[Advertisingserver] This section contains parameters related to Flash advertisements to be added to the book background beside the front and back covers. Please skip this section if you specify “0” for parameter “Advertisingserver” at [Customize] section.
URL=
This parameter specifies the URL of a CSV file.
The CSV file should be in the following format:
[front_policy]
A sample of CSV file: [front_policy] randomly [back_policy] randomly [front] 20,3,1,chinesetext.swf 20,3,1,englishtext2.swf 60,3,1,japanesetext.swf [back] 20,,,demoFVX.swf
Explanation of CSV file: 1. “[front_policy]” and “[back_policy]” determines how FV Xpress chooses an advertisement Flash (.SWF) URL to be added to the book background beside Front Cover and Back Cover respectively. a. “firstone” means the first advertisement in the list will be chosen. b. “randomly” means the advertisement will be chosen randomly from a list of advertisements. c. “byindex” means the advertisement will be chosen from a list of advertisements based on specified index. The index for first item in the list is “1”.
- “[front]” and “[back]” are sections specifying list of advertisements for beside Front Cover and Back Cover respectively. a. “[weight]” (optional field) is a number indicating the weight of the advertisement. The higher the weight of an advertisement compared with other advertisements, the higher chances that the advertisement will be chosen. The total weight of all advertisements may not necessary must be equal to 100. The default value is 1. b. “[interval]” (optional field) specifies number of seconds before showing front cover after the advertisement is shown. It is only applicable to advertisement beside front cover. The default value is 3. c. “[bestfit]” (optional field) can be a number "1" (default value) or "0". If “[bestfit]” is specified as "1", the Flash advertisement will be stretch to fit the available space and its aspect ratio will be kept. If it’s specified as "0", the original size of the advertisement will be kept regardless of changing of browser windows or screen resolutions. d. “[URL of SWF]” (compulsory field) is the URL of the Flash advertisement. The URL can be an absolute URL starts with “http://” or a relative URL that is relative to the CSV file (the SWF should be in the same folder with the CSV file). E.g. URL=http://asp6.digitalflip.com/training/xpress/ads/coverads/adscover.csv
[Toc] This section contains parameters related to table of contents. Please skip this section if you specify “0” for parameter “Toc” at [Customize] section.
File=
(Definition of file changed since Command Line FVX Tool 1.7) Specify the path of the definition file (.XML) for Table of Contents.
The format of the definition file should be something like this:
<?xml version = "1.0" encoding = "UTF-8"?>
b. Only one level of sub-title is supported under a main title.
c. Please ignore the field "FlipBook ID".
d. You can add single or multiple titles to a page number. The sequence of the items appearing in the table of contents is according to their sequence in the list at this step.
E.g. File=C:\fvxtool\toc\twolevel_toc.xml
[Dst_license] This section contains parameters related to license type if your input FlipBook is not a DRM-ed FlipBook. Please skip this section if your input FlipBook is a DRM-ed FlipBook from FlipBook Creator. Embedded=
Specify “0” (default value) if the output FlipBook should use Server License. Specify “1” if the output FlipBook should use Embedded License.
E.g. Embedded=1
[Dst_rights] This section contains parameters related to permission of the license if you specify “1” for “Embedded” parameter at [Dst_license] section.
Zoom=
Specify “0” for not allowing users to zoom the pages of FV Xpress FlipBook. Specify “1” for allowing users to zoom the pages of FV Xpress FlipBook.
E.g. Zoom=1
Print=
Specify “0” for not allowing users to print the pages of FV Xpress FlipBook. Specify “1” for allowing users to print the pages of FV Xpress FlipBook.
E.g. Print=1
[Dst_security] This section contains parameters related to security of the FlipBook if your input FlipBook is not a DRM-ed FlipBook. Please skip this section if your selected FlipBook is a DRM-ed FlipBook.
Encrypt=
Specify “0” for not encrypting the FV Xpress FlipBook. Specify “1” for encrypting the FV Xpress FlipBook. E.g. Encrypt=1
Expirydate=
Specify expiry date of your FlipBook if you specify “1” for “Embedded” parameter at [Dst_license] section. The format of the date should be “yyyy-mm-dd”.
E.g. Expirydate=2015-01-01
[Server] This section contains parameters related to URL of servers. Analyzer=
Specify the URL of the FlipAnalyzer Server for FlipBook tracking purposes. You still need to register your FlipBook to FlipAnalyzer Server.
E.g. Analyzer=http://asp2.flipanalyzer.com/flipAnalyzer101
[Pdfconvert] This section contains parameters related to PDF conversion library. Std= Poly= Bitmap= For standard conversion, please specify: Std=1 Poly=0 Bitmap=0
If standard conversion could not work, please try Level 1: (Level 1) Std=0 Poly=1 Bitmap=0
If Level 1 could not work, please try Level 2: (Level 2) Std=0 Poly=0 Bitmap=1
If Level 2 could not work, please try Level 3: (Level 3) Std=0 Poly=0 Bitmap=0
Comparison: Standard conversion: Links and keyword highlighting during search are preserved. Option 1: Links and keyword highlighting during search are preserved. Quality of SWF files is poorer and conversion time may be longer than Standard. Use only when Standard fails to convert properly. Option 2: Links are preserved but keyword highlighting during search is not available. Use only when Standard and Level 1 fails to convert properly. Option 3: Links and keyword highlighting during search are not preserved. Use only when Standard, Level 1 and Level 2 fail to convert properly.
E.g. Std=1 Poly=0 Bitmap=0
[Miscellaneous] This section contains parameters related to FlipBook customization if inputs are PDFs or CSV.
Background=
This parameter specifies the image (.JPG, .JPEG, .GIF, .PNG) path of book background.
E.g. Background=C:\fvxtool\images\bg.jpg
Pagebackground= [available for FV Xpress 1.8 or above] This parameter specifies the image (.JPG, .JPEG, .GIF, .PNG) path of the page loading background.
The customized page loading background will be seen while waiting for pages to be loaded. If the page loading background is not customized, readers will see blank pages with page-loading message while waiting for the pages to be loaded.
E.g. Pagebackground=C:\fvxtool\images\logo.jpg
Flipping_sound=
This parameter specifies whether to enable the Flipping Sound when the pages are flipped.
Specify “1” (default value) for enabling the Flipping Sound. Specify “0” for muting the Flipping Sound.
E.g. Flipping_sound=1
Standard_direction=
This parameter specifies whether to open the FlipBook in standard direction (front cover on the right side) or not (front cover on the left side).
Specify “1” for opening the FlipBook in standard direction. Specify “0” for not opening the FlipBook in standard direction.
E.g. Standard_direction=1
Bgmusic=
This parameter specifies whether to allow Background Music to be played in FV Xpress FlipBook.
Specify “1” to allow playing of Background Music. Specify Background Music at [Bgmusic] section. Specify “0” to disallow playing of Background Music.
E.g. Bgmusic=1
Autoextractbookmark=
This parameter specifies whether to allow auto-extraction of PDF bookmarks as Table of Contents for FV Xpress FlipBook.
Specify “1” to allow. If this takes effect, the table of contents specified by “Toc” parameter will not take effect. Specify “0” for not allowing. E.g. Autoextractbookmark=1
[Bgmusic] This section contains parameters related to Background Music. Please skip this section if you specify “0” for parameter “Bgmusic” at [Miscellaneous] section.
Files=
This parameter specifies the file paths of background musics to be played in FV Xpress FlipBook.
Note: 1. To specify more than one music file, delimit them with “|” 2. If there’s space in the path, please change to “+” 3. Only MP3s are allowed.
E.g. Files=C:\fvxtool\mp3\music1.mp3| C:\fvxtool\mp3\music2.mp3