New v2.2.0 Attributes

From MegaZine3
Jump to: navigation, search

These book attributes had been introduced with version 2.2.0.


Some attributes define the use of icons, that can differ depending on use for desktop computers or wwith mobile devices.

For mobile/touch devices a new set of bigger icons was designed and now is available and can be selected (also for desktop computers).

The new gestures plugin now allows full control via touch or mouse gestures. Attributes define which gestures are recognized and what navigation elements are visible or will be hidden (most support* attributes are used for this). The gestures* attributes mostly define variables used for fine tuning the behavior of the gestures plugin. Usually those work well with the default settings.

ASUL configuration changes can be avoided in most cases, but are still possible. Many customization options now are supported by book attributes (e.g. support Fullscreen or supportMute to show/hide those toggle buttons).

All attributes are listed in the first table as they are declared in the megazine3.dtd file, referenced in every mz3 file and used for validation in IDEs like IntelliJ IDEA. The description of each attribute follows; in a similar way as how the legacy attributes are defined on the [book page].

Most new attributes support an "auto" value. The final value used is device specific. If auto us used, then big icons will be used for mobile devices, and small ones for desktop computers (you might prefer big one for big monitors also, though).

This documentation is in work! Not all settings are documented yet, and if a description is missing, even the type and default value might be incorrect. Only those attributes with a description had been adjusted and will be valid!

   videoSeekDelay               CDATA                            "1000"
   videoPlayDelay               CDATA                            "1000"
   infoInBrowser                (yes | no | auto)                "auto"
   bookPanScaleEnabled          (yes | no | auto)                "auto"
   bookPanEnabled               (yes | no | auto)                "auto"
   bookPanRotationEnabled       (yes | no | auto)                "auto"
   bookSwipeEnabled             (yes | no | auto)                "auto"
   bookTapEnabled               (yes | no | auto)                "auto"
   bookDoubleTapEnabled         (yes | no | auto)                "auto"
   bookTwoFingerTapEnabled      (yes | no | auto)                "auto"
   bookLongPressEnabled         (yes | no | auto)                "auto"
   bookStartExpanded            (yes | no | auto)                "auto"
   bookHideNavbar               (yes | no | auto)                "auto"
   bookHideSearchInput          (yes | no | auto)                "auto"
   bookHideZoomControls         (yes | no | auto)                "auto"
   instantFlip                  (yes | no | auto)                "auto"
   galleryalign                 CDATA                            "center middle"
   galleryfade                  (true | false)                   "false"
   gallerymute                  (true | false)                   "false"
   galleryzoominit              CDATA                            "0"
   galleryzoommax               CDATA                            "1"
   galleryzoomsteps             CDATA                            "5"
   galleryzoomsnap              CDATA                            "0.25,0.5,1,2,4,8"
   galleryPanScaleEnabled          (yes | no | auto)                "auto"
   galleryPanEnabled            (yes | no | auto)                "auto"
   galleryPanRotationEnabled    (yes | no | auto)                "auto"
   gallerySwipeEnabled          (yes | no | auto)                "auto"
   galleryRotationEnabled       (yes | no | auto)                "auto"
   galleryTapEnabled            (yes | no | auto)                "auto"
   galleryDoubleTapEnabled      (yes | no | auto)                "auto"
   galleryTwoFingerTapEnabled   (yes | no | auto)                "auto"
   galleryLongPressEnabled      (yes | no | auto)                "auto"
   galleryHideControls          (yes | no | auto)                "auto"
   galleryHideZoomControls      (yes | no | auto)                "auto"
   gesturesInstantFlip          (yes | no | auto)                "auto"
   gesturesScaleSnap            (yes | no | auto)                "auto"
   gesturesMinRotationDelta     CDATA                            "45"
   gesturesRotationFactor       CDATA                            "1"
   gesturesRotationStep         CDATA                            "90"
   gesturesPanStep              CDATA                            "0"
   gesturesSwipeMinOffset       CDATA                            "-1"
   gesturesSwipeMinVelocity     CDATA                            "0"
   gesturesSwipeMaxDuration     CDATA                            "0"
   gesturesMinLongPressDuration CDATA                            "0"
   gesturesMaxTapDelay          CDATA                            "0"
   gesturesMaxTapDuration       CDATA                            "0"
   gesturesMaxTapDistance       CDATA                            "0"
   gesturesMaxDoubleTapDelay    CDATA                            "0"
   gesturesMaxDoubleTapDuration CDATA                            "0"
   gesturesMaxDoubleTapDistance CDATA                            "0"
   gesturesTransformSlop        CDATA                            "0"
   barGraphScaleEnabled         (yes | no | auto )               "auto"
   barGraphRotationEnabled      (yes | no | auto )               "auto"
   guipath                      CDATA                            "gui/"
   guiBigPath                   CDATA                            "guiBig/"
   enginePath                   CDATA                            "engine/"
   mz3ButtonsPath               CDATA                            "mz3Buttons/"
   mz3ButtonsBigPath            CDATA                            "mz3ButtonsBig/"
   flagsPath                    CDATA                            "flags/"
   flagsBigPath                 CDATA                            "flagsBig/"
   mobileConfig                 (yes | no | auto | undefined)    "auto"
   openInFullscreen             (yes | no | auto)                "auto"
   supportBackButton            (yes | no | auto)                "auto"
   supportConsoleButton         (true | false)                   "false"
   supportFullscreen            (yes | no | auto)                "auto"
   supportMute                  (yes | no | auto)                "auto"
   supportRotation              (yes | no | auto)                "auto"
   supportFirstLast             (yes | no | auto)                "auto"
   supportPreviousNext          (yes | no | auto)                "auto"
   supportPageNumberInput       (yes | no | auto)                "auto"
   supportFlags                 (yes | no | auto)                "auto"
   supportLangButtons           (yes | no | auto)                "auto"
   supportPageSlider            (yes | no | auto)                "auto"
   supportChapterJump           (yes | no | auto)                "auto"
   supportPageJump              (yes | no | auto)                "auto"
   supportPageButtons           (yes | no | auto)                "auto"
   supportPageThumbnails        (yes | no | auto)                "auto"
   supportPageNumbers           (yes | no | auto)                "auto"
   supportZoomButtons           (yes | no | auto)                "auto"
   useBigIcons                  (yes | no | auto | undefined)    "no"


Bar graphs for rotation and scale

Contents

barGraphRotationEnabled

available with v2.2.0 p033-042-077

If set to "yes" or "auto", the graphical feedback for the rotation gesture is enabled and the vertical bar graph shows up when either the control button is pressed while the mouse is moved vertically, or when a vertical pinch is made (spreading 2 fingers up/down). . The rotation bar graph is the vertical indicater named "Rotation"

Actually auto always is interpreted as "no".

barGraphScaleEnabled

available with v2.2.0 p033-042-077

If set to "yes" or "auto", the graphical feedback for the scale gesture is enabled and the horizontal bar graph shows up when either the control button is pressed while the mouse is moved horizontally, or when a horizontal pinch is made (spreading 2 fingers left/right)

Actually auto always is interpreted as "yes".

bookDoubleTapEnabled

available with v2.2.0 p033-042-077

If set to "no", this special gesture is disabled. With a double tap (or double click with the mouse) all changes in scale (zoom factor) and rotation angle will be reset, i.e. the book will be oriented in the default position of 0° with scale set to a value that makes the book fit into the window (liquid scaling).

Actually auto always is interpreted as yes.

bookHideNavbar

available with v2.2.0 p033-042-077

If set to yes or auto, the navigationbar will not be shown. If the gestures plugin is used, most operations usually performed with buttons of the navigationbar can be performed with gestures. This allows to completely hide the navigationbar to reduce distraction.
In case of need, e.g. to toggle mute or fullscreen, the navigationbar can be shown with a special gesture (long pressure).
If bookHideNavbar is set to true, ALL gui elements (zoom, search, navigationbar) will be hidden at startup

Actually auto always is interpreted as no.

bookHideSearchInput

available with v2.2.0 p033-042-077 Similar to bookHideNavbar: if set to true, the search "widget" (the search input field and the search button) does not show up at start.

Actually auto always is interpreted as no.

bookHideZoomControls

available with v2.2.0 p033-042-077 " Similar to bookHideNavbar and bookHideSearchInput: if set to "true", the zoom "widget" (scroll bar, preview and zoom buttons in the left top corner) does not show up at start.

Actually auto always is interpreted as "no".

bookLongPressEnabled

available with v2.2.0 p033-042-077

If set to "no", this special gesture is disabled. With a longpress (or long click with the mouse)

Providing 4 different options for book and GUI layout (no navbar, normal size / with navbar, normal size / no navbar, maximized / with navbar, normal) which will show up in sequence. The attribute navbarbehindbook should be set to "false" in case of bookLongPressEnabled is enabled to avoid inaccessibility of the navbar in the state where the book is maximized.

Actually auto always is interpreted as "yes".

bookPanEnabled

available with v2.2.0 p033-042-077

