Différences entre versions de « Contribuer à la documentation »

De wikilab
Ligne 2 : Ligne 2 :
 
===Pour contribuer à la documentation===
 
===Pour contribuer à la documentation===
 
# créer un compte utilisateur sur wikilab  
 
# créer un compte utilisateur sur wikilab  
# demander à un fabmanager de valider votre compte
+
# demander à un fabmanager de valider votre compte et de vous associer les droits selon le type de contenu que vous souhaitez éditer.
  
===Créer une nouvelle page Projet===
+
==Créer une nouvelle page==
# créer la page en ajoutant le nom du projet dans la zone de texte puis cliquer sur le bouton pour "créer nouveau projet". Ne jamais laisser d'espace dans le nom du projet, il faut les remplacer par des underscores (ou tirets du bas)
+
Un usager peut créer 4 types de contenus sur ce wiki et il doit disposer des droits en édition sur l'espace de nom associé au contenu (Projets, Ressources, Supports_peda ou Formations):
# Cette page sera créé automatiquement avec un modèle regroupant toutes les informations à remplir pour constituer une documentation complète
+
* Un projet = étapes de fabrication pour reproduire un prototype [[Projets:Guide_doigt_clavier_Logitech_K360|(exemple)]]
# Valider la création de la page en cliquant sur "Enregistrer" en bas de la page"
+
* Un tutoriel = une aide pas à pas pour s'emparer d'une technique [[Ressources:Communication_Bluetooth_HC_05|(exemple)]]
<inputbox>
+
* Un support pédagogique = un support pour animer un atelier [[Supports_peda:Lecteur_MP3_tactile|(exemple)]]
type=create
+
* Un atelier = documentaton des réalisations produites pendant un atelier [[Formations:Askoria-BPJEPS-Morlaix|(exemple)]]
labeltext=nom du projet
 
break=no
 
prefix=Projets:
 
buttonlabel=Créer nouveau projet
 
preload=Template:Projet
 
</inputbox>
 
  
 +
{| class="wikitable" style="width: 100%;background-color:#3D6999;color:white;text-align:center;font-size:18px;border-style: solid; border-width: 20px;padding:20px;"
 +
| style="width: 25%;"|[[Nouveau_projet|'''<span style="color:white">Créer un projet'''</span>]]
 +
| style="width:2%;background-color:#A2A9B1;"|
 +
| style="width: 25%;"|[[Nouveau_tutoriel|'''<span style="color:white">Créer un tutoriel'''</span>]]
 +
| style="width:2%;background-color:#A2A9B1;"|
 +
| style="width: 25%;"|[[Nouveau_support_pédagogique|'''<span style="color:white">Créer un support pédagogique'''</span>]]
 +
| style="width:2%;background-color:#A2A9B1;"|
 +
| style="width: 25%;"|[[Nouvel_atelier|'''<span style="color:white">Documenter un atelier'''</span>]]
 +
|}
  
===Créer une nouvelle page Support pédagogique===
+
===Editer sa page===
# créer la page en ajoutant le nom du support pédagogique dans la zone de texte puis cliquer sur le bouton pour "Créer nouveau support pédagogique". Ne jamais laisser d'espace dans le nom du projet, il faut les remplacer par des underscores (ou tirets du bas)
+
* Cliquer sur "Éditer avec formulaire" pour éditer le cartouche du projet
# Cette page sera créé automatiquement avec un modèle regroupant toutes les informations à remplir pour constituer une documentation complète
 
# Valider la création de la page en cliquant sur "Enregistrer" en bas de la page"
 
<inputbox>
 
type=create
 
labeltext=nom du support pédagogique
 
break=no
 
prefix=Supports_peda:
 
buttonlabel=Créer nouveau support pédagogique
 
preload=Template:Supports_pédagogiques
 
</inputbox>
 
  
===Editer sa page===
+
* Cliquer sur "Modifier" en haut à droite pour éditer le contenu de la page
* Cliquer sur "Modifier" en haut à droite
 
  
 
* Trouver de l'aide [[Aide_MHK|ici pour éditer votre page ]], également accessible dans le menu de gauche sous l'onglet "Aide MHK"
 
* Trouver de l'aide [[Aide_MHK|ici pour éditer votre page ]], également accessible dans le menu de gauche sous l'onglet "Aide MHK"
Ligne 38 : Ligne 30 :
 
* Le code utilisé s'appelle le wikicode (language utilisé pour wikipedia, basé sur le langage Markdown), il est simple à utiliser et vous trouverez toutes les manipulations d'édition basique sur la page [[Aide MHK|Aide MHK]]
 
* Le code utilisé s'appelle le wikicode (language utilisé pour wikipedia, basé sur le langage Markdown), il est simple à utiliser et vous trouverez toutes les manipulations d'édition basique sur la page [[Aide MHK|Aide MHK]]
  
* Si vous êtes sur une page vous pouvez visualiser le code source sur l'onglet "Voir le code source" en haut à droite de la page.
+
* Si vous êtes sur une page vous pouvez visualiser le code source sur l'onglet "Modifier" (en étant logué) ou "Voir le code source" (sans être logué) en haut à droite de la page.
  
 
==Les bonnes pratiques==
 
==Les bonnes pratiques==
 
Afin de rendre la documentation accessible y compris aux malvoyants, nous vous encourageons fortement à '''ajouter les fichiers source de Fritzing pour les schémas (et pas uniquement les images) ce qui permet aux malvoyants de pouvoir rouvrir le fichier et de le visualiser avec contraste.'''
 
Afin de rendre la documentation accessible y compris aux malvoyants, nous vous encourageons fortement à '''ajouter les fichiers source de Fritzing pour les schémas (et pas uniquement les images) ce qui permet aux malvoyants de pouvoir rouvrir le fichier et de le visualiser avec contraste.'''

Version du 28 juin 2022 à 15:21

Comment contribuer?

Pour contribuer à la documentation

  1. créer un compte utilisateur sur wikilab
  2. demander à un fabmanager de valider votre compte et de vous associer les droits selon le type de contenu que vous souhaitez éditer.

Créer une nouvelle page

Un usager peut créer 4 types de contenus sur ce wiki et il doit disposer des droits en édition sur l'espace de nom associé au contenu (Projets, Ressources, Supports_peda ou Formations):

  • Un projet = étapes de fabrication pour reproduire un prototype (exemple)
  • Un tutoriel = une aide pas à pas pour s'emparer d'une technique (exemple)
  • Un support pédagogique = un support pour animer un atelier (exemple)
  • Un atelier = documentaton des réalisations produites pendant un atelier (exemple)
Créer un projet Créer un tutoriel Créer un support pédagogique Documenter un atelier

Editer sa page

  • Cliquer sur "Éditer avec formulaire" pour éditer le cartouche du projet
  • Cliquer sur "Modifier" en haut à droite pour éditer le contenu de la page
  • Le code utilisé s'appelle le wikicode (language utilisé pour wikipedia, basé sur le langage Markdown), il est simple à utiliser et vous trouverez toutes les manipulations d'édition basique sur la page Aide MHK
  • Si vous êtes sur une page vous pouvez visualiser le code source sur l'onglet "Modifier" (en étant logué) ou "Voir le code source" (sans être logué) en haut à droite de la page.

Les bonnes pratiques

Afin de rendre la documentation accessible y compris aux malvoyants, nous vous encourageons fortement à ajouter les fichiers source de Fritzing pour les schémas (et pas uniquement les images) ce qui permet aux malvoyants de pouvoir rouvrir le fichier et de le visualiser avec contraste.