Contribuer à la documentation de Bokeh
De WIKI-BOKEH
Révision datée du 29 septembre 2015 à 09:51 par Chernandez (discussion | contributions)
Mediawiki est un logiciel open source qui permet de gérer un wiki en ligne. Wikipedia est par exemple géré avec ce logiciel. La documentation utilisateur est très dense, vous pouvez vous y référer. Cette page pointe quelques informations essentielles pour démarrer. L'ensemble du site est historisé et versionnés, sentez vous libres de le mettre à jour. Vous pouvez faire des test sur la page PlayGround.
Créer une page[ ]
- Utiliser les formulaires de création de page sur la page d'accueil ou utiliser les de création de pages de Mediawiki
- Pour entrer dans la documentation, une page doit être dans une catégorie
- soit la catégorie parente "Documentation utilisateur": ajouter dans le corps de la page
- soit une sous-catégorie de cette catégorie parente
- Pour une raison encore inconnue, le plugin qui permet d'afficher l'arborescence sur la page d'accueil n'est pas rafraîchi de suite. Pour voir votre page éditer et enregistrer la page d'accueil pour forcer son enregistrement.
- Créer une nouvelle
page de Documentation utilisateur:
{{#createpage:|nom de la page|Créer|Template:Documentation_utilisateur}}- Par défaut, la cétégorie "documentation utilisateur" est sélectionnée, mais vous pouvez décocher / cocher la catégorie qui correspond le mieux à votre besoin.
catégorie:
{{#createpage:Category|nom de la catégorie|Créer}}page de Notes de version:
{{#createpage:|nom de la page|Créer|Template:Notes_de_version}}
Organisation de la documentation[ ]
- Une page ou une catégorie déclare uniquement son "parent" avec , un nom de catégorie correspond donc uniquement à une catégorie.
- Nous avons découpé la documentation comme suit: une grande catégorie regroupe un découpage général "utilisateur / technique", les sous-catégories représentent les grandes parties de l'application "publique/administration/...", vous trouverez en dessous une organisation en fonction des menus disponibles dans le logiciel avec plus ou moins de catégories en fonction des besoins.
- Catégorie:Doc : Catégorie de plus haut niveau
- Catégorie:Documentation_utilisateur : pages d'ordre "fonctionnel" sur le logiciel
- Catégorie:Interface_administration_Bokeh : documentation sur la partie administrative de bokeh - sous "/admin/"
- Catégorie:Interface_administration_Cosmogramme : documentation sur la partie administrative de cosmogramme - sous "/cosmogramme/"
- Catégorie:Interface_publique : documentation de la partie publique de bokeh - à la racine "/" de votre site
- Catégorie:Autres_notions : autres pages qui ne trouvent pas place dans les catégories précédentes
- Catégorie:Documentation_développeur : pages d'ordre "technique" - veuillez noter que la documentation technique prendre place dès que possible dans les fichiers du code source
- Catégorie:Notes_de_version : résumé des versions publiées
- Catégorie:Documentation_utilisateur : pages d'ordre "fonctionnel" sur le logiciel
Gérer mon compte[ ]
- Vous devez avoir créé votre compte, être identifié et avoir validé votre adresse email avant de créer une nouvelle page ou modifier une page existante.
- Pour changer votre mot de passe ou préférences, une fois connecté, aller dans "Préférences" lien en haut à droite puis lien de changement du mot de passe
Mise en forme[ ]
- Page de référence de la mise en forme
- Importer une image
- Mettre dans votre page [[File:nom_image.png]] avec nom_image.png le nom que vous souhaitez donner à votre image
- Enregistrer la page et cliquer sur le lien rouge rendu visible
- Suivre les indications d'envoi de l'image sur le serveur (bouton parcourir, puis enregistrer)
- En théorie, votre image est maintenant visible sur votre page.
- Gestion des liens
- Gestion des tableaux
- Gestion de la traduction
Travaux en cours[ ]
- Transfert des fiches internes vers le wiki public http://afi-forge.afi-sa.fr/issues/14391
Donner du feedback sur une page[ ]
- Connectez vous
- Aller sur la dite page
- Créer sur l'onglet "Discussion" en haut de la page
- Si la page n'existe pas, cliquer sur "Créer le wikicode"
- Si la page existe, cliquer sur "Modifier le wikicode"
- Mettez votre nom et votre commentaire
- Validez