Différences entre versions de « Contribuer à la documentation »
| Ligne 42 : | Ligne 42 : | ||
*Modèle de page : | *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 | Pour créer une page basée sur le modèle type de documentation de projet, insérer en haut de la page | ||
| + | <nowiki>{{subst:Projet}} </nowiki> | ||
| + | |||
| + | Pour insérer un modèle non modifiable | ||
<nowiki>{{Template:Projet}} </nowiki> | <nowiki>{{Template:Projet}} </nowiki> | ||
| + | |||
| + | |||
== Débuter sur mediawiki == | == Débuter sur mediawiki == | ||
Version du 27 mars 2018 à 09:52
Comment contribuer?
Pour contribuer à la documentation, créez-vous un compte utilisateur et demander au Humanlab que votre compte soit assigné au groupe Projets.
Avant de commencer à éditer, merci de lire les quelques recommandations suivantes concernant le formatage du texte et les images.
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 "Voir le code source" en haut à droite de la page.
Création de votre page Projet
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 (Attention le nom ne doit pas contenir d'espace, il faut les remplacer par des underscores aussi appelés tirets du bas (_).
http://wikilab.myhumankit.org/index.php?title=Projets:Nom_de_votre_projet
Valider ce nouvel url en appuyant sur entrée dans la barre d'adresse de votre navigateur (Firefox ou autre) et appuyer ensuite sur le bouton "Créer la page" en haut à droite.
Afin d'avoir une trame de documentation insérer ce modèle en ajoutant simplement cette ligne en bas de page
{{subst:Projet}}
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 en appuyant sur le bouton "modifier" pour chacun d'eux.
Documentation type d'un projet
Voici les éléments principaux requis pour la documentation de projets une fois votre page créée. En plaçant le modèle {{Template:Projet}} en bas de votre page tout ces paragraphes seront créés automatiquement avec un sommaire associé.
- 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 (Ajouter le nom du référent initiateur du projet)
- 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.
[[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 en haut de la page
{{subst:Projet}}
Pour insérer un modèle non modifiable
{{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 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
- 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
*Projets
Lien vers page
** Projets:Ressenti sonore|Ressenti sonore
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é
Aller sur cet url : http://wikilab.myhumankit.org/index.php?title=MediaWiki:Sidebar
Ajouter cette ligne :
Category:**Nom de la catégorie|Nom du lien vers la page de cette catégorie
Exemple pour la catégorie projet:
Category:**Nom de la catégorie|Nom du lien vers la page de cette catégorie
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.
[[Espace_de_nom:Nom de la page|Nom du lien]]
- 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 User's Guide for information on using the wiki software.
