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

Jump to: navigation, search
(Position du produit)
(separating projects and products to allow for better specificity and avoid mixing unrelated sections)
Line 1: Line 1:
== Problème ==
+
== libmediawiki ==
 +
 
 +
=== Problem statement ===
 +
 
 +
{| class="wikitable"
 +
|-
 +
! scope="row" | The fact that
 +
| there doesn't exist a Qt API for MediaWiki 
 +
|-
 +
! scope="row" | affects
 +
| Qt and KDE developers, and their users,
 +
|-
 +
! scope="row" | because
 +
| the absence of readily available API discourages developers from building desktop tools for reading or editing MediaWiki-hosted content.
 +
|-
 +
! scope="row" | 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 ===
 +
 
 +
{| class="wikitable"
 +
|-
 +
! scope="row" | For
 +
| Qt and KDE developers
 +
|-
 +
! scope="row" | who
 +
| want to build software that interacts with a MediaWiki website
 +
|-
 +
! scope="row" | libmediawiki
 +
| is a Qt API and an akonadi resource
 +
|-
 +
! scope="row" | that
 +
| allows to quickly and abstractly interface with a MediaWiki interface
 +
|-
 +
! scope="row" | 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
 +
|-
 +
! 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
 +
|-
 +
! scope="row" | Akonadi resource
 +
|
 +
| ?
 +
|}
 +
 
 +
== Widgets / plasmoids ==
 +
 
 +
== Mass file uploader ==
 +
 
 +
== Offline editor ==
 +
 
 +
== Original page ==
 +
 
 +
=== Problem statement ===
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 16: Line 112:
 
|}
 
|}
  
== Critères de succès ==
+
=== Critères de succès ===
  
 
* Bibliothèque utilisable et utilisée.
 
* Bibliothèque utilisable et utilisée.
 
* Taux de satisfaction et d'utilisation élevés de la part des utilisateurs. (ex : nombre d'étoiles proche de 5)
 
* Taux de satisfaction et d'utilisation élevés de la part des utilisateurs. (ex : nombre d'étoiles proche de 5)
  
== Position du produit ==
+
=== Position du produit ===
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 41: Line 137:
 
|}
 
|}
  
== Rôles ==
+
=== Rôles ===
  
 
* Développeur
 
* Développeur
Line 47: Line 143:
 
* Utilisateur KDE
 
* Utilisateur KDE
  
== Features ==
+
=== Features ===
  
 
{|
 
{|

Revision as of 18:02, 1 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 and an akonadi resource
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
Akonadi resource ?

Widgets / plasmoids

Mass file uploader

Offline editor

Original page

Problem statement

Le problème de l'accès à Wikipedia, dépendant d'une connexion internet et d'un navigateur,
affecte les développeurs et les utilisateurs.
L'impact du problème est que les utilisateurs ne peuvent pas avoir le contenu de Wikipedia sur le bureau et que s'il n'ont pas de connexion, le contenu de Wikipedia est indisponible.
Une solution réussie permettrait de pouvoir accéder au contenu de Wikipedia à partir de l'environnement KDE en étant connecté à internet ou hors-ligne.

Critères de succès

  • Bibliothèque utilisable et utilisée.
  • Taux de satisfaction et d'utilisation élevés de la part des utilisateurs. (ex : nombre d'étoiles proche de 5)

Position du produit

Pour les utilisateurs et les développeurs
Qui cherchent à utiliser de manière simplifié Wikipedia.
MediaWiki/Silk est une API ainsi qu'une ressource akonadi
Qui permet d'interfacer l'API MediaWiki en Qt, de synchroniser des pages Wikipedia afin de les utiliser en étant hors-ligne.
Mieux que le navigateur internet.

Rôles

  • Développeur
  • Utilisateur
  • Utilisateur KDE

Features

Intitulé Priorité
Bibliothèque libmediawiki *
Widget photo du jour 12
Widget article du jour 7
Widget Interrogation dictionnaires (Wiktionary) 7
Ressource akonadi 17
Outil de publication 12

Content is available under Creative Commons License SA 4.0 unless otherwise noted.