Aide MHK

From wikilab
Jump to: navigation, search

Contents

Création d'une page Projet

Assurez-vous d'abord d'avoir un compte créé sur ce wiki et d'avoir demandé les droits d'écriture à un responsable du Humanlab :)

Méthode simplifiée à privilégier

  1. créer la page en ajoutant le nom du projet dans la zone de texte puis cliquer sur le bouton pour valider. Ne jamais laisser d'espace dans le nom du projet, il faut les remplacer par des underscores (ou tirets du bas)
  2. Cette page sera créé automatiquement avec un modèle regroupant toutes les informations à remplir pour constituer une documentation complète
  3. Valider la création en cliquant sur "Enregistrer" en bas de la page"


Méthode standard (sans l'usage du plugin InputBox)

Pour créer une page, il suffit de copier l'URL (dans la barrre d'adresse du navigateur) d'une page de projet existant et de remplacer le nom du projet par le nom du nouveau projet. Par exemple :

http://wikilab.myhumankit.org/index.php?title=Projets:Nom_du_projet

Appuyer sur la touche Entrée et cliquer sur Créer (en haut à droite de la page).

Important :

  • ne jamais laisser d'espace dans le nom du projet, il faut les remplacer par des underscores (ou tirets du bas)


Afin d'avoir une trame de documentation ajouter simplement cette ligne dans la page :

{{subst:Projet}}

Aller ensuite en bas de la page pour appuyer sur le bouton "enregistrer".

Votre page est maintenant créée avec les principaux titres de chapitres. Vous pouvez ajouter du contenu en appuyant sur le bouton "modifier" pour chacun d'eux.

Catégories

Les catégories sont très importantes pour indexer les projets afin qu'ils soient référencés sur les pages concernées. Autrement il sera impossible d'accéder à votre page.

Pour qu'une page soit classée dans une catégorie, il suffit de l'ajouter en bas de la page.

[[Category:Projets]]

Votre page sera ainsi indexée dans cette catégorie. Une même page peut appartenir à plusieurs catégories.

