Module:Biblio/Commun/Documentation

Utilisation

modifier

Ce module est destiné à être utilisé par les autres modules biblios, et ne fournit aucune fonction directement utilisable depuis l'espace modèle.

Fonctions utilisables depuis un autre module

modifier

Constantes

modifier

Parfois suivies ou précédées d'une espace insécable, ici remplacée par « _ ».

  • chap : chap._ ;
  • coll : coll._ ;
  • ed : _éd. ;
  • nbp : _p. ;
  • numero : no_ ;
  • numeros : nos_ ;
  • page : p._ ;
  • pages : p._ ;
  • ['page(s)'] : p._ ;
  • plume : _  ;
  • premiere : 1re ;
  • reimpr : réimpr._ ;
  • tome : t._ ;
  • vol : vol._ ;

Fonctions

modifier
  • validTextArg( args, name, ... ) – retourne le premier paramètre nommé n'étant pas vide. (copie de Outils.validTextArg mais sans le "trim" pour performances)
  • detailEdition( ref ) – affiche « [détail de l’édition] ».
  • detailEditions( ref ) – affiche « [détail des éditions] ».
  • romain( texte ) – affiche le texte en capitales.
  • fusionTexteLien( texte, lien, categ ) – fusionne un texte avec une cible de lien optionnelle, en supprimant les liens externes.
  • spanInitial( args, validArg ) – crée un span de class ouvrage avec un id correspondant aux quatre premiers noms et à l'année.
  • libelle( args ) – affiche en <small> et entre crochet le paramètre libellé.
  • commentaire( args ) – affiche le paramètre commentaire dans un <div>.
  • indicationDeLangue( args, validArg ) – affiche un ou plusieurs indicateur de langue type (en) en fonction du contenu du paramètre langue. Ignore le français s'il est seul.
  • responsabilitePrincipale( args, validArg ) – affiche la liste des auteurs avec leur responsabilité.
  • responsabiliteSecondaire( args, validArg ) – affiche entre parenthèse traducteur, illustrateur, photographe...
  • inscriptionDate( frame ) – affiche une date correctement formatée, sans lien. L'année est obligatoire. Paramètres nommés année, mois, jour, ou paramètre unique nommé date.
  • formatePagesTotales( pages ) – retourne la valeur en y ajoutant l'abréviation « p. » derrière, si un nombre de pages est détecté.
  • formatePassage( passage ) – retourne la valeur en y ajoutant l'abréviation « p. » la plus précise possible devant, si un numéro de page ou un intervalle de pages est détecté.
  • COinS( args, validArg, genre ) – génère un « Context Object in Span », suivant la norme ANSI Z39.88-2004

Fonctions internes

modifier
  • texteLien( str ) – à partir d'un lien wiki, retourne son texte et sa cible.
  • abr( args ) – génère une abréviation.
  • nettoyageTexte( texte ) – retourne le texte sans lien interne, externe ni balise HTML.

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

modifier
  • Module:Date – fonction dateISO
  • Module:Langue – fonctions codeLangue2 et indicationMultilingue ; chargé seulement si un paramètre langue, lang, lien langue ou language est renseigné
  • Module:Langue/Data – chargé seulement si le paramètre langue originale est renseigné