Aide MHK

De wikilab

Cette page résume les fonctions d'édition principales. Pour toute information complémentaire, consulter l'aide officielle qui est complète : Lien vers l'aide à l'édition d'un Mediawiki

Création d'une page : Projet, Tutoriel ou support pédagogique

Voir cette page : Contribuer à la documentation

Informations à remplir dans le formulaire

Le formulaire contient toutes les informations qui résument le projet et qui apparaîtront dans l'infobox, l'encart en haut à droite de la page .


L'image d'en-tête doit être au format paysage ( horizontal) pour éviter une déformation des proportions quand elle est visualisée dans les galeries de projets et doit être redimensionnée de manière à ce que son poids soit inférieur à 200Ko.


Pour les champs suivants: Porteur de projet, Contributeur, Fabmanager, Animateur, utiliser le nom d'utilisateur de la personne sur le wiki (pour celles qui ont un compte)


Une fois les informations remplies, cliquer sur enregistrer en bas du formulaire

Bouton Enregistrer en bas du formulaire
Bouton Enregistrer en bas du formulaire


Documentation type d'un projet

Le modèle de documentation d'une page Projet est automatiquement généré à la création de la page. Celui-ci contient toutes les sections que doit contenir la documentation. A vous de les remplir au fur et à mesure de l'évolution du projet.

Il existe deux onglets pour une page Projet :

  • Onglet "Projets" :c'est celui où vous êtes par défaut
  • Onglet "Journal de bord" : au départ le lien est rouge car la page n'est pas créée. C'est à vous de le faire en cliquant simplement dessus en cas de besoin.

Onglet Projets

L'onglet Projets contient la documentation finale du projet nécessaire à sa réplication. Au début du projet on remplit seulement les trois premières sections (Description, Cahier des charges, Analyse de l'existant)

Les autres sections sont remplies une fois que le prototype est finalisé et les notes de suivi de projet se font sur l'onglet Journal de bord du projet.

Ensemble des informations pour une documentation complète :

  • Description du projet (de quoi s'agit-il?, quel est l'objectif du projet, à quel(s) besoin(s) 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é sur tel et tel aspect etc ...)
  • Durée totale de la fabrication du prototype (pour le répliquer uniquement, on ne compte pas le temps passé pour le développer)
  • Équipe (Ajouter le porteur de projet et les contributeurs)
  • Matériel nécessaire
  • Outils nécessaires
  • Coût avec le plus de détails possible élément par élément (et sourcer les fournisseurs de préférence)
  • Fichiers sources
  • Etapes de fabrication pas à pas. Documenter tout le processus de création étape par étape, en mettant en lien les fichiers sources quand nécessaires

Onglet Journal de bord

  • 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 ..)

L'onglet Journal de bord, nous sert de cahier de suivi du projet. On va y mettre nos notes, premiers développements, les raisons pour lesquelles on abandonne une piste et pas l'autre selon les retours de l'utilisateur que l'on note également au fur et à mesure des échanges. C'est l'endroit aussi où on met les premières photos ainsi que les fichiers sources (modélisations 3D, code, fichiers 2D etc, schéma électroniques ..) au fur et à mesure des évolutions. On y note également les références des consommables utilisés.

Aide à l'édition :modifier, enregistrer

Pour éditer la page, soit cliquer sur le bouton modifier en haut à droite de la page pour éditer toute la page soit cliquer sur le bouton Modifier visible à côté de chaque chapitre pour éditer uniquement cette section.

Bouton modifier pour éditer la page entière en haut à droite de la page
Bouton modifier pour éditer la page entière en haut à droite de la page
Bouton modifier pour éditer une section de page
Bouton modifier pour éditer une section de page


Pour sauver les modifications cliquer sur le bouton "Enregistrer les modifications" tout en bas de la page

Texte pour intégrer l'image qui apparait là où le curseur de la souris était placé avant de cliquer sur "Insérer en tant qu'image"


Formatage du texte

Pour formater le texte (en gras, italique, faire des titres, des listes, tableaux etc ..), deux solutions, soit écrire directement en wikicode grâce à l'aide de l'éditeur de texte, soit aller dans le menu avancé de l'éditeur de texte pour sélectionner le formatage voulu une fois le texte sélectionné.