This attribute only is interpreted if the gestures plugin is installed, i.e. listed as plugins attribute value. If bookPanEnabled is set to "no", the pan gesture is disabled. Panning is a special kind of dragging and can be performed with the mouse, or a finger on a touch screen. A pan gesture starts after a click/tap and holding down the mouse button and finger for a short while before moving the mouse or finger. If the book is zoomed in and part of the page content is located outside of the visible area, the open page(s) will follow the mouse/finger, so hidden areas can be moved into the visible area (viewport).

Without the gestures plugin this behavior could be achieved in setting the mouse mode in the megazine.asul file to "mouse_drag".

If set to "no", the zoom controls should not be hidden (see bookHideZoomControls), because the preview window of the zoom control then is the only option left to move the book.

Actually auto always is interpreted as "yes".

bookPanRotationEnabled

available with v2.2.0 p033-042-077

If enabled, i.e. set to "yes", a vertical pinch gesture is supported (or as equivalent the simulation with a vertical mouse move while the control key is pressed). This gesture rotates the book in 90° steps. Alternatively / additionally the book can be rotated with the rotate buttons of the navigationbar, if those are enabled (see book attribute supportRotation).

Actually auto always is interpreted as "no".


bookPanScaleEnabled

available with v2.2.0 p033-042-077

If enabled, i.e. set to "yes" or "auto", a horizontal pinch gesture is supported (or as equivalent the simulation with a horizontal mouse move while the control key is pressed). This gesture scales the book in steps (defined as zoomsteps).

Alternatively / additionally the book can be scaled with the zoom buttons of the zoom widget, if the zoom plugin is installed. And also with the zoom buttons in the navigationbar, if those are enabled (see book attribute supportZoomButtons).

Actually auto always is interpreted as "yes".

bookStartExpanded

available with v2.2.0 p033-042-077

If set the MZ3 Title (the book) will open scled in a way that either height or width is the same as the containing window, i.e. in a best fit mode.
The navigationbar will be in front of the book, if it is not hidden with the attribute bookHideNavbarand not positioned behind the book with the book attribute navbarbehindbook.


bookSwipeEnabled

available with v2.2.0 p033-042-077

A Swipe is a fast move with a finger on a touch devices, or with the clicked mouse. If enabled, i.e. set to either "yes" or "auto", 4 different swipe gestures are recognized:

  1. up Jump to the first page
  2. down Jump to the last page
  3. left Go to the previous page
  4. right Go to the next page

A swipe must start outside a drag area; otherwise the page will be dragged and no swipe detected.

A swipe also can start and/or end outside of the book to avoid conflicts with drag areas.

With these 4 gestures it is fast and easy to manouver the book. In most cases the controls/buttons in the navigationbar are no longer needed and the book can be maximized (see double tap).

On mobile devices a swipe results in an instant flip, if the gesturesInstantFlip book parameter is set to "true" or "auto".

Actually auto always is interpreted as "yes".

bookTapEnabled

available with v2.2.0 p033-042-077

If enabled, i.e. set to either "auto" or "true", some special tap simulations with the mouse are supported:

  1. only the CTRL key held down when clicked: The scale value is set to the next bigger value in the list of zoom steps. Once the maximum value is reached, consecutive CTRL-clicks will then decrease the scale value step wise. And will again increase in steps once the minimum value is reached.

This simulates a double tap with one finger; see bookDoubleTapEnabled.

  1. both CTRL and SHIFT key pressed: The book will rotate counter clockwise with every click.

This simulates a double tap with two fingers; see bookTwoFingerTapEnabled

Actually auto always is interpreted as "yes".

bookTwoFingerTapEnabled

available with v2.2.0 p033-042-077

If enabled, i.e. set to either "yes" or "auto", this allows a special combined gestures together with a double tap (see bookDoubleTapEnabled). A double tap with two fingers rotates the book in steps of 90° counter clockwise.

Actually auto always is interpreted as "yes".

engineBigPath

available with v2.2.0 p033-042-077

This attribute defines an alternative path to enginePath. If the attribute mobileConfig is set to "auto" or "yes", the path defined with the attribute engineBigPath will be used for mobile devices.
If the attribute useBigIcons is set to "auto" or "yes", the path defined with the attribute engineBigPath will be used. The folder to which the engineBigPath points to should contain copies of all images/icons available at enginePath, but with bigger sizes (i.e. 48x48) to better fit mobile devices or big monitors.
The folder to which the enginePath points to contains all standard images/icons in default sizes (24x24 px).
The path is relative to the location of the megazine software (meazine-fat.swf) or to the mz3 file (with mz3Viewer*.exe or mz3Viewer*.app)

