Difference between revisions of "IUP ISI/MediaWiki-Silk/Project vision"

Jump to: navigation, search
(formatting)
(reworded some parts)
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Problème ==
+
== libmediawiki ==
 +
 
 +
=== Problem statement ===
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! scope="row" | Le problème de
+
! scope="row" | The fact that
| l'intégration du contenu de Wikipedia sur le bureau et l'indisponibilité de son contenu hors-ligne
+
| there doesn't exist a Qt API for MediaWiki 
 
|-
 
|-
! scope="row" | affecte
+
! scope="row" | affects
| les développeurs et les utilisateurs de KDE.
+
| Qt and KDE developers, and their users,
 
|-
 
|-
! scope="row" | L'impact du problème est
+
! scope="row" | because
| que l'accès à Wikipedia dépend d'une connexion internet.
+
| the absence of readily available API discourages developers from building desktop tools for reading or editing MediaWiki-hosted content.
 
|-
 
|-
! scope="row" | Une solution réussie permettrait de
+
! scope="row" | A successful solution would
| pouvoir accéder au contenu de Wikipedia à partir de l'environnement KDE en étant connecté à internet ou hors-ligne.
+
| provide Qt developers with such a tool, therefore enabling and encouraging them to create new software based on it.
 
|}
 
|}
  
== Critères de succès ==
+
=== Success criteria ===
  
* Bibliothèque utilisable et utilisée.
+
* The library is usable and reused outside this project.
* Taux de satisfaction et d'utilisation élevés de la part des utilisateurs. (ex : nombre d'étoiles proche de 5)
 
  
== Position du produit ==
+
=== Product position ===
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! scope="row" | Pour
+
! scope="row" | For
| les utilisateurs et les développeurs de KDE
+
| Qt and KDE developers
 
|-
 
|-
! scope="row" | Qui
+
! scope="row" | who
| cherchent à utiliser de manière simplifié Wikipedia.
+
| want to build software that interacts with a MediaWiki website
 
|-
 
|-
! scope="row" | MediaWiki/Silk
+
! scope="row" | libmediawiki
| est une API ainsi qu'une ressource akonadi
+
| is a Qt API
 
|-
 
|-
! scope="row" | Qui
+
! scope="row" | that
| permet d'interfacer l'API MediaWiki en Qt, de synchroniser des pages Wikipedia afin de les utiliser en étant hors-ligne.
+
| allows to quickly and abstractly interface with a MediaWiki interface
 
|-
 
|-
! scope="row" | Mieux que
+
! scope="row" | in a better way than
| le navigateur internet.
+
| building a (different) interface from scratch each time.
 
|}
 
|}
  
== Rôles ==
+
=== Roles ===
 +
 
 +
* Qt & KDE developer
 +
 
 +
=== Features ===
 +
 
 +
See http://www.mediawiki.org/wiki/API for details.
 +
 
 +
{|
 +
|-
 +
! Name !! Priority !! Short description
 +
|-
 +
! scope="row" | Authentication API
 +
|
 +
| Login & logout
 +
|-
 +
! scope="row" | Query API
 +
|
 +
| Meta info, properties & lists
 +
|-
 +
! scope="row" | Parsing API
 +
|
 +
| Template expansion & rendering
 +
|-
 +
! scope="row" | Editing API
 +
|
 +
| Page creation, edition, move, watch
 +
|-
 +
! scope="row" | Maintenance API
 +
|
 +
| Deletion, protection, rollback, patrol
 +
|-
 +
! scope="row" | User API
 +
|
 +
| Block, e-mails, user rights
 +
|-
 +
! scope="row" | Uploading API
 +
|
 +
| File upload
 +
|}
  
* Développeur de KDE
+
== Wikimedia widgets ==
* Utilisateur de KDE
 
  
== Features ==
+
=== Problem statement ===
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Intitulé !! Priorité
+
! scope="row" | The fact that
 +
| a web browser is required to access information from Wikimedia websites
 
|-
 
|-
! scope="row" | Librairie libmediawiki
+
! scope="row" | affects
| *
+
| KDE users,
 
|-
 
|-
! scope="row" | Widget photo du jour
+
! scope="row" | because
| 12
+
| they have no way of quickly accessing Wikimedia information from the desktop.
 +
|-
 +
! scope="row" | A successful solution would
 +
| provide widgets to reach Wikimedia's services.
 +
|}
 +
 
 +
=== Success criteria ===
 +
 
 +
* Good mark (e.g. 4 stars)
 +
 
 +
=== Product position ===
 +
 
 +
{| class="wikitable"
 +
|-
 +
! scope="row" | For
 +
| users of the KDE desktop
 +
|-
 +
! scope="row" | who
 +
| wish to access bits of Wikipedia and other Wikimedia websites from their desktop,
 +
|-
 +
! scope="row" | Wikimedia widgets
 +
| are a suite of widgets/plasmoids
 +
|-
 +
! scope="row" | that
 +
| bring pieces of information from Wikipedia/Wikimedia to their desktop
 +
|-
 +
! scope="row" | in a better way than
 +
| the browser.
 +
|}
 +
 
 +
