Outils personnels

alwaysdata:Contribuer

Un article de alwaysdata.

La documentation d'alwaysdata, sous la forme de ce wiki, est constamment en évolution. Comme rien n'est parfait, et parce que toute explication peut toujours être améliorée, ce wiki est en édition libre par ses utilisateurs. Vous connaissez une astuce dans un domaine ? Vous connaissez la meilleure façon de faire quelque chose ? N'hésitez pas à partager vos lumières avec les autres utilisateurs en créant un nouvel article ou en corrigeant ceux qui existent déjà.

Ce petit guide explique succinctement comment contribuer à l'amélioration de la documentation d'alwaysdata.

Sommaire

Créer et éditer les articles

Éditer un article existant

Pour commencer, sachez que la grande majorité des pages que vous pouvez consulter sur cet espace est librement modifiable par tout le monde. Ainsi, si vous remarquez une erreur dans un article ou que vous voulez détailler davantage une notion, vous pouvez très simplement cliquer sur l'onglet modifier en haut de l'article. Vous pourrez alors modifier le contenu de l'article. La mise en forme suit certaines normes qu'il faut respecter pour un meilleur rendu. Consultez la suite de cette aide pour en savoir plus.

Quand vous avez terminé votre modification, cliquez d'abord sur le bouton Prévisualiser, vérifiez le bon rendu de votre modification, puis cliquez finalement sur Publier. Votre correction est immédiatement en ligne. N'oubliez pas de préciser un rapide résumé de votre modification dans le champ prévu à cet effet (exemple : « détails sur la création d'un sous-domaine ») avant de cliquer sur Publier.

Ajouter un nouvel article

Il se peut que la notion que vous souhaitez expliquer ne soit pas encore documentée dans le wiki. Vous pouvez alors commencer un nouvel article. Pour cela, rien de plus simple : tapez le titre de votre article dans le moteur de recherche (à gauche) et validez. Le moteur vous indique qu'il n'a trouvé aucun résultat. Cliquez alors sur le lien rouge créer cet article. Vous obtenez le même formulaire (mais vide, bien entendu) que pour l'édition d'un article. À vous de jouer, maintenant !

Révisions

Notez que chaque modification (on dit aussi révision) d'un article entraîne la sauvegarde de la version précédente. Cela permet de conserver les contributions antérieures afin d'éviter que les éditions erronées, ou celles de personnes mal intentionnées, soient irréversibles. En effet, si quelqu'un vide un article de son contenu ou insère un contenu hors-sujet, il sera très facile de revenir à une révision antérieure, nette de tout vandalisme, grâce à l'historique des révisions.

Aussi, en cas d'erreur lorsque vous éditez un article, ne paniquez pas. Vous pouvez éditer l'article à nouveau et corriger vos erreurs, ou revenir à la version précédente : cliquez sur l'onglet historique puis cliquez sur le lien défaire à côté de la dernière modification. Cliquez sur Publier pour confirmer.

Aide à la modification

Lorsque vous créez ou éditez un article, le formulaire d'édition est une simple zone de texte. Aussi, vous ne pouvez pas voir directement la mise en forme de l'article (gras, italique, titres, etc.), comme dans Word, mais vous voyez à la place un ensemble de caractères spéciaux. Ces caractères permettent, selon certaines normes détaillées dans la suite de cet article, de donner de la mise en forme au texte brut. L'assimilation de ces normes pouvant être ardue, ce guide vous servira de mémo.

Syntaxe et sémantique

Si vous souhaitez vous essayer sur l'utilisation de la syntaxe du wiki (pour voir comment ça marche, si ce qu'il se passe est conforme à vos attentes, etc.), vous pouvez utiliser cet article « bac à sable » que vous êtes libre d'éditer comme bon vous semble, afin d'effectuer vos essais. Cette page est dédiée aux débutants qui souhaitent s'initier à la syntaxe du wiki. N'hésitez pas à l'utiliser.

Titres

Tout d'abord, sachez qu'un bon article est un article dont la division en parties et sous-parties sera bien réfléchie. Si votre article est un peu long, il est donc utile de le partager en différents points, synthétisés par un titre. Les différents niveaux de titres (titre, sous-titre, sous-sous-titre, etc.) permettent de faire apparaître un plan dans votre article et donc de le rendre plus lisible et compréhensible.

Pour insérer un titre, entourez celui-çi d'un nombre de = égal au niveau du titre. Par exemple :

= Partie 1 =
== Sous-partie ==
Bla bla.

== Encore une sous-partie ==
Bla bla.
 
=== Une sous-sous-partie ===
Bla bla.

= Partie 2 =

Emphase

