Cette traduction est plus ancienne que la page originale et est peut-être dépassée. Voir ce qui a changé.
fr:slackdocs:tutorial - SlackDocs

Welcome to the Slackware Documentation Project

Ceci est une ancienne révision du document !


Tutoriel et utilisation du Wiki

Cette page est en cours de traduction (zithro). En attendant, vous pouvez consulter la version anglaise de cette page pour les parties manquantes.

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 qui mentionné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 standart.

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, ce 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: les tags sont pour l'instant uniquement 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 francais 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.

La suite est en cours de traduction, finissez de lire sur la version anglaise.

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