Boîte à outils

From KDE Wiki Sandbox
Revision as of 18:53, 16 February 2018 by ChristianW (talk | contribs)
Information
Cette page montre des exemples de formatage du code pour les cas courants


Ajouter une capture d'écran introductive et une description

Chaque fois que cela est possible nous commençons une page importante d'une application avec cela. Le code pour le faire est celui-ci

{|class="tablecenter vertical-centered"
|[[Image:YourScreenshot.png|250px|thumb]]
|Votre texte de description
|}

Formater votre texte

Uiliser des titres

Chaque titre démarre sa propre ligne et la termine avec deux ou plus caractères '='. S'ils sont plus d'un sur une page, ils créent automatiquement une Table des matières, aussi utilisez-les. Le nombre de caractères '=' détermine leur niveau dans la Table des matières, ainsi les titres peuvent être '==Nom de la principale section=', '===Nom de la sous-section===', '====ici nom de la sous-sous-section====', et ainsi de suite. Évitez d'utiliser un seul '=', comme cela indique un titre de page et chaque page de wiki a déjà un nom fabriqué à partir du sien ; par exemple, ce titre de page "Toolbox/fr" apparaît come son titre de page

Utiliser le gras et l' italique

Les guillemets sont utilisés pour spécifier les mots en gras et en italique.

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

Pour être certain que nous obtiendrons des traductions faciles et fiables, veuillez appliquer les règles typographiques.

Ajouter un fragment de code

Nous avons des modèles pour aider à afficher correctement les fragments de code. Des exemples d'utilisation dans différentes situations sont disponibles à la page des règles typographiques

Si vous rencontrez des problèmes pour afficher les caractères pipe dans votre fragment de code, veuillez consulter l'explication et le détail des balises dans Règles typographiques

Ajouter des indentations

":" est utilisé pour une indentation, et était utilisé dans certaines pages anciennes. Cela est déprécié et cause certains problèmes, aussi les multiples doivent etre supprimés lorsqu'ils sont trouvés. Un simple ":" indentera de quatre caractères.

Formater les dates

Les dates dans un format purement numérique provoquent une confusion, dûe aux différences dans les zones géographiques. Veuillez formater les dates ainsi

18 mars 2011

avec le mois soit écrit en entier sous forme abrégée, et l'année sur 4 chiffres. Le jour peut avoir un ou deux chiffres.

Listes à puces

* est le symbole à utiliser pour les listes à puces. ** produit un second niveau :

* Amandes

* Noisettes
** Noix de cajou

* Raisins

produit

  • Amandes
  • Noisettes
    • Noix de cajou
  • Raisins

Énumérations

Les énumérations sont produites de la même façon, en utilisant '#'.

# Tamiser
# Mélanger
## Remuer soigneusement
# Cuire

produit

  1. Tamiser
  2. Mélanger
    1. Remuer soigneusement
  3. Cuire

Pour plus de détails sur les listes, voir wikimedia.

Combiner listes à puces et énumérations

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

* Noisettes
*# Noix de cajou
*# folies
* Autres choses

produit

  • Noisettes
    1. Noix de cajou
    2. Folie
  • Autres choses

tandis que

# Noisettes
#* Noix de cajou
#* Folies
# Autres choses

donne

  1. Noisettes
    • Noix de cajou
    • Folies
  2. Autres choses
Note
Les énumérations ne doivent jamais comporter de lignes vides : elles cassent la séquence et la numérotation redémarre à un à nouveau. Pareillement, il ne doit pas y avoir de ligne vide avant un item de sous-liste qu'elle soit numérotée ou avec des puces : elle crée alors deux niveaux d'items (puces ou nombres)


Note
Veuillez vous souvenir que les longues listes sont un problème pour les traducteurs. Avec de simples listes à puces, placez chaque puce dans sa propre section, i.e. laissez une ligne vide entre les puces. Avec deux niveaux de puces, les sous-items doivent être conservés dans leur niveau supérieur de puces ; si vous utilisez des sous-puces, veuillez faire des sous-listes courtes ! Avec des énumérations incluses, vous devez conserver chaque contenu dans une unité. Essayer d'éviter les énumérations, et si vous trouvez nécessaire d'en utiliser, essayez de les faire brèves.


