CIRAD  SIST o Module WIKI

CIRAD

 SIST

o Module WIKI

Manuel d’utilisation : Module Wiki

Février 2007

Ref. [Référence document]

Documentation du module WiKI Page 2 sur 13 Historique des versions du document

Version / Date Auteur Commentaire Date de validation / Approbateur V0.0.1 09/01/2005 O. DOUARCHE Création

V1.0 25/01/2006 C.CHAMBERLIN Relecture

Documentation du module WiKI Page 3 sur 13

Sommaire

1 PRÉAMBULE...4

1.1 OBJECTIFSDUDOCUMENT...4

1.2 PRÉREQUIS TECHNIQUE...4

2 PRÉSENTATION...5

3 FONCTIONNALITÉS...6

3.1 MENU : ACCUEIL...6

3.2 MENU : TOUTESLESPAGES...6

3.3 MENU : S’IDENTIFIER... 7

3.4 MENU : RECHERCHE... 8

3.5 MENU : AIDE... 9

3.6 EDITIOND’UN WIKI... 10

3.7 HISTORIQUES DESMODIFICATIONS...11

4 ADMINISTRATION...13

Documentation du module WiKI Page 4 sur 13

1 P RÉAMBULE

1.1 O

Ce document à pour but de décrire l’utilisation du module Wiki.

Il spécifie la façon de procéder pour créer les différentes pages wiki.

1.2 P

T

Le module Wiki fonctionne dans l’environnement suivant - PHP v4.3 et supérieure,

- Base MySQL v3.23 et supérieure,

- Nécessite le dossier Commun au même niveau que le répertoire du module.

Documentation du module WiKI Page 5 sur 13

2 P RÉSENTATION

Un Wiki est un outil de communication (comme peuvent l’être les forums) qui permet à tous les visiteurs de créer ou d’enrichir le contenu d’une page Web.

Cet outil permet de diffuser et de structurer l’information afin de pouvoir y naviguer aux moyens de liens réalisés à partir de « Mot Wiki ».

Un mot Wiki est un mot qui contient au minimum deux lettres capitales.

Les textes rédigés dans le cadre d’un Wiki peuvent comporter des raccourcis typographiques afin de procéder à la mise en forme de certains mots, phrases ou paragraphes.

Voici un exemple d’écran d’un article contenant un Wiki :

Ce module n’a pas de partie d’administration. Toutes les opérations sont donc effectuées sur la partie publique du site.

Documentation du module WiKI Page 6 sur 13

3 F ONCTIONNALITÉS 3.1 M

: A

La page d’accueil est la page racine de l’arborescence des pages Wiki du Wiki courant.

Le module Wiki est composé d’un menu comportant plusieurs rubriques : - Accueil

o Cette rubrique permet de revenir sur la page d’accueil du Wiki, c'est-à-dire sur la page racine.

- Toutes les pages

o Permet d’afficher l’ensemble des pages réalisées dans le Wiki.

- S’identifier

o Par défaut l’utilisateur est identifié via son adresse IP, cette rubrique permet de l’identifier par son pseudo.

- Recherche

o Cette rubrique permet de rechercher un critère dans l’ensemble des pages Wiki déjà créées.

- Aide

o Cette rubrique affiche la liste des raccourcis typographiques gérés par le module Wiki pour mettre en forme les textes.

3.2 M

: T

Le menu « Toute les pages » permet d’afficher l’ensemble des pages Wiki qui ont été rédigées.

Menu Informations sur

l’internaute Titre de la page

Contenu de la page Commande

d’édition Information

sur la version de la page

Documentation du module WiKI Page 7 sur 13

3.3 M

: S’

Par défaut, l’utilisateur est identifié par son adresse IP. Cette page lui laisse donc la possibilité de s’identifier par un nom. Une adresse email doit être saisie pour pouvoir obtenir un compte Wiki.

3.3.1 Création d’un nouveau compte

Les comptes créés dans le Wiki sont indépendants des comptes créés dans l’administration du framework.

Pour créer un nouveau compte, il suffit de renseigner : - Votre nom

- Votre mot de passe

- La confirmation de votre mot de passe - Votre adresse de messagerie

Une fois les champs renseignés, il suffit de cliquer sur le bouton « Créer un nouveau compte ».

3.3.2 S’identifier

Pour s’identifier, il suffit de renseigner le champ : - Votre nom

- Votre mot de passe

Puis de cliquer sur le bouton « S’identifier ».

Si l’identification a réussi, dans les informations de l’internaute située en haut à droite, l’adresse IP est remplacée par le nom de la personne.

3.3.3 Retrouver son mot de passe

Pour retrouver son mot de passe, il suffit de renseigner le champ : - Votre nom

Documentation du module WiKI Page 8 sur 13

Puis de cliquer sur le bouton « Retrouver mon mot de passe ».

Une email sera alors envoyé à l’adresse de messagerie associé au nom spécifié avec les paramètres d’accès au Wiki.

3.4 M

: R

La page de recherche permet d’effectuer une interrogation « plein texte » sur l’ensemble des pages Wiki réalisées.

Pour réaliser une recherche, il suffit de renseigner : - Le mot(s) à rechercher

Plusieurs mots séparés par des espaces peuvent être saisis, une recherche ET sera alors effectuées sur l’ensemble des mots.

Le résultat d’une recherche présente l’ensemble des pages Wiki satisfaisant les critères renseignés.

Documentation du module WiKI Page 9 sur 13

3.5 M

: A

La page d’aide liste les raccourcis typographiques disponibles dans l’éditeur pour la mise en forme du texte.

Documentation du module WiKI Page 10 sur 13

3.6 E

’

W

Pour éditer une page Wiki, il suffit de cliquer sur le bouton « Editer » présent sur chacune d’entres elles.

Pour enregistrer les modifications, il faut passer préalablement par une étape de confirmation en cliquant sur le bouton « Visualiser ».

Documentation du module WiKI Page 11 sur 13

Pour valider les modifications, il suffit alors de cliquer sur le bouton « Enregistrer » ou de revenir en édition avec le bouton « Annuler ».

3.7 H

Pour visualiser l’historique des modifications d’une page Wiki, il suffit de cliquer sur le lien

« l’historique des modifications » situé en bas à droite de chacune d’entres elles.

Une page s’affiche avec la liste des versions pour une page Wiki donnée.

Dans le cas où l’utilisateur est le créateur de la page Wiki (celui qui est à l’origine de la première version), des boutons supplémentaires apparaîssent en face de chacune des versions permettant de « Revenir à cette version » :

Documentation du module WiKI Page 12 sur 13 En cliquant sur le bouton « Revenir à cette version », toutes les versions ultérieures de la page courante seront supprimées de telle sorte que la version associée au bouton d’action devienne la version courante.

En choisissant deux versions grâce aux boutons radio, on peut également voir les différences qui existent entre ces versions en cliquant sur le bouton « Voir les différences »

Documentation du module WiKI Page 13 sur 13

4 A DMINISTRATION

Ce composant n’a pas de d’interface d’administration dans le back-office du framework.