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
generated by LDoc 1.4.6 Last updated 2017-10-08 14:57:40