À propos
Bien qu'il soit important d'éviter les lignes vides dans les énumérations et les listes, il est encore possible de scinder de telles listes en plusieurs unités de traduction. C'est fortement recommandé !


Pour obtenir chaque puce et chaque sous-puce dans sa propre unité de traduction, vous pouvez taper quelque chose comme ceci :

* Première puce </translate >
<translate >
** Première sous-puce </translate >
<translate >
** Une autre sous-puce<br /><br />Celle-ci est formée de deux paragraphes </translate >
<translate >
* La prochaine puce principale </translate >
<translate >
** Ainsi de suite

Cela s'affiche ainsi :

  • Première puce
    • Première sous-puce
    • Une autre sous-puce

      elle est formée de deux paragraphes
  • La puce principale suivante
    • Ainsi de suite

La même méthode peut s'appliquer à toutes sortes de listes.

Si d'un autre côté, vous avez besoin d'avoir plus de sections dans le même item, vous pouvez faire quelque chose comme ça pour avoir chaque section dans sa propre unité de traduction :

* Première puce </translate >
<translate >
* Deuxième puce, première section. </translate><br /><br /> <translate > Seconde section de la deuxième puce. Cette section a sa propre unité de traduction</translate >
<translate >
* Ainsi de suite 

Cela s'affiche ainsi :

  • Première puce
  • Seconde puce, première section.

    Seconde section de la deuxième puce. Cette section a sa propre unité de traduction
  • Ainsi de suite

Itémisations

Les itémisations sont produites en utilisant ; et : alternativement. Elles sont préférables pour donner de courtes descriptions à un groupe d'objets liés.

; Animaux
: Ils se déplacent autour et dévorent les autres créatures.

; Plantes
: Elles ont des racines et exigent une terre arrosée et du soleil.

donne

Animaux
Ils se déplacent autour et dévorent les autres créatures.
Plantes
Elles ont des racines et exigent une terre arrosée et du soleil.
Note
Comme d'habitude, veuillez conserver chaque item dans sa propre section ; cela aidera beaucoup les traducteurs.


Ajouter un lien

Il y a trois sortes de liens à connaître: les internes vers une autre page de la base utilisateurs, ou vers une section de page dans la base utilisateurs, et les externes vers une URL.

Pour un lien interne, le format [[PageLayout]], où vous souhaitez afficher le nom de la page, fonctionnera mais ce n'est pas l'idéal, particulièrement pour la traduction vers Docbook et pour la localisation. Il est préférable d'utiliser la forme [[Special:myLanguage/PageLayout|Mise en page]], parce que cela permet aux traducteurs de faire un lien correct même si le nom de la page est localisé. Le résultat en est un lien direct vers la page correctement traduite, si elle existe. Vous avez souvent besoin d'inclure le lien dans une phrase, dans ce cas, vous devrez utiliser

[[Special:myLanguage/PageLayout|cette page]]

qui affiche

cette page

Les liens internes vers les sous-sections d'une page utilisent le caractère '#' (dièse) et ont le format suivant :