Option 1: Écrire en wikicode avec l'aide de l'éditeur

Cliquer sur la flèche Aide dans l'éditeur de texte pour afficher l'aide
Cliquer sur la flèche Aide dans l'éditeur de texte pour afficher l'aide
Vue de l'aide à l'édition ouverte dans l'éditeur de texte. A gauche de l'éditeur il y a plusieurs onglets pour accéder aux différentes pages de l'aide
Vue de l'aide à l'édition ouverte dans l'éditeur de texte. A gauche de l'éditeur il y a plusieurs onglets pour accéder aux différentes pages de l'aide


Option 2: Utiliser l'onglet avancé de l'éditeur

Cliquer sur la flèche pour afficher le menu Avancé
Cliquer sur la flèche pour afficher le menu Avancé
Vue du menu Avancé ouvert. Sélectionner la partie du texte à mettre en forme et cliquer sur le formatage voulu (liste, titre, gras, italique etc..
Vue du menu Avancé ouvert. Sélectionner la partie du texte à mettre en forme et cliquer sur le formatage voulu (liste, titre, gras, italique etc..



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]]

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

[https://fr.wikipedia.org/wiki/Aide:Liens_externes_(wikicode)  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]

Importer une ou des image(s)

IMPORTANT: redimensionner les images avant de les importer. Les images peuvent être redimensionnées à 700px de large, et ne doivent pas dépasser 200ko. L'extension de l'image doit être de type "jpg" ou "png".

Voir le tutoriel pour redimensionner une image

Ou utiliser ce site web pour le faire en ligne :https://tinypng.com/

  • Ouvrir votre dossier d'images dans l'explorateur de fichiers de l'ordinateur et sélectionner les images à importer (pour en sélectionner plusieurs , appuyer sur la touche Control)
Sélection des images
Sélection des images


  • Faire glisser la sélection dans l'éditeur là où est indiqué "Glisser ici les fichiers"
  • Cliquer sur Téléverser tous les fichiers
Bouton téléverser tous les fichiers
Bouton téléverser tous les fichiers


  • Positionner le curseur de la souris à l'endroit où vous voulez que votre image apparaisse puis cliquer sur Insérer en tant qu'image
Lien insérer en tant qu'image
Lien insérer en tant qu'image


  • Vérifier que l'image a bien été ajoutée à l'emplacement du curseur, avec un texte de ce type : [[File:Inserer_en_tant_image.png|400px]]
Texte d'intégration d'image apparu à l'emplacement du curseur de la souris après avoir cliquer sur lien insérer en tant qu'image


Configuration de l'intégration de l'image

Accessibilité : Il est préférable d'éviter l'usage de galeries sans texte alternatif ou avec image défilante car elles sont inaccessibles pour les malvoyants. Il faut privilégier des images avec des légendes et textes alternatifs.


Le format de vignette est donc idéal car il permet d'ajouter une légende sous l'image ainsi qu'un texte alternatif qui sera lisible par les lecteurs d'écran. Il faut ajouter l'argument :

alt="le texte alternatif décrivant l'image".


Si l'image n'est pas porteuse de contenu, il est nécessaire d'ajouter quand même l'argument alt en le laissant vide, ainsi l'usager de lecteur d'écran sait que l'éditeur a pris le soin d'informer le lecteur que cette image n'est pas significative. (exemple:image d'illustration avec un groupe de personne autour d'une table, n'est pas significative et on peut se passer de la décrire, contrairement à un schéma électronique qui est essentiel comme information )


alt=""


La légende est dissociée du texte alternatif pour ce format, les deux sont donc utiles !


Pour ajouter un paramètre on ajoute un pipe (trait vertical) pour chaque nouveau paramètre après le nom de l'image. L'ordre n'a pas d'importance à part le nom de l'image qui doit rester en première position


Exemple :

[[File:Televerser_fichiers.png|700px|vignette|gauche|alt=Bouton téléverser tous les fichiers|Bouton téléverser tous les fichiers]]

