Wiki

Recherche

Édition

Navigation

Guide de rédaction d'un article sur le Wiki

Organisation des pages

Un article nommé « Madoc » a été créé à la racine du Wiki, accessible à l’adresse « wiki.univ-nantes.fr/madoc ». Il fait office de portail et redirige vers les différents articles concernant Madoc. Un dossier Madoc a été créé à la racine du Wiki pour contenir tous les articles concernant Madoc. Chaque article est nommé suivant les titres indiqués dans le catalogue, précédé d’un nombre à incrémenter pour les nouveaux articles à venir. Exemple de nom d’article : 2-adapter_son_tableau_de_bord

Création d’un nouvel article

Vérifications préalables

  • Vérifier l’existence ou non de l’article sur le wiki pour éviter les doublons.
  • Vérifier si le sujet est traité dans la documentation officielle de Moodle : si oui, est-ce que l’ajout dans le Wiki apporte une plus-value ? (adaptation à un contexte spécifique, captures d'écran).

Marche à suivre

  1. Se connecter sur wiki.univ-nantes.fr
  2. Saisir l’adresse souhaitée du nouvel article sur le modèle https://wiki.univ-nantes.fr/madoc:XX-NOM_ARTICLE
    Le nom de l’article doit être précédé d’un numéro (incrémenté depuis l’index des articles madoc) + un tiret + le titre de l’article
  3. Une fois l’article rédigé, mettre à jour son statut dans le catalogue

Rédaction

Un modèle d’article est proposé pour être cohérent sur la forme. Vous pouvez en copier-coller le contenu dans le nouvel article puis le modifier, ou créer votre nouvel article en respectant rigoureusement la mise en forme du modèle. Voici quelques règles à respecter :

  • Structurer l'article avec les styles de titre : les titres de nivreau 5 et 4 apparaîtront dans la table des matières en haut à droite et permettront au lecteur de naviguer plus facilement dans l'article. Vérifier que les titres concernés sont pertinents au regard des besoins des utilisateurs.
  • Les articles devront être rédigés à l’infinitif (Exemple : cliquer sur le lien et pas cliquez sur le lien). D’autres modes de conjugaison peuvent être utilisés si nécessaire mais il faut éviter l’infinitif.
  • Utiliser des chevrons pour séparer les différentes étapes de navigation dans un menu (exemple : Menu de gestion du cours > Utilisateurs > Méthodes d'inscription).
  • Mettre l’intitulé des boutons/liens en gras (Exemple : bouton Enregistrer).

Concernant les illustrations et documents utilisés dans les articles

La création

Logiciels conseillés :

  • Pour les capture d’écran : Greenshot (Windows). Choisir de préférence un outil qui permette d’ajouter un bord noir d’un pixel autour de l’image et des légendes dans l'image.
  • Pour les GIF animés : ScreenToGif
  • Pour les vidéos : l’outil de capture intégré dans Mediaserver, ou OBS (Cf. guide OBS).

Le stockage

Les captures d’écran et documents utilisés dans les articles devront être stockés au même emplacement que l’article concerné. Si vous copier-coller vos images directement dans un article, l'emplacement du stockage sera automatiquemen déterminé. Les contenus iconographiques pouvant être mutualisés entre plusieurs articles sont stockés dans différents dossiers du répertoire « madoc » du Gestionnaire Multimédia » :

  • Dossier « icones » : les icônes de Madoc pouvant être réutilisés dans un article (exemple : icône d’acton, icône d’activités, etc.).
  • Dossier « boutons » : les image de bouton Madoc pouvant être réutilisés dans un article (exemple : le bouton du mode édition).
  • Dossier « documents » : les documents texte (exemple : la charte informatique de l’université).
  • Dossier « numeros » : des numéros sous forme d’image pouvant être utilisés pour faire référence aux légendes d'une capture d’écran.
  • Dossier « icones-bloc » : les icônes à utiliser dans les blocs « Note, Astuce Attention et Important).

Pour les vidéos, il est préférable de les stocker sur le Mediaserver.

Le nommage

Pour les fichiers spécifiques à un article, le nom de fichier devra comporter le numéro de l’article dans lequel il est utilisé (exemple : 5-menu_format_cours.png).

L’insertion des vidéos

Les vidéos : les intégrer à l’aide d’un iframe avec le code suivant : <html><iframe width="720" height="530" src="ADRESSE URL" allowfullscreen="allowfullscreen" allow="autoplay"></iframe></html>

L’insertion des images

Vous pouvez insérer des images par un simple copier-coller. Le formats compatibles : gif, jpg, png. Une fosi votre image insérée, le code doit ressembler à ça : {{:madoc:numeros:2.png?nolink&30|}}

  • La mention « nolink » indique que l’image n’est pas cliquable
  • Le nombre désigné la largeur de l’image en pixel

Validation et diffusion d’un article

A la fin de la rédaction/modification de l’article, faire relire l’article si besoin. Si l'article est validé, ajouté le code suivant en haut de page : <code>Cet article a été validé le JJ/MM/AAAA</code>

Suppression d’un article

Préalable

Vérifier si la page à supprimer est la cible d’autres pages du Wiki en ajoutant « ?do=backlink » à l’URL de la page à supprimer :

  • Si la page est orpheline la suppression ne posera pas de problème.
  • Si la page n’est pas orpheline, il faudra supprimer/modifier les liens contenus dans les autres pages qui dirigent vers la page à supprimer.
Marche à suivre
  1. Se connecter sur wiki.univ-nantes.fr
  2. Accéder à la page à supprimer
  3. Cliquer sur le lien « Modifier cette page » situé dans le menu de gauche
  4. Effacer tout le contenu
  5. Cliquer sur le bouton « Enregistrer »
 
madoc/guide_redaction.txt · Dernière modification: 2024/02/20 12:14 de aubert-d
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki