Tell us your story
Tell us your story
How has offline Wikipedia affected you? The Wikimedia Foundation (the non-profit that supports Wikipedia) is looking for personal, diverse and inspiring stories about how offline Wikipedia affects the world. If you have a personal story that you would like to share, please contact: stories@kiwix.org. Thank you!

Phpzim

From Kiwix
Revision as of 10:18, 13 September 2012 by Kelson (talk | contribs) (Created page with "The '''phpzim project''' is a project to create a new [https://en.wikipedia.org/wiki/Php PHP] binding to the zimlib, allowing to easily read and write ZIM files in this langua...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The phpzim project is a project to create a new PHP binding to the zimlib, allowing to easily read and write ZIM files in this language. This project include the creation of the necessary code, documentation and demo script. phpzim will be based on the zimlib like pyzim, the Python extension to deal with ZIM files. phpzim is essential to:

Properties

  • Legal name of organization or individual requesting this grant: Emmanuel Engelhart
  • Project contact name: Emmanuel Engelhart
  • Project contact username or email: Kelson
  • Project contact title (position): Project manager
  • Project leader name: Emmanuel Engelhart
  • Project leader username or email: Kelson
  • Project leader title (position), if any: Project manager
  • Full project name: phpzim
  • Provisional target start date: 01-11-2012
  • Provisional completion date: 01-01-2013

Goals

The goal is mainly about the creation of a ZIM PHP extension called "phpzim". phpzim is an extension allowing PHP developers to read/write ZIM files.

Delivarables:

  • Create a tgz of the zimlib with only the necessary for phpzim
  • Create the code (c++) of the phpzim PHP extension using the GNU tools for the compilation
  • phpzim should offer a easy API to read/write ZIM files with all the necessary options
  • Code of phpzim should be online developed on openZIM subversion and as a tgz directly compilable
  • Code usage should be documented and documentation should be automaticaly generated using doxygen or similar
  • Rewrite and improve buildZimFileFromDirectory.pl in PHP (dealing directly with the zimlib)

Activities

This project would be split in 2 work-packages:

Resources

  • 160 hours of development
  • 20 hours of volunteer time for the project management
  • 3 months of time
  • 4.000 CHF for the development work

Fit strategy and user demand

Increase reach is currently the first Wikimedia strategic goal. Offline is an essential part of the Wikimedia strategy and Kiwix, as official Wikimedia offline reader, is a master piece of this strategy.

Benefits

  • Mandatory to integration the ZIM generation directly in DumpHTML (See the global Mediawiki DumpHTML extension improvement project)
  • Speed-up the ZIM creation (avoiding using a postgresql database and the zimwriter binary).
  • Essential for many CMS coded in PH to generate also ZIM files (we hope to see also other project to release there own ZIM files).
  • Collaboration with Wikimédia France which already granted the rest of the project.

People

This project would be led by Kelson and executed by two students (swiss and austrian).

See also