Template:Cite IETF/doc

From Vigyanwiki
< Template:Cite IETF
Revision as of 00:55, 8 December 2021 by wikipedia>AManWithNoPlan (canonical parameters)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This is a template to cite IETF documents[1][2] including:

Usage

This template supports most of the parameters available to {{citation}}. For information about those parameters see that template's documentation.

Note: All parameter names must be in lowercase.

cite IETF specific parameters

  • |appendix= – Appendix number of the document. |appendix=A.1 produces "sec. A.1" Also used to create an anchor link for the document's URL.
  • |autolink= – |autolink=yes or |autolink=no Automatically generate a link to ietf.org for documents specified with |rfc=, |std=, |bcp=, |fyi=, |draft=, |ien=, or |rtr=. (enabled by default)
  • |bcp= – Number of the Best Current Practice (BCP) document. Also used to automatically generate a link to ietf.org.
  • |draft= – Name of the Internet Draft (I-D) document, including the leading draft-. Also used to automatically generate a link to ietf.org.
  • |fyi= – Number of the For Your Information (FYI) document. Also used to automatically generate a link to ietf.org.
  • |idanchor= – Anchor link target. By default, no anchor link is generated. The special value |idanchor=ietf generates an anchor link suitable for use with this template's ref parameter. Requires one of id, rfc, std, bcp, fyi, draft, ien or rtr fields to be present for the anchor link text.
  • |idlink= – Internal document anchor or title of a Wikipedia article to link via the document identifier. Article should already exist. Must not be wikilinked itself. Do not use this on its own, but along with id, rfc, std, bcp, fyi, draft, ien or rtr.
  • |idlinktype= – One of the values: id, rfc, std, bcp, fyi, draft, ien or rtr can be given to idlinktype to force the template to use the specified document identifier as the link text for idanchor or idlink. Do not use this on its own, but along with idanchor or idlink and id, rfc, std, bcp, fyi, draft, ien or rtr.
  • |ien= – Number of the Internet Experiment Note (IEN) document. Also used to automatically generate a link to ietf.org.
  • |nosec= – Using section, 'sections, or appendix automatically places the sec. notation. Se |nosec=y to hide the sec. notation.
  • |referenceid= – Reference id for the document. Used to create an anchor link for the document's URL.
  • |rfc= – Number of the Request for Comments (RFC) document. Also used to automatically generate a link to ietf.org.
  • |rtr= – Number of the RARE Technical Reports (RTR) document. Also used to automatically generate a link to ietf.org.
  • |section= – Section number of the document. |section=4.3.1 produces "sec. 4.3.1" Also used to create an anchor link for the document's URL. Can also be used in combination with sections to link to the first section in the given section range.
  • |sections= – Section range of the document. |sections=4.3-4.7 produces "sec. 4.3-4.7"
  • |sectionname= – The section name or section title of the document, written in full; displays before title and enclosed in quotes.
  • |std= – Number of the Internet Standard (STD) document. Also used to automatically generate a link to ietf.org.

As with all cs1|2 templates, |title= is required. If omitted, the template will attempt to auto-generate a title using the first of rfc, std, bcp, fyi, draft, ien, rtr or id document identifier parameters, in that order.

Copy a blank version to use. Remember to use the "|" (pipe) character between each parameter. Please delete any unused parameters to avoid clutter in the edit window.

