KOReader

• Index

Contents

• Functions

Modules

• android
• apps.filemanager.filemanagerbookinfo
• apps.filemanager.filemanagerconverter
• apps.filemanager.filemanagerutil
• apps.filemanager.lib.md
• apps.reader.modules.readerlink
• apps.reader.modules.readerview
• apps.reader.readerui
• baseexporter
• cache
• cacheitem
• datetime
• dbg
• depgraph
• device.generic.device
• device.gesturedetector
• device.input
• device.kindle.mockrtc
• device.kobo.nickel_conf
• device.sysfs_light
• device.wakeupmgr
• dispatcher
• docsettings
• document.doccache
• document.documentregistry
• document.koptinterface
• dump
• ffi.blitbuffer
• ffi.crypto
• ffi.framebuffer
• ffi.freetype
• ffi.jpeg
• ffi.koptcontext
• ffi.loadlib
• ffi.md5
• ffi.mupdf
• ffi.png
• ffi.rtc
• ffi.sdl2_0
• ffi.utf8proc
• ffi.util
• ffi.webp
• ffi.zipwriter
• ffi.zlib
• ffi.zstd
• gettext
• koplugin.HelloWorld
• koplugin.QRClipboard
• koplugin.autodim
• koplugin.autowarmth
• koplugin.calibre.metadata
• koplugin.coverimage
• koplugin.exporter
• koplugin.japanese
• koplugin.japanese.deinflector
• koplugin.patchmanagement
• koplugin.terminal
• koplugin.terminal
• koplugin.vocabbuilder
• koplugin.wallabag
• languagesupport
• logger
• luadata
• luadefaults
• luasettings
• optmath
• random
• socketutil
• sort
• suntime
• time
• ui.bidi
• ui.data.css_tweaks
• ui.data.keyboardlayouts.generic_ime
• ui.data.keyboardlayouts.ja_keyboard
• ui.data.keyboardlayouts.ja_keyboard_keys
• ui.data.keyboardlayouts.ko_KR_helper
• ui.data.keyboardlayouts.zh_keyboard
• ui.data.optionsutil
• ui.downloadmgr
• ui.event
• ui.font
• ui.geometry
• ui.hook_container
• ui.menusorter
• ui.network.wpa_supplicant
• ui.otamanager
• ui.plugin.background_task_plugin
• ui.plugin.switch_plugin
• ui.quickstart
• ui.renderimage
• ui.rendertext
• ui.size
• ui.translator
• ui.trapper
• ui.uimanager
• ui.viewhtml
• ui.widget.bboxwidget
• ui.widget.button
• ui.widget.buttondialog
• ui.widget.checkbutton
• ui.widget.checkmark
• ui.widget.confirmbox
• ui.widget.container.alphacontainer
• ui.widget.container.bottomcontainer
• ui.widget.container.centercontainer
• ui.widget.container.framecontainer
• ui.widget.container.inputcontainer
• ui.widget.container.leftcontainer
• ui.widget.container.movablecontainer
• ui.widget.container.rightcontainer
• ui.widget.container.scrollablecontainer
• ui.widget.container.topcontainer
• ui.widget.container.underlinecontainer
• ui.widget.container.widgetcontainer
• ui.widget.datetimewidget
• ui.widget.eventlistener
• ui.widget.horizontalgroup
• ui.widget.htmlboxwidget
• ui.widget.iconbutton
• ui.widget.iconwidget
• ui.widget.imageviewer
• ui.widget.imagewidget
• ui.widget.infomessage
• ui.widget.inputdialog
• ui.widget.keyboardlayoutdialog
• ui.widget.keyvaluepage
• ui.widget.linewidget
• ui.widget.listview
• ui.widget.multiconfirmbox
• ui.widget.multiinputdialog
• ui.widget.networksetting
• ui.widget.notification
• ui.widget.numberpickerwidget
• ui.widget.openwithdialog
• ui.widget.overlapgroup
• ui.widget.progresswidget
• ui.widget.qrmessage
• ui.widget.radiobuttontable
• ui.widget.radiobuttonwidget
• ui.widget.scrollhtmlwidget
• ui.widget.scrolltextwidget
• ui.widget.textboxwidget
• ui.widget.textviewer
• ui.widget.textwidget
• ui.widget.toggleswitch
• ui.widget.touchmenu
• ui.widget.trapwidget
• ui.widget.verticalgroup
• ui.widget.widget
• userpatch
• util
• version

Topics

• Collaborating with Git
• DataStore
• Development Guide
• Events
• Hacking
• Porting
• README
• Unit Tests

Module ui.quickstart

This module is responsible for generating the quickstart guide.

Functions

QuickStart:isShown ()	Returns true if shown, false if the quickstart guide hasn't been shown yet or if display is forced through a higher version number than when it was first shown.
QuickStart:getQuickStart ()	Generates the quickstart guide in the user's language and returns its location.

Functions

QuickStart:isShown ()

Returns true if shown, false if the quickstart guide hasn't been shown yet or if display is forced through a higher version number than when it was first shown.

QuickStart:getQuickStart ()

Generates the quickstart guide in the user's language and returns its location.

The fileformat is quickstart-en-v2015.11-985-g88308992.html, en being the language of the generated file and v2015.11-985-g88308992 the KOReader version used to generate the file.

Returns:

string path to generated HTML quickstart guide