Difference between revisions of "Library"

Jump to navigation Jump to search
no edit summary
Line 1: Line 1:
[[File:Library screenshot.png|right|thumb|Screenshot of the library in Kiwix]]
[[File:Library screenshot.png|right|thumb|Screenshot of the library in Kiwix]]


The '''content manager''' or '''library''' is a software solution responsible to deal with available content offline&online. This is a c++ class which deals with one or many XML library files. In the library, there are books, which are for example ZIM files. Each book may have a lot of details about the ZIM file like title, number of page, size, infos about how to download it, corresponding index paht, etc.
The '''content manager''' or '''library''' is a software solution responsible to deal with available content offline&online. In the library, there are contents (books), which are for example ZIM files. Each book may have a lot of details about the ZIM file like title, number of page, size, infos about how to download it, corresponding index path, etc.


== Use cases ==
== Use cases ==
Line 16: Line 16:


By running the local instance, this should work like a local instance only scenario. By running the installed instance, this should ignore the local instance.
By running the local instance, this should work like a local instance only scenario. By running the installed instance, this should ignore the local instance.
== Location ==
Library XML files should be located in specific locations (related to Kiwix binary path).
All platforms:
* In Kiwix profile (~/.www.kiwix.org on POSIX systems or .../Application Data/www.kiwix.org on Windows) at library.xml
* ../data/library/*.xml
On Linux:
* ../../share/kiwix/data/library/*xml
== Implementation ==
The content manager is a c++ class which deals with one or many XML library files. For Kiwix you have the corresponding XPCOM which is called by the javascript module "library".

Navigation menu