=== Roles ===
 +
 
 +
* KDE users
 +
 
 +
=== Features ===
 +
 
 +
{|
 +
|-
 +
! Name !! Priority !! Short description
 +
|-
 +
! scope="row" | Commons picture of the day
 +
|
 +
|
 +
|-
 +
! scope="row" | Wikipedia article of the day
 +
|
 +
| in multiple languages?
 +
|-
 +
! scope="row" | Wiktionary look-up
 +
|
 +
|
 +
|-
 +
! scope="row" | Watchlist RSS
 +
|
 +
|
 +
|-
 +
|}
 +
 
 +
== Mass file uploader ==
 +
 
 +
(name TBD)
 +
 
 +
=== Problem statement ===
 +
 
 +
{| class="wikitable"
 +
|-
 +
! scope="row" | The fact that
 +
| Wikimedia Commons doesn't provide an intuitive, fully-fledged and cross-platform mass file uploader
 +
|-
 +
! scope="row" | affects
 +
| the current and potential participants to Wikimedia Commons
 +
|-
 +
! scope="row" | because
 +
| contributing large amounts of media files is cumbersome.
 +
|-
 +
! scope="row" | A successful solution would
 +
| provide an easy way to mass upload media files from the desktop to Wikimedia Commons.
 +
|}
 +
 
 +
=== Success criteria ===
 +
 
 +
* The tool is well-received by the community of users.
 +
* The tool is downloaded by a large number of people.
 +
* A large number of media files are uploaded using the tool.
 +
 
 +
