WMDE Technical Wishes/Suggested values for template parameters/nl

Suggested values for template parameters/nl
Status	Ingevoerd op alle wiki's
Focus area	Sjablonen
Phabricator	T273857
Responsible	Technische Wensen Team

Deze pagina documenteert de voortgang van de ontwikkeling van en discussies over het project Voorgestelde waarden voor sjabloonparameters uit het aandachtsgebied "Maak het werken met sjablonen eenvoudiger". Algemene informatie over het aandachtsgebied en hoe we de projecten hebben gekozen die worden uitgevoerd, staat hier.

Wij verwelkomen op de overlegpagina de opmerkingen en vragen over dit project.

Beschrijving

Bij het invullen van parameterswaarden in sjablonen in Visual Editor is het vaak op het eerste gezicht niet duidelijk welke waarden worden verwacht voor een bepaalde parameter. In sommige gevallen worden alleen bepaalde waarden door de sjabloon aanvaard, maar de gebruiker kan niet noodzakelijkerwijs zien wat die waarden zijn. Als een gebruiker bijvoorbeeld een artikel over een roman redigeert en het genre in de parameter "genre" in de infobox wil specificeren, kan hij zich afvragen of hij criminaliteit, thriller of misschien mysterie moet invoeren.

Met de nieuwe voorgestelde waarden eigenschapparameter kan iedereen die sjablonen creëert of onderhoudt nu een lijst van voorgestelde waarden voor een parameter definiëren. Deze waarden worden vervolgens weergegeven aan VisualEditor-gebruikers in een dropdown menu. Als u het sjabloon gebruikt en een waarde voor deze parameter wilt invoeren, kunt u de juiste waarde snel uit de lijst selecteren. Als u een waarde wilt invoeren die niet in de lijst staat, bijvoorbeeld Sci-Fi Crime in het bovenstaande voorbeeld, is deze optie nog steeds beschikbaar. Omdat er soms situaties zijn waarin een artikel een meer aangepaste waarde nodig heeft, zal het mogelijk zijn andere waarden in te vullen dan de voorgestelde.

Op deze manier hoeft de gebruiker de verwachte waarden en het vereiste formaat niet vooraf te kennen. Het is niet langer nodig om uit te zoeken welke waarden in elk veld zijn door de documentatiepagina van het sjabloon te bezoeken of zelfs te proberen de verwachte waarden te raden. Deze nieuwe functie is vooral nuttig voor degenen die nog niet bekend zijn met een sjabloon.

Dit voorkomt mogelijke fouten, vermindert de inspanning die nodig is om het sjabloon met waarden te vullen en maakt de opmaak van de waarden consistenter. Samen met de geplande verbeteringen in het sjabloondialoogvenster, maakt de functie voor voorgestelde waarden het gebruik van sjablonen in de VisualEditor eenvoudiger.

Hoe de nieuwe functies te gebruiken

Een nieuwe parameter eigenschap, suggestedvalues, stelt u in staat een lijst te definiëren van parameterwaarden die aan VisualEditor-gebruikers moeten worden getoond in een dropdown voor eenvoudige selectie. Om deze functie te gebruiken, moeten de voorgestelde waarden worden toegevoegd aan de TemplateData van het sjabloon. Dit kan worden gedaan in JSON of met behulp van de TemplateData-editor (geen codering vereist). Beide methoden worden hieronder in detail beschreven.

TemplateData

U kunt voorgestelde waarden toevoegen die in VisualEditor moeten worden weergegeven voor parameters waarvan het type is ingesteld op een van de volgende opties:

• content
• line
• string
• number
• unknown
• unbalanced wikitext.

Andere typen (file, page, template, user, date, boolean, URL) worden nu niet ondersteund omdat ze al speciale functionaliteiten in VisualEditor hebben, zoals autocomplete, die de dropdown menu voor voorgestelde waarden in VisualEditer zou verstoren.

TemplateData als JSON in Wikitext bewerken

Als u voorgestelde waarden wilt toevoegen aan een parametertype, voegt u de nieuwe eigenschap 'suggestedvalues' toe aan de parameter in JSON. Het attribuut 'suggestedvalues' moet een lijst met tekenreeksen zijn.

Een voorbeeld zou er zo uit kunnen zien:

"media_type": {
    "label": "Type media",
    "example": "Krant",
    "type": "string",
    "description": "In welk medium werd het artikel gepubliceerd?",
    "suggestedvalues": [
        "Journaal",
        "Boek",
        "Krant",
        "Magazine"
    ]
}

Voorbeeld van het toevoegen van gesuggereerde waarden in de TemplateData editor

TemplateData bewerken met de TemplateData Editor

Voor de hierboven vermelde parametertypen kunt u gesuggereerde waarden toevoegen met behulp van de TemplateData-editor.

Stap 1. Klik op "TemplateData beheren".

Stap 2. Klik op naam van de parameter waar u suggesties van wilt gaan aangeven.

Stap 3. Als het er nog niet is, stel het type van de parameter in op een van de volgende: content, line, string, number, unknown of unbalanced wikitext. Er wordt een nieuw invoerveld "Voorgestelde waarden" weergegeven. Als de parameter al is ingesteld op een van deze typen, moet het invoerveld al zichtbaar zijn.

Stap 4. Typ de gesuggereerde voorgestelde waarde(s) in, inclusief eventuele spaties en speciale tekens, en druk op Enter om deze aan de lijst toe te voegen.

Voorbeeld van invullen van een sjabloon met de functie gesuggereerde waarden in VisualEditor

Effect in VisualEditor

Nadat de waarden zijn toegevoegd in TemplateData, zal de VisualEditor ze tonen in een combobox (een dropdown waar de gebruiker ook een waarde kan invoeren) voor de bovengenoemde parametertypes. De gebruiker kiest de gewenste waarde door er op te klikken. Bij een lange lijst, een lijst gemeenten, kan de gebruiker beginnen met invoeren, de lijst wordt dan op die ingevoerde waarde gefilterd. Als de gemeente ontbreekt, dan kan de gebruiker die niet selecteren maar handmatig invullen.

Status en vervolgstappen

• Ingevoerd op alle wiki's op 29 april 2021.