Comment utiliser for

Une des plus importantes fonctionnalités de notre base de connaissances est la capacité d'afficher les instructions personnalisées pour les systèmes d'exploitation (Windows, Android...) et les versions de Firefox. Nous pouvons dire, par exemple, qu'une certaine section d'un article d'aide est pour (for en anglais) les utilisateurs de Windows, et les utilisateurs de Mac et Linux ne le verront pas. Lorsque quelqu'un accède à un article d'aide, nous détectons automatiquement le système d'exploitation et la version de Firefox qu'il utilise et lui montrons les instructions appropriées. Cet article décrit les détails sur la manière d'utiliser {for} dans les articles de la base de connaissances.

Comment changer les instructions en fonction des différents systèmes d'exploitation ou versions de Firefox

Afin de suivre l'exemple de cet article, vous devrez définir le système d'exploitation et la version de Firefox à l'aide du sélecteur « L'article est pour ». Il se trouve en bas du panneau latéral droit.
For selector

Syntaxe et comportement de base

Systèmes d'exploitations

Voici la syntaxe pour afficher une image uniquement pour Windows :
{for win}[[Image:vista.jpg]]{/for}

  • Réglez le sélecteur sur Windows pour voir l'image :
    vista.jpg
  • Si vous réglez le sélecteur sur Mac OS X ou Linux, l'image ci-dessus ne s'affichera pas car il n'est pas prévu pour eux.
Note : Si vous réglez le sélecteur sur Android, l'image est visible même s'il n'est pas spécifié. C'est parce que nous avons choisi d'afficher les instructions Windows par défaut (sauf spécifié autrement) si vous utilisez Firefox pour mobile. Nous avons également choisi d'afficher les instructions Android si vous regardez l'aide pour mobile avec Windows, Mac ou Linux.

Versions de Firefox

Voici la syntaxe pour afficher quelque chose pour Firefox 9 et supérieur :
{for fx9}[[Image:Firefox Logo]]{/for}

  • Réglez le sélecteur sur Firefox 9 ou supérieur pour voir l'image :
    Firefox Logo
  • Si vous réglez le sélecteur sur Firefox 3.5 - 3.6, le message ci-dessus disparaîtra car il n'est pas prévu pour eux.

Afficher les instructions pour une seule version de Firefox

Pour afficher les instructions uniquement pour Firefox 9, utilisez l'opérateur « = » :
{for =fx9}[[Image:Firefox Logo]]{/for}

  • L'image ne s'affiche désormais que lorsque vous réglez le sélecteur sur Firefox 9 :
    Firefox Logo

Firefox 3.5-3.6 fonctionne différemment. Lorsque vous spécifiez {for fx35}, les instructions s'afficheront uniquement pour Firefox 3.5-3.6, l'opérateur « = » n'est pas nécessaire :
{for fx35}[[Image:Firefox Logo]]{/for}

  • Réglez le sélecteur sur Firefox 3.5-3.6 pour voir une image :
    Firefox Logo

Combiner les systèmes d'exploitation et versions de Firefox

Vous pouvez spécifier un système d'exploitation et une version de Firefox en les séparant par une virgule :
{for win,fx9}[[Image:vista.jpg]][[Image:Firefox Logo]]{/for}

  • Réglez le sélecteur sur Windows et Firefox 9 ou supérieur pour voir les images :
    vista.jpg Firefox Logo

Une situation plus complexe avec un « ou » implicite peut être écrite comme ceci :
{for mac, win, fx35, =fx9}[[Image:vista.jpg]][[Image:macos.jpg]][[Image:Firefox Logo]]{/for}

  • Réglez le sélecteur sur Mac ou Windows et Firefox 3.5-3.6 ou Firefox 9 pour voir les images :
    vista.jpg macos.jpg Firefox Logo

Formellement, le texte entre {for} et {/for} sera affiché si une de ces conditions est remplie :

  • Le {for} liste au moins un OS et inclut celui que l'utilisateur exécute (ou a sélectionné manuellement).
  • Le {for} liste au moins une version de Firefox et inclut celle que l'utilisateur exécute (ou a sélectionné manuellement).

Autrement, le contenu de {for}...{/for} n'est pas affiché.

D'autres choses sont à noter :

  • Les espaces après les virgules sont facultatives.
  • La syntaxe {for} ne fonctionne que sur les articles de la base de connaissances.
  • {for} et d'autres balises Wiki ne fonctionnent pas dans les résumés des résultats de recherche.
  • Les titres de rubrique qui sont masqués par les blocs de {for} n'apparaissent pas dans la table des matières de la page. Si l'utilisateur les fait afficher en sélectionnant manuellement la bonne combinaison d'OS/navigateur, les entrées de la table des matières apparaissent instantanément.

Abréviations de système d'exploitation et de navigateur

Ce sont les abréviations de système d'exploitation et de navigateur disponibles pour l'utilisation dans {for} :

  • win (Windows)
  • mac (Mac OS X)
  • linux (Linux)
  • android (OS mobile Android)
  • fx35 (Firefox 3.5 et 3.6)
  • fxN où N = la version de Firefox version, c.-à-d. fx8, fx9, fx10, etc.
  • mN où M = la version de Firefox version, c.-à-d. m8, m9, m10, etc.
