Difference between revisions of "Projects"

From Kiwix
Jump to navigation Jump to search
m (Reverted edits by Mbcrq6fhj (talk) to last revision by Macofe)
(94 intermediate revisions by 7 users not shown)
Line 1: Line 1:
The Kiwix '''volunteers program''' has for purpose to offer to motivated and talented programers ways to work for Kiwix during a limited time.
{{translations}}
<translate><!--T:1-->
The Kiwix '''volunteers program''' offers motivated and talented people ways to work for Kiwix during a limited time. Contributors can speak English, French, or German.  Technical volunteers should know JavaScript, CSS, or other web languages, or C++.
</translate>


== Tasks ==
<translate>== Tasks == <!--T:2-->
</translate>


=== Kiwix for Android ===
== [https://phabricator.wikimedia.org/T73660 (re)-Introduce ZIM support in MediaWiki Book creator/OCG] ==


A next big step for Kiwix will be to ported to Android. Code base will not be rewritten so this port will also runs on the Gecko base platform. We need for this task someone with good knowledges in C++, compilation, Mozilla technologies and Android.
<translate><!--T:3-->
[https://www.mediawiki.org/ MediaWiki] is the wiki engine behind [https://www.wikipedia.org Wikipedia], all [https://www.wikimedia.org/ Wikimedia projects] and thousands other Web sites. It's a cutting edge free software providing highly featured web sites that anybody can edit. MediaWiki hosted content can be made available for offline usage through the [https://www.mediawiki.org/wiki/Extension:Collection Collection extension] (written in PHP). The Collection extension allows to easily create collection/selection of articles: so called books ; here is [https://en.wikipedia.org/w/index.php?title=Special:Book how it works on the English Wikipedia]. Once created, books can be exported in PDF format. The PDF exporting backend itself is not provided by the Collection extension, it's done with a JavaScript based solution called [https://www.mediawiki.org/wiki/Offline_content_generator OCG]. OCG is a NodeJS daemon able to transform a book definition in a PDF and it should be able to do the same in the ZIM format. The [http://www.openzim.org ZIM format] allows to store web pages (with images, videos, etc...) in one extremely compressed file. These pages are then available to read on most computers with a reader like [http://www.kiwix.org Kiwix]. A [https://github.com/cscott/mw-ocg-zimwriter stub of solution] has already been written and the [https://sourceforge.net/p/kiwix/other/ci/master/tree/mwoffliner/ MWOffline] is already functional. This [https://phabricator.wikimedia.org/T73660 task] is mostly about merging them.
</translate>


=== New Web site ===
=== [[phpzim]] (assigned) ===


We need to replace the current web site by a more simple and sexy one. This new one should be based on mediawiki and we already have a design. The wiki part, like we know it, would be still accessible but not push on the front of the Web site. So we need someone we good PHP & Web languages knowledges to do that.
== Promotional video (assigned) ==
Look [[Video|here]] for more details.


=== Build a compilation Platform ===
<translate>=== Testing platform === <!--T:4-->
We need a solution to test automatically Kiwix. We have currently nothing... so we start from scratch!
</translate>


=== Bug fixing and new features ===
<translate>=== Wikipublish === <!--T:5-->
</translate>


=== Mediawiki ZIM building solution ===
<translate><!--T:6-->
Create a publication platform, a Web site online similar to iTunes which would provide the list of available contents to download in ZIM, EPUB, .... also offer to see the book before downloading it.
</translate>


=== Fix Mediawiki DumpHTML extension ===
<translate><!--T:7-->
* [http://meta.wikimedia.org/wiki/Offline_Projects/Library/Wikipublish#Volunteers Want to know more...]
* Add support of EPUB in Kiwix
</translate>


The [http://www.mediawiki.org/wiki/Extension:DumpHTML Mediawiki DumpHTML extension] is the solution to export hte dynamic generated HTML pages in a set of static HTML/Media files. This extension is the best way to get a good set of HTML pages from a Mediawiki (in comparison with a Web site mirroring tool for example).
<translate>=== OSM === <!--T:8-->
Make a proof of concept of a ZIM file providing a map using OSM data and a tool like [http://openlayers.org/ openLayer].
</translate>


Unfortunately, this extension is not correctly maintained and with the time [https://bugzilla.wikimedia.org/buglist.cgi?query_format=advanced&list_id=2671&component=DumpHTML&resolution=---&product=MediaWiki%20extensions many issues were discovered]. Currently, the extension is not really usable without fixing/tweaking the code.
<translate>=== Improve P2P support === <!--T:9-->
* Fix Mirrorbrain to [http://mirrorbrain.org/issues/issue92 integrate torrent links in mirrorbrain]
* Fix Mirrorbrain to [http://mirrorbrain.org/issues/issue83 support fallback torrent trackers in .torrent files]
* Add a way to exchange library and content on a local network (for example, using "bonjour" & BitTorrent DHT)
</translate>


The purpose of this work package is to fix the most critical bugs that everyone having a Mediawiki would be able to simply get a HTML dumps of his content and consequently easily generate a ZIM file.
=== [[Linux Packaging project]] (assigned) ===


=== Sugar port ===
<translate>=== Ambassador Program === <!--T:10-->


== Open positions ==
<!--T:14-->
Create an '''ambassador program'''. '''Ambassadors''' would be special people especially aware about Kiwix and able to help others:
* Spread contents
* Make conferences
* Make advertisement
* Local representative


=== 6 months internship ===
<!--T:15-->
We search a volunteer/intern for a duration of 6 months. This intern would help us to work on one or many of the task already listed on this page. Location is Bamako (Mali).
To do that, we should develop a set of tools:
* Advertisement Package
* Ambassador program definition
* Map base on Ushahidi to locate them
</translate>


Profile:
<translate>==== Starter Kit (Assigned) ==== <!--T:11-->
* Engineer student or junior
Perhaps a nice kit would help.  You know, like for organizing Linux installation parties[1] or Mozilla's event kits[2] etc., that encourages people, and provides step-by-step guidance and advice, to go and install Kiwix with a relevant offline Wikipedia file in their local no-Internet (or restricted/expensive Internet) school, college, community center, etc.
* Experienced free software developer
 
<!--T:16-->
Skills:
Would anyone be interested in working on that?  WMF can contribute funding for some materials -- a Kiwix quick-start guide or cheatsheet, stickers, T-shirts.
* English speaking (French an advantage)
[1] http://ladypine.org/installfest.html, http://www.wikihow.com/Arrange-Linux-Install-Party
* C++ / Perl / Php
[2] https://wiki.mozilla.org/Webmaker/Teach/WebmakingResources
* Web languages
</translate>
* GNU Compilation tools
 
<translate>== Video == <!--T:12-->
It would be great to have a video (screencast) presenting the software with its most important features.
 
<!--T:17-->
Here is a proposition:
* Presentation slide of the video with slide and authors
* Presentation of the context (Online Wikipedia put offline of a DVD)
* Presentation of the principle of Kiwix and ZIM
* Starting Kiwix
* Open file
* Indexing file
* surfing
* searching
* special features: fullscreen, switch language, font bigger/smaller, random page, etc.
* Finish (present the ZIM availables and how to download them)
</translate>
 
<translate>== See also == <!--T:13-->
* [[{{ll|Participate}}|Participate]]
* [[{{ll|Roadmap}}|Roadmap]]
* [[{{ll|Development}}|Development]]
* [https://bugs.kiwix.org Kiwix bugs & feature requests]
* [https://secure.wikimedia.org/wikipedia/meta/wiki/Offline_Projects/Recommended_Projects#Proposed_project_ideas WMF Offline project overview]
</translate>

Revision as of 18:48, 19 January 2018

Other languages:
English • ‎español • ‎français • ‎magyar

The Kiwix volunteers program offers motivated and talented people ways to work for Kiwix during a limited time. Contributors can speak English, French, or German. Technical volunteers should know JavaScript, CSS, or other web languages, or C++.

Tasks

(re)-Introduce ZIM support in MediaWiki Book creator/OCG

MediaWiki is the wiki engine behind Wikipedia, all Wikimedia projects and thousands other Web sites. It's a cutting edge free software providing highly featured web sites that anybody can edit. MediaWiki hosted content can be made available for offline usage through the Collection extension (written in PHP). The Collection extension allows to easily create collection/selection of articles: so called books ; here is how it works on the English Wikipedia. Once created, books can be exported in PDF format. The PDF exporting backend itself is not provided by the Collection extension, it's done with a JavaScript based solution called OCG. OCG is a NodeJS daemon able to transform a book definition in a PDF and it should be able to do the same in the ZIM format. The ZIM format allows to store web pages (with images, videos, etc...) in one extremely compressed file. These pages are then available to read on most computers with a reader like Kiwix. A stub of solution has already been written and the MWOffline is already functional. This task is mostly about merging them.

phpzim (assigned)

Promotional video (assigned)

Look here for more details.

Testing platform

We need a solution to test automatically Kiwix. We have currently nothing... so we start from scratch!

Wikipublish

Create a publication platform, a Web site online similar to iTunes which would provide the list of available contents to download in ZIM, EPUB, .... also offer to see the book before downloading it.

OSM

Make a proof of concept of a ZIM file providing a map using OSM data and a tool like openLayer.

Improve P2P support

Linux Packaging project (assigned)

Ambassador Program

Create an ambassador program. Ambassadors would be special people especially aware about Kiwix and able to help others:

  • Spread contents
  • Make conferences
  • Make advertisement
  • Local representative

To do that, we should develop a set of tools:

  • Advertisement Package
  • Ambassador program definition
  • Map base on Ushahidi to locate them

Starter Kit (Assigned)

Perhaps a nice kit would help. You know, like for organizing Linux installation parties[1] or Mozilla's event kits[2] etc., that encourages people, and provides step-by-step guidance and advice, to go and install Kiwix with a relevant offline Wikipedia file in their local no-Internet (or restricted/expensive Internet) school, college, community center, etc.

Would anyone be interested in working on that? WMF can contribute funding for some materials -- a Kiwix quick-start guide or cheatsheet, stickers, T-shirts. [1] http://ladypine.org/installfest.html, http://www.wikihow.com/Arrange-Linux-Install-Party [2] https://wiki.mozilla.org/Webmaker/Teach/WebmakingResources

Video

It would be great to have a video (screencast) presenting the software with its most important features.

Here is a proposition:

  • Presentation slide of the video with slide and authors
  • Presentation of the context (Online Wikipedia put offline of a DVD)
  • Presentation of the principle of Kiwix and ZIM
  • Starting Kiwix
  • Open file
  • Indexing file
  • surfing
  • searching
  • special features: fullscreen, switch language, font bigger/smaller, random page, etc.
  • Finish (present the ZIM availables and how to download them)

See also