Module:Arbre généalogique Wikidata/Documentation

Utilisation

Ce module est conçu pour une utilisation à travers le modèle Modèle:Arbre généalogique Wikidata. Il exploite les données issues de Wikidata pour créer un arbre généalogique.

Son code est basé sur celui de wikidata:Module:Wikidata/FamilyTree. Le modèle fonctionne en coordination avec la feuille de rendu css Modèle:Arbre généalogique Wikidata/styles.css.

La sous–page Module:Arbre généalogique Wikidata/Rendu HTML n'est pas appelée par ce module.

Fonctions exportables

• drawTree( frame ) – Met en forme les arguments reçu dans frame pour un appel de drawTreeImpl( args ) ;
• drawTreeImpl( args ) – Prend en argument un tableau (décrit dans la section suivante) et retourne le code html d'un arbre généalogique.

Liste des paramètres

Le tableau suivant liste les différents paramètres et leurs valeurs acceptées. Un appel valide de la fonction drawTreeImpl( args ) est de la forme :

local gen = require("Module:Arbre généalogique Wikidata")
local arbre = gen.drawTreeImpl({entityId="Q7742", ancestors=4, descendants=0, decorate="by-generation"})

Nom du paramètre	Description
entityId	Identifiant Wikidata pour la base de l'arbre généré. Par défaut, identifiant de la page courante.
mode	Mode de rendu de l'arbre généalogique. Les valeurs acceptées sont "horizontal" et "vertical". Par défaut, "vertical" (nb. Le modèle {{Arbre généalogique Wikidata}} a comme mode de rendu par défaut le mode horizontal).
invert	Booléen indiquant si l'arbre généalogique doit être inversé (les ancêtres en bas et les descendants en haut). Par défaut, false.
interleave	Booléen indiquant si les ancêtres doivent être entrelacés (père et mère affichés sur la même ligne). Par défaut, false.
ancestors	Le nombre de générations d'ancêtres à afficher. Par défaut, 2 pour un mode horizontal et 3 pour un mode vertical.
descendants	Le nombre de générations de descendants à afficher. Par défaut, 2 pour un mode horizontal et 3 pour un mode vertical.
compactParents	Booléen indiquant si les parents doivent être affichés de manière compacte (sur la même ligne) ou non. Vaut toujours true si mode horizontal et vaut false par défaut si mode vertical.
compactChildren	Booléen indiquant si les enfants doivent être affichés de manière compacte (sur la même ligne) ou non. Dans le code actuel, vaut toujours true.
years	Booléen indiquant si les années de naissance et de décès doivent être affichées. Les valeurs acceptées sont true, "next-line" et "new-line". Dans les deux derniers cas, la valeur du paramètre définit la classe css utilisée pour l'affichage des années. Par défaut, vaut false.
descriptions	Booléen indiquant si les descriptions des entités doivent être affichées. Les valeurs acceptées sont true, "next-line" et "new-line". Dans les deux derniers cas, la valeur du paramètre définit la classe css utilisée pour l'affichage de la description. Par défaut, vaut false.
decorate	Chaîne de caractères indiquant les décorations à appliquer à l'arbre généalogique. Les deux valeurs acceptées sont "by-generation" (qui applique une coloration par génération si la feuille de style est appliquée) et "none". Par défaut, vaut "none".

Modules externes et autres éléments dont ce module a besoin pour fonctionner

Extension:Client Wikibase

• mw.wikibase.getEntityIdForCurrentPage – Retourne l'id de l'élément wikidata associé à la page courante ;
• mw.wikibase.getLabel – Retourne le label wikidata associé à la page courante ou à celle dont l'id associé est passé en argument ;
• mw.wikibase.sitelink – Retourne le nom sur wikipédia en français de la page dont l'id associé est passé en argument ;
• mw.wikibase.getDescription – Retourne la description wikidata associée à la page courante ou à celle dont l'id associé est passé en argument ;
• mw.wikibase.getBestStatements – Prend en argument un id d'entité wikidata et un id de propriété et retourne une table décrivant la valeur de la propriété pour cet élément. Les éléments de rang normal ne sont pas retournés si un élément de rang préféré est présent et les éléments de rang obsolète ne sont jamais retournés.

Autres modules et fonctions externes

• mw.title.new – Crée un nouvel objet title ;
• mw.ustring.match – Cherche la première correspondance d'un motif dans une chaine de caractères ;
• mw.getCurrentFrame – Retourne l'objet frame courant, généralement l'objet frame du dernier appel à #invoke ;
  • frame:getTitle() – Renvoie le nom du module invoqué par le {{#invoke:}} ;
  • frame:getParent() – Renvoie l'objet frame de la page qui a appelé le {{#invoke:}} ;
• mw.site.namespaces – Table contenant les informations sur tous les espaces de noms, indexés par leur numéro ;

• Module:Romain – Prend en argument un nombre décimal et retourne son écriture en numération romaine.

Modules lua utilisant ce module

Aucun

Modèles appelant directement ce module

• Modèle:Arbre généalogique Wikidata

Exemples

Dans Modèle:Arbre généalogique Wikidata, ce module est appelé par le code suivant :

<templatestyles src="Modèle:Arbre généalogique Wikidata/styles.css" />
{{#invoke:Arbre généalogique Wikidata|drawTree|mode={{{mode|horizontal}}}}}