Module:Biblio/Commun/Documentation
< Module:Biblio | Commun
Aller à la navigation
Aller à la recherche
La documentation pour ce module peut être créée à Module:Biblio/Commun/Documentation/doc
Erreur de script : Erreur Lua à la ligne 1 : unexpected symbol near '=='.
== Utilisation ==
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 ===
==== Constantes ====
Parfois suivies ou précédées d'une espace insécable, ici remplacée par « _ ».
* <code>chap</code> : {{abréviation discrète|chap.|chapitre}}_ ;
* <code>coll</code> : {{abréviation discrète|coll.|collection}}_ ;
* <code>ed</code> : _{{abréviation discrète|éd.|édition}} ;
* <code>nbp</code> : _{{abréviation discrète|p.|pages}} ;
* <code>numero</code> : {{abréviation discrète|n<sup>o</sup>|numéro}}_ ;
* <code>numeros</code> : {{abréviation discrète|n<sup>os</sup>|numéros}}_ ;
* <code>page</code> : {{abréviation discrète|p.|page}}_ ;
* <code>pages</code> : {{abréviation discrète|p.|pages}}_ ;
* <code>['page(s)']</code> : {{abréviation discrète|p.|page(s)}}_ ;
* <code>plume</code> : _<span title="Ouvrage utilisé pour la rédaction de l'article">[[Fichier:Icon flat design plume.svg|20px|link=|alt=Ouvrage utilisé pour la rédaction de l'article]]</span> ;
* <code>premiere</code> : {{abréviation discrète|1<sup>re</sup>|première}} ;
* <code>reimpr</code> : {{abréviation discrète|réimpr.|réimpression}}_ ;
* <code>tome</code> : {{abréviation discrète|t.|tome}}_ ;
* <code>vol</code> : {{abréviation discrète|vol.|volume}}_ ;
==== Fonctions ====
* <code>validTextArg( args, name, ... )</code> – retourne le premier paramètre nommé n'étant pas vide. <small>(copie de [[Module:Outils#validTextArg|Outils.validTextArg]] mais sans le "trim" pour performances)</small>
* <code>detailEdition( ref )</code> – affiche « <small>[[[ref|détail de l’édition]]]</small> ».
* <code>detailEditions( ref )</code> – affiche « <small>[[[ref|détail des éditions]]]</small> ».
* <code>romain( texte )</code> – affiche le texte en capitales.
* <code>fusionTexteLien( texte, lien, categ )</code> – fusionne un texte avec une cible de lien optionnelle, en supprimant les liens externes.
* <code>spanInitial( args, validArg )</code> – crée un span de class ouvrage avec un id correspondant aux quatre premiers noms et à l'année.
* <code>libelle( args )</code> – affiche en <code><nowiki><small></nowiki></code> et entre crochet le paramètre libellé.
* <code>commentaire( args )</code> – affiche le paramètre commentaire dans un <code><nowiki><div></nowiki></code>.
* <code>indicationDeLangue( args, validArg )</code> – 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.
* <code>responsabilitePrincipale( args, validArg )</code> – affiche la liste des auteurs avec leur responsabilité.
* <code>responsabiliteSecondaire( args, validArg )</code> – affiche entre parenthèse traducteur, illustrateur, photographe...
* <code>inscriptionDate( frame )</code> – affiche une date correctement formatée, sans lien. L'année est obligatoire. Paramètres nommés <code>année</code>, <code>mois</code>, <code>jour</code>, ou paramètre unique nommé <code>date</code>.
* <code>formatePagesTotales( pages )</code> – retourne la valeur en y ajoutant l'abréviation « {{abréviation discrète|p.|pages}} » derrière, si un nombre de pages est détecté.
* <code>formatePassage( passage )</code> – retourne la valeur en y ajoutant l'abréviation « {{abréviation discrète|p.|page(s)}} » la plus précise possible devant, si un numéro de page ou un intervalle de pages est détecté.
* <code>COinS( args, validArg, genre )</code> – génère un « Context Object in Span », suivant la norme [[ANSI]] Z39.88-2004
=== Fonctions internes ===
* <code>texteLien( str )</code> – à partir d'un lien wiki, retourne son texte et sa cible.
* <code>abr( args )</code> – génère une abréviation.
* <code>nettoyageTexte( texte )</code> – retourne le texte sans lien interne, externe ni balise HTML.
=== Modules externes et autres éléments dont ce module a besoin pour fonctionner ===
* <code>[[Module:Date]]</code> – fonction dateISO
* <code>[[Module:Langue]]</code> – fonctions codeLangue2 et indicationMultilingue ; chargé seulement si un paramètre <code>langue</code>, <code>lang</code>, <code>lien langue</code> ou <code>language</code> est renseigné
* <code>[[Module:Langue/Data]]</code> – chargé seulement si le paramètre <code>langue originale</code> est renseigné
<!--
== Exemples ==
Pour des exemples, voir la page de test permettant de tester diverses modifications apportées.
-->
{{Projet Scribunto}}
<includeonly>
[[Catégorie:Module en langage Lua]]
</includeonly>