Tous les pages projets doivent contenir 3 catégories qu'il faut toujours laisser en bas de page.

  • Le type de page : Projets ou Ressources (espace en général réservé à l'édition aux fabmanagers ou aux utilisateurs avancés)
  • L'état d'avancement du projet: Concept, En_cours, Réalisés ET Tutoriels quand le projet est terminé et documenté de manière claire
  • La typologie de handicap : Mobilité, Malvoyance, Surdité, Membre supérieur, Autisme, Autre


  • la catégorie "Projets"
[[Category:Projets]]
  • la catégorie qui indique l'état d'avancement du projet
[[Category:Concept]]
[[Category:En cours]]
[[Category:Réalisés]]
[[Category:Tutoriels]]
  • la catégorie qui indique la typologie de handicap pour ce projet
[[Category:Autisme]]
[[Category:Mobilité]]
[[Category:Malvoyance]]
[[Category:Surdité]]
[[Category:Autre]]

Assigner votre page projet à des catégories

Tous les projets doivent contenir 3 catégories qu'il faut toujours laisser en bas de page.

  • Le type de page : Projets ou Ressources
  • La typologie de handicap : Mobilité, Malvoyance, Surdité, Membre supérieur, Autisme, Autre
  • L'état d'avancement du projet: Concept, En_cours, Réalisés

Ces catégories vont nous permettre de retrouver les pages grâce aux rubriques du menu. Elles sont donc très importantes, car en cas d'oubli la page ne sera référencée dans aucun des menus.

Par défaut lorsque nous générons la structure de la page, la catégorie Projets est automatiquement intégrée. Vous devriez voir en bas de page:

[[Category:Projets]] 

Il reste alors deux catégories à ajouter :

  • La typologie de handicap, à choisir entre : Mobilité, Malvoyance, Surdité, Membre supérieur, Autisme, Autre

Par exemple:

 [[Category:Malvoyance]] 
  • L'état d'avancement du projet : Concept,En cours, Réalisés

Ajouter la catégorie correspondante. ne pas oublier de modifier cette catégorie quand l'état d'avancement du projet change. Par exemple :

[[Category:Réalisés]]

Documentation type d'un projet

Voici les éléments principaux requis pour la documentation de projets une fois votre page créée. Ce modèle est automatiquement intégré lorsque vous créez la page avec la méthode simplifiée.

Attention pour que votre page apparaisse dans les rubriques des menus, assurez-vous de toujours garder en bas de page les catégories.

  • Description du projet (quel est l'objectif du projet, à quel besoin il répond?)
  • Cahier des charges prenant en compte la faisabilité / les contraintes
  • Analyse de l'existant (liens vers des systèmes existants et dire en quoi l'existant ne répond pas au besoin : trop cher, pas adapté etc ...)
  • Durée totale réelle de la fabrication du prototype
  • Équipe (Ajouter le porteur de projet et les contributeurs)
  • Matériel nécessaire
  • Outils nécessaires
  • Compétences/techniques nécessaires
  • Coût avec le plus de détails possible élément par élément (et sourcer les fournisseurs de préférence)
  • Documenter tout le processus de création étape par étape, en uploadant les fichiers sources
  • Journal de bord : le journal de bord permet de suivre les avancées du projet, à chaque nouveau rendez-vous on écrit un petit compte-rendu, et on ajoute les fichiers source (dessins 2D, 3D, code etc ..)
  • Intégrer la ou les catégories auxquels le projet appartient. Tous les projets appartiennent à la catégorie Projets. Pour l'affilier il suffit d'intégrer en bas de page cette ligne.
[[Category:Projets]]
  • Spécifier l'état d'avancement du projet (Concept,En cours, Réalisé): Ajouter la catégorie correspondante en fin de page. ne pas oublier de modifier cette catégorie quand l'état d'avancement du projet change.
[[Category:En cours]]
  • Modèle de page :

Pour créer une page basée sur le modèle type de documentation de projet, insérer dans la page

{{subst:Projet}} 

Tout les chapitres seront créés automatiquement avec un sommaire associé

Introduction pour comprendre la documentation suivante concernant la mise en page

Cette page permet de visualiser les bases de la syntaxe pour intégrer du texte, des médias (images et autres types de fichiers comme des pdf, zip etc) et liens dans une page. Elle est structurée de la façon suivante:le rendu et en dessous le code utilisé que l'on voit dans un encart.

Dans cet exemple on utilise le symbole "===" au début et à la fin du texte que l'on souhaite afficher comme un titre.

Rendu du wikicode appliqué au texte ou à l'image

=== Rendu du wikicode appliqué au texte ou à l'image === 

Création d'un encart souvent utilisé pour documenter du code

La création des encarts se fait simplement en laissant un espace en début de ligne.

Ici ma phrase commence par un espace en début de ligne pour que mon texte  apparaisse dans un encart

Titre de chapitre : Niveau 2

Il y a 6 niveaux de titre. Le niveau 1 n'est pas listé car il correspond au titre de la page. Donc, ne pas utiliser un seul signe "=" pour un titre.

==Titre de chapitre : Niveau 2== 

Sous-titre : Niveau 3

===Sous-titre : Niveau 3=== 

Sous sous-titre : Niveau 4

 ====Sous sous-titre : Niveau 4====
Sous sous sous-titre : Niveau 5
=====Sous sous sous-titre : Niveau 5=====
Sous sous sous sous-titre: Niveau 6
======Sous sous sous sous-titre: Niveau 6======

Faire des listes

Liste à puces

Une liste à puce se fait en ajoutant un astérisque devant le mot.

Plus vous mettez d'astérisques, plus il y a de sous niveaux

  • Item principal
*Item principal 
    • Sous item
 **Sous item 
      • Sous sous item
***Sous sous item 

Plus vous mettez d'astérisques, plus il y a de sous niveaux

Liste numérotées

  1. pomme
  2. poire
  3. cerise


#pomme
#poire
#cerise
 

Formatage texte

  • texte en italique
''texte en italique''
  • texte en gras
'''texte en gras'''
  • texte en gras et italique
'''''texte en gras et italique'''''
  • souligner
<u>souligner</u>
  • Revenir à la ligne

Pour revenir à la ligne, il faut sauter une ligne.

Liens

Documentation complète sur les [liens]

Insérer un lien interne

Lien interne avec nom de la page comme nom de lien

Main Page

[[Main Page]]

Lien interne avec nom autre que celui de la page

Lien vers la page principale

[[Main Page|Lien vers la page principale]]

Insérer un lien vers un média

[[Media:nom_du_media.extension|Nom_du_lien]]

Télécharger

[[Media:Calculs-Francis.pdf|'''Télécharger''']]

Lien vers titre de section

Un lien vers une section précise d’un article sera rédigé ainsi :

[[article#section de l'article|lien à afficher]]

Exemple:

Retour vers le début du chapitre Liens

[[Exemple:Exemple-de-page#Liens|Retour vers le début du chapitre Liens]]

Insérer un lien externe

Toutes les infos sur les liens externes ici

Exemple de redirection vers une URL avec visibilité de l'adresse URL:

Article sur http://myhumankit.org/


Exemple de redirection vers une URL cachée derrière un nom de lien :

Myhumankit

[url nom_du_lien]

Intégrer des images

L'intégration d'une image dans une page se passe en trois temps :

  1. Redimensionner la ou les image(s) (800px de large est une bonne valeur)
  2. Importer l'image sur le serveur du wiki
  3. Intégrer l'image dans la page

Redimensionner une image

Sur linux installer Nautilus image converter

Ou en ligne de commande pour redimensionner sous Linux avec Imagemagick : méthode rapide et efficace

Installer Imagemagick si ce n'est pas déjà fait en tapant la ligne de commande suivante dans le terminal

   sudo apt-get install imagemagick

Copier ensuite le dossier des images que vous souhaitez redimensionner

   sudo cp /chemin/vers/le/dossier/mesimages chemin/vers/le/nouveau/dossier/mesimagesOK

Aller dans le dossier mes images OK

   cd /chemin/vers/le/nouveau/dossier/mesimagesOK

Redimensionner la largeur en respectant la proportion en hauteur. ici, 512 px = la largeur

   mogrify -resize 512x *.jpg

Si le redimensionnement ne suffit pas voici la commande pour baisser la qualité

   mogrify -quality 80 *.jpg

Si cela ne fonctionne pas, vérifiez que vous êtes bien dans le dossier de vos images à traiter et vérifier l'extension, parfois l'extension est en majuscule (.JPG)

Quelques liens utiles d'autres fonctionalités de traitement d'image avec Imagemagick:

https://www.howtogeek.com/109369/how-to-quickly-resize-convert-modify-images-from-the-linux-terminal/

https://www.imagemagick.org/script/mogrify.php

Redimensionner une image avec le programme Gimp (équivalent libre de Photoshop) : méthode visuelle pour les frileux de la ligne de commande

Télécharger et installer Gimp pour votre OS (Windows, MAc, ou Linux)

https://www.gimp.org/downloads/

Ouvrir votre image avec Gimp, puis ajuster la taille de l'image dans l'onglet :

Image > Echelle et taille de l'image

Choisir 800 px de large et appuyer sur entrée pour que la hauteur soit changée propotionnellement automatiquement. (Appuyer sur le cadenas pour verrouiller la hauteur et largeur afin de garder les proportions si ce n'est pas déjà le cas)

Si l'image est trop lourde baisser la résolution dans ce même onglet à 72px

Importer des images

Les images doivent être redimensionnées avec une largeur max recommandée de 800 px et un poids max de 100 ko avant d'être importées sinon elles vont rapidement saturer le wiki :)

Méthode simple avec le plugin qui facilite l'import d'images

  • Depuis un dossier sur votre ordinateur, faire glisser l'image ou les images dans le bandeau bleu "Glisser les fichiers"
  • Téléverser fichier

Televerser fichier.png

  • Placer le curseur à l'emplacement voulu et cliquer sur "Insérer en tant qu'image"

Inserer en-tant-quimage.png

  • Vous devriez avoir un texte de ce type apparaitre

Image inseree.png

  • Enregistrer la page et vérifier que l'image est intégrée

Méthode classique (avant l'ajout du plugin qui facilite l'import d'images)

Pour insérer une image, il faut d'abord la téléverser sur le serveur du wikilab.

Aller dans le menu à gauche Outils>Importer un fichier>Parcourir (en anglais: Tools>Upload file, et descendre en bas de la page pour valider, cliquer sur "Importer (ou upload en anglais)

En haut de la page apparait le nom de fichier sous le format suivant

File:NomImage.JPG

Copier ce nom pour l'intégrer ensuite dans la page avec le code qui vous convient (voir chapitres suivants)


Intégrer une image dans une page

Documentation complète [ici]

Légende


 [[File:Ampoule-e27.jpeg|thumb|left|Légende]]


Ampoule-e27.jpeg

[[File:Ampoule-e27.jpeg|200px]]

Alignement image

Alignement à gauche

Ampoule-e27.jpeg


[[File:Ampoule-e27.jpeg|left|100px]]


Alignement au centre

Ampoule-e27.jpeg


[[File:Ampoule-e27.jpeg|center|100px]]


Alignement à droite

Ampoule-e27.jpeg


[[File:Ampoule-e27.jpeg|right|100px]]

Insérer une galerie d'images

Toutes les infos sur les galeries ici

Exemple:

<gallery mode="slideshow">
File:nomImage1.extension|Légende
File:nomImage2.extension|Légende
File:nomImage3.extension|Légende
File:nomImage4.extension|Légende
File:nomImage5.extension|Légende
</gallery>

Insérer une image dans un encart

[[File:titre du fichier.jpeg|thumb|left|Titre de la légende]]


Ampoule fluocompact carrée à vis



Forcer le texte à apparaitre sous une image

Pour que le texte apparaisse sous l'image, écrire cette balise après l'image :

<br clear=all>

Retrouver les images importées

Pour retrouver les images que vous venez d'importer sur le wiki, il vous suffit de cliquer sur le lien suivant :

http://wikilab.myhumankit.org/index.php?title=Special:ListFiles

OU de passer par le menu à gauche>Pages spéciales>Liste des fichiers

Catégories

Les catégories sont très importantes pour indexer les projets afin qu'ils soient référencés sur les pages concernées. Autrement il sera impossible d'accéder à votre page.

Pour qu'une page soit classée dans une catégorie, il suffit de l'ajouter en bas de la page.

[[Category:Projets]]

Votre page sera ainsi indexée dans cette catégorie. Une même page peut appartenir à plusieurs catégories.

Toutes les pages "projets" devraient contenir :

  • la catégorie "Projets"
[[Category:Projets]]
  • la catégorie qui indique l'état d'avancement du projet
[[Category:Concept]]
[[Category:En cours]]
[[Category:Réalisés]]
  • la catégorie qui indique la typologie de handicap pour ce projet
[[Category:Autisme]]
[[Category:Mobilité]]
[[Category:Malvoyance]]
[[Category:Surdité]]
[[Category:Autre]]

Créer un tableau

https://fr.wikipedia.org/wiki/Aide:Ins%C3%A9rer_un_tableau_(wikicode,_avanc%C3%A9)

Créer une nouvelle entrée dans le menu de gauche (sidebar)

Entrer cet url et l'éditer : http://wikilab.myhumankit.org/index.php?title=MediaWiki:Sidebar

Débuter sur mediawiki :ressources externes

A lire !

https://fr.wikibooks.org/wiki/MediaWiki_pour_d%C3%A9butants/Premi%C3%A8re_utilisation_de_votre_wiki

Autres ressources

Formater le texte et placer les images

https://www.mediawiki.org/wiki/Help:Formatting/fr

https://fr.wikipedia.org/wiki/Aide:Syntaxe_(wikicode)

https://fr.wikipedia.org/wiki/Aide:Ins%C3%A9rer_une_image_(wikicode,_avanc%C3%A9)

Article, sommaire

https://fr.wikipedia.org/wiki/Mod%C3%A8le:Article_d%C3%A9taill%C3%A9

https://fr.wikipedia.org/wiki/Aide:Sommaire