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

De wikilab
(37 versions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
 
==Comment contribuer?==
 
==Comment contribuer?==
Pour contribuer à la documentation, créez-vous un compte utilisateur et demander au Humanlab que votre compte soit assigné au groupe Projets.  
+
===Pour contribuer à la documentation===
 +
# créer un compte utilisateur sur wikilab
 +
# demander à un fabmanager de valider votre compte et de vous associer les droits selon le type de contenu que vous souhaitez éditer.
  
Avant de commencer à éditer, merci de lire les quelques recommandations suivantes concernant le formatage du texte et les images.
+
==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 [[Projets:Guide_doigt_clavier_Logitech_K360|(exemple)]]
 +
* Un tutoriel = une aide pas à pas pour s'emparer d'une technique [[Ressources:Communication_Bluetooth_HC_05|(exemple)]]
 +
* Un support pédagogique = un support pour animer un atelier [[Supports_peda:Lecteur_MP3_tactile|(exemple)]]
 +
* Un atelier = documentaton des réalisations produites pendant un atelier [[Formations:Askoria-BPJEPS-Morlaix|(exemple)]]
  
Le code utilisé s'appelle le wikicode (language utilisé pour wikipedia, basé sur le langauge Markdown), il est simple à utiliser et vous trouverez toutes les manipulations d'édition basique sur la page [[Aide MHK|Aide MHK]]
+
{| 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>]]
 +
|}
  
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.
+
===Editer sa page===
 +
* Cliquer sur "Éditer avec formulaire" pour éditer le cartouche du projet
  
==Création de votre page Projet ==
+
* Cliquer sur "Modifier" en haut à droite pour éditer le contenu de la page
Pour créer votre page, trouver un nom au projet que vous portez et aller dans la barre d'adresse pour taper l'url de votre page en recopiant le modèle ci-dessous et en changeant juste "Nom_de_votre_projet" avec le vôtre.
 
  
http://wikilab.myhumankit.org/index.php?title=Projets:Nom_de_votre_projet
+
* Trouver de l'aide [[Aide_MHK|ici pour éditer votre page ]], également accessible dans le menu de gauche sous l'onglet "Aide MHK"
  
Valider ce nouvel url en appuyant sur entrée dans la barr d'adresse de votre navigateur (Firefox ou autre) et appuyer ensuite sur le bouton "Créer la page" en haut à droite.
+
* 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]]
  
Afin d'avoir une trame de documentation insérer ce modèle en ajoutant simplement cette ligne en bas de 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.
  
<nowiki>{{Template:Projet}}</nowiki>
+
==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.'''
Aller ensuite en bas de la page pour appuyer sur le bouton "enregistrer".
 
 
 
Votre page est maintenant créé avec les principaux titres de paragrapĥes. Vous pouvez ajouter du contenu pour chacun d'eux en appuyant sur le bouton "modifier" de chacun d'eux.
 
 
 
== Documentation type d'un projet ==
 
* Nom du projet
 
* Nom du référent initiateur du projet
 
* Description du projet (Y a-t-il eu des : Réplications, Modifications, Hacks, Détournements)
 
* Cahier des charges prenant en compte la faisabilité / les contraintes
 
* Système similaire existant (open source ?)
 
* Durée totale réelle de la fabrication du prototype
 
* Équipe / Collaborateur / Partenaires (Qui Fait Quoi !!! Répartir les taches)
 
* Matériel nécessaire
 
* Outils nécessaires
 
* Compétences/techniques nécessaires
 
* Documenter tout le processus de création étape par étape, en uploadant les fichiers sources
 
* Coût avec le plus de détails possible élément par élément (et sourcer les fournisseurs de préférence)
 
* 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.
 
<nowiki>[[Category:Projets]]</nowiki>
 
* 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.
 
<nowiki>[[Category:En cours]]</nowiki>
 
*Modèle de page :
 
Pour créer une page basée sur le modèle type de documentation de projet, insérer en haut de la page
 
<nowiki>{{Template:Projet}} </nowiki>
 
 
 
[[Template:Projet]]
 
 
 
== Débuter sur mediawiki ==
 
 
 
https://fr.wikibooks.org/wiki/MediaWiki_pour_d%C3%A9butants/Premi%C3%A8re_utilisation_de_votre_wiki ('''A LIRE''')
 
 
 
https://fr.wikipedia.org/wiki/Mod%C3%A8le:Article_d%C3%A9taill%C3%A9
 
 
 
https://fr.wikipedia.org/wiki/Aide:Sommaire
 
 
 
== Débuter en tant qu'administrateur ==
 
===Comprendre les droits des utilisateurs===
 
*Le plugin "Lockdown" est installé sur ce mediawiki afin de restreindre l'édition des pages.
 
 
 
*Chaque utilisateur doit être assigné à un groupe qui correspond à un [https://fr.wikipedia.org/wiki/Aide:Espace_de_noms espace de nom]. Pour éditer le droit d'un utilisateur aller dans le menu Tools>Special pages>User right management
 
 
 
*Le espaces de noms sont définis dans LocalSettings.php (Accessible sur le serveur via Filezilla).
 
 
 
'''IMPORTANT''':
 
 
 
*Quand un espace de nom est défini, on lui assigne un numéro, ce numéro est très important, il doit être pair pour une page basique et impair pour une page "talk". D'autre part, ''' si l'on souhaite changer ce numéro, il faut impérativement sauvegarder la page avant ce changement: l'éditer et sauver dans un fichier texte, le lien vers les medias sera aussi ainsi sauvegardé, car après ce changement toutes les données auront disparues à cause de cette nouvelle indexation!!'''
 
 
 
*Ne pas mettre de tiret "-" dans les espace de noms, sinon cela ne fonctionne pas
 
 
 
===Personaliser le menu===
 
 
 
====Créer une page à partir du menu====
 
 
 
*Pour que les pages soient éditables par les utilisateurs, les pages créés doivent spécifier qu'elles appartiennent à un espace de nom.''' Pour cela, il suffit de le mettre en préfixe sur la page créée.
 
 
 
