mirror of
https://github.com/kiwix/kiwix-js.git
synced 2025-09-22 12:01:15 -04:00
Re-organize the About section
Add privacy policy, step-by-step usage, ways to contribute, credits, links for other platforms etc. Fixes #54 Fixes #52 Also add the version number at the top
This commit is contained in:
mossroy
parent
dbfee80d06
commit
e58d6e8545
14
README.md
14
README.md
@ -1,6 +1,14 @@
|
||||
evopedia-html5
|
||||
==============
|
||||
|
||||
Port of Evopedia (offline wikipedia reader) in HTML5/Javascript, with Firefox OS as the primary target
|
||||
The original application is at http://www.evopedia.info/
|
||||
It uses wikipedia dumps located at http://dumpathome.evopedia.info/dumps/finished
|
||||
Evopedia is an offline wikipedia viewer. See the official site : http://www.evopedia.info/
|
||||
This application is developed in HTML5/Javascript, with Firefox OS as the primary target.
|
||||
|
||||
You can search among the article titles, and read any of them without any Internet access.
|
||||
All the content of wikipedia is inside your device (except the images). It also works with Wiktionary and Wikivoyage.
|
||||
If your Internet access is expensive/rare/slow/unreliable/watched/censored, you still have access to this valuable knowledge and culture.
|
||||
|
||||
It uses wikipedia archives located at http://dumpathome.evopedia.info/dumps/finished
|
||||
You have to first download one of them (with a Bittorrent client) and store it on your SD-card.
|
||||
|
||||
This application is released under the GPL v3 license. See http://www.gnu.org/licenses/ or the included LICENSE-GPLv3.txt file
|
||||
|
||||
94
index.html
94
index.html
@ -51,7 +51,7 @@
|
||||
<span class="icon-bar"></span>
|
||||
<span class="icon-bar"></span>
|
||||
</button>
|
||||
<a class="navbar-brand">Evopedia</a>
|
||||
<a class="navbar-brand">Evopedia v1.0.0</a>
|
||||
</div>
|
||||
|
||||
<!-- Collect the nav links, forms, and other content for toggling -->
|
||||
@ -79,44 +79,65 @@
|
||||
</header>
|
||||
<article class="view-content">
|
||||
<div id="about" style="display: none;">
|
||||
<h2>About</h2>
|
||||
This is a port of Evopedia (offline wikipedia reader) in HTML5/Javascript, with Firefox OS as the primary target
|
||||
<br />
|
||||
The original application (developed in Qt) is at <a href="http://www.evopedia.info/" target="_blank">http://www.evopedia.info/</a>
|
||||
<h2>
|
||||
<img src="img/evopedia-64x64.png"/>
|
||||
Evopedia : offline wikipedia viewer
|
||||
</h2>
|
||||
<br />Official site : <a href="http://www.evopedia.info/" target="_blank">http://www.evopedia.info/</a>
|
||||
<br />
|
||||
<br />You can search among the article titles, and read any of them without any Internet access.
|
||||
<br />All the content of wikipedia is inside your device (except the images). It also works with Wiktionary and Wikivoyage.
|
||||
<br />If your Internet access is expensive/rare/slow/unreliable/watched/censored, you still have access to this valuable knowledge and culture.
|
||||
<br />
|
||||
<br />NB : If you're connected to the Internet when using the application, the images inside the articles will be displayed from the Internet.
|
||||
<h3>Usage</h3>
|
||||
To use it, you have to first download locally an archive from <a href="http://dumpathome.evopedia.info/dumps/finished" target="_blank">http://dumpathome.evopedia.info/dumps/finished</a>, from a regular computer.
|
||||
<h4>Step 1 : download an archive</h4>
|
||||
From <a href="http://dumpathome.evopedia.info/dumps/finished" target="_blank">http://dumpathome.evopedia.info/dumps/finished</a>, with a regular computer.
|
||||
<br />If you get a compressed archive (.zip, .tar.gz or .tar.bz2), you will have to decompress it.
|
||||
<br />For a quick test, you can start with the dump called <a href="http://evopedia.info/dumps/wikipedia_small_2010-08-14.tar.gz" target="_blank">"small"</a> : it can be downloaded through HTTP and contains a very small subset of the English archive (note that the hyperlinks between articles will rarely work, as a lot of articles are missing in it).
|
||||
<br />For a quick test, you can start with the dump called <a href="http://evopedia.info/dumps/wikipedia_small_2010-08-14.tar.gz" target="_blank">"small"</a> : it contains a very small subset of the English archive (note that the hyperlinks between articles will rarely work, as a lot of articles are missing in it).
|
||||
<br />After that, you can download an archive in your language, through a Bittorrent client. Check its size : these archives take several GB each.
|
||||
<br />
|
||||
<br />
|
||||
<h4>Step 2 : put it on your SD-card</h4>
|
||||
The archive can be stored is any subdirectory of your SD-card (ex: /wikipedia_small_2010-08-14, or /evopedia/wikipedia_small_2010-08-14). If you have enough space, you can put several archives
|
||||
<h4>Step 3 : enjoy wikipedia offline!</h4>
|
||||
<h3>Privacy policy</h3>
|
||||
This application works offline. There is no central server. We do not collect any of your personal data and don't even know what you are doing with this application.
|
||||
<br />Anyway, if you think your Internet access can be watched and/or if you are paranoid, you should shut down your 3G and Wifi access before using the application. If not, the application will try to read the images of the articles on the wikipedia servers, which might indicate which articles you are reading.
|
||||
<br />This application only reads the wikipedia archives of your SD-card : it does not read any other files.
|
||||
<h3>Feedback / helping / contributing</h3>
|
||||
This is a first version of Evopedia. There are many ways this could be enhanced. In particular :
|
||||
<ul>
|
||||
<li>On a Firefox OS device, you simply have to put the archive files in any subdirectory of your sdcard (ex: /wikipedia_small_2010-08-14). The application needs to be installed to have the right to read the archive. For now, you have to install it manually (use the push feature of the Firefos OS Simulator). I hope it will soon be available in the MarketPlace</li>
|
||||
<li>On the Firefos OS simulator, you have to put the archive files in any subdirectory in a "fake-sdcard" folder of your firefox profile (ex : ~/.mozilla/firefox/xxxx.default/extensions/r2d2b2g@mozilla.org/profile/fake-sdcard/wikipedia_small_2010-08-14). You need to install the application from the dashboard of the simulator</li>
|
||||
<li>On desktops, it works on recent Firefox and Chromium, and probably on some other browsers (it even seems to work on IE10). In this case, you have to manually select the files from your archive (see the configuration section)</li>
|
||||
<li>On Android, it does not seem to work for now (tried with internal browser, Chrome and Firefox) because you can not select all the files of an archive</li>
|
||||
</ul>
|
||||
<br />
|
||||
<h3>Feedback</h3>
|
||||
It's still a beta version : there are many ways this could be enhanced (suggestions and patches are welcome : the source code is on <a href="https://github.com/mossroy/evopedia-html5" target="_blank">github</a>). In particular :
|
||||
<ul>
|
||||
<li>It is not easy to use on the Peak device from Geeksphone because the buttons and inputs are too small</li>
|
||||
<li>Some features of the original application still have to be implemented : in particular the "Articles nearby" feature (geolocation)</li>
|
||||
<li><a href="https://github.com/mossroy/evopedia-html5/issues/8" target="_blank">Issue #8</a> : It is not easy to use on the Peak device from Geeksphone if you're still using Firefox OS 1.0.1, because the buttons and inputs are too small. This should be improved with Firefox OS 1.1, which should be deployed OTA soon</li>
|
||||
<li><a href="https://github.com/mossroy/evopedia-html5/issues/9" target="_blank">Issue #9</a> : Some features of the original application still have to be implemented : in particular the "Articles nearby" feature (geolocation)</li>
|
||||
<li><a href="https://github.com/mossroy/evopedia-html5/issues/13" target="_blank">Issue #13</a> : All the user interface is in English : I plan to translate it at least in French. If you feel able to translate it in your language, please <a href="mailto:mossroy@free.fr?subject=%5BEvopedia%5D%20Translating%20Evopedia%20HTML5">contact me by email</a></li>
|
||||
<li><a href="https://github.com/mossroy/evopedia-html5/issues/4" target="_blank">Issue #4</a> : The performance when reading an article can probably be improved. I'm working on it</li>
|
||||
</ul>
|
||||
Suggestions and patches are welcome : the source code is on <a href="https://github.com/mossroy/evopedia-html5" target="_blank">github</a>.
|
||||
The <a href="https://github.com/mossroy/evopedia-html5/issues" target="_blank">bugtracker</a> is on github too. I use it as my roadmap.
|
||||
<br />Alternatively, you can send your feedback <a href="mailto:mossroy@free.fr?subject=Feedback%20about%20Evopedia%20HTML5">by email</a>.
|
||||
<br />In all cases, please give me as much detail as you can : which device or browser you are using, which archive, which articles etc.
|
||||
<br />
|
||||
<br />Alternatively, you can send your feedback <a href="mailto:mossroy@free.fr?subject=%5BEvopedia%5D%20Feedback%20about%20Evopedia%20HTML5">by email</a>.
|
||||
<br />In all cases, please give me as much detail as you can : which device you are using, which version of Evopedia, which archive, which articles etc.
|
||||
<br />
|
||||
<br />If you like the Evopedia project and use it, please consider giving donations :
|
||||
<ul>
|
||||
<li>to the Wikimedia foundation, to help maintaining their servers and article contents. See the <a href="https://donate.wikimedia.org/" target="_blank">donation page</a></li>
|
||||
<li>to Evopedia, to help maintaining the archives and applications. You can send small donations with <a href="https://flattr.com/thing/1071868/evopedia" target="_blank">Flattr</a></li>
|
||||
</ul>
|
||||
You can also help by :
|
||||
<ul>
|
||||
<li>Adding articles or improving the existing ones, by <a href="https://en.wikipedia.org/wiki/Wikipedia:Introduction" target="_blank">editing online wikipedia articles</a></li>
|
||||
<li>Using the ressources of your computer to <a href="http://dumpathome.evopedia.info/contribute" target="_blank">help generating the archives</a></li>
|
||||
</ul>
|
||||
<h3>Credits</h3>
|
||||
Many thanks to christian@evopedia.info, leader of the Evopedia project. He originally developed the Qt application, designed the archive format, and organizes the updates of these archives
|
||||
<br />Christian also contributed some code on this application, for the math images.
|
||||
<br />Thank you mapilette for testing and supporting
|
||||
<br />
|
||||
<h3>License</h3>
|
||||
This application is licensed under the GPL v3 license :
|
||||
I have to distribute some thanks to :
|
||||
<ul>
|
||||
<li>Christian Reitwießner, leader of the Evopedia project. He originally developed the Qt application, designed the archive format, and organizes the updates of these archives. Christian also contributed some code on this application, for the math images</li>
|
||||
<li>Mapilette for testing and supporting.</li>
|
||||
<li>Mozilla for building Firefox OS. It's an amazing platform. Many thanks in general for your commitment to keeping the web open, alive and respectful. For those who didn't, please read their <a href="https://www.mozilla.org/en-US/about/manifesto/" target="_blank">Manifesto</a> to see what are the goals of this non-profit organization</li>
|
||||
<li>Wikipedia teams and contributors to help spreading knowledge to everybody</li>
|
||||
<li>All the developers of libraries and tools I used for releasing them as Free software (see License paragraph)</li>
|
||||
</ul>
|
||||
<h3>License information</h3>
|
||||
Copyright 2013 Mossroy
|
||||
<br />This application is licensed under the GPL v3 license :
|
||||
<br />
|
||||
<i>
|
||||
<br />Evopedia is free software: you can redistribute it and/or modify
|
||||
@ -133,7 +154,7 @@
|
||||
<br />along with Evopedia (file LICENSE-GPLv3.txt). If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>
|
||||
</i>
|
||||
<br />
|
||||
<br /> Main libraries and ressources used :
|
||||
<br />Main libraries and ressources used :
|
||||
<ul>
|
||||
<li><a href="http://jquery.com/" target="_blank">jQuery</a> 2, released under the <a href="http://jquery.org/license" target="_blank">MIT license</a></li>
|
||||
<li><a href="http://getbootstrap.com/" target="_blank">Bootstrap</a> 3, released under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache license 2.0</a>, which includes icons from <a href="http://glyphicons.com/">Glyphicons</a></li>
|
||||
@ -141,9 +162,20 @@
|
||||
<li><a href="http://www.requirejs.org/" target="_blank">RequireJS</a> 2, released under the <a href="https://github.com/jrburke/requirejs/blob/master/LICENSE" target="_blank">MIT license or new BSD license</a></li>
|
||||
<li><a href="http://zeptojs.com/" target="_blank">ZeptoJS</a> 2, released under the <a href="https://github.com/madrobby/zepto/blob/master/MIT-LICENSE" target="_blank">MIT license</a></li>
|
||||
<li><a href="http://qunitjs.com/" target="_blank">QUnit</a> 2, released under the <a href="http://jquery.org/license" target="_blank">MIT license</a></li>
|
||||
<li>Icon, algorithms and inspiration from <a href="https://github.com/evopedia/evopedia_qt/" target="_blank">Evopedia (Qt version)</a>, released under the <a href="https://www.gnu.org/licenses/" target="_blank">GPL v3 license</a></li>
|
||||
<li>Icons, algorithms and inspiration from <a href="https://github.com/evopedia/evopedia_qt/" target="_blank">Evopedia (Qt version)</a>, released under the <a href="https://www.gnu.org/licenses/" target="_blank">GPL v3 license</a></li>
|
||||
<li>Mediawiki CSS from <a href="http://wikidev.net/" target="_blank">Wikidev</a>, released under the <a href="http://www.gnu.org/copyleft/gpl.html" target="_blank">GPL license</a></li>
|
||||
</ul>
|
||||
<h3>Other platforms/versions</h3>
|
||||
Other Evopedia clients exist on various platforms. See the official site : <a href="http://www.evopedia.info/" target="_blank">http://www.evopedia.info/</a>
|
||||
<br />
|
||||
<br />This HTML5/javascript application is currently mainly targeted on Firefox OS devices. But it also can be used on some other platforms :
|
||||
<ul>
|
||||
<li>It works perfectly on the <a href="https://addons.mozilla.org/en-US/firefox/addon/firefox-os-simulator/" target="_blank">Firefos OS simulator</a> (a Firefox plugin), you have to put the archive files in any subdirectory in a "fake-sdcard" folder of your firefox profile (ex : ~/.mozilla/firefox/xxxx.default/extensions/r2d2b2g@mozilla.org/profile/fake-sdcard/wikipedia_small_2010-08-14)</li>
|
||||
<li>On desktops, it works but is less user friendly : you have to manually select the files of your archive, and it's not yet easily deployable as a "web application". I tested it on recent Firefox and Chromium, but it probably works on some other browsers (it even seems to work on IE10). You can test on <a href="http://mossroy.github.io/evopedia-html5/" target="_blank">this online page</a> or from a local copy of the <a href="https://github.com/mossroy/evopedia-html5" target="_blank">source code</a></li>
|
||||
<li>On Android, it does not seem to work for now (tried with internal browser, Chrome and Firefox) because you can not select all the files of an archive</li>
|
||||
<li>On Android and desktops, the DeviceStorage API (which is used to browse the SD-card for archives) should become available at some point (see <a href="https://wiki.mozilla.org/index.php?title=WebAPI" target="_blank"> https://wiki.mozilla.org/index.php?title=WebAPI</a>). As soon as it is, I will update the application to make it available on these platforms</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="configuration" style="display: none;">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"version": "1.0.0",
|
||||
"name": "Evopedia",
|
||||
"description": "Offline Wikipedia Viewer",
|
||||
"launch_path": "/index.html",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user