enginePath

available with v2.2.0 p033-042-077

This attribute defines an alternative path to engineBigPath. If the attribute mobileConfig is set to "auto" or "no", the path defined with the attribute enginePath will be used for desktop computers.
If the attribute useBigIcons is set to "auto" or "no", the path defined with the attribute enginePath will be used. The folder to which the enginePath points to contains all standard images/icons in default sizes (24x24 px).
The path is relative to the location of the megazine software (meazine-fat.swf) or to the mz3 file (with mz3Viewer*.exe or mz3Viewer*.app)

flagsBigPath

available with v2.2.0 p033-042-077

This attribute defines an alternative path to flagsPath. If the attribute mobileConfig is set to "auto" or "yes", the path defined with the attribute flagsBigPath will be used for mobile devices.
The folder to which the flagsBigPath points to should contain copies of all symbols of country flags, used to indicate the used language, in bigger sizes (i.e. 48x48) than available at the folder flagsPath point to; to better fit mobile devices or big monitors.
The path is relative to the location of the megazine software (meazine-fat.swf) or to the mz3 file (with mz3Viewer*.exe or mz3Viewer*.app)

flagsPath

available with v2.2.0 p033-042-077

This attribute defines an alternative path to flagsBigPath. If the attribute mobileConfig is set to "auto" or "no", the path defined with the attribute flagsPath will be used for desktop computers.
The folder to which the flagsPath points to contains all standard images/icons in default sizes (24x24 px) of all symbols of country flags, used to indicate the used language.
The path is relative to the location of the megazine software (meazine-fat.swf) or to the mz3 file (with mz3Viewer*.exe or mz3Viewer*.app)

galleryDoubleTapEnabled

available with v2.2.0 p033-042-077

If set to "no", this special gesture is disabled (within the gallery only; bookDoubleTapEnabled and galleryDoubleTapEnabled are independent on each other). With a double tap (or double click with the mouse) all changes in scale (zoom factor) and rotation angle will be reset, i.e. the gallery image will be oriented in the default position of 0° with scale set to a value that makes the image fit into the window (liquid scaling).

Actually auto always is interpreted as yes.

galleryHideControls

available with v2.2.0 p033-042-077

If set to yes or auto, all controls (navigationbar buttons, zoom widget) will become invisible to maximize the space for the gallery image.
If the gestures plugin is used, most operations that usually are performed with buttons of the navigationbar, can be performed with gestures. This allows to completely hide the navigationbar to reduce distraction.
In case of need, e.g. to rotate if gesture rotation is not enabled or to zoom, the navigationbar can be shown again with a special gesture (gallery longpress).

If galleryHideControls is set to true, ALL gui elements (zoom, search, buttons) will be hidden at startup

Actually auto always is interpreted as no.

galleryHideZoomControls

available with v2.2.0 p033-042-077 " Similar to ( bookHideZoomControls): if set to "true", the zoom "widget" (scroll bar, preview and zoom buttons in the left top corner) does not show up when the gallery opens.

Actually auto always is interpreted as "no".

galleryLongPressEnabled

available with v2.2.0 p033-042-077 If set to "no", this special gesture is disabled. With a longpress (or long click with the mouse)

Providing 4 different options for gallery and GUI layout (no controls, normal size / with controls, normal size / no controls, maximized / with controls, normal) which will show up in sequence.

Actually auto always is interpreted as "yes".

gallerymute

available with v2.2.0 p033-042-077

Controls the state of mute while the gallery is openend. The mute state at book and gallery level are contolled independently.

galleryPanEnabled

available with v2.2.0 p033-042-077

