|Language:||English • Deutsch|
This page contains a list of frequently asked questions (FAQ).
Document with a summary of Posts collected from the Forum
Please download this document if you want to get an overview about some key topics discussed in the forum: Forum overview
Q: How to get started?
A: First steps
Download the Demo Package form our website. This package contains everything needed to build first titles like books out of PDF files in a fast and easy way. After you made your first experiences you can check all other downloads on this page.
Addidional hints: If the extension is .7z, the file was compressed using the freeware tool 7zip. If the extenssion is .zip, it can be extracted directly with Windows (Vista, Win7) or a tool like WinZip.
After extraction you'll find the complete framework in the folder you extracted the files to.
You then can directly edit the megazine.mz3 file with an editor like notepad++ (set language to XML and the content will be color coded and easier to read).
You then can add tags using the syntax/language of MegaZine3, which can be found here in the wiki. A good pararaph to start with is: Quickstart Guide
Many answers can be found in our technical forum (use GOOGLE or search, and if you cannot find the answer, please post your question): MZ3 Forum
If you want to see examples of other users, please see our showcase: MZ3 user examples
Q: My images aren't showing up, what am I doing wrong?
A: it's most likely a problem relating the paths in your XML file. Try opening the console (press
# when the book is focused, i.e. you clicked on it at least once). If there are any warnings showing, it means the paths are incorrect. All paths must be relative to the
Q: Can I have a look at the files of the Demo?
A: sure, there's a package available in the downloads section of the homepage.
Q: Why doesn't my mouse wheel work? / Why can't I zoom in in gallery mode using the mouse wheel?
A: try disabling
wmode: transparent in your page.
Q: My book's kinda bleak, compared to the demo. What's going on?
To load plugins, use the
book@plugins attribute, e.g.
<book plugins="gallery, navigationbar">
Q: Why the "3" in the name?
A: to be perfectly honest, I'm not really sure any more. I think it was inspired by the 3 in ActionScript 3, after moving on from the old ActionScript 2 based version (yes, there was one... timeline scripting was so much fun).
Q: What's with the "mighty pirates" name? Are you software pirates?
- Note: this is regarding the domain used for SVN and the bugtracker.
A: gods forbid, no! The domain name was inspired by Monkey Island, which had the sentence "My name is Guybrush Threepwood and I'm a mighty pirate" as a running gag. It kinda stuck. The domain was originally only used for fun projects (which the engine started out as).
Q: Does page flip work in zoom mode?
Yes and no, depending on which kind of "zoom" is used.
The confusion came up with the new "real zoom" capabilities, because now there are several options to "zoom" with different behavior:
No Flip Book features are provided in Gallery Mode:
- Gallery Mode: No page flip features work!
Gallery Mode is just a preview mode of the defined hires image, presented in full screen mode. With the mouse wheel the zoom scale can be adjusted. The default scale at start of full screen mode is set the way to make the image fit within the size (resolution) of the monitor.
The new zoom features have no restrictions (but no page number entry in full screen mode):
- Liquid Scaling: All features work!
The book size varies with the browser window.
All operations, i.e. all book features like flip, next/previous page, language selection, page number selection, ... behave as normal.
To enable Liquid Scaling zoomminscale has to be set to a different value than "1.0", which is the default for both zoomminscale and zoommaxscale, i.e. if zoomminscale is different to zoommaxscale, then the size of the book adjusts automatically in size to best fit the browser window ("automatic zoom").
Instead of zoomminscale and zoommaxscale also the aliases minscale and maxscale are accepted.
- Manual Zoom: All features work!
Clicking the spy glasses "+" or "-" in the navigation bar performs a zoom within the (unchanged) browser window. Alternatively to the spy glass buttons also the mouse wheel can be used.
The mouse wheel only works after flash got control, i.e. you have to do any click before (like a click just below the book).
This manual zoom will take over control and "automatic zoom" will no longer work (liquid scaling). This is intentionally to not interphere with your interactions. A browser refresh will allow liquid scaling again.
- Full Screen: All features but those where values have to be entered (like page number) work!
This is different to the full screen mode behavior when using the gallery mode!
- Adaptive Zoom: All features work!
If zoomminscale is different to zoommaxscale trigger levels can be set where images with different resolution that are assigned to that scale are (re)loaded.
E.g. you can have a low resolution image for zoom scales < 1.0, and show the high resolution image at zoom scales > 1.0.
Here's a post on the vservu.de blog, giving some example usage of the adaptive zoom.
Q Can you show some typical examples?
Q: How to do changes in Localization?
Parameterization is done in the <book> statement
The languages are defined using the “lang” parameter like this:
<book plugins=”…, … “ lang=”nl, fr” … >
Some icons of flags are available in the subfolder megazine\gui\navigationbar\langs of the Binaries. More language files can be found here in the Wiki at V2.0 Localizion Files
Q: How to use adaptive Zooming?
In setting the zoom related parameters
With adaptive zoom new elements (like images, pages) will be dynamically (re-)loaded depending on the choosen scale.
These are the typical steps needed:
- define maxscale and minscale like
<book ... maxscale="4.0" minscale="0.5" ... >
- add the info about zoom trigger levels (scale) together with the related elements
- define zoomsteps if desired
- alternatively to zoomsteps define zoomsnap levels (then zoomsteps must be <= 2)
- set zoomliquidsnap="true" to force liquid scaling to snap to the zoomsnap values only. For this zoomsnap values must be defined (avialble since build 432, i.e. officially with v2.0.9)
See an example with several scales here:
spreadpage with 3 different images linked to certain scales
This is the related code, including English/German localization:
<spreadpage buffer_animate="true" > <img position="center middle" width="1280" height="853" hires="data/2009/events/soelden/img/f028.jpg" gallery="bmw09" title=""> <src lang="de" >data/2009/events/soelden/img/s028.jpg</src> <src scale="0.6" lang="de">data/2009/events/soelden/img/m028.jpg</src> <src scale="1.0" lang="de">data/2009/events/soelden/img/mf028.jpg</src> <src scale="2.0" lang="de">data/2009/events/soelden/img/f028.jpg</src> <src lang="en" >data/2009/events/soelden/img/s028.jpg</src> <src scale="0.7"lang="en">data/2009/events/soelden/img/m028.jpg</src> <src scale="1.0" lang="en">data/2009/events/soelden/img/mf028.jpg</src> <src scale="2.0" lang="en">data/2009/events/soelden/img/f028.jpg</src> </img> </spreadpage>
Q: How to get the plugins to work?
Plugins must be listed
Differently to v1.x in version 2.0 all plugins you intend to use must be explicitely declared in the <book> tag! The magazine.mz3 file provided with the download shows the smallest possible way to create a book, and that is without any plugins.
Read the comment above the <book> tag; there you'll find all possible plugins listed and you can pick (copy and paste) those you need.
If you list plugins not needed, this has no big negative impact; it will take a little bit longer to load, and some memory will be consumed. But if in doubt you can add all in a first shot and then take those out you do not need, if performance becomes an issue.
Example of the declaration of plugins in the book tag:
Q How to make MegaZine3 V2.0 work with IIS7?
You have to declare the new extensions .mz3 and .asul
IIS7 does not know the extensions "mz3" and "asul", so you have to declare them. A tutorial about how to do so can be found here in the wiki at: Tutorial 'MegaZine3 on IIS'
Q: Can I have a wide video using the space of two adjacent pages?
Yes, using spreadpages
Just use <spreadpage> instead of <page> and everything works as if you had a double width page; and also position="center, middle" works, positioning the video in the middle of the 2 pages. A <spreadpage> always must start on a left (even) page.
Q: Where are those ASUL files located?
In the megazine/gui folder
BUT, if you want to make changes or just browse those files, we highly recommend to use those files available in the SVN trunk; i.e. the sources area.
Reason: There the files are commented and easier to read. The final files in the Binaries are for performance reasons stripped and hardly readable.
The ASUL files can be found as source files here: "ASUL sources"
Q: Where to place the megazine folder on a server?
Copy all into a subfolder on your server
The easiest, safest and quickest way for the first MegaZine3 book is to use the structure of the folder you downloaded as MegaZine3 Binaries, modify the megazine.mz3 file to your needs and add a subfolder with your content; like megazine/pages/page_l1.swf or megazine/jpgpng/img_l1.jpg. A sample book might look like this then:
<book pagewidth="330" pageheight ="510" plugins="navigationbar,console, options,swfaddress" errorlevel="ALL"> <chapter> <page> <img height="240" keepar="true" top="10" position="center" src="pages/page_l1.swf"/> <img width="320" keepar="true" top="260" left="5" src="jpgpng/img_l1.jpg"/> </page> <spreadpage> <img position="center middle" width="640" height="480" src="jpgpng/img_l2.jpg"/> </spreadpage> <page> <img position="center middle" keepar="true" width="320" src="pages/page_l2.swf"/> </page> </chapter> </book>
This generates a book with 4 pages. On page one a swf page in the upper half, and a jpg image in the lower half. Both scaled to fit, and centered.
The next two pages are combined to one spreadpage (double page), with one image extended across the full space. Again scaled and centered.
The back cover page is a single page with just one swf image, fit to the page. Only the size of one side of the image is defined, the size of the other side is calculated out of the original aspect ratio. This is defined by the parameter keepar (keep aspect ratio).
Then the complete folder where the MegaZine3 Binaries had been extracted to, e.g. a folder named mz3/, should be uploaded to the server's root directory, like web/mz3/. Including the index.html and style.css files and the megazine/ folder and subfolders.
After the upload you can open your book in calling the index.html file, like www.yourserver.com/mz3/index.html
Keep in mind that on a Unix/Linux system, what in many cases will be prsent on your server, capital and lower case letters will be differentiated. So /MZ3 and /mz3 are two different folders!
Another point to keep in mind is that even if on a Windows system you could use the backslash "\", this will not work under Unix/Linux. Best is to always use "/", since Windows also interprets that correctly!
What folder structutes are suggested to handle multi-lingual books and several MZ3 books with just one instance of the MegaZine3 framework, will be discussed in a topic of a special chapter in the tutorial handboos, available end of June 2010. Those tutorials will be presented and accessible unter the tab Tutorials at our home page www.vservu.com.
Q: How to modify the GUI?
Modify the related ASUL files
If you want to adjust the color of the buttons, their position and shape, hide selected ones and similar, then look for the .asul file (ActionScript User Language) that is related to the plugin you're considering.
If you e.g. want to make changes to the navigation bar, look for the file navigationbar.asul in the Subversion source code folder. THis points to the latest development version in the folder trunk at: megazine/trunk/src/assets/megazine/gui/navigationbar.asul
The released versions are available at http://svn.mightypirates.de/megazine/tags/ in folders named after the version.
There you can make all edits needed with a text editor like notepad++.
Take this as an example (unchanged extract of navigationbar.asul):
<!-- Description of the navigation bar --> <box id="navigationframe" anchors="0,0,pw,ph"> <!-- Left page number --> <box width="50" height="24" anchors="pw/2-pagew!25,ph-25-h" style="container"> <text name="pagenum_left" style="big"/> </box> <!-- Right page number --> <box width="50" height="24" anchors="pw/2+pagew-w?pw-w-25,ph-25-h" style="container"> <text name="pagenum_right" style="big"/> </box> <!-- Container for the page buttons. --> <hflow name="page_buttons" anchors="(pw-w)/2,ph-25-h" minwidth="16" maxwidth="(pagew*2?pw-50)-150" collapse_height="24" collapse_time="0.125" mouseenabled="true" style="container"/> <!-- Page preview thumbnail --> <box name="thumbnail" style="container" anchors="(pw-w)/2,(ph-h)/2"/> <!-- The bar with the control buttons --> <hflow height="24" anchors="(pw-w)/2,25" style="container" clipchildren="false"> <!-- Mute button --> <togglebutton name="btn_mute" style="common mute"/>
If you e.g. want to remove the page numbers, just enclose lines starting after the comment "Left page numer" until the comment "Container for the page buttons" in a comment brackets (pair of ) and they will disappear.
If you then want to have the page buttons (the container with those bubbles representing the thumb nails) in the left half of the book, ending in the middle, instead of centered in the middle of the book, simply change the coordinates of
anchors from (pw-w)/2 to pw/2-w.
The first parameter is the position from the left, the second one the position from the top. With 0,0 being top left corner.
with p: parent width and w: object width, i.e. the width of the actual container. See Layouting in the Wiki for details.
And keep in mind that those parameters like anchors are inherited (here defined by "style="container", where the container style is defined in the megazine.asul)
Q: What to do if my CD does not work?
Check Adobe Flash settings
If your megazine.exe file does not work (the projector file), please check the publishing settings in Adobe Flash under the Flash tab for "security with local presentation". And set it to "Access only local files".
If the tab "Flash" is not present, set the mark at Type: Flash; then it should appear (no a logic thing, you just need to know).
For details see this thread in the forum
Q: Why do pink areas show up?
What you see is one of the masks used in MegaZine3 to define areas for elements. Those masks should not be visible, they are for test purposes only. So something went wrong…
- Do you use the latest version of the flash player? Please update
- Did you modify the code? Then please download the standard Zip File with the Binaries again
- Do you download the sources with SVN and build the Binaries yourself?
Then please be aware to select the right folder:
- TRUNK always gives access to the actual version under development. Binaries of the latest version are available as nighly build
- TAG contains the released and Beta versions
- Do not mix modules of different versions!
Q: Can sub or superscript charaters be used?
With HTML formatted text
In a “text” attribute you can have HTML formatted text.
<lnk URL="someURL"><![CDATA[<b>Some text</b>]]></lnk>
This would show a bold list entry with the text "Some text" and is listed in the documentation (search for CDATA). Other standard HTML tags should work to format text. Most probably also those for sub and superscription (not tested).
Nevertheless, since it is risky to trust Flash Players and Browsers to correctly present everything the way you intended, we suggest you put your special text into an image (.jpg, .png, .swf). Then you can be assured it will look as expected.
Please see Hint about cross page links for details
Q: How can I change the Preloader?
change the path and name in the index file
The Preloader is called in the index.html file. You there can substiture the preloader.swf by megazine.swf to directly go to the book or by your own preloader.
Adjust the position or use liquid scaling
With the possibility to freely position the navigation bar using the .asul files and if using liquid scaling, this problem is gone away.
Q: Why does my video not work on my lokal PC?
Running videos in a MZ3 book on a local PC can be tricky. We did some tests (October 12, 2010) on a Windows7, 64 bit system, with a .f4v video of about 50 MB.
Embedded in a spreadpage of a book with 26 pages. With images and text on all pages(besides the spreadpage with the video).
Different browsers show different behavior! And different versions of your browser and FLASH might also operate differently.
At the end most effects are related to the global security and sandboxing mechanisms of FLASH.
Details about the sandbox can be found in an article on Adobe's help page.
It also depends on where your video files are located: in respect to the location of the megazine3 software (in the same path or in a parallel path).
And also of the location of the complete folder: if on your local drive, a network drive or on an external server.
Here the results of actual and up to date browsers and Flash versions (as of Oct 12, 2010), in different configurations.
- different storage locations:
- local disk drive
- NAS (network storage) and
- external server (internet)
- different relative locations of the video file:
- in the same path as the megazine software and
- in a parallel path.
Here a simplified directory structure to explain local and parallel paths:
- base folder
- video.f4v ⇒ video located in the same path as the megazine software
- video.f4v ⇒ video located in a parallel path to the megazine software
- video.f4v ⇒ video located in a parallel path to the megazine software
|Browser|| Same path
|| Parallel path|
|IE9 (Beta)|| +
One effect surprised:
Although IE9 (beta) worked always (!), it took significantly longer before the video showed up, compared to e.g. Chrome.
Probably because of the Beta status:
|| Background image
| IE9 (Beta)
In all cases the cache was cleared before the measurement was made. </br> The internet connection for the server access was very fast; at measured 85 MB/s.
If in doubt you should upload the files to your server and test the book over the internet.
With all browsers, directory structures and video formats this was successfull and worked in all cases.
Side remark: Only if files are located on different domains, you have to care about the cross domain issues; not a topic here.
Alternatively using a local server like XAMPP or WAMP will be a good choice.
Hopefully this saves you some time getting your videos working and not chasing phantoms ;-)
Here a work around that might help you:
Create a folder in which you put a "HTL page" for every link you'll need.
And within this HTLM file put a javasrcipt line of code that redirects to the URL you want to link to. This also is discussed in a blog (actually as test blog on a test site at TIPS Blog, which later can be found at megazine3.com under the tab 'community'
Q: Why is my Flash Player not working correctly on Windows XP and IE?
If you experience problems opening/presenting MegaZine3 books with the Internet Explorer on Windows XP, this “cook book” can be of help for you.
This is the result of a combined effort of MZ3 users (thanks to Patrice and friends!).
Important is to get the Flash Player installed correctly. Obviously there is a conflict with Windows Messenger and the installer of Adobe.
Despite the statement of the Adobe installer, that FLASH will install correctly once the Windows Messenger is closed during installation, the installation usually will not work correctly; and Flash Player later will not run.
The simple solution is:
Stop Windows Messenger and Internet Explorer BEFORE you start the installation of Flash!
Here a step by step guide line:
- Close Windows Messenger (and ideally also Internet Explorer) first!
- Go to drive\WINDOWS\system32\Macromed\Flash and run the uninstaller of Flash Player
- Download Flash Player from Adobe’s web site. We suggest to select “use other operating system”, so you can download first and install later (after you closed your browser and messenger). You could directly go here: Direct link for Flash Player download. Then select “Windows XP/Vista/7” and “Internet Explorer” and download Flash Player.
- Make sure you have closed all browsers and the Messenger (and probably your anti virus software) BEFORE you start the installation of Flash Player.
You should NOT get any warnings or messages like "the installation will continue after you stopped your browser or messenger".
You MUST do that before you start the installation!
The installation then will finish without problems or warnings.
After that you’ll have a working system and your problems are gone.
Now MegaZine3 will also work on Windows XP with Internet Explorer (and Messenger ;-)
BTW: Alternatively you could forget about IE and use a different browser like e.g. Firefox or Chrome or others ;-)
Q: What is your refund Policy?
All sales are final.
Please test the product before any purchase! Once you received the License Key you cannot return and we do not refund. You only need to pay a license fee if you intend to use for commercial purposes.
To make it a risk free purchase, we offer free and unlimited test (no restrictions in functionality or time), as long as such tests are limited to your local server, and the Books are not published on the Internet or media like CDs, DVDs, USB-Sticks, ... Even a quick test on your server is granted, but this must be limited to some few days on a hidden page.
You are allowed to demonstrate your demo Book on your local machine, e.g. for a prove of concept for potential customers. You even can doo all developments including creating new plugins using the open source interfaces we provide (licensed under MIT license).
So please do not buy and use MegaZine3 commercially before
- you have fully read and understood our license terms and
- you have tested and verified that the product fullfills all your needs and
- you are fully satified with the results
Q: How many years have you been in business?
VservU GmbH was founded October 1st, 2009
We combine many years of experience in several areas, like:
- Software development: 5... 15 years
- Project management: >10 years
- World Wide Sales: >15 years
- Pre- and after sales tech support: >10 years
- Parnter Management: >10 years
- Graphic design: 5...15..20 years
- Manufacturing Execution Systems (MES), Porcess/Workflow Optimization, Vision/Data Analysis: 15 years
- (A)SPC, Simulation, ERP: 5 years
- Multimedia Projects (video, sound, graphics): >15 years
Mostly working for and with industrial/manufacturing companies in high tech industries. BTW: Development of MegaZine3 started in 2007 with ActionScript2 and after the conversion to ActionScript 3 it was named MegaZine3, version 1. Middle of Oct. 2009 MegaZine3 version 2.0 was released, a fully new, plugin based framework. Since then we have released new releases of version 2almost every month, and are actually (June 2010) at v2.0.8.
The feature list is growing: see the feature list with a comparison between v1.x and 2.x
Q: I have problems, whom should I contact?
Please use the Technical Forum
In the forum you will find:
- FAQs focused on technical and usage problems
- Add Ons (e.g. language files)
- Patches and Beta releases
- Hints on best practices, code examples
- Technical guidance
- Many answered questions
- Many helpful users... and us ;-)
Usually you can expect an answer within a day or so...
For a first overview see the FAQ Summary in form of an MZ3-Book. This can be browsed and searched. In urgent cases you also can contact us directly by email or using the ContactUs page. Although we do our best to answer soon, we cannot guarantee any response times.
Q: What if I need a special Feature?
Custom deployment / Developing
Q: When loading the
megazine.swf file into another SWF parts of the book are cut off, what can I do against that?
A: When no size is given manually, the MegaZine3 object's size are automatically set to
width * 2 by
height, which might not be enough. It will most definitely not be enough, when using the default megazine.asul file, as it defines a certain padding, to make sure the book does not collide with the areas where the navigationbar normally resides.
So there are at least two things you can do:
- adjust the size of the loaded object manually to fit all of the content, or
- adjust the megazine.asul file so that there is no padding.
Q: Where can I find the sources?
A: Check this document with information on how to find the links for the sources:
Q: Pages are turning rather slowly, how can I speed them up?
A: this might be a rather subjective impression. To simply speed up the animation, use the
book@dragspeed attribute (set it to a lower value).
Version 2.0.7 includes various performance increases, so try upgrading to the newest version of Megazine to improve performance.
Generally, be aware that larger pages (i.e. higher page width / height) need more resources than smaller ones, because more display area has to be updated.
On slower target configurations, it is recommended to disable some features / leave some features disabled, which have a hit on performance. E.g.
book@cornerhint (only in the beginning, but this behaves like a normal drag, so it can be CPU intensive at the time) and
book@centercovers (while repositioning the pages). You might also want to consider reducing the number of pages it takes until going to low quality mode using
book@lowqualitycount. Lastly, if really necessary, disable the shadows and highlights while dragging pages using
book@shadows. This should only be a last resort, though.
Q: Everything is extremely slow in full screen mode, is this a bug?
A: no, it's a feature. Just kidding. This seems to be a problem for some computer configurations, and is not related to the engine. Try disabling the hardware acceleration (right click somewhere, click "Settings", untick the box and reload the page).
For more information on that topic, read this article.
Q:How to make best use of zoom to not impact performance too much?
A: In most cases using Liquid Scaling (with e.g. zoommaxscale="4.0" and zoomminscale="0.25") probably together with the "adaptive Zoom" using the scale tag will give you all you need. In certain cases the gallery mode can be a helpful additional option to offer highest resolution in full screen. But this also increases risk to confuse users ("why does the book not flip any more?").
The real challenge is when you have to convert existing PDF files with big sized pages and tons of little text into SWF pages! Then FLASH gets to its limits because every change (zoom, flip) needs the vectorized text being rasterized. And rasterizing 50.000+ vectors shows the limits of even very powerful computers! And not all users are really up to date (yet) ;-)
Then it becomes difficult to find the best optimum between size, quality and performance!
Best would be to design the pages having MegaZine3 and Flash in mind, i.e. creating reasonably sized pages with good balanced amount of text. It could be better having some more pages in a book, than squeezing everything into some big pages with small fonts! That approach probably was forced by licenses based on the number of pages, or because of output to printed media. With licenses as MZ3-TIME and MZ3-FIX there are no limits in the number of pages, so that's no more an argument.
ImO it is questionable if adapting different ("old") technologies and "old" best practices and behaviors to a different a kind of (new) technology will lead to the best results; probably not ;-)
Better learning to use the already existing features to its full extend (like powerful search, book edges, side bar, page view with thumbnails - the "bubbles"- , ToC, links with anchors and areas, ...) over time will help.
And there will be new, additional features in future, helping to find better compromises. Like bookmarking to easier find pages again, table of content with thumbnails, highlighting of text, preloading support for thumbnails, ...).
A: have a look at the
.asul files in the
gui directory. Just remove the elements you don't want from those files. E.g., to remove the fullscreen button, open
gui/navigationbar.asul and remove the
togglebutton block with the name
Q: Liquid scaling? / How do I get my pages to fit the browser window?
Q: My book moves around when I move the mouse, what can I do against that?
A: when the book's dimensions exceed the area used for displaying it this automatic scrolling (or auto pan) will kick in. There are three alternatives: either disable it completely, or switch to using scrollbars, or use mouse drag.
Disable automatic scrolling
Remark: To get access to the source version (i.e. the not minified version) define a custom path name using the <customization_path> parameter of the make config file. We suggest a path name like "software/custom/". The ASUL files will be copied into the "(software/custom)megazine/gui/" folder with the next run of MZ3-Tool3; and used as long as the customization_path is defined.
- Look for the scrollpane element with the id
- It has an attribute named mousemode, which is set to
- Remove the attribute or set it to
If changing this attribute seems to have no effect, it may happen due to the fact that the last used state is stored in a Flash cookie and re-used the next time it gets loaded. To clear the Flash cookie, visit the Flash settings manager.
Remark: You can change the behavior interactively at run time, if the plugin "options" is installed (i.e. listed in the plugins list in the book tag).
Use Scroll Bars
After disabling automatic scrolling, you can add scrollbars:
- You'll have to add two scrollbars to the scrollpane. Have a look at the help.asul to see an example for a vertical scrollbar. Here's the basic code. You'll still need to style the bars and set the width and height yourself (replace the
?s with the width and height you want).
<scrollpane id="pagecontainer" ...> <box name="$viewport$" width="pagew*2" height="pageh" clipchildren="false"/> <scrollbar name="$scroll_x$" height="?" anchors="0,ph-h,pw,ph"> <button name="$scroll_handle$"> <box name="$up$"/> <box name="$over$"/> <box name="$down$"/> </button> </scrollbar> <scrollbar name="$scroll_y$" orientation="vertical" width="?" anchors="pw-w,0,pw,ph"> <button name="$scroll_handle$"> <box name="$up$"/> <box name="$over$"/> <box name="$down$"/> </button> </scrollbar> </scrollpane>
Use Mouse Drag
Using mouse drag has some undesirable side effects, but you may prefer it. Most notably, it drags the book when you flip a page, and starting and ending a mouse drag over a link activates the link, however accidentally activating links will be fixed in 2.0.9. Follow the instructions in the disable automatic scrolling section but instead of setting mousemode to
mouse_none set it to
A useful setting to pair with mouse_drag is anchoring your book so it only scrolls if it's larger than the currently visible space. <scrollpane anchors="0,10,pw-0,ph-10" clipchildren="false" id="pagecontainer"
Have a look at the
megazine.asul file, where you'll find this:
<scrollpane id="pagecontainer" anchors="25,75,pw-25,ph-75" clipchildren="false" mousemode="mouse_move"> <box name="$viewport$" width="pagew*2" height="pageh" clipchildren="false"/> </scrollpane>
This is the outermost container for the pages, which is also used for scrolling when the page size exceeds the available size (e.g. when zoomed in). The important part is the
anchors attribute. Replace the original values with something like
0, 10, pw, ph-10 (also see Layouting). So after that it should look like this:
<scrollpane id="pagecontainer" anchors="0,10,pw,ph-10" clipchildren="false" mousemode="mouse_drag"> <box name="$viewport$" width="pagew*2" height="pageh" clipchildren="false"/> </scrollpane>
- Note: for better readability, consider using the file from the SVN repository.
The goal of changing the anchor tag is to prevent the book from being moved when it's fully on the screen, play with the anchor values till you get your margins the way you want. If you resize your browser so the book is overlapped (or zoom in?) you should see that mouse_drag is still enabled.
A: Have a look at the navigationbar.asul file (linked to the version in the SVN repository, for better readability - ASUL files in the releases are stripped of unnecessary characters to reduce filesize).
There are two
<hflow> elements, one for the controls and one for the page buttons. They have a
style="container", which defines their background color and the dropshadow. Either remove that to remove the background completely, or add a new attribute
background="color(#rrggbb)" where rrggbb is the hexadecimal RGB value of the color (optionally aarrggbb, being the ARGB value).
Q: How can I reset the search?
Or: After a search many words might be highlighted. How do I get rid of the hightlighting?
A: The easiest is a new but empty search. Since no words are found, the highlighted words are no longer highlighted.
If you want to add something like a "search reset" button, you can do so using the ASUL.
<!-- Input box for the search --> <box width="150" height="24" id="search_input" style="container" anchors="pw-w-25,25" alpha_out="0.9" onaddedtostage="searchadded(event.currentTarget)"> <box anchors="2,2,pw-51,ph-2" style="input"> <text name="txt_search" value="localize(LNG_SEARCH_TITLE, Search)"/> </box> <button name="btn_search" title="localize(LNG_SEARCH_START, Start search)" style="common search" anchors="pw-w-25,0"/> <button width="24" height="24" onclick="megazine.pluginManager.getPlugin('search').search('')" anchors="pw-w,0"/> </box>
This only shows the principle. A second button was added to the search box in the megazine/gui/search.asul (as always using the "source doe asul files"!). And to give some room for the additional button, the search box was expanded adding 25 pixel to the width of the box. And then shifting the input field and spy glass by 25px to the left.
The new button is not yet styled, i.e. no icon linked to the button yet. But functionality already is there: a click starts an empty search, which works like a reset.
Regarding the DTD (DocType Definition)
The DTD (megazine2.dtd, asul.dtd) which may be used in a book's definition file (per default megazine.mz3) is only there to allow users to validate their book XML to make it easier to find errors in their code. It does not have any influence on the actual functionality of the book at all.
ASUL versus Book Definition
ASUL definitions, which are used exclusively for GUI related content, are not to be confused with the book definition (consisting of the
page and page elements). ASUL properties, such as anchors (meaning the ones used to layout/position components) are not available for book elements, and vice versa (e.g. anchors, meaning named pages / chapters, are not available in ASUL components). To further this confusion, it cannot be generally said that ASUL is not available in .mz3 files, though: in some context (namely the
sidebarcontent tags) ASUL may be used.