=== Product position ===
 +
 
 +
{| class="wikitable"
 +
|-
 +
! scope="row" | For
 +
| current and potential participants to Wikimedia Commons
 +
|-
 +
! scope="row" | who
 +
| want to contribute media files,
 +
|-
 +
! scope="row" | the mass file uploader
 +
| is a cross-platform Qt application
 +
|-
 +
! scope="row" | that
 +
| facilitates the upload of multiple files
 +
|-
 +
! scope="row" | in a better way than
 +
| [[:commons:Special:Upload|the web interface]], [[:commons:Commons:Tools/Commonist|Commonist]], [[:commons:User:Nichalp/Upload script|Nichalp's Upload Script]] and [[:metawikipedia:Pywikipediabot/upload.py|Pywikipediabot]].
 +
|}
 +
 
 +
=== Roles ===
 +
 
 +
* Wikimedia Commons participant
 +
 
 +
=== Features ===
 +
 
 +
{|
 +
|-
 +
! Name !! Priority !! Short description
 +
|-
 +
! scope="row" | Multilingual descriptions
 +
|
 +
|
 +
|-
 +
! scope="row" | Copyright terms
 +
|
 +
| Author, source, license
 +
|-
 +
! scope="row" | Specifics of Wikimedia Commons
 +
|
 +
| Mandatory fields, licenses and other templates
 +
|-
 +
! scope="row" | Prepopulation of fields
 +
|
 +
| Metadata extraction from EXIF, IPTC, XMP
 +
|-
 +
! scope="row" | Batch operations
 +
|
 +
| Ability to apply specific changes to a selection of files
 +
|-
 +
! scope="row" | User preferences
 +
|
 +
| Ability to customize and remember settings
 +
|-
 +
! scope="row" | Integration with KIPI plugins
 +
|
 +
|
 +
|-
 +
! scope="row" | Lossless rotation
 +
|
 +
|
 +
|-
 +
! scope="row" | Progress bar
 +
|
 +
|
 +
|-
 +
! scope="row" | Geolocation
 +
|
 +
| Ability to extract from EXIF and add template or hide for privacy
 +
|-
 +
! scope="row" |
 +
|
 +
|
 +
|-
 +
! scope="row" |
 +
|
 +
|
 +
|-
 +
! scope="row" |
 +
|
 +
|
 +
|-
 +
! scope="row" |
 +
|
 +
|
 +
|-
 +
! scope="row" |
 +
|
 +
|
 +
|-
 +
|}
 +
 
 +
== Wikimedia offline editor ==
 +
 
 +
=== Problem statement ===
 +
 
 +
{| class="wikitable"
 +
|-
 +
! scope="row" | The fact that
 +
| an Internet connection is required to edit Wikimedia websites
 +
|-
 +
! scope="row" | affects
 +
| current and potential participants to Wikimedia websites, including Wikipedia, who have limited, intermittent or no access to Internet
 +
|-
 +
! scope="row" | because
 +
| they can't share their knowledge
 +
|-
 +
! scope="row" | A successful solution would
 +
| provide a way to edit Wikimedia sites offline and synchronize the changes later.
 +
|}
 +
 
 +
=== Success criteria ===
 +
 
 +
* The product is downloaded, and used, by a large amount of users to edit Wikimedia and other Wikimedia sites offline.
 +
 
 +
=== Product position ===
 +
 
 +
{| class="wikitable"
 +
|-
 +
! scope="row" | For
 +
| current and potential participants to Wikimedia websites
 +
|-
 +
! scope="row" | who
 +
| have a limited, intermittent or no Internet connection
 +
|-
 +
! scope="row" | the Wikimedia offline editor
 +
| is a cross-platform Qt application
 +
|-
 +
! scope="row" | that
 +
| allows to edit Wikimedia content offline and synchronize the changes later
 +
|-
 +
! scope="row" | in a better way than
 +
| manual offline editing and synchronization.
 +
|}
 +
 
 +
=== Roles ===
 +
 
 +
* Wikipedia users
 +
 
 +
=== Features ===
 +
 
 +
{|
 
|-
 
|-
! scope="row" | Widget article du jour
+
! Name !! Priority !! Short description
| 7
 
 
|-
 
|-
! scope="row" | Widget Interrogation dictionnaires (Wiktionary)
+
! scope="row" |  
| 7
+
|  
 +
|
 
|-
 
|-
! scope="row" | Ressource akonadi
+
! scope="row" |  
| 17
+
|  
 +
|
 
|-
 
|-
! scope="row" | Outil de publication
 
| 12
 
 
|}
 
|}

Latest revision as of 18:04, 7 October 2010

libmediawiki

Problem statement

The fact that there doesn't exist a Qt API for MediaWiki
affects Qt and KDE developers, and their users,
because the absence of readily available API discourages developers from building desktop tools for reading or editing MediaWiki-hosted content.
A successful solution would provide Qt developers with such a tool, therefore enabling and encouraging them to create new software based on it.

Success criteria

  • The library is usable and reused outside this project.

Product position

For Qt and KDE developers
who want to build software that interacts with a MediaWiki website
libmediawiki is a Qt API
that allows to quickly and abstractly interface with a MediaWiki interface
in a better way than building a (different) interface from scratch each time.

Roles

  • Qt & KDE developer

Features

See http://www.mediawiki.org/wiki/API for details.

Name Priority Short description
Authentication API Login & logout
Query API Meta info, properties & lists
Parsing API Template expansion & rendering
Editing API Page creation, edition, move, watch
Maintenance API Deletion, protection, rollback, patrol
User API Block, e-mails, user rights
Uploading API File upload

Wikimedia widgets

Problem statement

The fact that a web browser is required to access information from Wikimedia websites
affects KDE users,
because they have no way of quickly accessing Wikimedia information from the desktop.
A successful solution would provide widgets to reach Wikimedia's services.

Success criteria

  • Good mark (e.g. 4 stars)

Product position

For users of the KDE desktop
who wish to access bits of Wikipedia and other Wikimedia websites from their desktop,
Wikimedia widgets are a suite of widgets/plasmoids
that bring pieces of information from Wikipedia/Wikimedia to their desktop
in a better way than the browser.

Roles

  • KDE users

Features

Name Priority Short description
Commons picture of the day
Wikipedia article of the day in multiple languages?
Wiktionary look-up
Watchlist RSS

Mass file uploader

(name TBD)

Problem statement

The fact that Wikimedia Commons doesn't provide an intuitive, fully-fledged and cross-platform mass file uploader
affects the current and potential participants to Wikimedia Commons
because contributing large amounts of media files is cumbersome.
A successful solution would provide an easy way to mass upload media files from the desktop to Wikimedia Commons.

Success criteria

  • The tool is well-received by the community of users.
  • The tool is downloaded by a large number of people.
  • A large number of media files are uploaded using the tool.

Product position

For current and potential participants to Wikimedia Commons
who want to contribute media files,
the mass file uploader is a cross-platform Qt application
that facilitates the upload of multiple files
in a better way than the web interface, Commonist, Nichalp's Upload Script and Pywikipediabot.

Roles

  • Wikimedia Commons participant

Features

Name Priority Short description
Multilingual descriptions
Copyright terms Author, source, license
Specifics of Wikimedia Commons Mandatory fields, licenses and other templates
Prepopulation of fields Metadata extraction from EXIF, IPTC, XMP
Batch operations Ability to apply specific changes to a selection of files
User preferences Ability to customize and remember settings
Integration with KIPI plugins
Lossless rotation
Progress bar
Geolocation Ability to extract from EXIF and add template or hide for privacy

Wikimedia offline editor

Problem statement

The fact that an Internet connection is required to edit Wikimedia websites
affects current and potential participants to Wikimedia websites, including Wikipedia, who have limited, intermittent or no access to Internet
because they can't share their knowledge
A successful solution would provide a way to edit Wikimedia sites offline and synchronize the changes later.

Success criteria

  • The product is downloaded, and used, by a large amount of users to edit Wikimedia and other Wikimedia sites offline.

Product position

For current and potential participants to Wikimedia websites
who have a limited, intermittent or no Internet connection
the Wikimedia offline editor is a cross-platform Qt application
that allows to edit Wikimedia content offline and synchronize the changes later
in a better way than manual offline editing and synchronization.

Roles

  • Wikipedia users

Features

Name Priority Short description

This page was last edited on 7 October 2010, at 18:04. Content is available under Creative Commons License SA 4.0 unless otherwise noted.