Modèle:Note ref/Documentation

Documentation du modèle

Ceci est la page de documentation de Modèle:Note ref. [rafraichir] • [modifier] • [historique] • [préproduction] • [tests unitaires]

Ce modèle sert à insérer des notes et références dans un article.

Code à copier-coller dans un article modifier

{{note|texte=|id=|url=|détails=|langue=|groupe=|nom=}}

Utilisation du modèle modifier

Liste des paramètres modifier

Nom du paramètre	Alias	Utilisation
`texte`	Paramètre non nomméModèle:Ref `1`	Texte de la note ou nom, auteur et année de l’ouvrage.
`langue`	`lang`	Code IETF de la langue du document utilisé comme source Avertissement : Remarque manquante ! .
`id`	∅	Dans le cas de l’utilisation des références Harvard, `id` de l’ouvrage, du périodique ou du site.
`url`	∅	Adresse URL d’une page web utilisée comme source, ou adresse de lecture en ligne d’un ouvrage, d’un article…
`détails`	`détail` `dtl`	Détail de la référence Harvard ou texte après le lien externe.
`nom`	`name`	Nom de la référence, à utiliser si la même référence est utilisée plusieurs fois.
`groupe`	`group`	Groupe de la référence.

Corps de la note modifier

Notes classiques modifier

L’utilisation basique du modèle note est {{note|texte=Texte de la note}}

Avertissement :

Remarque manquante !

. Il est possible d’utiliser le paramètre langue pour spécifier le code de la langue du document utilisé comme source. Il est aussi possible d’insérer un lien externe facilement avec le paramètre url, qui est l’adresse URL sur laquelle doit pointer texte. Le paramètre détails peut alors contenir du texte à insérer après le lien.

Exemple :