Note : Toutes les six semaines, nous ajoutons la prise en charge pour la dernière version bêta de Firefox. Au même moment, nous supprimons du sélecteur la plus ancienne version, sans que cela n'empêche la vieille balise de toujours fonctionner. Ainsi, par exemple, si quelqu'un affiche un article avec Firefox 4, il verra les instructions pour sa version.

Contextes ligne et bloc de lignes

{for} peut être utilisé aussi bien sur une ligne ou sur un bloc de lignes (au sens HTML). La forme ligne prend effet en travaillant dans une ligne de texte :

C'est {for win}l'utilisation par ligne{/for}.

La forme bloc est utilisée pour entourer des paragraphes entiers, des listes ordonnées, des titres de rubrique, et ainsi de suite. La seule restriction est que, en utilisation la forme bloc, le {for} et {/for} doivent être chacun sur une ligne. Autrement, il pourrait être considéré comme une partie d'un paragraphe voisin et produire des résultats surprenants.

{for win}
C'est un bloc.
*Un
*Deux
{/for}

Utiliser le bouton {for} dans l'éditeur d'article

Quand vous modifiez un article de la base de connaissances, vous pouvez utiliser le bouton {for} dans la barre d'outils pour écrire la balise souhaitée.

  1. Surlignez le texte que vous voulez mettre entre les balises {for}.
  2. Cliquez sur Afficher pour... dans la barre d'outils d'édition.
  3. Cochez les cases des versions de Firefox et des système d'exploitation qui seront vus pour ce contenu, puis cliquez sur Ajouter une règle. Les balises personnalisées {for} seront placées autour de la section que vous avez surlignée.

Meilleurs pratiques pour l'utilisation de {for} dans les articles

Lors de la rédaction d'instructions pour différents systèmes d'exploitation, le mieux est d'écrire des phrases et paragraphes entiers pour chaque OS et version de Firefox même si cela implique de dupliquer des choses. Cela rend l'article plus facile à comprendre, à maintenir et à localiser. En temps voulu, par exemple, pour supprimer les instructions spécifiques à Firefox 3.5/3.6, ces sections pourront simplement être effacées plutôt que d'essayer de les exciser d'une section plus grande.

Exemple :
Mauvais
#{for win,linux}En haut de la fenêtre de Firefox{/for}{for mac}Sur la barre de menus{/for}, cliquez sur le {for fx35}menu {menu Outils}{/for}{for mac,linux,fx4}menu {menu Outils}{/for}{for win,fx4}bouton {button Firefox}, survolez le menu {menu Historique}, puis sélectionnez le menu {menu Supprimer l'historique récent...}{/for}{for not win,fx4}, puis sélectionnez le menu {/for}{for win,fx35}{menu Supprimer l'historique récent...}{/for}{for mac,linux}{menu Supprimer l'historique récent...}{/for} {for win,fx4}<br>'''Pour Windows XP :''' En haut de la fenêtre de Firefox, cliquez sur le menu {menu Outils}, puis sélectionnez {menu Supprimer l'historique récent....}{/for}

Bon
{for fx4}
#{for win}En haut de la fenêtre de Firefox, cliquez sur le bouton {button Firefox}, survolez le menu {menu Historique}, puis sélectionnez {menu Supprimer l'historique récent...} ('''Windows XP :''' cliquez sur le menu {menu Outils}, puis sélectionnez {menu Supprimer l'historique récent...}).{/for}{for mac}Sur la barre de menus, cliquez sur le menu {menu Outils}, puis sélectionnez {menu Supprimer l'historique récent...}{/for}{for linux}En haut de la fenêtre de Firefox, cliquez sur le menu {menu Outils}, puis sléectionnez {menu Supprimer l'historique récent...}{/for}
{/for}
{for fx35}
#{for win,linux}En haut de la fenêtre de Firefox, cliquez sur le menu {menu Outils}, puis sélectionnez {menu Supprimer l'historique récent...}{/for}{for mac}Sur la barre de menus, cliquez sur le menu {menu Outils}, puis sélectionnez {menu Supprimer l'historique récent...}{/for}
{/for}

Un autre exemple :
Dans l'exemple ci-dessus, nous traitons de Firefox 3.6, et Firefox 4 et supérieur, comme deux jeux d'instructions différents. C'est souvent le cas, mais au fur et à mesure que nous changerons Firefox toutes les six semaines, nous verrons plus de modifications dans les dernières versions. Elles ressembleront à ceci :

Bon :
{for fx35}
#Les anciennes instructions.
{/for}
{for =fx8,=fx9}
#Les nouvelles instructions.
{/for}
{for fx10}
#Les toutes nouvelles instructions.
{/for}

Cet article vous a-t-il été utile ? Veuillez patienter…

Ces formidables personnes ont aidé à écrire cet article : scoobidiver. Vous pouvez également aider - découvrez comment.