Boîte à outils

From KDE TechBase
Revision as of 17:34, 7 September 2020 by ChristianW (talk | contribs) (Created page with "=== Itemisations ===")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Attention
Cette page est un doublon de https://userbase.kde.org/Toolbox et son contenu sera progressivement fusionné dans Userbase. Donc n'effectuez plus de mise à jour ici.


 
Information
Cette page offre des examples pour formater le code dans les tâches communes


Mettre en forme votre texte

Utiliser les paragraphes

Les titres de paragraphe sont automatiquement inclus dans le sommaire, ils doivent donc être structurés. Leur place dans l'arborescence est indiquée par des signes formés de multiples caractères '=' de part et d'autre du titre lui-même. Evitez le signe unique - réservé au titre des pages, pour lequel la déclaration automatique est utilisée. Vos paragraphes au niveau 1 commenceront par '== titre de paragraphe niveau 1 ==', puis au premier niveau inférieur, '=== titre du paragraphe de niveau 2 ===' et ainsi de suite.

Utiliser le gras et l' italique

Les spots sont utilisés pour marquer les mots en gras et en italique.

Utilisez '''texte en gras''' pour spécifier un texte en gras et ''texte en italique'' pour spécifier un texte en italique.

Afin de nous assurer d'avoir des traductions faciles et appropriées, veuillez adhérer aux règles typographiques.

Ajouter un extrait de code

Nous avons des modèles pour vous aider à afficher correctement des parties de code. Des exemples d'utilisation dans des situations variées sont disponibles sur la page des règles typographiques. Le code des différents modèles de boîte peuvent être recopiés de cette page.

Si vous avez des problèmes pour afficher les barres verticales '|' dans votre extrait de code, veuillez lire les explications et le balisage détaillé dans les règles typographiques

Ajouter des indentations

":" est utilisé pour l'indentation, et se trouve sur d'anciennes pages pour les multiples . Ceci est obsolète et cause des problèmes, par conséquent les multiples seront supprimés dès qu'ils apparaissent. Chaque ":" indente de quatre caractères.

Formater les dates

Les dates dans un format purement numérique créent la confusion, à cause des différences de présentation dépendant des zones géographiques. Veuillez formater les dates ainsi :

18 Mar 2011

avec le mois soit écrit en clair complètement ou sous forme abrégée, et l'année sous forme de quatre chiffres. Le jour peut être exprimé sur un ou deux chiffres.

Listes à puces

* est le symbole utilisé pour les listes à puces. ** exprime le second niveau :

* Amandes

* Noix
** Noix de cajou

* Raisins

génère

  • Amandes
  • Noix
    • Noix de cajou
  • Raisins

Enumérations

Les énumérations se font sur le même principe, mais en utilisant '#'.

# Tamiser
# Mélanger
## Bien mélanger
# Cuire

génère :

  1. Tamiser
  2. Mélanger
    1. Bien mélanger
  3. Cuire

Combiner les listes à puces avec des listes énumérées

Vous pouvez avoir une sous-liste énumérée dans une liste à puces et vice versa, comme ceci :

* Noix
*# Noix de cajou
*# Divers
* Autres choses

génère :

  • Noix
    1. Noix de cajou
    2. Divers
  • Autres choses

alors que :

# Noix 
#* Noix de cajou
#* Divers
# Autres choses

génère :

  1. Noix
    • Noix de cajou
    • Divers
  2. Autres choses
Remarque
Les énumérations ne doivent pas comporter de ligne blanche dans la liste : ceci casse la séquence et la numérotation reprend à 1. De manière similaire, il ne doit jamais y avoir de ligne blanche avant un élément de sous-liste, qu'il soit numéroté ou à puce : cela crée un marquage à deux niveaux d'éléments (puces ou numéros).


Remarque
Veuillez considérer que les longues listes sont un problème pour les traducteurs. Avec des listes à puces à un niveau, placez chaque puce dans une section individuelle, par exemple ajoutez une ligne blanche entre chaque puce. Pour les listes à puces à deux niveaux, les sous-éléments doivent être gardés dans la même section que la puce de niveau supérieur où ils se trouvent; si vous utilisez des sous-puces, faites des sous-listes courtes ! Avec l'énumération en plus, vous devez placer chaque élément dans une unité séparée. Veillez à éviter les énumérations, et si vous pensez que vous devez néanmoins les utiliser, faites les courtes.


Itemisations

Itemizations are produced using ; and : alternately. They are best for giving short descriptions for a group of related objects.


;Animals
: They move around and devour other creatures.

;Plants
: They have roots and feed upon ground water and sun.

produces

Animals
They move around and devour other creatures.
Plants
They have roots and feed upon ground water and sun.
Note
As allways, please keep each item in a section of its own; it helps translators a lot.


Ajouter un lien

There are two kinds of links to learn, internal ones, to another TechBase page, and external URL links.