[[Special:myLanguage/Tasks_and_Tools#Working_with_Languages|...]]

Avec ce type de lien, il est très important que la page que vous liez déclare l'ancre référencée. Si l'ancre possède des caractères espace, il faut dans l'appel de la référence, les remplacer par des caractères '_' (souligné). Si la référence est trouvée, la section sera directement affichée par votre navigateur (s'il prend en charge les ancres). Dans le cas contraire, il vous faudra descendre manuellement dans la page pour trouver la section référencée.

Déclarer une ancre de sous-page

La déclaration doit être faite immédiatement AVANT la section que vous liez et suivie d'une ligne vide séparant l'ancre du titre. Dans l'exemple suivant, il suffit de recopier, dans l'ID, le titre de la section associée. Cela doit ressembler à ça :

 </translate><span id="Working with Languages"></span><translate>

Si la page contenant la section que vous avez liée n'est pas encore marquée pour la traduction, vous devez omettre les balises </translate> et <translate>.

Les liens externes sont légèrement différents ainsi

[http://techbase.kde.org/Calendriers de notre feuille de route]

affiche

de notre feuille de route, qui vous conduit droit vers votre page technique.

Une dernière chose à noter - lorsque vous prévisualisez votre page, tous les liens sont actifs. Cela vous apporte deux bénéfices. vous pouvez vérifier (en les survolant) que vos liens sont définis come vous l'espériez, et vous pouvez utiliser un lien rouge pour créer une nouvelle page.

Construire une liste d'applications

Si vous souhaitez fair eune liste d'applications comme celle de la sous-pages de Applications, vous devez utiliser le modèle AppItem. Simplement tapez

{|
{{AppItem|System Settings/Locale|Preferences-desktop-locale.png|
Paramètres pour localiser les nombres, les dates, etc}}Un court texte.
Quelques lignes à propos de l'application. C'est optionel.
|-
{{AppItem|System Settings/Shortcuts and Gestures|Preferences-desktop-keyboard.png|
Raccourcis}}Un autre texte court. si vous ne tapez pas <keycap>Entrée</keycap> entre les textes
vous obtenez une section pas plus qu ene l'es tle texte.
|}

Cela donne l'affichage suivant :

Paramètres pour la localisation des nombres, dates, etc

Un court texte.

Quelques lignes supplémentaires sur l'application. C'est optionel.

Shortcuts and Gestures

Un autre court texte. Si vous ne tapez pas Entrée entre les textes, vous obtiendrez une seule section pas plus longue que le texte.

Notez que vous n'avez pas à préfixer le nom de la page avec "Special:myLanguage" - le modèle s'en occupe. Notez aussi que vous devez donner un titre, même si ce lui-ci est le même de celui de la page.

Pied de page

Les notes de pied de page sont rarement utilisées dans nos pages, mais si vous en avez besoin, vous pouvez placer un <ref>texte</ref> dans la source où la marque de la note de pied de page doit apparaître. Il doit y avoir une <référence /> quelquepart aussi dans la source, habituellement vers le bas de la page. C'est l'endroit où le texte ajouté par les balises <ref> apparaîtront. Pour plus d'informatins, voir Wikipedia help page.

Illustrer votre texte

Ajouter une seule image, centrée

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

Notez que vous pouvez modifier la position de l'image, mais la posiiton par défaut est la gauche. La taille de l'image dépend des circonstances, mais pour les captures d'écran, je recommande un minimum de 250 px et un maximum de 500 px.

Remarquez aussi que «  Image: » et « File: » sont synonymes. Si bien que [[Image:KMail-kde4.png]] est la même chose que [[File:KMail-kde4.png]]

voir mediawiki pour plus d'infos.

Rendre l'image cliquable, et ajouter une légende

Lorsque vous avez besoin d'afficher plus de détails, créer une image de taille moyenne, cliquable, afin que la pleine taille puisse être affichée. Ajoutez simplement le paramètre '|thumb' entre les parenthèses de l'image.

Une légende peut aussi être ajoutée comme paramètre, mais elle ne sera affichée que si '|thumb' est présent.

Exemple:

[[File:file_name.png|thumb|Ceci sera la légende]]

Ajouter une légende sans vignette

La légende peut aussi apparaître sur les images formatées avec la syntaxe frame .

Exemple:

[[File:image.png|frame|left|Ceci sera la légende]]

Empêcher le texte de circuler autour de l'image

Parfois, vous pourriez ne pas vouloir que le texte s'étale sur les côtés de votre image. Vous pouvez empêcher cela en ajoutant une balise <br clear=all> entre l'étiquette du fichier et le texte en question.

Exemple:

[[File:image.png]]
<br clear=all>
Ce texte devrait normalement s'étaler sur les côtés de l'image mais maintenant il se trouvera sous l'image

Utiliser des tableaux pour placer précisément des images multiples

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

affichages

centré
centré


Notez que tous les paramètres pour une image sont contenues dans [[...]], et les cellules sont séparées par '||'. Pour commencer une nouvelle ligne, insérez '|-' sur une ligne vide, puis '|' au début de la prochaine.

Pour plus de détails sur le formatage des tableaux, voir mediawiki

Embarquer une vidéo

En juillet 2012 l'extension MediaWiki EmbedVideo a été installée sur userbase.kde. Cela signifie que vous pouvez intégrer des vidéos depuis divers sites vidéos dans le contenu de la page et les afficher en ligne.

La fonction EmbedVideo peut être appelée de manière suivante :

{{#ev:service|id}}
{{#ev:service|id|largeur}}
{{#ev:service|id|largeur|alignement}}
{{#ev:service|id|largeur|alignement|description}}
{{#evp:service|id|description}}
{{#evp:service|id|description|alignement}}
{{#evp:service|id|description|alignement|largeur}}

Où :

service est le nom du service de partage vidéo (See "nom du service" dans la liste ci-dessous)
id est l'id de la vidéo à inclure

largeur (optionel) est la largeur en pixels de l'aire de vision (la hauteur est déterminée automatiquement) alignement (optionel) est un attribut d'aligneùment. Il peut être "gauche" ou "droite". description (optionel) est une courte description pour afficher avec la vidéo quand elle est affichée

Par exemple, pour inclure la fameuse vidéo YouTube "evolution of dance", vous devez taper :

{{#ev:youtube|dMH0bHeiRNg}}

Et si vous voulez réduire jusqu'à la taille d'une vignette, sur la droite avec une courte description, vous devriez utiliser :

{{#ev:youtube|dMH0bHeiRNg|100|right|ceci est une vidéo incluse !}}


Depuis la version 1.0, EmbedVideo gère l'inclusion de contenus vidéo depuis les services suivants :

Site Nom du service
Dailymotion dailymotion
Div Share divshare
Edutopia edutopia
FunnyOrDie funnyordie
Google Video googlevideo
Interia interia or interiavideo
Revver revver
sevenload sevenload
TeacherTube teachertube
YouTube youtube and youtubehd
Vimeo vimeo

Ajouter des notes et des avertissements

Important
Les boîtes indentées ne s'affic hent pas correctement ! Ne mettez jamais une colonne en début de boîte ; cela rendra l'aspect de la boîte très mauvais.


Là où une note ou une alerte est placée dans votre texte, utilisez ces modèles :

{{Info|Ceci est une information générale}} affiche

Information
Ceci est une information générale


{{Note|Une information importante à cet endroit}} affiche

Note
Une information importante à cet endroit


{{Tip|Un bon conseil, utile à se rappeler}}affiche

Tip
Un bon conseil, utile à se rappeler


{{Warning|Attention - C'est une opération dangereuse à réaliser}} affiche

Warning
Take care - C'est une opération dangereuse à réaliser


Là où l'avertissement le plus important possible est nécessible, vous pouvez utiliser la boîte Remember, mais veuillez à l'uitliser avec parcimonie. {{Remember|1=Destiné à des choses qui ne peuvent absolument pas être oubliées}}

Remember
Destiné à des choses qui ne peuvent absolument pas être oubliées


Vous pouvez aussi modifier le titre :

À ne pas oublier !
Vous pouvez utiliser le paramètre numéro 2 pour définir un titre individuel de boite :
{{Remember|2=À ne pas oublier ! |1=Vous pouvez utiliser...}}


Redirection de page

Vous pouvez rediriger automatiquement une page vers une page destination, en écrivant :

#REDIRECT [[NomDeLaPageDestination]]

Versions KDE3 et KDE SC 4 des applications

Par défaut, KDE SC 4 est géré. Si la version de KDE SC 4 n'est pas encore prête pour la mise à jour, ou si n'existe seulement une version de KDE 3, il peut être nécessaire de documenter la version KDE3. Dans ce cas, vous devez ajouter le modèle {{KDE3}} qui affiche . Si vous devez écrire à propos de la version de KDE3 et de KDE SC 4 sur la même page, utilisez des icônes pour les deux — {{KDE4}} qui affiche

Autres modèles utiles

Insertion d'icônes de l'interface graphique

La meilleure manière de se référer aux icônes de l'interface graphique est de les afficher dans le texte. Cela peut être fait avec un modèle comme celui-ci : {{Icon|list-add}}. Il affiche l'icône .

Pour que cela fonctionne, l'icône de l'image doit être téléchargée vers le wiki. Voir Mettre à jour une image pour comprendre comment télécharger des images. Les fichiers .png peuvent être normalement trouvés ici : usr/share/icons/oxygen. Si possible utilisez l'icône 16x16. Le nom de fichier doit avoir un préfixe Icon- comme dans Icon-list-add.png — en dehors du préfixe, le nom de fichier doit correspondre exactement au nom usuel. Notez qu'en utilisant le modèle, vous ne devez jamais écrire le préfixe Icon- ni l'extension du type de fichier .png.

L'icône peut aussi être écrite {{Plus}}, et l'icône comme {{Minus}} . Vous pouvez aussi utiliser {{Configure}} pour obtenir l'icône , et {{Exit}} vous donne l'icône .

Applications de la communauté

La dernière remarque concerne ces applications qui ne sont pas distribuées comme des applications-coeur de KDE. Elles doivent être indiquées par une icône, indiquant {{Applications de la communauté}}

Template:Applications de la communauté

à la fin de votre phrase ou de votre ligne, juste comme vous voulez montrer un pied de page dans l'écriture courante. Vous avez besoin ensuite d'ajouter {{pied de page-applications de la communauté}} qui créera un pied page, comme ceci :

Template:Note de pied de page-applications de la communauté

Faire des éditions majeures aux pages existantes

Si une page est destinée à être ouverte en édition pour un certain temps, il y aun risque de conflits - quelqu'un peut vouloir éditer en même temps, et enregistrer votre édition peut annuler la sienne, ou vice versa. La manière d'éviter cela est de faire une entrée temporaire, directement sour la barre de langage, en utilisant {{En édition}} qui affichera

Template:En édition

N'oubliez pas de la supprimer quand vous avez terminé !

Ajouter une nouvelle page complexe

Si vous devez travailler sur une page pendant un certain temps, plusieurs jours, par exemple, vous pouvez utiliser le modèle Construction - {{Construction}}, qui affiche

Under Construction
This is a new page, currently under construction!


Liens vers les pages avoisinantes

Vous pouvez ajouter des liens vers une page suivante ou précédente en utilisant les modèles suivants décrits ici :

{{Prevnext2|prevpage=Previous Pagename|nextpage=Following Pagename|prevtext=La page précédant celle-ci|nexttext=La page que vous lirez ensuite|index=Index page|indextext=retour au menu}}

Ces six arguments sont optionels. Pour les premières pages qui n'ont pas de pages précédentes ou les dernières pages sans pages suivantes, utilisez ceci :

{{Prevnext2|nextpage=Following Pagename|nexttext=La page que vous lirez ensuite}}
{{Prevnext2|prevpage=Previous Pagename|prevtext=La page précédant celle-ci}}

si vous ne précisez pas indexname le nom de la page courante sera affiché.

Note
Vous devez toujours spécifier un texte pour les pages que vous liez, et vous devez toujours utiliser Special:myLanguageavec vos liens ; autrement vous créez des problèmes pour les traducteurs.


Liens vers les bogues

Vous pouvez relier un bogue directement à son entrée dans Bugzilla en utilisant ce modèle :

{{Bug|123456}}

Veuillez ne pas oublier d'ajouter le <s> et </s>pour barrer un bogue qui serait fermé.

Ajouter une liste de sous-pages

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

est très utile quand vous voulez lister les souspages avec des liens actifs comme

Sous-pages de Toolbox/fr

Il liste, de toute façon, aussi toutes les pages "autre-langage", aussi utiisez-le avec modération.