OpenInkpot 0.2 Users' Guide

For installation information, see the Installation Guide.

e-Ink readers overview

Book readers supported by OpenInkpot are based on e-Ink technology. Bistable displays, such as e-Ink, are interesting — they keep picture on screen even when powered off.

OpenInkpot uses this feature and puts the device to sleep as much as it can, so

• if you carry the reader around, the only action you need before putting it into a bag is to lock the keys of the device. You don't need to shut it down or "hibernate" it — the device consumes very little power in the sleep mode.
• Devices survive several weeks of operation from a single recharge.

Note that the screen technology is still young, so you'll see the displays are slow and need white->black->white transition in order to clean up artifacts while changing a picture on screen. Such "flashing" is not an OpenInkpot bug, it's a limitation of the screen technology.

Typographical conventions

OpenInkpot is ported to several devices with different hardware keys, so keybindings are described by tables like this:

V3	N516	Action
Key on Hanlin V3	Key on Hanvon N516	Some action

If any cell in a table is empty, then either the function is not available on the device, or that it can be activated by some other means (usually from the menu).

User interface

Global operations

There are global actions which can be performed anywhere:

V3	N516	Global action
Power button	long-pressed OK	Lock screen. Pop-up dialog contains directions for screen unblocking
long-pressed Power	Power button	Shutdown device (not usually needed, except for reflashing firmware)
long-pressed +/-	Rotate button	Rotate screen
long-pressed ↶	Menu	Go to main menu
	►/■	Play/pause music

Lists

There are many lists in the interface (various menus, lists of files etc). They all behave alike:

V3	N516	Action
</>	Left/Right	Previous/next page
1-9	1-9	Activate Nth item
0	M (Bookmark)	Open context menu (if present)
	Up/Down, Wheel Up/Down	Move cursor up/down
	Ok	Activate item under cursor
↶	C	Close (e.g. go to parent directory for directory view)

Main menu

V3	N516	Action
↶	C	Switch between text and graphical main menu
1	1	Go to the current open book (if any)
2-8	2-8	Go to the specified location

Library	Navigates you to the bookshelf (see below)
Images	Navigates you to the imageshelf
Audio	Navigates you to the musicshelf
Games	Navigates you to the list of games installed
Applications	Navigates you to the list of applications installed
Setup	Navigates you to the global settings screen

Games/Applications

Just a lists of installed applications to run.

Settings

Screen update

Currently available only on N516.

Selects between adaptive, partial and full screen updates.

Partial means that screen will updated using partial update, so it will not blink, but there will be traces of the previous picture.

Full means that screen will be updated using full update, so it will blink on every change, but all traces will be cleaned.

Adaptive will use either partial or full update, according to the size of changed part of the screen.

Rotation

Order of screen rotations when long-pressed + (for V3) or rotation button (for N516) is pressed. long-pressed - on V3 will rotate screen in other direction.

Language

Allows you to select the interface language.

Clock setup

Allows you to set up the clock.

Bookshelf

File manager (Bookshelf) in OpenInkpot can be run by "Library", "Audio" and "Pictures" items in main menu, with appropriate filetype filters activated.

Disks menu

Disks menu provides access to all disks on device (e.g. SD and internal memory), recent files list and favorites list. If some of disks are inaccessible (e.g. SD card is not inserted) corresponding items in menu will be drawn inactive (gray).

Application keys:

V3	N516	Actions
↶	C	Go to main menu
1-9	1-9	Activate menu item
	Up/Down/Wheel up/Wheel down	Move cursor
	OK	Activate item under cursor

Directory

Directory view allows to navigate directories and run files. By default certain types of files are hidden, but can be shown by using context menu.

Application keys:

V3	N516	Actions
↶	C	Go to parent directory (or to disks menu if current directory is top one)
1-9	1-9	Activate menu item
Left/Right	Left/Right	Change page
0	M / Bookmark	Open directory context menu
	Up/Down/Wheel up/Wheel down	Move cursor
Long-pressed 1-9		Open file context menu
	OK	Open context menu for selected item

Favorites

Favorites view collects all files marked as favorites.

Application keys:

V3	N516	Actions
↶	C	Go to disks menu
1-9	1-9	Activate menu item
Left/Right	Left/Right	Change page
0	M / Bookmark	Open favorites context menu
	Up/Down/Wheel up/Wheel down	Move cursor
Long-pressed 1-9		Open file context menu
	OK	Open context menu for selected item

Recent files

Recent files view keeps track of all recently viewed files.

Application keys:

V3	N516	Actions
↶	C	Go to disks menu
1-9	1-9	Activate menu item
Left/Right	Left/Right	Change page
0	M / Bookmark	Open recent files context menu
	Up/Down/Wheel up/Wheel down	Move cursor
Long-pressed 1-9		Open file context menu
	OK	Open context menu for selected item

Book Reader (FBReader)

Application keys:

V3	N516	Actions
↶	C	Close
</>, 9/0	Left/Right, Up/Down, Scroll Up/Down	Previous/next page
	0	Help
1		Move back to the position before the navigation hyperlink
long pressed 1		Undo the previous move back
2	2	Open "Go to page" dialog
long pressed 2		Show/hide footer
3	3	Add bookmark
long pressed 3		Show bookmarks
4	4	Go to the previous chapter (section in ToC)
long pressed 4		Go to the start of the current chapter (section)
5	5	Go to the next chapter (section)
long pressed 5		Go to the end of the current chapter (section)
6	6	Cycle through footnotes on the current page
7	7	Show the table of contents
8	8	Enter the hyperlink navigation mode (see below)
long pressed 8	Zoom	Search
+	9	Increase font size
-		Decrease font size
OK	M (Bookmark)	Open book menu
long pressed OK	OK	Open settings menu (see below)

