Difference between revisions of "Phpzim"

Jump to navigation Jump to search
208 bytes removed ,  10 years ago
 
(13 intermediate revisions by 3 users not shown)
Line 10: Line 10:
* Project leader title (position), if any: Project manager
* Project leader title (position), if any: Project manager
* Full project name: phpzim
* Full project name: phpzim
* Provisional target start date: 01-11-2012
* Provisional target start date:  
* Provisional completion date: 01-01-2013
* Provisional completion date:


== Goals ==
== Goals ==
Line 18: Line 18:
Deliverables:
Deliverables:
* Create a tgz of the zimlib with only the necessary for phpzim
* 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
* Create the code (c/c++) of the phpzim PHP extension using the GNU tools for the compilation
* phpzim should offer an easy API to read/write ZIM files with all the necessary options
* phpzim should offer an easy API to read/write ZIM files with all the necessary options
* Code of phpzim should be online developed on openZIM subversion repository
* Code of phpzim should be online developed on openZIM repository
* At the end a tgz directly compilable of phpzim should be provided with a documentation about how co compile/install/configure it with Apache.
* At the end a tgz directly compilable of phpzim should be provided with a documentation about how co compile/install/configure it with Apache.
* Code usage should be documented and documentation should be automatically generated using doxygen or similar
* Code usage should be documented and documentation should be automatically generated using doxygen or similar
Line 28: Line 28:


This project would be split in 2 work-packages:
This project would be split in 2 work-packages:
* Work for Gilbert: Everything regarding the phpzim PHP extension (3000 CHF)
* Everything regarding the phpzim PHP extension (3000 CHF)
* Work for Marco: Everything regarding the buildZIMFileFromDirectly.php (1000 CHF)
* Everything regarding the buildZIMFileFromDirectory.php (1000 CHF)


== Resources ==
== Resources ==
Line 41: Line 41:
Increase reach is currently [https://strategy.wikimedia.org/wiki/Strategic_Plan/Movement_Priorities#Increase_Reach 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.
Increase reach is currently [https://strategy.wikimedia.org/wiki/Strategic_Plan/Movement_Priorities#Increase_Reach 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.


We have now a good Desktop software, we need to increase the offert of ZIM file, this project is one essential stone in that way:
We have now a good Desktop software, we need to increase the offer of ZIM files, this project is one essential stone in that way.
* Speed up the ZIM creation process we have at Kiwix
* Offer a software solution to every PHP developer to easily create ZIM files
* Allow in the future to allow any Mediawiki Administrator to export his content to ZIM - until now, they contact me ([[User:Kelson|Kelson]])


== Benefits ==
== Benefits ==


* Mandatory to integration the ZIM generation directly in DumpHTML (See the global [[Mediawiki DumpHTML extension improvement]] project)
* 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 [http://www.openzim.org/Zimwriter zimwriter] binary) - directly usable on the new created Kiwix zimfar (see [[ZIM Autobuild]] project).
* Speed-up the ZIM creation (avoiding using a postgresql database and the [http://www.openzim.org/Zimwriter zimwriter] binary) directly usable on the new created Kiwix zimfarm (see [[ZIM Autobuild]] project).
* 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).
* Essential for many CMS coded in PHP to generate also ZIM files (we hope to see also other project to release there own ZIM files).
* Allow in the future any Mediawiki Administrator to export his content to ZIM – until now, they contact me ([[User:Kelson|Kelson]])
* Collaboration with [http://www.wikimedia.fr Wikimédia France] which already granted the rest of the project.
* Collaboration with [http://www.wikimedia.fr Wikimédia France] which already granted the rest of the project.


== People ==
== People ==
This project would be led by [[User:Kelson|Kelson]] and executed by two students (swiss and austrian).
This project would be led by [[User:Kelson|Kelson]] and executed by third part developer(s).


== See also ==
== See also ==

Navigation menu