Vorlage:RFC-Internet/Doku
Diese Seite ist die Dokumentations-Unterseite der Vorlage:RFC-Internet.
Vorlagenparameter
| Parameter | Beschreibung | Typ | Status | |
|---|---|---|---|---|
| RFC-Code | RFC | Ziffernfolge der Request for Comments ohne RFC, maximal vier Ziffern
| Zahlenwert | erforderlich |
| Autor | Autor | Namen der Autoren (bzw. oft eher Herausgeber); Komma-separierte Liste
| Wikitext | vorgeschlagen |
| Titel | Titel | Titel des Dokuments. Mit - kann hinterlegt werden, dass absichtlich kein RFC-Titel dargestellt werden soll, etwa bei wiederholtem Verweis auf einzelne Abschnitte.
| Einzeiliger Text | vorgeschlagen |
| Abschnittsnummer | Abschnitt | Ziffernfolge, die den genauen Abschnitt definiert (ohne den hinteren Punkt); nicht zugleich mit dem Parameter Seite verwenden
| Einzeiliger Text | vorgeschlagen |
| Anhangsnummer | Anhang | Ziffernfolge, die den genauen Abschnitt im Anhang definiert (ohne den hinteren Punkt); nicht zugleich mit dem Parameter Seite verwenden
| Einzeiliger Text | vorgeschlagen |
| Abschnittstitel | Abschnittstitel |
| Einzeiliger Text | vorgeschlagen |
| Datum | Datum | Publikationsdatum im ISO-Format JJJJ-MM-TT
| Datum | vorgeschlagen |
| Seite | Seite | Link auf eine Seite (nur einzelne Seite, keine Seitenbereiche und nicht zugleich mit dem Parameter Abschnitt verwenden)
| Zahlenwert | vorgeschlagen |
| Standard | Standard | Einstufung als STD oder BCP (best current practice) | Einzeiliger Text | vorgeschlagen |
| Ersetzt | Obsoletes | Ziffernfolge einer RFC, die zuletzt durch diese Version ersetzt wurde; noch frühere im Kommentar
| Zahlenwert | vorgeschlagen |
| Aktualisierung | Updated | Ziffernfolge einer RFC, durch die diese Version unmittelbar aktualisiert wurde; spätere im Kommentar
| Zahlenwert | vorgeschlagen |
| Fehlerbericht | Errata | Fehlerbericht existiert
| Wahrheitswert | optional |
| Anmerkung | Kommentar | Kurze Anmerkung oder Zitat | Wikitext | vorgeschlagen |
Hinweis
[Quelltext bearbeiten]Perspektivisch wird die automatische Verlinkung als „Magisches Wort“ nicht mehr erfolgen.
- Das Feature stammt aus den Anfangsjahren der Wikis. Es macht das effiziente Parsen von Wikitext jedoch unmöglich, weil nicht erst durch ein Sonderzeichen wie
<oder{oder[eine Analyse ausgelöst werden braucht, sondern aller Text auch aufRoderPoderIuntersucht und dann die vorangehenden und folgenden Zeichen weiter analysiert werden müssen. RFC 1925wird eines Tages als ganz normaler Text (unverlinkt) erscheinen.
Im Fließtext von Artikeln sollte verwendet werden:
… wird in <nowiki>RFC 1925</nowiki><ref>{{RFC-Internet |RFC=1925}}</ref> sowie in <nowiki>RFC …
verhindert nicht die Erkennung als Magisches Wort, vermeidet jedoch eine Auffindung abgearbeiteter Fälle bei globaler Textsuche. Dass nebenbei der Zeilenumbruch verhindert wird, ist ein angenehmer Zusatznutzen.<nowiki>RFC …</nowiki>ist temporär bis zum Abschluss der Migration erforderlich, um Irritationen durch doppelte Verlinkungen zu vermeiden.
Bei Aufzählungen wie etwa im Abschnitt „Weblinks“ kann ganz normal eine Internetquelle mittels dieser Vorlage zitiert werden.
- Natürlich können überall aufschlussreiche Parameterwerte wie der Titel oder das Erscheinungsjahr beigegeben werden.
Kopiervorlagen
[Quelltext bearbeiten]Pflichtangabe
{{RFC-Internet |RFC=}}
mit Titel und Datum
{{RFC-Internet |RFC= |Titel= |Datum=}}
Seitenlink
{{RFC-Internet |Autor= |RFC= |Titel= |Datum= |Seite= |Standard= |Updated= |Obsoletes= |Kommentar=}}
Abschnittslink
{{RFC-Internet |Autor= |RFC= |Titel= |Datum= |Abschnitt= |Abschnittstitel= |Standard= |Updated= |Obsoletes= |Kommentar=}}
Verlinkung der Ressource
[Quelltext bearbeiten]Die Verlinkung erfolgt über „Pseudo-Interwiki“ [[rfc:…]] und nicht über eine bestimmte Website.
- Die aktuelle Website wird von MediaWiki global gepflegt.
- Damit weisen auch alle Wikis, die sich dieser Methodik anschließen, eine einheitliche Präsentation der Dokumente auf.
- Die Vorlage selbst hat keine Kenntnis davon, welche Website dies momentan ist.
Im Lauf der Jahrzehnte gab es unterschiedliche Domains, die teils offiziell, teils vertrauenswürdig spiegelnd die Ressourcen bereitstellten. Zunächst waren das TXT-Dateien über FTP-Server, später kamen inoffiziell HTML-Aufbereitungen hinzu, auch mit einem eingefügten Inhaltsverzeichnis und Sprungzielen. Bekannt wurden:
ietf.org(offiziell)rfc-editor.org(offiziell)doi:10.17487/RFC1(offiziell)w3.org(offiziös/befreundet)faqs.orgsunsite.auc.dkhunter.comcurl.haxx.se
Entscheidend ist lediglich, dass eine glaubwürdige Website verlinkt wird.
Wartung
[Quelltext bearbeiten]Fehlerhafte Einbindungen werden aufgelistet in der Kategorie:Wikipedia:Vorlagenfehler/Vorlage:RFC-Internet – aktuell keine (22. November 2024 21:14)