The galleryPan gesture (dragging the image with one (!) finger is similar to the draggesture of the book.

Only if the gallery image is zoomed so it does not fit completely a drag ist possible.

galleryPanRotationEnabled

available with v2.2.0 p033-042-077

If set to "yes" a rotation of the gallery image with a gesture is possible.
For that the spread fingers are rotated on the screen

galleryRotationEnabled

available with v2.2.0 p033-042-077

This is the general parameter that enables or disables rotation of the gallery images; either by gesture (if (#galleryPanRotationEnabled) is "yes" or "auto") or with a mouse gesture: click and hold down the CTRL (MAC: COMMANF) key while moving the mouse up or down with the mouse button clicked.
This will turn the gallery image left or right.

galleryPanScaleEnabled

available with v2.2.0 p033-042-077

This is the general parameter that enables or disables scaling of a gallery image; either by gesture (if (#galleryPanScaleEnabled) is "yes" or "auto") or with a mouse gesture: click and hold down the CTRL (MAC: COMMANF) key while moving the mouse left or right with the mouse button clicked.
This will scale the gallery image up or down (zoom in or out).

gallerySwipeEnabled

available with v2.2.0 p033-042-077

The swipe gesture can be individually enabled (set gallerySwipeEnabled attribute to "yes") or disabled (set to "no").
If enabled, a swipe left (fast move with the finger or clicked mouse to the left) will advance to the next image in the gallery, and a swipe right goes back to the previous image.

galleryTapEnabled

available with v2.2.0 p033-042-077

galleryTwoFingerTapEnable

available with v2.2.0 p033-042-077

galleryzoominit

available with v2.2.0 p033-042-077

galleryzoommax

available with v2.2.0 p033-042-077

galleryzoomsnap

available with v2.2.0 p033-042-077

galleryzoomsteps

available with v2.2.0 p033-042-077


gesturesInstantFlip

available with v2.2.0 p033-042-077

gesturesMaxDoubleTapDelay

available with v2.2.0 p033-042-077

gesturesMaxDoubleTapDistance

available with v2.2.0 p033-042-077

gesturesMaxDoubleTapDuration

available with v2.2.0 p033-042-077

gesturesMaxTapDelay

available with v2.2.0 p033-042-077

gesturesMaxTapDistance

available with v2.2.0 p033-042-077

gesturesMaxTapDuration

available with v2.2.0 p033-042-077

gesturesMinLongPressDuration

available with v2.2.0 p033-042-077

gesturesMinRotationDelta

available with v2.2.0 p033-042-077

gesturesPanStep

available with v2.2.0 p033-042-077

gesturesRotationFactor

available with v2.2.0 p033-042-077

gesturesRotationStep

available with v2.2.0 p033-042-077

gesturesScaleSnap

available with v2.2.0 p033-042-077

gesturesSwipeMaxDuration

available with v2.2.0 p033-042-077

gesturesSwipeMinOffset

available with v2.2.0 p033-042-077

gesturesSwipeMinVelocity

available with v2.2.0 p033-042-077

gesturesTransformSlop

available with v2.2.0 p033-042-077

infoInBrowser

available with v2.2.0 p033-042-077

instantFlip

available with v2.2.0 p033-042-077

mobileConfig

available with v2.2.0 p033-042-077

useBigIcons

available with v2.3.3.9

mz3ButtonsBigPath

available with v2.2.0 p033-042-077

mz3ButtonsPath

available with v2.2.0 p033-042-077

openInFullscreen

available with v2.2.0 p033-042-077

supportBackButton

available with v2.2.0 p033-042-077

supportChapterJump

available with v2.2.0 p033-042-077

supportConsoleButton

available with v2.2.0 p033-042-077

supportFirstLast

available with v2.2.0 p033-042-077

supportFlags

available with v2.2.0 p033-042-077

supportFullscreen

available with v2.2.0 p033-042-077

supportLangButtons

available with v2.2.0 p033-042-077

supportMute

available with v2.2.0 p033-042-077

supportPageButtons

available with v2.2.0 p033-042-077

supportPageNumbers

available with v2.2.0 p033-042-077

supportPageJump

available with v2.2.0 p033-042-077

supportPageNumberInput

available with v2.2.0 p033-042-077

supportPageSlider

available with v2.2.0 p033-042-077

supportPageThumbnails

available with v2.2.0 p033-042-077

supportPreviousNext

available with v2.2.0 p033-042-077

supportRotation

available with v2.2.0 p033-042-077

supportZoomButtons

available with v2.2.0 p033-042-077

videoSeekDelay

available with v2.2.0 p034-042-077 Time in milliseconds (default is 1000ms = 1s) after which the playhead will be set to the start position by seek(0) after the player stopped at the end of the scene. This time is needed to keep the states in correct sequence. Seems to be an Adobe bug. Without a delay the video can get stuck after minutes or hours (depending on the length of the video, bitrates and other factors). Also see videoPlayDelay, which should be used for the same reasons.

videoPlayDelay

available since v2.2.0 p034-042-077 Time in milliseconds (default is 1000ms = 1s) after which the the video will be started again in case the loop attribute is set to true. This time is needed to keep the states in correct sequence. Seems to be an Adobe bug. Without a delay the video can get stuck after minutes or hours (depending on the length of the video, bitrates and other factors). See also videoSeekDelay, which should be used for the same reasons.

Personal tools
Namespaces
Variants
Actions
Navigation
documentation
miscellaneous
Toolbox