L'emphase désigne l'importance donnée à un terme dans une phrase. Cela se traduit sur le papier (enfin, sur l'écran) par l'italique et par le gras (le souligné n'a pas de valeur sémantique). Pour mettre une expression (un ou plusieurs mots) en italique, entourez-la de deux guillemets simples : ''ceci en italique'' ; pour du gras, mettez-en trois : '''ceci en gras'''.

Utilisez l'emphase avec modération et réservez-la aux termes vraiment importants. Notez que vous pouvez aussi utiliser les boutons présents au-dessus de la zone d'édition pour appliquer l'emphase à un texte préalablement sélectionné.

Liens

L'intérêt d'un wiki est de permettre à l'utilisateur de se documenter sur une notion, et d'être renvoyé vers un autre article de ce wiki si une notion spéciale est abordée et qu'il souhaite en savoir plus. Il s'agit alors d'un lien interne, car il pointe sur un autre article de ce wiki. Mais il peut également être utile de donner à l'utilisateur un lien vers un site extérieur au wiki.

Aussi, ces deux types de liens (interne et externe) ne sont pas notés de la même façon.

Texte par défaut Texte personnalisé
Lien interne [[Nom de l'article]]

Exemple : [[Support]] donne Support

[[Nom de l'article|Texte personnalisé]]

Exemple : [[Support|de l'aide]] donne de l'aide

Lien externe http://site.com/

Exemple : http://alwaysdata.com/ donne http://alwaysdata.com/

[http://site.com/ Texte personnalisé]

Exemple : [http://alwaysdata.com/ le meilleur hébergeur] donne le meilleur hébergeur

Vous remarquerez la présence d'une petite icône en forme de flèche à côté des liens externes.

Listes

Souvent, il est intéressant de présenter des éléments sous forme d'une liste, numérotée ou à puces. Pour créer une liste à puces simple, il suffit de faire précéder chaque élément par un astérisque *. Pour une liste numérotée, utilisée plutôt un dièse #.

Comme pour les titres, on peut utiliser plusieurs fois le caractère en début de ligne pour créer différents niveaux d'indentation.

Exemples :

Syntaxe Rendu
* Salades
* Pommes de terres
* Fruits :
** Poires
** Cerises
* Courgettes
  • Salades
  • Pommes de terres
  • Fruits :
    • Poires
    • Cerises
  • Courgettes
Syntaxe Rendu
# Préchauffer le four
# Préparer la salade
#* Vinegrette
#* Croutons
# Mettre au four
  1. Préchauffer le four
  2. Préparer la salade
    • Vinegrette
    • Croutons
  3. Mettre au four

Extraits de code

Dans la documentation d'alwaysdata, qui est un service d'hébergement de site web, il n'est pas rare de croiser des morceaux de code dans une explication. Pour insérer des extraits de code dans votre article, il existe deux méthodes.

La première est d'écrire chaque ligne du code précédée d'une espace (représentée ci-dessous par le caractère ␣). Ainsi :

Syntaxe Rendu
␣import module
␣print "Hello world!"
␣module.start()
import module
print "Hello world!"
module.start()

Autres modèles utiles

Outre ces quelques outils de mise en forme, il existe d'autres syntaxes un peu plus complexes (tableaux, images, catégories, etc.). Vous retrouverez sur l'article de Wikipédia une aide plus approfondie concernant ces syntaxes.

De plus, il existe sur ce wiki des modèles (c'est à dire des bouts de pages que l'on utilise souvent dans les articles) spécifiques à la documentation d'alwaysdata. Ils permettent de rendre plus facile l'insertion de certains éléments, ainsi que d'homogénéiser la mise en forme des articles. Merci d'y jeter un coup d'œil afin de les utiliser au bon moment.

Combinaisons de touches

Parfois dans un article, vous demandez à l'utilisateur de presser une combinaison de touches (raccourcis clavier). Pour afficher une combinaison dans un article, utilisez la syntaxe suivante :

{{keypress|touche|touche|...}}

Par exemple :

{{keypress|Alt|F4}} pour afficher Alt + F4
{{keypress|Ctrl|Shift|X}} pour afficher Ctrl + ⇧ Shift + X

Lien vers l'administration

Souvent, les articles demandent à l'utilisateur de se rendre dans son interface d'administration, dans une certaine rubrique de cette interface (comme les bases de données MySQL par exemple). Pour faciliter la navigation de l'utilisateur, il est donc utile de mettre un lien externe vers la bonne rubrique de l'administration alwaysdata directement dans l'article. Ce serait un peu long de le faire manuellement. Aussi vous pouvez plutôt utiliser le modèle suivant :

{{adminpath|/adresse/de/la/rubrique|Nom de la rubrique}}

Cela affiche automatiquement un lien vers l'adresse spécifiée, avec le nom de rubrique spécifiée. Exemples :

{{adminpath|/usage/storage/|Espace disque}} donne Espace disque
{{adminpath|/domain/add/1/|Domaines|Ajouter un domaine}} donne Domaines › Ajouter un domaine

Boutons

Pour finir, il existe quelques modèles pour afficher les boutons couramment utilisés dans l'administration alwaysdata. En voici la liste :

Syntaxe Rendu
{{bouton|Texte du bouton}}
Texte du bouton
{{bouton/edit}}  Image:IconEdit.png
{{bouton/delete}}  Image:IconDelete.png
{{bouton/more}}  Image:IconSearch.png
{{bouton/pdf}}  page_white_acrobat.png

En cas de problème

Ce guide n'est qu'un aperçu des capacités de ce wiki. Si vous le souhaitez, vous pouvez en savoir plus grâce à l'aide de Wikipédia qui décrit en détails les fonctionnalités de cet outil de documentation (nous utilisons, à peu de choses près, le même système que Wikipédia).

Sachez également que vous pouvez contacter l'équipe alwaysdata si vous avez une requête particulière à propos de ce wiki. Pour cela, nous préférerions que vous utilisiez la page de discussion de cet article ou bien le canal de discussion.