Exemple, si l'espace de nom = Projets
 
 
 
Aller sur cet url : http://wikilab.myhumankit.org/index.php?title=MediaWiki:Sidebar
 
 
 
Editer la page. On remarque que les titres du menu ont une asterisque et les liens vers les pages en ont deux. Voir ci-dessous
 
 
 
'''Titre'''
 
 
 
<nowiki>*Projets</nowiki>
 
 
 
'''Lien vers page'''
 
 
 
<nowiki>** Projets:Ressenti sonore|Ressenti sonore</nowiki>
 
 
 
 
 
Il suffit d'ajouter un lien vers la nouvelle page que l'on souhaite créer
 
 
 
Espace_de_nom:Nom de la page|Nom du lien
 
 
 
'''Exemple:'''
 
 
 
**Projets:Bras anti-gravité|Bras anti-gravité
 
 
 
 
 
===Ajouter une catégorie comme élément du menu===
 
Aller sur cet url : http://wikilab.myhumankit.org/index.php?title=MediaWiki:Sidebar
 
 
 
Ajouter cette ligne :
 
 
 
<nowiki>Category:**Nom de la catégorie|Nom du lien vers la page de cette catégorie </nowiki>
 
 
 
Exemple pour la catégorie projet:
 
 
 
<nowiki>Category:**Nom de la catégorie|Nom du lien vers la page de cette catégorie </nowiki>
 
 
 
===Créer une page depuis une autre page===
 
Si on est déjà sur une page et que l'on souhaite créer un lien vers une nouvelle page éditable par le même groupe d'utilisateur, il faut assigner à cette page le même espace de nom.
 
 
 
<nowiki>[[Espace_de_nom:Nom de la page|Nom du lien]]</nowiki>
 
 
 
 
 
*Liens utiles :
 
https://fr.wikipedia.org/wiki/Aide:Espace_de_noms
 
 
 
https://fr.wikipedia.org/wiki/Aide:Cr%C3%A9er_un_mod%C3%A8le
 
 
 
https://fr.wikipedia.org/wiki/Aide:Cat%C3%A9gorie
 
 
 
== Liens utiles pour formater le texte et placer les images : WIKICODE ==
 
Mediawiki est le wiki surlequel est basé Wikipedia. Il utilise un langage simplifié de formatage : le wikicode
 
 
 
Regarder dans Projets>Exemple de page pour les bases d'édition d'une page.
 
 
 
Quelques liens utiles:
 
 
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)
 
 
 
== Getting started ==
 
Consult the [https://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
 
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
 
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
 
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
 
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
 
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
 
 
 
}}
 

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.