Explications du wikicode entre les double crochets pour intégrer l'image.

  • File:Televerser_fichiers.png => Nom de l'image
  • 700px => largeur de l'image, qui change proportionnellement la hauteur. Pour choisir la bonne taille il faut se dire que l'image doit être "lisible" sans avoir à cliquer dessus pour l'agrandir.
  • vignette => Format encadré de l'image permettant d'ajouter une légende
  • gauche =>alignement de l'image (options possible: gauche, centre, droite)
  • alt=Bouton téléverser tous les fichiers => Texte alternatif décrivant l'image
  • Bouton téléverser tous les fichiers =>Légende (décrire précisément ce qu'on voit dans l'image, penser qu'un malvoyant s'en sert pour visualiser l'image)

Problème mise en page avec les images et le texte

Après l'intégration d'une ou plusieurs image(s) notamment avec le format vignette, il est nécessaire d'ajouter cette balise afin que la mise en page soit correcte et que le texte apparaisse sous l'image.

 <br clear=all>  

Intégrer une galerie avec légendes sous les images

Exemple de code pour intégrer une galerie avec légende

<gallery widths="200px" heights="400px">
File:application_cecible_interfaceV2.jpg|Interface v1.22 de l'écran principal correspondant au code source sur ESP32|alt=Interface v1.22 de l'écran principal correspondant au code source sur ESP32
File:appinventor_cecible_esp32_ecran2.jpg|Interface v1.22 de l'écran de paramétrage correspondant au code source sur ESP32||alt=Interface v1.22 de l'écran principal correspondant au code source sur ESP32
File:appinventor_cecible_esp32_ecran_infos.jpg|Interface v1.22 de l'écran d'information de l'application correspondant au code source sur ESP32|alt=Interface v1.22 de l'écran principal correspondant au code source sur ESP32
</gallery>


En cas de message d'erreur "Invalid CSRF token"

Source:https://www.mediawiki.org/wiki/Extension:MsUpload#Invalid_CSRF_token

Le message "Invalid CRSF token" signifie que le navigateur n'a pas pu créer de cookie sécurisé, ou qu'il n'a pas pu accéder au cookie pour autoriser votre connection.

Google Chrome, Firefox, Safari

   Ouvrir Paramètres, Avancés, Vie privée et Sécurité, Paramètres de contenus, Cookies, Autoriser, Ajouter, et entrer wikilab.myhumankit.org, se déconnecter et se reconnecter au wiki.

Intégrer des videos

Doc de l'extension : https://www.mediawiki.org/wiki/Extension:EmbedVideo#Installation


Si la vidéo est un film du prototype, le mieux est de demander au Fabmanager référent d'héberger la vidéo sur le compte Youtube de MyHumanKit avant de l'intégrer sur la page.

 {{#ev:facebook|https://www.facebook.com/MyHumanKit/videos/1207269089675935}} 
 {{#ev:youtube|https://www.youtube.com/watch?v=eAORm-8b1Eg}} 

Intégrer un pdf dans la page

Importer le fichier de la même manière qu'une image en faisant glisser le fichier dans la barre de l'éditeur.

Placer le curseur de la souris là où vous souhaitez voir apparaitre le pdf

Cliquer sur "insérer le lien"

Si vous souhaitez visualiser le pdf sur la page formater le code la manière suivante

 [[File:Accoudoir pivotant v0.pdf|700px]]

Ce qui donne cela:

Accoudoir pivotant v0.pdf

Si vous souhaitez simplement ajouter le pdf avec un lien hypertexte, formater le code de cette manière

 [[Media:Accoudoir pivotant v0.pdf|Télécharger ou visualiser le pdf]]

Ce qui aura ce résultat : Télécharger ou visualiser le pdf

Créer un tableau avancé

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

FAQ : Questions fréquentes

Ma page n'est pas mise à jour malgré mes changements

Cliquer sur le bouton "Purger" en haut à droite de la page en étant connecté à son compte et recharger la page. Les mises à jour devraient être visibles

Ma mise en page est complètement décalée après insertion d'une image au format vignette (thumbnail)

Ajouter la balise suivante sous l'image, et la mise en page devrait de nouveau être cohérente.

<br clear =all>