Difference between revisions of "Javascript API"

From openZIM
Jump to navigation Jump to search
(add potential capabilities)
(add Proposed Solution)
Line 26: Line 26:
* night mode
* night mode
* readability
* readability
* snippet
* page thumb image

Revision as of 19:10, 13 October 2017


Zim files can be seem as a subset and a snapshot of a website. Webpages in the zim file could have totally different structure and layout.

The problem arises when interaction with the webpage is needed, since it is impossible to perform those interactions when there's little information regarding if and how an interaction should be performed.

Some kind of indication should be provided to allow zim readers to turn interactions on or off once a page is loaded. Further, implementations to perform those interactions needs to be included in the zim file itself.


A basic function of zim readers is to provide a table of content of an article. But it is impossible come up with one javascript function to extract table of content in all sorts of zim files. It would make sense for each webpage to come with its own `getTableOfContent()` and `scrollToSection()` function. Some webpages, such as phet or main page, it might make little sense to provide table of content. A way to check `hasTableOfContent` could also be provided.

Proposed Solution

Add javascript with indication and implementation of capabilities to each offliner and load the javascript when page loads. A standard interface should be defined and documented.

Potential capabilities to include:

  • title
  • table of content
    • extraction
    • scrolling position indicating
    • scroll to section
  • font
    • size
    • line spacing
    • justification
  • night mode
  • readability
  • snippet
  • page thumb image