« Module:Biblio/Commun » : différence entre les versions

Navigation interactive dans l’historique

← Modification précédente Modification suivante →

Contenu supprimé Contenu ajouté

Intégrés

Version du 29 juillet 2014 à 10:26

Documentation[voir] [modifier] [historique] [purger]

Ce module à risque est inclus sur un très grand nombre de pages et ne peut pas être modifié.

Cette protection ne constitue pas obligatoirement une approbation de la version actuelle. Vous pouvez proposer une modification en page de discussion. Lorsqu'un compromis sera trouvé en page de discussion, vous pourrez demander la modification auprès des administrateurs (voir le journal des protections).

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 « _ ».

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

Fonctions

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

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

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é

Projet Scribunto

La documentation de ce module est générée par le modèle {{Documentation module}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (modifier).
Voir les statistiques d'appel depuis le wikicode sur l'outil wstat et les appels depuis d'autres modules.

-- Les fonctions du module Biblio/Commun sont des éléments nécessaire au modules Biblio/Ouvrage, Biblio/Article, Biblio/Lien web

local Commun = {}


local Date = require( 'Module:Date' )
local Outils = require( 'Module:Outils' )
local TableBuilder = require( 'Module:TableBuilder' )
local Langue -- = require( 'Module:Langue' ) ne sera chargé que si nécessaire

local abr = Outils.abr      -- fonction abréviation discréte

-- extractArgs permet de récupérer les arguement du modèle, 
-- ou la table transmise à la fonction par une autre fonction d'un module
local extractArgs = Outils.extractArgs

function Commun.validTextArg( args, name, ... ) 
	local texte = args[name]
	if type( texte ) == 'string' and texte ~= '' and texte:match( '%S' ) then
		return texte
	elseif #{ ... } > 0 then
		return Commun.validTextArg( args, ... )
	end
end


-- Abréviation utiles 
Commun.chap =   abr{ 'chap.', 'chapitre(s)', nbsp='+' }
Commun.coll =   abr{ 'coll.', 'collection', nbsp='+' }
Commun.ed =     abr{ 'éd.', 'édition', nbsp='-' }
Commun.nbp =    abr{ 'p.', 'pages', nbsp='-' }
Commun.numero = abr{ 'n<sup>o</sup>', 'numéro', nbsp='+' }
Commun.page =   abr{ 'p.', 'page(s)', nbsp='+' }
Commun.plume = [=[&nbsp;<span title="Ouvrage utilisé pour la rédaction de l'article">[[Image:Nuvola apps ksig horizonta.png|30px|link=|alt=Ouvrage utilisé pour la rédaction de l'article]]</span>]=]
Commun.premiere = abr{ '1<sup>re</sup>', 'première' }
Commun.reimpr = abr{ 'réimpr.', 'réimpression', nbsp='+' }
Commun.tome = abr{ 't.', 'tome', nbsp='+' }
Commun.vol = abr{ 'vol.', 'volume', nbsp='+' }


function Commun.detailEdition( ref ) 
	return '<small>&#91;[[' .. ref .. '|détail de l’édition]]&#93;</small>'
end

function Commun.detailEditions( ref ) 
	return '<small>&#91;[[' .. ref .. '|détail des éditions]]&#93;</small>'
end


-- affiche le texte en nombre romain majuscule.
function Commun.romain( texte )
    local a = '<span class="romain" style="text-transform:uppercase">'
    local b = '</span>'
    return a, texte, b
end


-- voir Modèle:Module biblio/span initial
function Commun.spanInitial( args, validArg )
	local id = validArg( 'id' )

	if id then
		id = ' id="' .. id .. '"'
	else
		local nom = validArg( 'nom1', 'nom', 'auteur', 'last1', 'last', 'author' )
		local auteur_i = validArg( 'auteur1', 'author1' )
		local i = 1
		local idTab = {  }
		
		while nom or auteur_i do
			if auteur_i and not nom then
				auteur_i = Outils.texteLien( auteur_i )
				local a1, a2, a3 = mw.ustring.match( auteur_i, '^([^ ]+) ?([^ ]*) ?(.-)$' )
				if Outils.notEmpty( a3 ) then
					local a2len = mw.ustring.len( a2 )
					if a2len == 1 or ( a2len == 2 and mw.ustring.sub( a2, -1 ) == "." ) then
						-- a1 est le prénom, a2 une initiale et a3 le nom
						nom = a3
					else
						-- a2 peut être le deuxième prénon ou le début du nom
						nom = a2 .. ' ' .. a3
					end
				elseif Outils.notEmpty( a2 ) then
					-- a1 prénom, a2 nom
					nom = a2
				else
					nom = a1
				end
			end
			table.insert( idTab, mw.uri.anchorEncode( nom ) )
			
			if i == 4 then
				break
			end
			i = i + 1
			nom = validArg( 'nom' .. i, 'last' .. i )
			auteur_i = validArg( 'auteur' .. i, 'author' .. i )
		end
		
		local annee = validArg( 'année', 'year' )
		if annee then
			table.insert( idTab, mw.uri.anchorEncode( annee ) )
		end
		
		if #idTab > 0 then
			id = ' id="' .. table.concat( idTab ) .. '"'
		else 
			id = ''
		end
	end

	return '<span class="ouvrage"' .. id .. '>'
end

-- voir Modèle:Module biblio/libellé
function Commun.libelle( args )
	local lib = args['libellé'] or ''
	if lib ~= '' then
		lib = '<small>[', lib, ']</small> '
	end
	return lib
end

-- voir Modèle:Commentaire biblio
function Commun.commentaire( args )
	if Outils.trim( args.commentaire ) then
		local a = '<div style="Margin-top:0.1em ;margin-left:2em; line-height:1.5; margin-bottom:0.5em;">'
		local b = '</div>'
		return a, args.commentaire, b
	end
	return ''
end

-- voir Modèle:Module biblio/indication de langue
function Commun.indicationDeLangue( args, validArg )
	local lang = validArg( 'langue', 'lang', 'lien langue', 'language' )
	if lang then
		Langue = require( 'Module:Langue' )
		
		-- on essai le code de langue comlet (nécessaire pour les langues avec plusieurs mot comme "grec ancien")
		local codeLangue = Langue.codeLangue2( lang )
		if codeLangue ~= '' then
			if codeLangue == 'fr' then
				return ''
			else
				return Langue.indicationMultilingue{ codeLangue }, codeLangue
			end
		end
		
		-- si la langue n'a pas été trouvé on considère qu'il y a plusieurs langues
		-- séparation des langues s'il y en a plusieurs
		local listeLangue = mw.text.split( lang, '[+,;:/ %.]+' )
		
		-- code langue principal qui sera appliqué aux titres
		codeLangue = Langue.codeLangue2( listeLangue[1] )
		
		if codeLangue == '' then
			return Langue.indicationMultilingue( listeLangue ), nil, true
		else
			-- cacul code de langue et catégorie
			local indicadionLangue = Langue.indicationMultilingue( listeLangue )
			local categLangue = string.find ( indicadionLangue, '???' , 1, true )
			
			if codeLangue ~= 'fr' then
				return indicadionLangue, codeLangue, categLangue
			elseif #listeLangue > 1 then
				return indicadionLangue, codeLangue, categLangue
			end
		end
	end
	return ''
end


-- voir Modèle:Module biblio/responsabilité principale
function Commun.responsabilitePrincipale( args, validArg )

	local nom = validArg( 'nom1', 'nom', 'last1', 'last' )
	local auteur = validArg( 'auteur1', 'auteur', 'author1', 'author' )
	if not ( nom or auteur ) then
		return ''
	end
	
	-- clarification des paramètres
	args['prénom1'] = validArg( 'prénom1', 'prénom', 'first1', 'first' )
	args['postnom1'] = validArg( 'postnom1', 'postnom' )

	args.directeur1 = validArg( 'directeur1', 'directeur' )
	args['lien auteur1'] = validArg( 'lien auteur1', 'lien auteur' )
	
	-- préparation des variables
	local listeRresponsables = { }  -- contiendra un élément pour chaque nom
	local directeur = abr { 'dir.', 'directeur de publication' }
	local prenom, postnom, dir, responsable, lien , precision, resp
	local i = 1
	

	-- boucle sur chaque nom, assemble toutes les caractéristique et ajoute l'ensemble à la liste.
	while nom or auteur do
	
		-- nom de l'auteur
		if not auteur then
			prenom = validArg( 'prénom' .. i, 'first' .. i )
			postnom = validArg( 'postnom' .. i)
			if prenom and postnom then
				auteur = prenom .. ' ' .. nom .. ' ' .. postnom
			elseif prenom then
				auteur = prenom .. ' ' .. nom
			elseif postnom then
				auteur = nom .. ' ' .. postnom
			else
				auteur = nom
			end
		end
		
		-- lien sur l'auteur
		if string.sub( auteur, 1, 2 ) ~= '[[' then
			lien = validArg( 'lien auteur' .. i )
			if lien then
				auteur = '[[' .. lien .. '|' .. auteur .. ']]'
			end
		end

		-- définition des responsabilités
		dir = validArg( 'directeur' .. i )
		resp = validArg( 'responsabilité' .. i )
		if dir then
			if resp then
				precision = ' (' .. directeur .. ' et ' .. resp .. ')'
			else
				precision = ' (' .. directeur .. ')'
			end
		elseif resp then
			precision = ' (' .. resp .. ')'
		else
			precision = ''
		end

		table.insert( listeRresponsables, auteur .. precision )

		i = i + 1
		nom = validArg( 'nom' .. i, 'last' .. i )
		auteur = validArg( 'auteur' .. i, 'author' .. i )
	end

	if validArg( 'et al.', 'et alii' ) then
		local et_al = " ''" .. abr { "et al.", "et alii (et d’autres)" } .. "''"
		return table.concat( listeRresponsables, ', ' ) .. et_al
	else
		return mw.text.listToText( listeRresponsables )
	end
end


-- voir Module biblio/responsabilité secondaire
function Commun.responsabiliteSecondaire( args, validArg )
	local liste = { }
	
	-- fonction qui teste l'existence d'un paramètre et insérere  dans liste une abréviation discrète suivi de ce paramètre
	local function insertAbr( arg, abrev, texte )
		if arg then
			table.insert( liste, abr{ abrev, texte, nbsp='+' } .. arg )
		end
	end
	
	-- ajout des différents responsables
	local trad = validArg( 'traducteur', 'trad', 'traduction' ) 
	insertAbr( trad, 'trad.', 'traduction' )
	insertAbr( validArg( 'préface' ), 'préf.', 'préface' )
	insertAbr( validArg( 'postface' ), 'post.', 'postface' )
	insertAbr( validArg( 'illustrateur' ), 'ill.', 'illustrations' )
	insertAbr( validArg( 'photographe' ), 'photogr.', 'photographies' )
	if validArg( 'champ libre' ) then
		table.insert( liste, args['champ libre'] )
	end
	
	-- concaténation de l'ensemble
	local texte = table.concat( liste, ', ')
	if texte ~= '' then 
		return ' (' .. texte .. ')'
	end
end

-- émule le modèle:Inscription date
Commun.inscriptionDate = Date.inscriptionDate

-- retire toutes le lien interne, externe et balise html pour ne garder que le texte brut.
local function nettoyageTexte( texte )
	if type( texte ) == 'string' then
		-- nettoyage des liens interne
		texte = mw.ustring.gsub( texte, 
			'%[%[ *([^%[%]|]*) *|? *([^%[%]]*) *%]%]', 
			function( l, t ) return ( t ~= '' and t ) or l end 
		)
		-- nettoyage des liens externes
		texte = mw.ustring.gsub( texte, '%[https?://[^%[%] ]* *([^%[%]]-)%]', '%1' )
		texte = mw.ustring.gsub( texte, '%[//[^%[%] ]* *([^%[%]]-)%]', '%1' )
		-- nettoyage des balise html
		texte = mw.ustring.gsub( texte, '%b<>', '' )
		return texte
	end
end

-- voir Modèle:COinS bibliographique
-- NISO Z39.88
-- http://www.openurl.info/registry
function Commun.COinS( args, validArg, genre ) 
	local liste = { }
	
	-- insertlist ajoute à la table 'liste' un couple 'nom Coins normalisé' - 'donnée' 
	-- Si istexte = true, le deuxième élément de tab est considéré comme du texte, 
	-- sinon comme le nom d'un paramètre.
	local function insertList( key, value, prefix )
		prefix = prefix or ''
		if type( value ) == 'string' and value ~= '' then
			table.insert( liste, key .. '=' .. mw.uri.encode( prefix .. value ) )
		end
	end
		
	-- norme du COinS
	insertList( 'ctx_ver', 'Z39.88-2004' )
	
	-- genre, titre et sous-titre
	if genre == 'article' then
		insertList( 'rft_val_fmt', 'info:ofi/fmt:kev:mtx:journal' )
		insertList( 'rft.genre', 'article' )
		insertList( 'rft.atitle', nettoyageTexte( args.titre ) )
		insertList( 'rft.jtitle', nettoyageTexte( validArg( 'périodique', 'revue', 'journal' ) ) )
		insertList( 'rft.issue', validArg( 'numéro', 'no', 'issue' ) )
	else
		-- genre = ouvrage ou chaitre
		insertList( 'rft_val_fmt','info:ofi/fmt:kev:mtx:book' )
		if genre == 'chapitre' then
			insertList( 'rft.genre', 'bookitem' )
		else
			insertList( 'rft.genre', 'book' )
		end
		insertList( 'rft.btitle', nettoyageTexte( args.titre ) )
		insertList( 'rft.atitle', nettoyageTexte( validArg( 'titre chapitre', 'titreChap' ) ) )
		
		-- donnée sur l'éditeur
		insertList( 'rft.place', Outils.texteLien( validArg( 'lieu', 'location' ) ), nil )
		insertList( 'rft.pub', Outils.texteLien( validArg( 'éditeur', 'édition' ) ), nil )
		insertList( 'rft.edition', args["numéro d'édition"] )
	end
	insertList( 'rft.stitle', args['sous-titre'] )
	
	-- Premier auteur, séparé en noms et prénoms
	local nom = Outils.texteLien( validArg( 'nom1', 'nom', 'last1', 'last' ) )
	if nom then
		insertList( 'rft.aulast', nom )
		insertList( 'rft.aufirst', validArg( 'prénom1', 'prénom', 'first1', 'first' ) )
	else
		local auteur = Outils.texteLien( validArg( 'auteur', 'auteur1' ) )
		if auteur then 
			-- séparation de auteurs au niveau des deux premiers espaces
			local a1, a2, a3 = mw.ustring.match( auteur, '^([^ ]+) ?([^ ]*) ?(.-)$' )
			if Outils.notEmpty( a3 ) then
				local a2len = mw.ustring.len( a2 )
				if a2len == 1 or ( a2len == 2 and mw.ustring.sub( a2, -1 ) == "." ) then
					-- a1 est le prénom, a2 une initiale et a3 le nom
					insertList( 'rft.aufirst', a1 )
					insertList( 'rft.auinitm', a2 )
					insertList( 'rft.aulast', a3 )
				else
					-- a2 peut être le deuxième prénon ou le début du nom => rft.au plus générique.
					insertList( 'rft.au', auteur )
				end
			elseif Outils.notEmpty( a2 ) then
				-- a1 prénom, a2 nom
				insertList( 'rft.aufirst', a1 )
				insertList( 'rft.aulast', a2 )
			else
				insertList( 'rft.aulast', a1 )
			end
		end
	end
	
	-- les autres auteurs, la norme ne prévoit pas de séparation
	for i = 2, 20 do
		local nom_i = Outils.texteLien( validArg( 'nom' .. i ) )
		if nom_i then
			local prenom_i = validArg( 'prénom' .. i )
			local postnom_i = validArg( 'postnom' .. i)
			if prenom_i and postnom_i then 
				insertList( 'rft.au', nom_i .. ' ' .. postnom_i .. ', ' .. prenom_i )
			elseif prenom_i then
				insertList( 'rft.au', nom_i .. ', ' .. prenom_i )
			elseif postnom_i then
				insertList( 'rft.au', nom_i .. ' ' .. postnom_i )
			else
				insertList( 'rft.au', nom_i )
			end
		else
			local auteur_i = Outils.texteLien( validArg( 'auteur' .. i ) )
			if auteur_i then
				insertList( 'rft.au', auteur_i )
			else
				break
			end
		end
	end
	
	-- date
	local datePub = Date.dateISO( args )
	if datePub then 
		insertList( 'rft.date', datePub )
	else
		insertList( 'rft.date', args.date )
	end
	
	-- doonées physique de la publication
	insertList( 'rft.volume', validArg( 'volume', 'vol' ) )
	insertList( 'rft.pages', validArg( 'passage', 'page' ) )
	insertList( 'rft.spage', args['page début chapitre'] )
	insertList( 'rft.tpages', args['pages totales'] )
	
	
	-- références internationales
	insertList( 'rft.isbn', args.isbn )
	insertList( 'rft.issn', args.issn )
	insertList( 'rft_id', args.doi, 'info:doi/' )
	insertList( 'rft_id', args.pmid, 'info:pmid/' )
	insertList( 'rft_id', args.oclc, 'info:oclcnum/' )
	insertList( 'rft_id', args.url )
	
	-- referer : page Wikipedia ou se trouve cette référence
	insertList( 'rfr_id', 'fr.wikipedia.org:' .. mw.title.getCurrentTitle().fullText, 'info:sid/' )
	
	local contextObject = table.concat( liste, '&' )
	
	-- calcul d'un id pour que le span vide ne soit pas supprimé par tydy ( cf. https://bugzilla.wikimedia.org/show_bug.cgi?id=27786 )
	local id=0
	for i = 1, #contextObject do 
		id = id + string.byte( contextObject, i )
	end
	
	return '<span class="Z3988" title="' .. contextObject .. '" id="COinS_' .. id ..'"></span>'
end

-- voir Modèle:Module biblio/indication de langue
-- la langue est passée en patamètre 
function Commun.indicationDeLangue2( args, validArg, lang )
	if lang then
		Langue = require( 'Module:Langue' )
 
		-- on essai le code de langue comlet (nécessaire pour les langues avec plusieurs mot comme "grec ancien")
		local codeLangue = Langue.codeLangue2( lang )
		if codeLangue ~= '' then
			if codeLangue == 'fr' then
				return ''
			else
				return Langue.indicationMultilingue{ codeLangue }, codeLangue
			end
		end
 
		-- si la langue n'a pas été trouvé on considère qu'il y a plusieurs langues
		-- séparation des langues s'il y en a plusieurs
		local listeLangue = mw.text.split( lang, '[+,;:/ %.]+' )
 
		-- code langue principal qui sera appliqué aux titres
		codeLangue = Langue.codeLangue2( listeLangue[1] )
 
		if codeLangue == '' then
			return Langue.indicationMultilingue( listeLangue ), nil, true
		else
			-- cacul code de langue et catégorie
			local indicadionLangue = Langue.indicationMultilingue( listeLangue )
			local categLangue = string.find ( indicadionLangue, '???' , 1, true )
 
			if codeLangue ~= 'fr' then
				return indicadionLangue, codeLangue, categLangue
			elseif #listeLangue > 1 then
				return indicadionLangue, codeLangue, categLangue
			end
		end
	end
	return ''
end



return Commun