Utilisateur:Ltrlg/TemplateDataEditor

Éditeur pour TemplateData

TemplateDataEditor (TDE) est un script pour éditer les données des modèles (TemplateData) avec une interface visuelle.

Installation modifier

Utilisation modifier

Démarrage modifier

Quand vous éditez un modèle (ou sa page de documentation) :

  • Vous devriez voir un lien   ou   dans les outils d’édition.
  • Vérifiez si la page contient déjà une balise <templatedata>
  • Sinon, ajoutez en une vide (<templatedata /> dans le wikitexte (il n’est pas nécessaire de sauvegarder cette modification)
  • Cliquez sur le lien TemplateData

S’il n’y a pas déjà de données modifier

TemplateDataEditor propose de pré-remplir les données à partir de l’analyse du code du modèle. Il s’appuie pour cela sur le script TDSkell de Salix alba.

Choisissez dans la liste déroulante le modèle que vous êtes en train de documenter puis cliquez sur le bouton « Exécuter ».

Modification des données modifier

La fenêtre de modification comporte trois sections : Description, Paramètres et Ensembles.

Section Description modifier

La section Description permet de décrire le modèle dans une zone de texte traduisible.

Section Paramètres modifier

La section Paramètres permet de décrire les paramètres du modèle. Elle est constituée d’une liste de paramètres pouvant être affichés complètement ou refermés.

Lorsqu’ils sont refermés, il est possible :

  • d’indiquer le nom réel du paramètre, c’est-à-dire celui qui est utilisé lors de l’appel du modèle dans le wikitexte ;
  • d’indiquer si le paramètre est obligatoire ;
  • de faire hériter la documentation de celle d’un autre paramètre (tous les champs non remplis sont remplis par la valeur de l’autre paramètre ;
  • d’ouvrir le paramètre en cliquant sur le bouton  ) ;
  • de supprimer le paramètre en cliquant sur le bouton  .

Lorsqu’il est ouvert, on peut de plus :

  • le refermer en cliquant sur le bouton   ;
  • indiquer un nom pour l’affichage (celui-ci est traduisible) ;
  • indiquer de quel type est le paramètre et sa valeur par défaut ;
  • indiquer si le paramètre est obsolète (en remplissant le champ : le texte entré est alors utilisé pour décrire la procédure de remplacement du paramètre) ;
  • indiquer d’autres noms pour le paramètre (par exemple le paramètre lang de {{lang}} peut aussi être appelé en utilisant 1) ;
  • décrire le paramètre (les descriptions sont traduisibles).

En bas de la liste, un bouton   permet de créer un nouveau paramètre.

Section Ensembles modifier

La section Ensembles permet de définir des ensembles de paramètres devant être utilisés simultanément. Elle est constituée d’une liste des ensembles.

Chaque ligne permet :

  • de donner un nom (traduisible) à l’ensemble ;
  • d’indiquer quels paramètres font partie de cet ensemble ;
  • de supprimer l’ensemble en cliquant sur le bouton  .

En bas de la liste, un bouton   permet de créer un nouveau paramètre.

Éléments traduisibles modifier

Une partie des éléments peut être traduite.

Lors du démarrage de TemplateDataEditor, seuls les contenus dans la langue du wiki et dans votre langues sont affichés. Vous pouvez afficher les autres langues en cliquant sur le bouton   (ou  ) ou les cacher en cliquant sur le bouton   (ou  ).

Lorsque les autres langues sont affichées, un bouton   permet d’en ajouter. À l’exception de la langue du wiki, il est possible de retirer une langue en cliquant sur le bouton  .

Sur d’autres wikis modifier

  • TDE est actuellement disponible en français, anglais, grec, coréen, japonais et italien. Si vous souhaitez proposer des traductions, vous pouvez le faire sur la page de discussion du script : les messages à traduire se trouvent au début du script (variable messages).
  • TDE peut être utilisé depuis un autre wiki, seule la commande pour l’importer est différente (voir les sections Installation et Notes).

Pages modifier

Limitations et problèmes connus modifier

  • La suggestion d’alias et de valeurs par défaut de TDSkell n’a pas été intégrée pour le moment.
  • Renommer un paramètre le déplace à la fin de l’objet JSON.
  • Les paramètres dont le nom contient { ou } ne peuvent pas être documentés.

Notes modifier

  1. Il est possible de le faire depuis un autre wiki, le texte est alors le suivant :
    mw.loader.load('//fr.wikipedia.org/w/index.php?title=Utilisateur:Ltrlg/scripts/TemplateDataEditor.js&action=raw&ctype=text/javascript');