5.6.2. Configuration Files

mz3Tool makes use of several dedicated XML files that store special configuration parameters.

Those local configuration files are not used in the final Server of mz3Viewer Packages but only used locally (with one exception: the mz3ToolJsConfigData.xml file.

Two different kinds of configuration files are used and collected in different folders:

1. _mz3ToolConfigData
   This folder contains several files for different sets of configuration parameters:
   • mz3ToolBookData.xml
     The main configuration file holding all basic configuration parameters, like
     - page type
     - page size
     - languages used
     - custom logo path and position
     And many more
   • mz3ToolConfigData.xml
     Mostly PDF conversion related settings
   • mz3ToolJsConfigData.xml
     Special parameters for the JavaScript version.
     This file is needed in the Online package, because it will be interpreted by the JavaScript version of MegaZine3.
     It contains e.g. all settings for the custom Pop-Up and all definitions for the navigation bar and the burger menu
   • mz3ToolPageData.xml
     No longer used (in old versions only)
   • mz3ToolScaleData.xml
     Special file, still used for some PDF settings
   • mz3ToolViewerConfigData.xml
     Not used yet; intended for mz3Viewer specific parameters that are not needed for the JavaScript version

2. _addPageElements
   This folder contains all files that add elements to book pages. Therefore, for each supported and used element type a dedicated file exists:
   • addArea.xml
     Every link is defined by page
   • addImage.xml
     The definition for all images added to pages (e.g. on top of a Page Image or on an empty page) are collected here; again grouped by page number.
   • addPimg.xml
     Normally for every page number the definition of one image (the page image).
     Page Images and images are separated because they are treated differently, e.g.
     - Page Images always are scaled to the size of a page
     - Only one Page Image allowed per page
     - in “Manage Elements” Page images and Images can be filtered separately
     - Page Images have a different “priority” than images; they are positioned in the lowest layer, i.e. all other elements are on top (hiding the Page Image).

Configuration File Example

Each configuration file is an XML-File.
The following example show a fake mz3ToolBookData.xml for demonstration purposes (some needed tags are missing).:

<?xml version='1.0' encoding='utf-8'?><!DOCTYPE book SYSTEM 'https://megazine3.de/megazine2.dtd'><book>
  <startpage>1</startpage>
  <bookBgColor>#ff000000</bookBgColor>
  <bookActualVersion>2.4.4.004</bookActualVersion>
  <showNavbar>yes</showNavbar>
  <showBurgerMenu>yes</showBurgerMenu>
  <pageheight>1100</pageheight>
  <cornerhint>false</cornerhint>
  <pageType>double</pageType>
  <pagewidth>800</pagewidth>
  <defaultLanguage>de</defaultLanguage>
  <pageWidth2>1600</pageWidth2>
  <pageCount>34</pageCount>
  <lang>de</lang>
  <creationDate>2020-01-23 13:26</creationDate>
  <bgcolor>0x111111</bgcolor>
  <modificationDate>2020-01-24 12:56</modificationDate>
</book>

Once you know that “Tag-Names” are included in a pair of <> and the value is enclosed in a pair of start and end Tag, you will be able to read such a file.
An end Tag looks very similar as the start tag but contains a / right after the starting <.
Although it is easy to modify an XML file, it is also easy making a mistake with unpredictable results!
In such a case it is best to restore form a backup or simply delete. If no needed config file is found, mz3Tool will create an empty one.