Difference between revisions of "Kiwix-manage"

Jump to navigation Jump to search
no edit summary
Line 1: Line 1:
'''kiwix-library''' is a console tool which allows to build library files for Kiwix. A library file is an XML flat file listing ZIM files with all the necessarz properties like (favicon, date, creator, description, indexpath, filepath, title, source/metalink, ...).
'''kiwix-manage''' is a console tool which allows to build library files for Kiwix. A library file is an XML flat file listing ZIM files with all the necessary informations like (favicon, date, creator, description, indexpath, filepath, title, source/metalink, ...).


kiwix-library generated files are thought for two usages:
kiwix-manage generated files are thought for two usages:
* Local library file for kiwix-serve
* Local library file for kiwix-serve (need to be implemented in kiwix-serve)
* Remote/portable library file for the Kiwix software, providing a list of downloadable content.
* Remote/portable library file for the Kiwix software, providing a list of downloadable content ([http://www.kiwix.org/library.xml example]).


By the way, an intern library file is also managed an build directly by Kiwix, following the user behaviour (adding, removing new content)... and the format is exactly the same.
By the way, an intern library file is also managed an build directly by Kiwix, following the user behaviour (adding, removing new content)... and the format is exactly the same.
Line 9: Line 9:
== Technical details ==
== Technical details ==


kiwix-library is based on a kiwix::library class coded in C++ and using a simple/fast/protable XML/DOM XML library. To exctract content from the ZIM file, it will use the zimlib code.
kiwix-manage is based on a kiwix::Manager class coded in C++ and using a simple/fast/protable XML/DOM XML library (pugixml). To extract content from the ZIM file, it will use the zimlib code.


== Usage ==
== Usage ==

Navigation menu