28-mar-2016: Welcome to our new server! Faster and less prone to crashing.

Welcome to the Slackware Documentation Project

Tutoriel et utilisation du Wiki

Catégories

Familiarisez-vous avec le concept des catégories sur DokuWiki: https://www.dokuwiki.org/fr:namespaces.

Articles simples

Quand vous créez seulement une page assez simple, il suffit d'utiliser une des catégories existantes :

  • howtos:
    L'endroit logique pour tous vos tutoriaux.
  • security:
    Documentation concernant la sécurité sous Linux (pas seulement Slackware) ; HOWTO's pour sécuriser votre installation et vos applications Linux ; comment naviguer sans danger sur Internet ; etc.
  • slackware:
    Articles concernant directement la distribution.
  • wiki:user:
    Là ou chaque utilisateur du Wiki peut faire sa propre “page d'accueil”.
  • Ou n'importe laquelle des catégories de traduction, fr: par exemple, qui à son tour contient les mêmes sous-catégories indiquées ci-dessus (par exemple fr:howtos, fr:security, etc).

Articles complexes

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.

Imaginez que vous êtes en train d'éditer la page principale des HOWTOs et que vous voulez ajouter votre propre HOWTO s'appelant “icecast streams” et que vous voulez utiliser plusieurs pages liées entre elles et contenant des captures d'écran. Normalement, vous ajouteriez un lien vers cette page dans la page principale des HOWTOs en utilisant le nom de page “.icecast_streams:start”. Dans ce wiki, la page d'index des HOWTOs est automatiquement peuplée par l'utilisation du tag “howtos”. Utilisez donc les tags de manière intelligente.
Un tel nom (dans un lien interne normal) positionnerai la page dans la catégorie fr:howtos:icecast_streams:. Vous pouvez alors mettre tous vos fichiers uploadés dans la même catégorie.
Notez que j'ai remplacé l'espace dans “icecast streams” par un underscore. Evitez les espaces dans les noms de catégories et de pages !

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.

Syntaxe et formatage

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 :

  • Le titre principal d'une page doit être en H1, le sous-titre suivant en H2, celui en-dessous devra être H3, etc.
  • N'utilisez pas les lignes horizontales sauf si vraiment nécessaire (par exemple elles ne sont pas nécessaires s'il y a un titre au-dessus ou en-dessous de là ou vous voulez marquer une “nouvelle section”).
  • Entourez les portions de texte qui contiennent des exemples de commandes, des noms de fichiers ou du texte “ordinateur” avec les balises de “code”. Par exemple : 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}}

Note du traducteur : vous pouvez utiliser des tags en français, mais laissez les tags anglais ! L'idéal est d'avoir les mêmes tags en français qu'en anglais.

Images

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.

Code

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.

Vérification linguistique

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.

Modèles d'articles

Note du traducteur: les modèles n'existent pas encore en français. Vous obtiendrez pour l'instant une page vide.

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}}

Utilisation des pages de discussion

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 :

  • Signez vos commentaires en cliquant sur le bouton insert signature sur la barre d'outils de l'éditeur WYSIWIG ou en utilisant le raccourci clavier ALT+SHIFT+Y.
  • Utilisez un titre de niveau 2 pour ajouter un nouveau commentaire en cliquant sur le H bleu de la barre d'outils de l'éditeur ou en utilisant le raccourci ALT+SHIFT+2.
  • Ajoutez tous vos commentaires en fin de page, sauf si vous répondez à un commentaire particulier. Dans ce cas, ajoutez vos commentaires directement en-dessous du commentaire auquel vous répondez. Utilisez le caractère “>” pour hiérarchiser la discussion, en en ajoutant autant que nécessaire. Par exemple :
===== 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.

Remarques sur la langue

En anglais, s'il vous plaît

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.

Alors comment les contributions qui ne sont pas en anglais sont-elles gérées ?

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.

  1. Envoyez un message à la liste de diffusion 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?”.
  2. Dès que vous avez trouvé votre traducteur, ou qu'un éditeur vous en a attribué un (ce qui ne devrait pas être trop dur puisque nos rangs grandissent chaque jour), vous continuez la discussion entre vous en dehors de la liste de diffusion, jusqu'à ce que l'article ET sa traduction soient finies.
  3. Le texte qui a été traduit en anglais paraît en premier, dans la section principale du site. La partie “Sources” vous mentionne en tant qu'auteur, et mentionne votre traducteur.
  4. Finalement, votre texte original paraît dans la partie traduite (française) du site, vous mentionnant comme auteur.

Sources

  • Version anglaise de la page
  • Traduction initiale par zithro


Autres langues
Traductions de cette page?:
QR Code
QR Code fr:slackdocs:tutorial (generated for current page)