For an internal link the format [[Typographical_Guidelines]], where you want to display the name of the page, does work, but it is not ideal, particularly for translation to docbook and for localisation. It is better to use the form [[Special:myLanguage/Typographical_Guidelines|Typographical Guidelines]], because that allows translators to link correctly even though the page name is localised. The result is that it directs to the correctly translated page, if one exists. You often need to include the link in a sentence, so in that case you would use

[[Special:myLanguage/Typographical_Guidelines|this page]]

which displays

this page

External links are slightly different so

[http://techbase.kde.org/Schedules our road map]

displays

our road map, which would take you straight to the techbase page.

One last thing to note - when you preview your page, all links are live. This gives you two benefits. You can check (by hovering) that your links are set up as you expected, and you can use a red link to create a new page.

Illustrate Your Text

Add a single image, centered

[[Image:KMail-kde4.png|250px|center]]

Note that you can change the position of the image, but the default is left. The size of the image depends on the circumstances, but for screenshots I recommend no less than 250px and no more than 500px.

Make the Image Clickable, and Add a Caption

Where you need to show more detail, create a moderately sized image, clickable, so that the full-size can be seen. Simply add the parameter '|thumb' within the image parentheses.

A caption can also be added as a parameter, but will only show if '|thumb' is present.

Use Tables to Precisely Place Multiple Images

{|class="tablecenter" style="border: 1px solid grey;"
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|-
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]
|}

génère :


Note that all the parameters for one image are contained within [[...]], and cells are separated by '||'. To start a new line, insert '|-' on an otherwise-empty line, then '|' at the start of the next one.

Ajouter des notes et des avertissements

Là où une explication où une mise en garde s'impose dans votre texte, utilisez ces modèles :

{{Info/fr|Ceci est une information générale }} génère :

 
Information
Ceci est une information générale


{{Note/fr|Voici des informations importantes à cette étape.}} génère :

Remarque
Voici des informations importantes à cette étape.


{{Tip/fr|Un conseil utile, quelque chose à se rappeler}} génère :

Astuce
Un conseil utile, quelque chose à se rappeler


{{Warning/fr|Manipulez avec précaution, cette action peut être dangereuse.}} génère :

Attention
Manipulez avec précaution, cette action peut être dangereuse.


Quand l'avertissement est impératif, la boîte Remember peut être utilisée, mais n'en abusez pas.
{{Remember/fr|1=Ceci concerne les choses qu'il ne faut absolument pas oublier.}} génère :

 
Rappel
Ceci concerne les choses qu'il ne faut absolument pas oublier.


Vous pouvez aussi modifier le titre.

 
N'oubliez pas!
Utilisez le paramètre numéro 2 pour donner un titre particulier à la boîte.
{{Remember/fr|2=N'oubliez pas!|1=Uilisez le paramètre numéro 2 pour donner un titre particulier à la boîte.}}


Autres modèles utiles

Insérer les icônes de l'interface utilisateur

The best way to refer to icons in the GUI is to display it in the text. This can be done with a template like this: {{Icon|list-add}}. This will display the icon.

For this to work, the icon image must have been uploaded to the wiki. See Update an Image for an explanation on how to upload images. The .png files can usually be found here: usr/share/icons/oxygen. If possible use the 16x16 icon. The file name should have an Icon- prefix as in Icon-list-add.png — apart from the prefix the filename should exactly match the usual name. Note, that when using the template you should neither write the Icon- prefix nor the .png file type extension.

The icon can also be written as {{Plus}}, and the icon as {{Minus}}. You can also use {{Configure}} to get the icon, and {{Exit}} gets you the icon.

Faire des modifications importantes sur les pages existantes

Si une page doit être ouverte pour modification pour un certain temps, il y a risque de conflits - quelqu'un d'autre peut se mettre à la modifier au même moment et si vous enregistrez vos modifications, vous effacerez les siennes, ou vice versa. La manière d'éviter cela est de faire une entrée temporaire, directement sous la barre des langues, en utilisant {{Being_Edited/fr}} qui affiche :

 
En cours de modification
Cette page est en cours de modification.
Si ce message s'affiche pendant un temps anormalement long, veuillez soit le notifier sur irc.freenode.org #kde-www ou le rapporter sur la page de discussion de Annewilson.


... et n'oubliez pas de le retirer quand vous aurez terminé !

Ajouter une nouvelle page complexe

Si vous voulez pouvoir travailler sur une page pendant un temps assez long, plusieurs jours par exemple, vous pouvez utiliser le modèle {{Construction/fr}}, qui génère :

 
En cours de construction
Ceci est une nouvelle page, actuellement en cours de construction !


Ajouter une liste de sous pages

== Sous-pages de {{FULLPAGENAME}} ==
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}

est très utile si vous voulez lister les sous-pages avec les liens actifs, tels que :

Sous-pages de Toolbox

Mais cela affiche aussi toutes les pages des autres langues, alors à utiliser avec discrétion.

{{Special:PrefixIndex/Toolbox/}} produit :