2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
NuPogodi 1f89704b90 storing rcountmax; user-configurable zoom step & pan steps, etc
1. In order to close issue #59, I've introduced user-configurable values for panning steps - for X- & Y-axis, separately. Now panning is called by pressing fiveway without mod_keys. When one presses Shift+FW, he/she changes panning steps in the following way - Shift-Left/Right = decrease / increase X-panning step (divide or multiply on factor 2), Shift-Up/Down = increase / decrease Y-panning step. The lowest value for panning steps is set 1. Both parameters, shift_x & shift_y, are saved to local settings (i.e. history file).

2. Manual zoom step was also made user-configurable. So, instead of two old zooming functions (with fixed 10% and 20%-steps), I made one function to zoom (Shift+<>), while the other (Alt+<>) changes the zoom step downto minimum 1%. 

3. Fresh introduced function to change parameter rcountmax was added by storing rcountmax to both setting files - global settings & local ones (i.e. history file) - so that the rcountmax-priority (from low to high) is the following: default rcountmax=5 < its value in global settings < rcountmax stored for each concrete document.

3. Dirty, the extention-based hack to avoid reading not crengine-related parameters stored in history files. TODO: one has to finally introduce loadSpecialSettings() & readSpecialSettings() for PDFReader & DJVUReader and to store therein the reader-specific parameters (like globalgamma, bbox, globalzoom, globalzoom_mode; render_mode = for djvu-files only, etc.)

4. Some lua-code cosmetics (to make code more readable); for example: "self.pan_margin = settings:readSetting("pan_margin") or self.pan_margin" instead of 
"local pan_margin = settings:readSetting("pan_margin")
if pan_margin then
		self.pan_margin = pan_margin
	end"

5. Fix for the today's tigran123 fix: issue #246 (details are included). Added InfoMessage:show() to inform most impatient users that the reader tries to redraw new zoo mode.

6. The fontface for the reading info (called by 'Menu') is restored to be in accordance with original intentions and with the same fontface in crereader.lua - namely, Font:getFace("rifont", 20)

7. Moved the exit hotkeys (Alt+Back & Home) to the end of hotkey list.
2012-09-03 22:23:06 +03:00
djvulibre@01a26bed05 update djvulibre and crengine to latest release 2012-04-17 11:01:40 +08:00
include included Linux kernel API header file for eink display 2011-11-16 15:59:37 +01:00
kite added shortcuts for Kite 2012-05-28 19:55:04 +02:00
kpvcrlib show search results as inverted block 2012-08-29 12:26:25 +02:00
launchpad fallback to stop framework approach on screensaver fix 2012-04-18 19:43:55 +08:00
luafilesystem@149e0fb8ec move third-party git checkouts into submodules #43 2012-03-07 17:19:52 +01:00
luajit-2.0@5bd133d6c8 switch to LuaJIT-2.0 2012-06-03 01:49:55 +02:00
mupdf@bdb6b688a2 update mupdf submodule to commit bdb6b688a238df56b2cf47fa17a08a4dd4b7a122 and small modification to source code to adapt to mupdf modifications 2012-03-24 17:47:52 +01:00
resources integrate rest of @NuPogodi changes #166 2012-05-19 13:04:49 +02:00
test added test file for ZOOM_FIT_TO_CONTENT_WIDTH_PAN 2012-04-09 16:36:22 +02:00
.gitignore add: patch files for previous commit 2012-04-04 03:00:20 +08:00
.gitmodules switch to LuaJIT-2.0 2012-06-03 01:49:55 +02:00
alt_getopt.lua better argument parsing and option for gamma correction 2011-11-16 17:13:08 +01:00
blitbuffer.c add paintCircle and RoundedCornerBorder 2012-04-26 15:15:34 +08:00
blitbuffer.h refactored code a bit to avoid duplication 2011-12-02 22:28:48 +01:00
commands.lua reread current directory files after unplug from PC 2012-06-08 00:53:45 +08:00
COPYING initial project, basic reader working 2011-11-14 18:30:16 +01:00
cre.cpp disable DEBUG_CRENGINE 2012-08-28 23:15:34 +02:00
cre.h add: data from crengine 2012-03-29 00:16:00 +08:00
crereader.lua crereader: remove not crengine-related 'M'-hotkey 2012-09-01 13:01:17 +03:00
dialog.lua rename debug() to Debug() to stop clashing with the debug submodule from Lua 2012-06-04 00:49:23 +02:00
djvu.c Comment out the setting of dithering bits because djvulibre ignores anything less than 8 bits anyway. 2012-09-02 18:57:37 +01:00
djvu.h mod: fix typo in comments 2012-03-05 10:02:39 +08:00
djvureader.lua Add description of MASK ONLY djvu page rendering mode. 2012-09-01 22:21:29 +01:00
drawcontext.c fix a Lua 5.0 syntax that was deprecated in 5.1 2012-03-19 19:11:32 +01:00
drawcontext.h separate DC out of pdf.c and djvu.c (cleanup) 2012-03-19 18:59:36 +01:00
einkfb.c remove dependency on <linux/fb.h> 2012-06-09 21:56:19 +08:00
einkfb.h remove dependency on <linux/fb.h> 2012-06-09 21:56:19 +08:00
extentions.lua 1. Disable filtering by file extension so that the program can be used as a proper filemanager. 2012-08-27 13:14:22 +01:00
filechooser.lua Remove the Debug() call I added when debugging the previous issue. 2012-09-02 15:45:29 +01:00
filehistory.lua Make sure the function that deletes history entry does NOT delete the physical file. 2012-08-27 15:14:15 +01:00
fileinfo.lua rename debug() to Debug() to stop clashing with the debug submodule from Lua 2012-06-04 00:49:23 +02:00
filesearcher.lua stay at current page after deletion 2012-06-09 14:46:45 +08:00
font.lua rename debug() to Debug() to stop clashing with the debug submodule from Lua 2012-06-04 00:49:23 +02:00
ft.c fixed various bugs in pointer handling 2012-04-16 22:51:13 +02:00
ft.h added freetype text rendering (still buggy) 2011-12-01 01:35:53 +01:00
graphics.lua faster refresh path for the cursor 2012-05-28 19:45:08 +02:00
helppage.lua To allow arbitrary header title 2012-08-28 22:28:29 +02:00
image.lua bugfix/typo 2012-04-15 23:39:53 +02:00
input.c remove dependency on <linux/input.h> 2012-06-11 02:49:45 +08:00
input.h remove dependency on <linux/input.h> 2012-06-11 02:49:45 +08:00
inputbox.lua a lot of inputbox improvements 2012-08-28 22:59:54 +02:00
keys.lua add usb charging events 2012-06-07 22:00:09 +08:00
kpdfview.c added interface to get blitbuffers from JPEG/PNG files 2012-04-14 22:32:05 +02:00
Makefile Improve customupdate target to only include the _real_ LUA source files, not 2012-09-02 18:43:07 +01:00
mupdf.patch modification to take into account new version of mupdf 2012-04-16 00:10:41 +02:00
mupdfimg.c fixed missing return values 2012-06-03 01:51:05 +02:00
mupdfimg.h added interface to get blitbuffers from JPEG/PNG files 2012-04-14 22:32:05 +02:00
pdf.c fixes for mac 2012-06-11 02:46:50 +08:00
pdf.h initial project, basic reader working 2011-11-14 18:30:16 +01:00
pdfreader.lua rename debug() to Debug() to stop clashing with the debug submodule from Lua 2012-06-04 00:49:23 +02:00
reader.lua first try to fix #127 2012-06-07 23:39:28 +08:00
README.TXT update building section in Makefile 2012-06-09 20:22:15 +08:00
rendertext.lua Update rendertext.lua 2012-08-29 15:42:20 +02:00
screen.lua fix comment in screen.lua 2012-08-26 03:19:59 +08:00
selectmenu.lua rename debug() to Debug() to stop clashing with the debug submodule from Lua 2012-06-04 00:49:23 +02:00
settings.lua rename debug() to Debug() to stop clashing with the debug submodule from Lua 2012-06-04 00:49:23 +02:00
slider_watcher.c add: demo for fixing #85, #86 2012-04-06 13:51:37 +08:00
unireader.lua storing rcountmax; user-configurable zoom step & pan steps, etc 2012-09-03 22:23:06 +03:00
util.c add: sleep and usleep in util module 2012-04-14 13:41:44 +08:00
util.h initial project, basic reader working 2011-11-14 18:30:16 +01:00
widget.lua Added widget abstraction framework 2012-04-15 01:59:49 +02:00