Settings

There are numerous settings in FBReader.

Format

Format settings control the appearance of text.

Setting	Action
Font Family	Typeface/font for the text of the book
Font Size	Size of font to be used in the text of the book (headings, super/subscripts and other elements are calculated based on this size)
Bold	Whether the font should be bold or not
Line spacing	Amount of space between text lines
Alignment	How to align text: left, right, center or justify
Margins	Allows configuration of the left, top, right and bottom margins around text
First line indent	Indentation at the start of paragraphs
Auto hyphenations	Whether the built-in hyphenation engine should be activated

Indicator

Indicator settings control the appearance of status bar at the bottom of screen.

Setting	Action
Show Indicator	Whether to show the status bar at all
Show TOC Marks	Whether to add ticks to the progress bar, depicting chapters and sections (you can see the ticks on the screenshot)
Show Position	Whether to show the current page on the status bar
Show Time	Whether to show the current time on the status bar
Show Battery	Whether to show the battery level on the status bar
Indicator height	Size of the status bar, in pixels
Offset From Text	Spacing between the status bar and text
Font Size	Size of the font in the status bar

Language

Language settings control language-specific behaviour of FBReader.

Setting	Action
Detect Language and Encoding	Whether to use the built-in encoding/language detector or to use default values
Default Language	Default language for text
Default Encoding Set	Default set of encodings (all encodings are grouped in several sets)
Default Encoding	Default encoding (taken from default set)
iso8859-1 -> win1521	Magic mumbo-jubmo for some Cyrillic stuff. Three expeditions were lost in source code trying to figure out the meaning of this setting

Book settings

Book settings allow configuration of options for the current book.

Setting	Action
Language	Select another language for the book (effects the hyphenation dictionary)
Encoding	Select another encoding for the book

There may be another format-dependent settings here.

Keys

Keys allows configuration of the keybindings. Currently only the keys 1-9 are remappable; more will be available later.

Book Menu

Book Info

Displays various information about the current book.

"Go to page" dialog

Numeric keys work for entering digits, ↶/C act as Backspace, OK acts as Apply and close.

Table of Contents

Table of Contents allows you to jump to another chapter of book. In case of hierarchical contents, the symbol + will be added to expandable nodes and activating them will move you to down the hierarchy.

Bookmarks

Activating a bookmark will go to it.

V3: long-pressing a bookmark will delete it.

N516: pressing the M/BookMark button will enable "bookmark delete" mode. While in this mode, any bookmark activated will be deleted. This mode is disabled by pressing M/BookMark again.

Hyperlinks navigation mode

If there are hyperlinks on the page, pressing 8 will enable hyperlinks navigation mode. In this mode, one of hyperlinks is highlighted, and the left/up/down/right keys move the selection to another hyperlink. 8 also "clicks" the hyperlink.

Book Reader (CoolReader)

</>	back/forward page
long pressed </>	back/forward 10 pages
1	move back in the navigation history
long pressed 1	move forward in the navigation history
2	go to page (with table of contents)...
3	dictionary with virtual keyboard input
long pressed 3	dictionary with T9-like input
4/5	back/forward section
long pressed 4/5	first/last page
6	hyperlink navigation...
long pressed 6	recent books list...
7	list of bookmarks... (Long press 1..8 - set bookmark, short press 1..8 - go to bookmark)
8	change font size
long pressed 8	change page orientation
9/0	back/forward page
long pressed 9/0	back/forward 10 pages
+/-	change font size
<-	exit to bookshelf
OK	menu (first/last page, go to page, dictionary, bookmarks, settings)
long pressed OK	settings...

Image Viewer (MadEye)

The image viewer is activated by opening an image file from the Images mode.

Application keys:

V3	N516	Action
↶	C	Close
</>, 9/0	Left/Right, Up/Down, 9/0	Previous/next image in directory
1/2	1/2	Adjust brightness
3/4	3/4	Adjust contrast
5	5	Enable/disable dithering
OK	OK	Reset brightness and contrast

PDF Viewer (LocoPDF)

The PDF viewer is activated by opening a PDF file from Library mode.

Application keys:

V3	N516	Action
↶	C	Close
OK	OK	Open settings menu (see below)
+/-	6/7	Zoom in/out
</>, 9/0	Up/Down, Wheel Up/Down	Page up/down
1	1	Open "Go to page" dialog
3	2	Open "Table of contents" dialog
2,6,7,8	8,Left,9,Right	Pan page up,left,down,right

Note that 2678 keys on V3 are like WASD keys from 3d-shooters.

Settings

Old-fashioned menu is slated to be replaced with the standard one in next version of OpenInkpot.

Horiz/Vert Panning	Controls the panning speed (percents of screen size)
Trimming	Allows trimming of margins for pages, with one setting for each margin
Zoom Increment	Controls the zooming speed (percentage of page size)
Fit mode	Controls default zoom level for the pages
Antialias	Enables and disables antialiasing
Reader mode	Enables and disables reader mode - with reader mode enabled panning after the end of page will switch the page to the next

Music Player (MadAudio)

Only supported on Hanvon N516.

The music player can be started by navigating to Audio in the main menu and activating a music file. The music player UI will be displayed. By default all music files from current directory will be added to the playlist, so you can switch the tracks without moving back to the directory with music.

The player is designed to work in background, so you can switch to another application any time. In order to pause/continue playback press ►/■ button.

Application keys:

N516	Action
C	Close player (music will continue to play)
1	Enable/disable repeat (loop) mode
2	Play single track / play all files from directory
3	Rewind
4	Fast forward
9	Play/pause
Up/Down, Wheel Up/Down	Volume up/down
Left/Right	Previous/next track

Global keys:

N516	Action
►/■	Play/pause

Customization

See customization page.