Full version (copy and paste text below and delete parameters you don't need)
{{cite IETF |title= |rfc= |std= |bcp= |fyi= |draft= |ien= |rtr= |sectionname= |section= |sections= |appendix= |referenceid= |page= |pages= |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |authormask= |editor1-last= |editor1-first= |editor1-link= |others= |date= |year= |orig-date= |publisher=[[Internet Engineering Task Force|IETF]] |location= |language= |format= |access-date= |url= |section-url= |page-url= |autolink= |id= |idanchor= |idlink= |idlinktype= |doi= |doi-broken-date= |issn= |archive-url= |archive-date= |quote= |nopp= |nosec= |ref= |lay-summary= |lay-date= |postscript= |last-author-amp=}}
Most commonly used parameters (use this and you won't have to delete as much)
{{cite IETF |title= |rfc= |sectionname= |section= |page= |last= |first= |author-link= |date= |publisher=[[Internet Engineering Task Force|IETF]] |access-date= |doi=}}
Example 1

{{cite IETF |title=The Tao of IETF: A Novice's Guide to the Internet Engineering Task Force |rfc=4677 |fyi=17 |last1=Hoffman |first1=P. |authorlink1=Paul Hoffman (VPNC) |last2=Harris |first2=S. |date=September 2006 |publisher=[[Internet Engineering Task Force|IETF]] |access-date=October 20, 2009 |doi=10.17487/RFC4677}}

Hoffman, P.; Harris, S. (September 2006). The Tao of IETF: A Novice's Guide to the Internet Engineering Task Force. IETF. doi:10.17487/RFC4677. FYI 17. RFC 4677. Retrieved October 20, 2009.

Example 2 
{{cite IETF
| title = Telnet protocol specification
| rfc = 854
| std = 8
| sectionname = Are You There (AYT)
| page = 8
| last1 = Postel
| first1 = J.
| author-link1 = Jon Postel
| last2 = Reynolds
| first2 = J.
| author-link2 = Joyce K. Reynolds
| date = May 1983
| publisher = [[Internet Engineering Task Force|IETF]]
| access-date = October 20, 2009
| doi = 10.17487/RFC0854
}}

Postel, J.; Reynolds, J. (May 1983). "Are You There (AYT)". Telnet protocol specification. IETF. p. 8. doi:10.17487/RFC0854. STD 8. RFC 854. Retrieved October 20, 2009.

Examples

  • {{cite IETF | title = JSON | rfc = 7159 | sectionname = IANA Considerations | section = 11 | author = T. Bray | authorlink = Tim Bray | date = March 2014 | publisher = [[Internet Engineering Task Force|IETF]] | access-date = November 26, 2017 | doi = 10.17487/RFC7159 }}
    → T. Bray (March 2014). "IANA Considerations". JSON. IETF. sec. 11. doi:10.17487/RFC7159. RFC 7159. Retrieved November 26, 2017.
  • {{cite IETF | title = Hypertext Transfer Protocol -- HTTP/1.1 | rfc = 2616 | first1 = R. | last1 = Fielding | authorlink1 = Roy Fielding | first2 = J. | last2 = Gettys | authorlink2 = Jim Gettys | first3 = J. | last3 = Mogul | first4 = H. | last4 = Frystyk | authorlink4 = Henrik Frystyk Nielsen | first5 = L. | last5 = Masinter | first6 = P. | last6 = Leach | first7 = T. | last7 = Berners-Lee | authorlink7 = Tim Berners-Lee |date=June 1999 | publisher = [[Internet Engineering Task Force|IETF]] | doi = 10.17487/RFC2616 }}
    → Fielding, R.; Gettys, J.; Mogul, J.; Frystyk, H.; Masinter, L.; Leach, P.; Berners-Lee, T. (June 1999). Hypertext Transfer Protocol -- HTTP/1.1. IETF. doi:10.17487/RFC2616. RFC 2616.
  • {{cite IETF | title = Domain names - concepts and facilities | rfc = 1034 | sectionname = Name space specifications and terminology | section = 3.1 | author = P. Mockapetris | authorlink = Paul Mockapetris |date=November 1987 | publisher = [[Internet Engineering Task Force|IETF]] | access-date = August 3, 2008 | doi = 10.17487/RFC1034 | quote = A domain is a subdomain of another domain if it is contained within that domain. This relationship can be tested by seeing if the subdomain's name ends with the containing domain's name. For example, A.B.C.D is a subdomain of B.C.D, C.D, D, and ' '. }}
    → P. Mockapetris (November 1987). "Name space specifications and terminology". Domain names - concepts and facilities. IETF. sec. 3.1. doi:10.17487/RFC1034. RFC 1034. Retrieved August 3, 2008. A domain is a subdomain of another domain if it is contained within that domain. This relationship can be tested by seeing if the subdomain's name ends with the containing domain's name. For example, A.B.C.D is a subdomain of B.C.D, C.D, D, and ' '.

Technical notes

Regression testing

Regression tests are available here:

Subtemplates

{{Cite IETF}} uses the following subtemplates:

URL generation

HTML versions of the IETF documents are created with the Rfcmarkup tool from Henrik Levkowetz.[10][11]

Request for Comments (RFC), Best Current Practice (BCP), and Internet Draft (I-D) documents which have been processed by the Rfcmarkup tool are cached by https://tools.ietf.org/html/[12][13] and are linked via:

https://tools.ietf.org/html/rfc<document number>
https://tools.ietf.org/html/bcp<document number>
https://tools.ietf.org/html/draft-<draft name>

Internet Standard (STD) and For Your Information (FYI) documents are linked via the Rfcmarkup tool using the doc= parameter:

https://tools.ietf.org/rfcmarkup?doc=std<document number>
https://tools.ietf.org/rfcmarkup?doc=fyi<document number>

Internet Experiment Note (IEN) and RARE Technical Reports (RTR) documents are linked via the Rfcmarkup tool using the url= parameter and a path to the document:

https://tools.ietf.org/rfcmarkup?url=ftp://ftp.rfc-editor.org/in-notes/ien/ien<document number>.txt
https://tools.ietf.org/rfcmarkup?url=ftp://ftp.rfc-editor.org/in-notes/museum/RAREreports/rtr<document number>.txt

URL anchor generation

Anchors are generated for the URL using four parameters:

|section=number generates #section-<number>
|appendix=number generates #appendix-<number>
|referenceid=id generates #ref-<id>
|page=number generates #page-<number>

The template will give priority to the first of the parameters: |section=, |appendix=, |referenceid=, or |page= in this order and create an anchor using the first matching parameter.

References

  1. ↑ Hoffman, Paul; Harris, Susan (September 2006). The Tao of IETF: A Novice's Guide to the Internet Engineering Task Force. IETF. doi:10.17487/RFC4677. FYI 17. RFC 4677. Retrieved November 2, 2009.
  2. ↑ Kessler, Gary C.; Shepard, Steven D. (December 1994). "Internet Documentation". A Primer On Internet and TCP/IP Tools. IETF. sec. 4. doi:10.17487/RFC1739. RFC 1739. Retrieved November 2, 2009.
  3. ↑ "Request for Comments (RFCs)". A Primer On Internet and TCP/IP Tools. pp. 36–38. sec. 4.1. doi:10.17487/RFC1739. RFC 1739.
  4. ↑ Bradner, Scott O. (October 1996). The Internet Standards Process -- Revision 3. IETF. doi:10.17487/RFC2026. BCP 9. RFC 2026. Retrieved November 2, 2009.
  5. ↑ "Internet Standards". A Primer On Internet and TCP/IP Tools. pp. 38–39. sec. 4.2. doi:10.17487/RFC1739. RFC 1739.
  6. ↑ Postel, Jon; Rekhter, Yakov; Li, Tony (August 1995). Best Current Practices. IETF. doi:10.17487/RFC1818. BCP 1. RFC 1818. Retrieved November 2, 2009.
  7. ↑ Malkin, Gary Scott; Reynolds, Joyce K. (March 1990). F.Y.I. on F.Y.I.: Introduction to the F.Y.I. Notes. IETF. doi:10.17487/RFC1150. FYI 1. RFC 1150. Retrieved November 2, 2009.
  8. ↑ "For Your Information Documents". A Primer On Internet and TCP/IP Tools. p. 39. sec. 4.3. doi:10.17487/RFC1739. RFC 1739.
  9. ↑ "RARE Technical Reports". A Primer On Internet and TCP/IP Tools. p. 40. sec. 4.4. doi:10.17487/RFC1739. RFC 1739.
  10. ↑ Levkowetz, Henrik (March 7, 2017). "Rfcmarkup Tool". IETF. Retrieved November 26, 2017.
  11. ↑ Levkowetz, Henrik (July 13, 2016). "rfcmarkup-1.121.tgz (29.7 KB)". IETF. Retrieved November 26, 2017.
  12. ↑ "IETF Documents". IETF. Retrieved November 2, 2009.
  13. ↑ "HTTP 404 handler for a directory of htmlized documents". IETF. October 14, 2009. Retrieved November 2, 2009.

Further reading

This template produces COinS metadata; see COinS in Wikipedia for background information.


Retrieved from ‘https://www.vigyanwiki.in/index.php?title=Template:Cite_IETF/doc&oldid=27474’