WMDE Technical Wishes/Suggested values for template parameters/fr
Cette page documente les progrès du développement et les discussions sur le projet Valeurs suggérées pour les paramètres des modèles du domaine d'intérêt "Faciliter le travail avec les modèles". Vous pouvez trouver des informations générales sur le domaine d'intérêt et sur la façon dont nous avons choisi les projets qui sont mis en œuvre |sur cette page.
| Suggested values for template parameters | |
|---|---|
| Status | Déployé à tousles wikis |
| Focus area | Modèles |
| Phabricator | T273857 |
| Responsible | Technical Wishes Team |
Les commentaires et les questions concernant ce projet sont les bienvenus sur la page de discussion.
Description
When filling in parameter values in templates in Visual Editor it is often not obvious at first glance which values are expected for a certain parameter. In some cases only certain values are even accepted by the template, but the user cannot necessarily see what those values are. For example, if a user edits an article about a novel and wants to specify the genre in the parameter "genre" in the infobox, they might ask themselves whether to enter crime, thriller or perhaps mystery?
With the new parameter property suggestedvalues, anyone who creates or maintains templates can now define a list of suggested values for a parameter. These values will then be displayed to VisualEditor users in a dropdown menu. If you use the template and want to enter a value for this parameter, you can then quickly select the appropriate value from the list. If you want to type in a value that is not in the list, e.g. Sci-Fi Crime in the example above, this option is still available. Because there are sometimes situations where an article needs a more customized value, it will be possible to fill in values other than the suggested ones.
This way, the user does not need to know the expected values and their required format in advance. It is no longer necessary to figure out what values go in each field by visiting the template documentation page or to even try to guess the expected values. This new feature is particularly helpful for those who are not yet familiar with a template.
This prevents potential errors, reduces the effort needed to fill the template with values and makes the formatting of the values more consistent. Together with the planned improvements in the template dialog, the suggested values feature makes the usage of templates in the VisualEditor easier.
Comment utiliser la nouvelle fonctionnalité
A new parameter property, suggestedvalues lets you define a list of parameter values to be shown to VisualEditor users in a dropdown for easy selection. In order to use this feature, the suggested values must be added to the template’s TemplateData. This can be done either directly in JSON or using the TemplateData editor (no coding required). Both methods are explained in detail below.
TemplateData
Vous pouvez ajouter des valeurs suggérées à afficher dans l'éditeur visuel pour les paramètres dont le type est défini par l'une des options suivantes :
- contenu
- ligne
- chaîne
- numéro
- inconnu
- wikitexte déséquilibré.
D'autres types (fichier, page, modèle, utilisateur, date, booléen, URL) ne sont pas actuellement supportés car ils ont déjà des fonctionnalités spéciales dans l'éditeur visuel, comme l'autocomplétion, qui interférerait avec le menu déroulant pour les valeurs suggérées dans l'éditeur visuel.
Editing TemplateData as JSON in Wikitext
To add suggested values to any parameter type, add the new property “suggestedvalues” to the parameter in JSON. The “suggestedvalues” attribute must be a list of strings.
Un exemple pourrait ressembler à ceci :
"media_type": {
"label": "Type de média",
"example": "Journal",
"type": "string",
"description": "Dans quel média l'article a-t-il été publié ?",
"suggestedvalues": [
"Journal",
"Livre",
"Journal",
"Magazine"
]
}
Editing TemplateData with the TemplateData Editor
For the parameter types listed above, you can add suggested values using the TemplateData editor.
Step 1. Click on "Manage TemplateData".
Étape 2. Cliquez sur le nom du paramètre auquel vous voulez ajouter des valeurs suggérées.
Étape 3. Si ce n'est pas déjà le cas, définissez le type du paramètre comme l'un des suivants : contenu, ligne, chaîne de caractères, nombre, wikitexte inconnu ou déséquilibré. Un nouveau champ de saisie "Valeurs suggérées" apparaît. Si le paramètre est déjà défini comme l'un de ces types, le champ de saisie devrait déjà être visible.
Étape 4. Saisissez la ou les valeurs suggérées, y compris les espaces et les caractères spéciaux, et appuyez sur la touche Entrée pour les ajouter à la liste.
Effet dans l'éditeur visuel
Once the values have been added to TemplateData, via JSON or the TemplateData editor, the VisualEditor will display them in a combo box (a dropdown into which users can also enter a custom value) for the parameter types listed above. The user selects the desired value by clicking on it. If the list of values is long -- for example, a list of a country’s states -- the user can begin typing in the field, whereupon the list will be filtered to show only values containing the typed text. To change an entered value, the user must simply clear the field, and the full dropdown list will appear again. If the user needs a value not included in the list (for example, "message in a bottle") they can type it in manually.
Statut et prochaines étapes
- Déploié sur tous les wikis le 29 avril 2021.