KindlePDFViewer
===============

This is a PDF viewer application, created for usage on the Kindle e-ink reader.
It is currently restricted to 4bpp inverse grayscale displays. It's using the
muPDF library (see http://mupdf.com/) and its UI is scripted using Lua (see
http://www.lua.org/).

The application is licensed under the GPLv3 (see COPYING file).


Building
========

Follow these steps:

- install muPDF sources into subfolder "mupdf"
- install muPDF third-party sources (see muPDF homepage) into a new subfolder
  "mupdf/thirdparty"

- install libDjvuLibre sources into subfolder "djvulibre"
- install CREngine sources into subfolder "kpvcrlib/crengine"

- install LuaJit sources into subfolder "luajit-2.0"

=> note that there's a make target to do all the above. You need wget, unzip and git
   installed. Then just run "make fetchthirdparty".

- adapt Makefile to your needs

- run "make thirdparty". This will build MuPDF (plus the libraries it depends
  on) and Lua.

- run "make". This will build the kpdfview application


Running
=======

The user interface (or what's there yet) is scripted in Lua. See "reader.lua".
It uses the Linux feature to run scripts by using a corresponding line at its
start.
So you might just call that script. Note that the script and the kpdfview
binary currently must be in the same directory.
You would then just call reader.lua, giving the document file path as its first
argument. Run reader.lua without arguments to see usage notes.
The reader.lua script can also show a file chooser: it will do this when you
call it with a directory (instead of a file) as first argument.


Device emulation
================

The code also features a device emulation. You need SDL headers and library
for this. It allows to develop on a standard PC and saves precious development
time. It might also compose the most unfriendly desktop PDF reader, depending
on your view.

To build in "emulation mode", you need to run make like this:
	make clean cleanthirdparty
	EMULATE_READER=1 make thirdparty kpdfview

And run the emulator like this:
	./reader.lua /PATH/TO/PDF.pdf

By default emulation will provide DXG resolution of 824*1200. It can be
specified at compile time, this is example for Kindle 3:

	EMULATE_READER_W=600 EMULATE_READER_H=800 EMULATE_READER=1 make kpdfview