Reference Information
Keyboard shortcuts
The following keyboard shortcuts allow you to quickly navigate through a DjVu document. They are activated when the plug-in window has keyboard focus (to gain keyboard focus, click on a DjVu document anywhere except within a hyperlink).
|
Key |
Action |
|
Up,
Down, Left, Right (Arrow Keys) |
Scroll the image in the given direction. |
|
Home |
View the First page of the document. |
|
End |
View the Last page of the document. |
|
Page Up |
Brings you to the top of the current page, or, if already there, to the previous page. |
|
Page Down |
Brings you to the bottom of the current page, or, if already there, to the next page. |
|
Space, Enter |
Brings you to the next page. |
|
Backspace |
Brings you to the previous page. |
|
+, - |
Allows you to Zoom In and Zoom Out. |
|
W |
Scales the image to fit the width of the window (Fit Width). |
|
P |
Scales the image to fit the window (Fit Page). |
|
G |
Displays the "Goto page" dialog, allowing you to switch to a particular page. |
|
F |
Searches the document for textual information. |
|
1 |
Sets the zoom to 100% |
|
2 |
Sets the zoom to 150% |
|
3 |
Sets the zoom to 300% |
|
? |
Displays the DjVu Help page. |
|
Pause/Windows App key |
Display the DjVu Pop Up Menu. |
EMBED flags
EMBED flags are flags that can be
specified in the EMBED or OBJECT tags of the HTML document used to
customize the behavior of the plug-in. In 3.2, we added more flags and made
some of the existing flags obsolete. All flags and values are case insensitive
can be either yes or no or true or false.
|
EMBED flag |
Description |
|
PASSIVE=yes/no |
This flag is useful to display a DjVu image in a manner similar to how a GIF or JPEG image is displayed. If you specify this flag, it does the following:
The previous version of the DjVu plug-in supported the PASSIVE flag without a yes/no argument. In this release we are advising you to add "=yes" after PASSIVE to stay compatible with the Windows platform. We are declaring that "=yes" and "=no" have the same effect for this flag to stay compatible with the previous version of the plug-in. Remember to always supply a value for the PASSIVE flag, and no matter what that value is, the plug-in will treat it as "yes" |
|
PASSIVESTRETCH |
Use PASSIVE=yes ZOOM=stretch instead. |
|
NOTOOLBAR |
Use TOOLBAR=no instead. |
|
NOSCROLLBARS |
Use SCROLLBARS=no instead. |
|
NOMENU |
Use MENU=no instead. |
|
TOOLBAR=yes/no |
If "no" is specified, this flag disables the pop-up toolbar (at the bottom of the plug-in's window). The user will still be able to enable the toolbar using the Preferences dialog (provided that popup menu is enabled). |
|
SCROLLBARS= |
If "no" is specified, this flag disables scrollbars. |
|
MENU=yes/no |
If "no" is specified, this flag disables the popup menu |
|
KEYBOARD=yes/no |
If "no" is specified, this flag disables keyboard input for the plug-in. |
|
FRAME=yes/no |
If "no" is specified, this flag disables the gray frame surrounding the DjVu image. |
|
LINKS=yes/no |
If "no" is specified, this flag disables hyperlinks. |
|
LOGO=yes/no |
If "no" is specified, this flag disables the DjVu logo. |
|
ZOOM=number
|
These flags set the initial zoom to be, number%, One to one, Fit Width, Fit Page, or Stretch. |
|
MODE=color
|
These flags set the initial display mode to be, Color, Black and White, Foreground, or Background. |
|
PAGE=number |
This flag displays the specified page, which may be any valid page number in the DjVu document referred by the embed tag. Example: PAGE=5 |
|
HIGHLIGHT= |
Creates a rectangular highlighted area with given coordinates and given color. The meaning of the parameters is as follows:
You can specify more than one highlight=... flag. In a multipage document, all flags will be applied to the first page displayed. To control what page should be displayed first, use page= flag. Note, that all the coordinates are internal document coordinates, not screen coordinates. Example: HIGHLIGHT=10,10,300,400,FF00FF
|
|
CACHE=yes/no |
This tag disables or enables caching of fully decoded pages of the document. As described in the Preferences, the plug-in can cache fully decoded DjVu pages and reuse them later. Normally, the user sets the size of the cache. With this option, Web developers can disable the cache if they need to. Note: Caching of documents with extension different from. .djvu and .djv is off by default. You can turn the cache on using this option. |
|
THUMBNAILS=yes/no |
This tag disables or enables thumbnails. Thumbnails are disabled by default. They can be turned on manually by choosing ShowThumbnails from pop-up menu or by specifying this embed flag. Thumbnails are never displayed for single page DjVu documents. You can also assign LEFT, TOP, RIGHT, or BOTTOM instead of YES/TRUE, which specify the plug-in where to display the thumbnails. YES/TRUE implies to show thumbnails at LEFT. All Unix plug-ins ignore these LEFT/TOP/RIGHT/BOTTOM values and takes the value as YES/TRUE. |
|
FLAGS="..." |
Flags can be assigned any valid combination of the above tags in double quotes(") separated by spaces. E.g., FLAGS="menu=false frame=true logo=yes zoom=134 mode=color". |
The following table contains examples of how the EMBED flags can be used to customize the plug-in's behavior:
|
Examples of using EMBED flags |
Results |
|
<EMBED SRC="image.djvu" TYPE="image/x.djvu" WIDTH=100% HEIGHT=100% MENU=false TOOLBAR=false SCROLLBARS=false KEYBOARD=false> |
No pop-up menu, no toolbar, no scrollbars and no keyboard input. |
|
<EMBED SRC="image.djvu" TYPE="image/x.djvu" WIDTH=100% HEIGHT=100% PASSIVE=yes> |
Passive mode: no toolbar, scrollbars, pop-up menu or keyboard input. |
|
<EMBED SRC="image.djvu" TYPE="image/x.djvu" WIDTH=100% HEIGHT=100% PASSIVE=yes MENU=yes> |
Passive mode with an additional MENU=yes flag which enables the pop-up menu. |
|
<EMBED SRC="image.djvu" TYPE="image/x.djvu" WIDTH=100% HEIGHT=100% MENU=yes PASSIVE=yes> |
Passive mode with an additional MENU=yes flag, however, the order is to have PASSIVE=yes specified after the MENU flag which has the effect of disabling the pop-up menu. |
|
<EMBED SRC="myimage.djvu" TYPE="image/x.djvu" WIDTH=100% HEIGHT=100% ZOOM=Stretch MENU=false TOOLBAR=false SCROLLBARS=false KEYBOARD=false> |
The DjVu image is stretched to fill the DjVu Plug-In display area. Also, no menu, no toolbar, no scrollbars and no keyboard input. |
|
<EMBED SRC="picture.djvu" TYPE="image/x.djvu" WIDTH=100% HEIGHT=100% TOOLBAR=no> |
No toolbar. |
|
<EMBED SRC="foo.djvu" TYPE="image/x.djvu" WIDTH=100% HEIGHT=100% TOOLBAR=no MENU=no> |
No toolbar and no menu. |
|
<EMBED SRC="mydog.djvu" TYPE="image/x.djvu" WIDTH=100% HEIGHT=100% TOOLBAR=no MENU=no SCROLLBARS=no> |
No toolbar, no menu and no scrollbars. |
|
<EMBED SRC="bar.djvu" TYPE="image/x.djvu" WIDTH=100% HEIGHT=100% FLAGS="MENU=false TOOLBAR=false SCROLLBARS=false KEYBOARD=false"> |
No menubar, no toolbar, no scrollbars and no keyboard input. |
CGI-style arguments
CGI-style arguments are yet another way to control the plug-in's behavior. They work the same way as the EMBED flags, and in fact, have the same names and same values. The only difference with CGI-style arguments is the place they are specified. EMBED flags have to be listed inside an EMBED tag. The CGI-style arguments are appended to the document's URL after the '?' sign and are separated with the '&' signs. In order to separate the DjVu arguments from other CGI arguments, the set of DjVu arguments must be preceded by the string "DJVUOPTS&".
For example: document.djvu?DJVUOPTS&PAGE=13&PASSIVE=yes will display the 13th page of document.djvu and will switch the plug-in to the PASSIVE mode (no toolbar, no pop-up menu, no scrollbars and disabled keyboard input).
The advantage of The CGI-style arguments is that you do not have to use the EMBED tag to control the plug-in. You pass commands to the plug-in as if it was a CGI script.
See how some examples from the EMBED flags section can be rewritten using this new feature.
|
Examples of using EMBED flags |
Results |
|
image.djvu?DJVUOPTS& |
No pop-up menu, and no toolbar. |
|
/cgi-bin/gendjvu.pl?arg=2& |
Here arg=2 is passed to the cgi-bin script gendjvu.pl. For the DjVu plug-in, we use passive mode: no toolbar, scrollbars, pop-up menu and keyboard input. Note that the cgi-bin script must be written specifically to ignore DJVUOPTS and anything after it. |
|
image.djvu?DJVUOPTS& |
Additional MENU=yes flag enables pop-up menu. |
|
image.djvu?DJVUOPTS& |
PASSIVE=yes overrides MENU=yes because it is specified after the MENU flag, and the popup menu is disabled. |
|
myimage.djvu?DJVUOPTS& |
The DjVu image is stretched to fill the DjVu Plug-In display area. In addition, the popup toolbar is disabled. |
|
report.djvu?DJVUOPTS& |
Display the 10th page of report.djvu and set the zoom factor to "Fit Page". |
|
report.djvu?DJVUOPTS& |
Will highlight rectangle with coordinates of the lower-left corner (10, 10), width 300, and height 200 with green color. The coordinates are specified in the document coordinate system with reference point in lower-left corner of the document and axis Y pointing upward. |
Chunk names
Any DjVu document is composed of at least two chunks. You can see the list of chunks when you display the Page information dialog. Please see the following description of currently recognizable chunks:
|
Chunk name |
Description |
|
INFO |
Page information. Contains page dimensions and DPI information. Should be present in any DjVu page. |
|
INCL |
Inclusion chunk. Directs the decoder to process additional (included) files. |
|
Djbz |
JB2 Shared Dictionary. Is usually present in a file included into two or more pages. |
|
Sjbz |
JB2 Foreground Mask. |
|
Smmr |
Foreground mask in MMR-G4 format |
|
BG44 |
IW44 background. |
|
BGjp |
Background in JPEG format |
|
FG44 |
IW44 foreground colors. When masked by contents of Sjbz or Smmr chunks it forms image displayed by the plug-in in Foreground mode. |
|
FGjp |
Foreground colors in JPEG format |
|
FGbz |
JB2 Foreground Colors. |
|
PM44/BM44 |
IW44 data. |
|
NDIR |
Navigation directory |
|
ANTa, ANTz |
Decompressed or compressed annotations (chunks with hyperlink information, startup zoom, mode, alignment and background color). |
|
TXTa, TXTz |
Decompressed or compressed textual information generated by an OCR engine. Used by the plug-in to search. |
Multipage formats
The original release of the DjVu plug-in supported multipage DjVu documents in two formats: INDEXED and BUNDLED. These formats have been replaced with two new formats: INDIRECT and BUNDLED. As a result, the original formats have been made obsolete (now called OLD_INDEXED and OLD_BUNDLED).The DjVu plug-in 3.2 supports four formats and can be used to convert documents from any format to INDIRECT or BUNDLED.