« Modèle:RFC/Documentation » : différence entre les versions

Contenu supprimé Contenu ajouté
FDo64 (discussion | contributions)
cat
NicoV (discussion | contributions)
Lien magique RFC obsolète
Ligne 2 :
 
== Utilité du modèle ==
Quand la chaîne de caractères « RFC » est insérée, suivie d'un ou plusieurs espaces, ou de <code>&amp;nbsp;</code>, puis d'un ou plusieurs chiffres, actuellement MediaWiki interprète automatiquement ceci comme une référence à une {{lang|en|[[Request for comments]]}}, et créée un lien externe vers le site de l'[[Internet Engineering Task Force|IETF]], où le lecteur peut en retrouver le texte. Par exemple,
:<code><nowiki>RFC 1149</nowiki></code>
est automatiquement transformé en :
:[https://tools.ietf.org/html/rfc1149 RFC 1149]
:RFC 1149
Ce comportement automatique est amené à disparaître (cf. [[:phab:T145604|T145604]]), les liens externes ne seront plus automatiquement créés.
 
 
Néanmoins, les [[Wikipédia:Liens externes|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 <code><nowiki><nowiki>...</nowiki></nowiki></code> ;
* de créer une note de 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 {{m|en}}, et si le titre est indiqué, {{m|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 ==
Ligne 21 ⟶ 23 :
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 <code><nowiki>{{RFC}}</nowiki></code>, immédiatement suivie du numéro (cf. exemple 15).
 
Note importante : n'oubliez pas d'insérer une balise <code><nowiki><references/></nowiki></code> (par exemple grâce au modèle {{m|Références}}) en fin d'article).
 
== Exemples ==