Familiarisez-vous avec le concept des catégories sur DokuWiki: https://www.dokuwiki.org/fr:namespaces.
Quand vous créez seulement une page assez simple, il suffit d'utiliser une des catégories existantes :
howtos:
security:
slackware:
wiki:user:
fr:
par exemple, qui à son tour contient les mêmes sous-catégories indiquées ci-dessus (par exemple fr:howtos
, fr:security
, etc).Si vous ajoutez des nouveaux tutoriaux (ou autres articles) qui consistent en plusieurs articles, contiennent des captures d'écran etc, il est recommandé de les placer dans leurs propres sous-catégories. Sinon vous allez surcharger la catégorie courante, et maintenir les fichiers uploadés deviendra un enfer pour les utilisateurs et les administrateurs.
Quand vous ajoutez un lien dans une page existante et que ce lien pointe vers votre nouvelle page dans sa propre sous-catégorie, vous devez ajouter cette catégorie dans le lien.
Pour ce faire, il faut utiliser les doubles points, et si vous commencez votre “catégorisation” avec un point '.' vous rendrez la catégorie relative à la catégorie courante de la page, ce qui est un standard.
fr:howtos:icecast_streams:
. Vous pouvez alors mettre tous vos fichiers uploadés dans la même catégorie. Merci de maintenir une structure de catégories saine. Il sera très difficile de réparer tous les liens si nous devons effectuer des corrections aux noms de catégories et de pages.
Familiarisez-vous d'abord avec la syntaxe de Dokuwiki. Ce n'est pas la même que celle de MediaWiki.
Essayez de garder le format de la page aussi propre que possible :
man rc.inet1.conf
. Il y a un bouton “TT” dans la barre de boutons de l'éditeur qui insérera ces balises.Voila un exemple d'une page simple, utilisant les catégories pour les pages liées, etc:
====== Titre de la page ====== D'abord une description de l'article. Souvenez-vous que vous pouvez utiliser des pages liées (sous-catégories) quand nécessaire. ===== La première section ===== Du bla bla [[.page_liee:start | Mon article détaillé]] ===== La deuxième section ===== Plus de bla bla [[.une_autre_page_liee:start | Plus d'information avec des captures d'écran]] <!-- Vous pouvez laisser des commentaires dans votre page - il ne seront pas visibles sur votre article sur le Wiki --> <!-- Les Tags sont essentiels pour créer une Table des Matières (ou TOC, Table Of Contents en anglais) --> {{tag>howtos software}}
Peut-être voulez-vous inclure des captures d'écran plutôt imposantes dans vos articles, mais les afficher en grand peut rendre ceux-ci illisibles. Heureusement, vous pouvez redimensionner l'image affichée dans l'article. Vous pouvez aussi régler l'alignement de l'image.
Quelques exemples :
Redimensionner à une largeur donnée (50 ici):
{{wiki:dokuwiki-128.png?50}}
L'alignement gauche/centré/droit se fait comme ceci (un espace -avant/aux deux extrémités/après- le lien de l'image):
{{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }}
Voir Information de DokuWiki sur les images et les autres fichiers pour plus d'informations.
Vous pouvez insérer du code en utilisant la balise code
, comme ceci :
<code c> float a; </code>
float a; float b; a = b * 10 + 2 * sin1(x);
Comme cet exemple le montre, la lisibilité est largement améliorée si vous appliquez le surlignement de syntaxe avec la balise code quand vous documentez des shell scripts ou autres.
Merci de vérifier l'orthographe et la grammaire de vos articles. Utilisez un français générique, n'utilisez pas les dialectes. N'hésitez pas à contacter un des éditeurs ou traducteurs du site pour une aide ou une vérification de vos textes.
Vous verrez que lorsque vous créez une nouvelle page, il y aura du texte pré-rempli. Ce texte vient d'un des modèles - chaque catégorie a un modèle un peu différent.
L'aspect le plus important d'un modèle est qu'il ajoute les tags par défaut à votre page. Ces tags permettront de peupler notre Table des Matières automatiquement.
Un exemple de modèle:
<!-- Ajoutez votre texte ci-dessous. Il est vivement recommandé de commencer avec un titre (voir la barre de boutons de l'éditeur). --> <!-- Merci de ne rien ajouter après ceci, à part des tags additionnels.--> <!-- Cependant il faut enlever le tag "template" ci-dessous, ou bien la page ne s'affichera pas dans la Table des Matières. --> <!-- Ne supprimez pas cette ligne avec la liste des tags. Merci ! slackdocs@--> {{tag>howtos template}}
C'est une bonne idée d'utiliser les pages de “discussion” (il y a un lien “discussion” sur le haut de chaque article) pour discuter du contenu de l'article, signaler des erreurs, clarifier des doutes, apporter quelque chose à l'attention de l'auteur, et/ou proposer des changements majeurs.
Si vous voulez ajouter un commentaire à une page de discussion, prenez un moment pour penser à ce que vous voulez écrire avant de cliquer sur l'onglet modifier cette page. Essayez de verrouiller la page le moins longtemps possible, pour ne pas être un obstacle aux autres qui veulent aussi commenter.
Quand vous décidez d'ajouter un commentaire à une page de discussion, vous devez suivre ces règles pour garder les discussions compréhensibles et en ordre :
===== Sujet ===== Commentaire original > La première réponse >> La deuxième >>> La troisième
Ce qui ressemblera à :
Vous pouvez voir que les “>” sont transformés en autant de traits bleus.
Vous pouvez vous abonner aux changements de la page de discussion si vous voulez être notifié des réponses en cliquant sur l'onglet S'abonner à la page de la page de discussion.
L'anglais est la langue principale du Projet de Documentation Slackware. Ceci est normal puisque Slackware Linux utilise un assistant d'installation et une documentation uniquement en anglais. L'équipe des administrateurs veut éviter que ce projet soit coincé dans un dilemne Babylonien.
Bien que la langue anglaise soit la langue officielle, beaucoup de contributeurs ne veulent pas écrire un article dans une langue qui n'est pas leur langue natale. On ne veut pas frustrer ces auteurs potentiels, surtout que nous comptons sur vous tous pour que ce projet aboutisse. Après quelques discussions dans la liste de diffusion des administrateurs, nous avons trouvé une solution viable à ce dilemne.
Voilà un exemple. Disons que vous voulez créer un HOWTO sur le scannage de texte type OCR, mais en français.
slackdocs@alienbase.nl
, en demandant un traducteur français. Vous pouvez copier/coller ce texte en remplaçant ce qu'il y a entre crochets par ce que vous souhaitez écrire : “Hello everybody, I'm busy writing [a HOWTO about OCR] in French. Can anybody translate my article into English once it's finished?”.