Aller au contenu

Module:Test wikicode/Documentation

Ajouter des liens
Une page de Wikipédia, l'encyclopédie libre.

Ceci est la page de documentation de Module:Test wikicode [modifier] [purger].

Cette sous-page contient les instructions et les catégories de son module d'origine et elle n'est pas destinée à être visualisée directement.

Ce module permet d'extraire et d'analyser des parties de wikicode. Il peut faciliter la comparaison de wikicodes ayant des structures similaires plus facilement qu'en les comparant sous forme de chaînes de caractères.

Utilisation

[modifier le code]

Fonctions exportables :

  • parseLink(link) - analyse le wikicode d'un lien interne pour en retourner les composants.
  • parseImage(image) - analyse le wikicode d'une image pour en retourner les composants.
  • extract(wikicode, items) – extrait les items demandés du wikicode.

Détail par fonction

[modifier le code]

parseLink(link)

[modifier le code]

Analyse le lien interne link et retourne ses composants :

  • page : la destination du lien
  • text : le texte du lien

Exemples

[modifier le code]
Appel Résultat
p.parseLink("[[Foo|Bar]]") 
{
    page = "Foo",
    text = "Bar"
}
p.parseLink("[[Foo]]") 
{
    page = "Foo",
    text = "Foo"
}

parseImage(image)

[modifier le code]

Analyse l'image image et retourne ses composants :

  • src : le nom de l'image, sans préfixe
  • format : une table dont les clés représentent les différents formats appliqués (border, frameless, framed et/ou thumbnail) avec en valeur true ou la valeur du paramètre thumbnail
  • halign : l'alignement horizontal de l'image (left, center ou right)
  • valign : l'alignement vertical de l'image (baseline, sub, super, top, text-top, middle, bottom ou text-bottom)
  • size : la taille de l'image ou le mot-clé upright ou une table avec la clé upright et en valeur la valeur du paramètre
  • link : la valeur du paramètre link
  • alt : la valeur du paramètre alt
  • class : la valeur du paramètre class
  • lang : la valeur du paramètre lang
  • caption : le titre de l'image

Exemples

[modifier le code]
Appel Résultat
p.parseImage("[[Fichier:Test.svg]]") 
{
    src = "Test.svg"
}
p.parseImage("[[Fichier:Test.svg|bordure|frameless]]") 
{
    src = "Test.svg",
    format = {border = true, frameless = true}
}
p.parseImage("[[Fichier:Test.svg|gauche]]") 
{
    src = "Test.svg",
    halign = "left"
}
p.parseImage("[[Fichier:Test.svg|top]]") 
{
    src = "Test.svg",
    valign = "top"
}
p.parseImage("[[Fichier:Test.svg|14x14px]]") 
{
    src = "Test.svg",
    size = "14x14px"
}
p.parseImage("[[Fichier:Test.svg|redresse]]") 
{
    src = "Test.svg",
    size = "upright"
}
p.parseImage("[[Fichier:Test.svg|upright=1.2]]") 
{
    src = "Test.svg",
    size = {upright = 1.2}
}
p.parseImage("[[Fichier:Test.svg|link=https://fr.wikipedia.org]]") 
{
    src = "Test.svg",
    link = "https://fr.wikipedia.org"
}
p.parseImage("[[Fichier:Test.svg|alt=Image de test]]") 
{
    src = "Test.svg",
    alt = "Image de test"
}
p.parseImage("[[Fichier:Test.svg|class = noviewer]]") 
{
    src = "Test.svg",
    class = "noviewer"
}
p.parseImage("[[Fichier:Test.svg|langue=fr]]") 
{
    src = "Test.svg",
    lang = "fr"
}
p.parseImage("[[Fichier:Test.svg|Image de test]]") 
{
    src = "Test.svg",
    caption = "Image de test"
}

extract(wikicode, items)

[modifier le code]

Permet d'extraire du wikicode donné les composants indiqués par la table items :

  • link : extrait un lien interne et retourne ses composants tels qu'analysés par parseLink.
  • image : extrait une image et retourne ses composants tels qu'analysés par parseImage.
  • -, *, + : extraient n'importe quel texte, la quantité de texte retournée correspond au comportement des quantifieurs dans les expressions régulières Lua.
  • ^, $ : n'extraient rien, permettent d'indiquer que l'extraction doit se faire respectivement depuis le début ou jusqu'à la fin du wikicode. Le comportement est similaire aux assertions des expressions régulières Lua.

La fonction retourne une table contenant la valeur extraite pour chacun des composants ou nil si la structure du code ne correspond pas aux items demandés.

Exemples

[modifier le code]
Appel Résultat
p.extract("Test [[Foo|Bar]] test", {"link"}) 
{
    {page = "Foo", text = "Bar"}
}
p.extract("Test [[Foo|Bar]] test", {"^", "-", "link", "+"}) 
{
    "Test ",
    {page = "Foo", text = "Bar"},
    " test"
}
p.extract("Test [[Image:Test.svg|40x40px]] [[Foo]]", {"image", "-", "link"}) 
{
    {src = "Test.svg", size="40x40px"},
    " ",
    {page = "Foo", text = "Foo"}
}
p.extract("Test [[Foo|Bar]] test", {"image"}) 
nil


Ce document provient de « https://fr.wikipedia.org/w/index.php?title=Module:Test_wikicode/Documentation&oldid=202443367 ».