Ceci est un premier exemple{{note|texte=CC-BY-SA 3.0|url=http://creativecommons.org/licenses/by-sa/3.0/ |détails=sur creativecommons.org, licences libres|langue=en}}.
{{références}}

Ceci est un premier exemple

Avertissement :

Remarque manquante !

.

Références Harvard modifier

Dès lors que le paramètre id est rempli, le modèle considère que l’utilisateur souhaite utiliser le système de références Harvard. L’utilisation de ces références est un peu plus complexe, et est à utiliser de préférence lors que la source est un extrait de document, un article d’un périodique, ou encore une page d’un site internet.

Dans un premier temps, il faut insérer dans une section Bibliographie l’un des modèles {{Ouvrage}}, {{Lien web}}, ou tout autre modèle pour bibliographie prenant un paramètre nommé id. Remplissez ce paramètre de manière différente dans chacun des modèles, de manière suffisamment claire

Avertissement :

On utilise généralement la (ou les) première(s) lettre(s) du nom du ou des auteurs suivie(s) de l’année de parution, par exemple les Mémoires de guerre de Charles de Gaulle pourront prendre l’id « CDG1954 ».

^,

Avertissement :

Un id est généré automatiquement en concaténant la première lettre du nom des auteurs et l’année ; il est possible de le garder.

. L’id doit être unique, commencer par une lettre et ne doit surtout pas contenir d’espace ni de caractères spéciaux (points, croisillons, diacritiques et caractères non-latins notamment).

On peut ensuite insérer dans le texte des références Harvard en remplissant les paramètres de la manière suivante :

Dans le paramètre id, l’id de l’ouvrage ;
Dans le paramètre texte, le nom complet du ou des auteurs et l’année ; et éventuellement le titre du livre ;
Dans le paramètre détails, les détails concernant la source : chapitre et page pour un livre, date de parution et titre de l’article pour un article de presse, titre de la page pour un lien web, etc. et si possible citation ;
Dans le paramètre url, une adresse internet où il est possible de consulter en ligne l'ouvrage, l’article ou le passage souhaité ;
Dans le paramètre langue, le code de la langue de la source.

Ainsi, un clic sur le renvoi dans le texte déplacera bien la page vers les notes, et un clic sur le nom de l’auteur et l’année renverra vers la présentation plus complète de l’ouvrage en bibliographie.

Exemple :

Autre exemple{{note|id=MG2006|texte=Frank Mittelbach, Michel Goossens, ''The LaTeX companion'', 2006|détails={{p.|230}}, {{chap.|8}}, {{citation étrangère|langue=en|To make an entire math formula bold (or as much of it as possible, depending on the available fonts), use <code>\boldmath</code> preceding the formula.}}|url=http://www.macrotex.net/texbooks/latexcomp-ch8.pdf%7Clangue=en}}.
{{références}}
*{{ouvrage|langue=en|prénom1=Frank|nom1=Mittelbach|prénom2=Michel|nom2=Goossens|titre=The LaTeX companion|numéro d'édition=2|éditeur=Pearson Education|lien éditeur=Pearson (maison d'édition)|année=2006|isbn=9782744071829|id=MG2006}}

Autre exemple

Avertissement :

Remarque manquante !

.

(en) Frank Mittelbach et Michel Goossens, The LaTeX companion, Pearson Education, 2006, 2^e éd. (ISBN 9782744071829)

Structure des notes et références modifier

Il est possible de gérer facilement l’organisation des notes au sein d’un article. Pour cela, il faut utiliser les deux paramètres nom et groupe.

Groupes de notes modifier

Par défaut, les références n’appartiennent à aucun groupe. Si vous le souhaitez, vous pouvez les répartir entre plusieurs groupes, par exemple les notes d’un côté, les références de l’autre…

La numérotation des groupes de notes se fait indépendamment ; et le nom du groupe apparaît à chaque transclusion du modèle. Par exemple, {{note|texte=Salut !|groupe=A}}{{,}}{{note|texte=Ça va ?|groupe=A}} donnera

Avertissement :

Remarque manquante !

^,

Avertissement :

Remarque manquante !

.

Il est là encore déconseillé d’utiliser des caractères spéciaux dans le nom des groupes.

À noter qu’il existe des groupes de notes prédéfinis qui permettent de modifier la numérotation :

decimal, utilisé par défaut, numérote les références en chiffres arabes (1, 2, 3…) ;
alpha, qu’il est conseillé d’utiliser pour le groupe des notes si l’on souhaite le séparer des références, et qui numérote en minuscules latines dans l’ordre alphabétiques (a, b, c…)
grec, qui peut servir pour un groupe de notes alternatif, et qui numérote en minuscules grecques (α, β, γ…).

Noms des notes modifier

Le paramètre nom permet de spécifier un nom pour chaque note. Bien que celui-ci n’apparaisse pas dans le rendu, le nom permet de faire plusieurs renvois à différents endroits de la page vers la même note, sans que celle-ci ne soit dupliquée en pied-de-page.

À la première occurrence de la note, il faut spécifier à la fois les paramètres du corps de la note (texte, éventuellement langue, détail…), et le paramètre nom (et éventuellement groupe). Par exemple : {{note|texte=J’utilise cette note plusieurs fois|nom=note1}}

Avertissement :

Remarque manquante !

.

Ensuite, pour insérer de nouveau la note, remplir le paramètre nom seul de la même manière suffit : {{note|nom=note1}}

Avertissement :

Remarque manquante !

.

Deux notes portant le même nom mais faisant parties de groupes différents seront considérées comme différentes ; il faut donc toujours préciser le paramètre groupe des notes réutilisées.

Encore une fois, il est recommandé de n’utiliser que des caractères alphanumériques pour remplir le paramètre nom.

Conventions sur les notes et références modifier

Seul, ce modèle est inutilisable. En effet, à chaque appel de {{note}}, un renvoi en bas de page est créé, mais le texte de la note n’est pas affiché. Par ailleurs, une erreur est affichée à la fin de la page.

Pour provoquer l’affichage des notes, il faut utiliser le modèle {{références}}, qui prend en paramètres colonnes le nombre de colonnes sur lesquelles insérer les notes (spécifier 2 ou 3 si les notes sont très nombreuses), ainsi qu’éventuellement groupe, le groupe de notes à afficher. Toutes les notes de tous les groupes doivent être affichée avant la fin de la page sous peine de créer des erreurs.

Si plusieurs notes sont utilisées à la suite, il convient de les séparer par le modèle {{,}}. Les notes doivent toujours être collées au dernier mot du passage qu’elles sourcent, et être avant l’élément typographique

Avertissement :

Foo

^,

Avertissement :

Bar

^,

Avertissement :

Baz

^,

Avertissement :

Qux

^,

Avertissement :

Fum

.

Il est possible d’imbriquer des références, c’est-à-dire d’utiliser le modèle {{note}} dans le paramètre texte, mais cet usage est en général déconseillé car la navigation est rendue peu ergonomique et les notes s’affichent dans l’ordre de fermeture du modèle et non dans celui d’ouverture :

Texte avec une note{{note|texte=Note avec une note{{note|texte=Note imbriquée}}}}

Texte avec une note

Avertissement :

Remarque manquante !

Le problème ne se pose cependant pas si les notes imbriquées appartiennent à des groupes différents :

''Lorem ipsum''{{note|texte=''dolor sit amet''{{note|texte=[[Cicéron]], ''De Finibus Bonorum et Malorum'' (''Liber Primus'', 32)}}|groupe=nota}}
; Notes
: {{références|groupe=nota}}
; Références
: {{références}}

Lorem ipsum

Avertissement :

Remarque manquante !

Notes

Références

Métadonnées modifier

Pour insérer des notes et références dans un article. Voir la documentation détaillée du modèle pour des explications complètes.

Paramètres du modèle[Modifier les données du modèle]
Paramètre		Description	Type	État
Texte principal	`texte` `1`	Texte de la note ou nom, auteur et année de l’ouvrage. Par défaut	Chaîne	obligatoire
Langue	`langue` `lang`	Code IETF (en, es, it, etc.) du document si différent du français. Par défaut	Chaîne	facultatif
Identifiant de la source	`id`	Dans le cas d’utilisation des références Harvard, id passé en paramètre à l’ouvrage, au site, au périodique… utilisé comme source. Ne pas utiliser ici de caractères autres que les caractères alphanumériques (lettres, chiffres, underscore), et ne pas commencer par un chiffre. Par défaut	Chaîne	facultatif
URL de la source	`url`	Adresse URL de la page web utilisée comme source, ou adresse de lecture en ligne d’un ouvrage, d’un article… Par défaut	Chaîne	facultatif
Détails à ajouter à la note	`détails` `détail` `dtl`	Si le paramètre id est rempli, mentionner la position du passage utilisé comme source dans l’ouvrage, le périodique ou le site : volume, chapitre et page, année et numéro, adresse de la page… S’il n’a pas été rempli, mais qu’une URL est indiquée, texte à ajouter éventuellement après le lien hypertexte. Par défaut	Chaîne	facultatif
Nom de la note	`nom` `name`	En cas d’usage multiple d’une même note : remplir tous les autres paramètres normalement à la première occurrence de la note, lui donner un nom clair et précis, et les fois suivantes, ne remplir que ce paramètre (et éventuellement groupe). Ne pas utiliser ici de caractères autres que les caractères alphanumériques (lettres, chiffres, underscore), et ne pas commencer par un chiffre. Par défaut	Chaîne	facultatif
Groupe de la note	`groupe` `group`	Permet de séparer les appels de notes en plusieurs groupes, par exemple, notes et références, ou par ouvrage si plusieurs sources sont utilisées un grand nombre de fois. Les noms de groupes spéciaux alpha et grec permettent respectivement d’indexer les appels de notes par des lettres latines et grecques à la place de chiffres. Ne pas utiliser ici de caractères autres que les caractères alphanumériques (lettres, chiffres, underscore), et ne pas commencer par un chiffre. Par défaut	Chaîne	facultatif

Modèle:Note ref/Documentation

Sommaire

Code à copier-coller dans un article modifier

Utilisation du modèle modifier

Liste des paramètres modifier

Corps de la note modifier

Notes classiques modifier

Références Harvard modifier

Structure des notes et références modifier

Groupes de notes modifier

Noms des notes modifier

Conventions sur les notes et références modifier

Métadonnées modifier

Voir aussi modifier