| Qui est en ligne ? |
| Il y a : 24 utilisateurs en ligne, consultez le détail |
Forum » Manuel utilisateur » Soumettre une documentation |
Connexe :
Editer |
Historique
Dernière mise à jour : jeudi 07 juin 2007
Soumettre votre documentation
Pour ajouter une documentation à Trustonme vous devez être authentifié. Allez dans la catégorie Documentation Linux et cliquez sur l'icône Nouveau sujet. Complétez le formulaire ainsi :
- 1 : Donnez un titre à cette documentation (ex : Installer et configurer Eclipse).
- 2 : Choisissez quel menu correspond le mieux à votre documentation.
- 3 : Sélectionnez l'icône la mieux adaptée à votre documentation
- 4 :
Placez votre message ici. Utilisez le bbcode suivant pour formater votre message. Si vous avez des images placez-les sur un site Internet et référencez-les dans votre documentation grâce au tag [ img ]. Le modérateur qui validera votre documentation uploadera votre image sur le serveur de Trustonme et remplacera votre lien par un lien vers l'image présente sur le serveur Trustonme.
Les documentations sur Trustonme seront agrégées dans un fichier PDF de plus de 1000 pages appelé Trustbook. Ce Trustbook est généré à partir de fichiers latex eux obtenus à partir du contenu de la documentation. C'est pourquoi je vous demande de respecter quelques principes pour les images :
a) Les images de votre documentation doivent être au format PNG ou JPEG uniquement. Les dimensions de chaque image ne doivent pas excéder 500x480.
b) Les images au format PNG auront comme extension ".png" (ex : dax1.png) et les images JPEG ".jpg" (ex : dax1.jpg)
c) Les noms des images ne doivent contenir que des chiffres et des lettres et dans tous les cas pas de caractères spéciaux ni accentués. C'est à dire que les +,_,é,à ... sont à éviter. - 5 : Vérifiez que la case "Désactiver les smileys" est cochée.
Avant de valider votre article, cliquez sur Aperçu pour pré-visualiser votre commentaire. Quand vous êtes satisfait du résultat, soumettez le formulaire. Gardez à l'esprit que le site Trustonme n'emploie personne mais dépend du temps et du bon vouloir de bénévoles. Cela peut expliquer pourquoi votre documentation même hyper importante pour vous n'est pas en ligne instantanément.
Une fois votre formulaire soumis, vous êtes redirigé vers la première page de votre documentation. Vous avez encore l'opportunité de faire évoluer votre texte en éditant votre message. Pour indiquer au modérateur que votre documentation est prête pour la validation, cliquez sur le lien Marquer comme résolu. Vous pourrez suivre l'évolution de votre demande depuis la catégorie Documentation en attente. Lorsque votre documentation sera validée vous pourrez la consulter dans la catégorie Documentation Linux ou directement sur le site.
Comme indiqué ci-dessus les documentations sont converties en Latex puis en PDF. C'est pourquoi il est absolument indispensable que le document XHTML généré sur le site à partir de votre documentation (ex : la documentation 60) soit conforme aux recommandations du W3C. Pour tester la conformité de votre documentation générée, cliquez sur le lien XHTML en bas du menu à droite sur la page de votre documentation.
Gérer le sommaire de votre documentation
Sur Trustonme, chaque documentation est associée à un sommaire qui permet de naviguer à l'intérieur de la documentation sur le site, voir par exemple : http://www.trustonme.net/didactels/164.html :
Tout est basé sur un système d'ancre placée à l'intérieur de la documentation, puis ajoutée dans la base de données. Cette partie explique comment créer et mettre à jour ce sommaire.
Allez dans la catégorie Documentation Linux et cliquez sur le lien qui correspond à votre documentation. Editez la documentation, au dessus de chaque section (tag [ h2 ]) placez une ancre :
Validez le formulaire. De retour sur la page de la documentation, cliquez sur Gérer le topic (en haut à gauche) pour accéder à l'interface de gestion du sommaire, entre autres. Pour chaque ancre ajoutée dans la documentation, créez une entrée dans la base de données comme suite :
Voilà c'est fait ! Vous utiliserez la même interface pour ajouter/supprimer/modifier des entrées dans le sommaire. Gardez simplement à l'esprit que le sommaire et le contenu de la documentation fonctionnent ensemble. Si vous modifiez l'un pensez à reporter vos modifications dans l'autre.
Forum » Manuel utilisateur » Soumettre une documentation |