Wikilivres

Modèle:RFC/Documentation

< Modèle:RFC
Documentation de Modèle:RFC. [rafraîchir] · [créer] · [historique]


Utilité du modèle

modifier

Quand la chaîne de caractères « RFC » est insérée, suivie d'un ou plusieurs espaces, ou de &nbsp;, puis d'un ou plusieurs chiffres, actuellement MediaWiki interprète automatiquement ceci comme une référence à une Request for comments, et créée un lien externe vers le site de l'IETF, où le lecteur peut en retrouver le texte. Par exemple,

RFC 1149

est automatiquement transformé en :

RFC 1149

Ce comportement automatique est amené à disparaître (cf. T145604), les liens externes ne seront plus automatiquement créés.


Néanmoins, les recommandations sur les liens externes proscrivent les liens externes directement dans le corps du texte, et recommandent de les passer en note de bas de page s'ils servent de référence. Pour ce faire, dans le cas qui nous occupe, il est nécessaire :

  • dans le corps du texte, d'interdire l'interprétation par MediaWiki au moyen de <nowiki>...</nowiki> ;
  • de créer une note de bas de page correctement présentée, mentionnant au moins le numéro de la RFC (ce qui implique de le répéter puisqu'il est déjà mentionné dans le corps du texte), et d'introduire diverses mises en forme (indications de langue au moyen de {{en}}, et si le titre est indiqué, {{lang|en}}, les RFC étant rédigées en anglais ; URL du lien ; etc.), ce qui créée une syntaxe lourde et redondante.

Le présent modèle permet d'automatiser ceci et de conserver les liens vers le texte des RFC même lorsque la fonctionnalité de lien automatique aura été supprimée de MediaWiki.

Syntaxe

modifier
{{RFC|<numéro de la RFC>|auteur=<nom de l'auteur>|titre=<titre de la RFC>|date=<date de la RFC>}}

Tous les paramètres sont facultatifs ; la mise en forme s'adapte en fonction de ceux qui sont renseignés.

Il est possible de faire en sorte que le modèle ne retourne que la note de bas de page, sans le texte destiné à être inséré dans le corps de l'article. Pour ce faire, il suffit de renseigner un paramètre ref= avec n'importe quelle valeur, typiquement oui (cf. exemples 8 à 14).

Si le numéro de la RFC n'est pas renseigné, le modèle retourne simplement « RFC » suivi d'une espace insécable, ce qui permet d'interdire l'interprétation par MediaWiki quand on souhaite simplement parler d'une RFC sans créer de lien externe ni de note de bas de page. Dans ce cas il est inutile de renseigner les autres paramètres, ils ne sont pas pris en compte ; la syntaxe est donc seulement {{RFC}}, immédiatement suivie du numéro (cf. exemple 15).

Note importante : n'oubliez pas d'insérer une balise <references/> (par exemple grâce au modèle {{Références}}) en fin d'article).

Exemples

modifier
Code wiki Rendu
1 {{RFC|1149}} RFC 1149[1]
2 {{RFC|1149|auteur=David Waitzman}} RFC 1149[2]
3 {{RFC|1149|titre=A Standard for the Transmission of IP Datagrams on Avian Carriers}} RFC 1149[3]
4 {{RFC|1149|date={{1er}} avril 1990}} RFC 1149[4]
5 {{RFC|1149|auteur=David Waitzman|titre=A Standard for the Transmission of IP Datagrams on Avian Carriers}} RFC 1149[5]
6 {{RFC|1149|auteur=David Waitzman|date={{1er}} avril 1990}} RFC 1149[6]
7 {{RFC|1149|auteur=David Waitzman|titre=A Standard for the Transmission of IP Datagrams on Avian Carriers|date={{1er}} avril 1990}} RFC 1149[7]
8 {{RFC|1149|ref=oui}} [8]
9 {{RFC|1149|ref=oui|auteur=David Waitzman}} [9]
10 {{RFC|1149|ref=oui|titre=A Standard for the Transmission of IP Datagrams on Avian Carriers}} [10]
11 {{RFC|1149|ref=oui|date={{1er}} avril 1990}} [11]
12 {{RFC|1149|ref=oui|auteur=David Waitzman|titre=A Standard for the Transmission of IP Datagrams on Avian Carriers}} [12]
13 {{RFC|1149|ref=oui|auteur=David Waitzman|date={{1er}} avril 1990}} [13]
14 {{RFC|1149|ref=oui|auteur=David Waitzman|titre=A Standard for the Transmission of IP Datagrams on Avian Carriers|date={{1er}} avril 1990}} [14]
15 {{RFC}}1149 RFC 1149
  1. ↑ (anglais) Request for comments no 1149.
  2. ↑ (anglais) David Waitzman, Request for comments no 1149.
  3. ↑ (anglais) « A Standard for the Transmission of IP Datagrams on Avian Carriers », Request for comments no 1149.
  4. ↑ (anglais) Request for comments no 1149, Modèle:1er avril 1990.
  5. ↑ (anglais) David Waitzman, « A Standard for the Transmission of IP Datagrams on Avian Carriers », Request for comments no 1149.
  6. ↑ (anglais) David Waitzman, Request for comments no 1149, Modèle:1er avril 1990.
  7. ↑ (anglais) David Waitzman, « A Standard for the Transmission of IP Datagrams on Avian Carriers », Request for comments no 1149, Modèle:1er avril 1990.
  8. ↑ (anglais) Request for comments no 1149.
  9. ↑ (anglais) David Waitzman, Request for comments no 1149.
  10. ↑ (anglais) « A Standard for the Transmission of IP Datagrams on Avian Carriers », Request for comments no 1149.
  11. ↑ (anglais) Request for comments no 1149, Modèle:1er avril 1990.
  12. ↑ (anglais) David Waitzman, « A Standard for the Transmission of IP Datagrams on Avian Carriers », Request for comments no 1149.
  13. ↑ (anglais) David Waitzman, Request for comments no 1149, Modèle:1er avril 1990.
  14. ↑ (anglais) David Waitzman, « A Standard for the Transmission of IP Datagrams on Avian Carriers », Request for comments no 1149, Modèle:1er avril 1990.
Récupérée de « https://fr.wikibooks.org/w/index.php?title=Modèle:RFC/Documentation&oldid=685311 »