Template:Cite IETF/doctypes/doc

From Wikipedia, the free encyclopedia

This template is a "subroutine" of {{Cite IETF}} used for conditionally generating a list of associated document identifiers.

This "subroutine" is designed for {{Cite IETF}} and makes assumptions that may not be valid elsewhere.

Background[edit]

It uses the following algorithm:

  1. If the |Id= parameter is given the template will simply display that value. If the |Idlink= parameter is also given, it will be used to create an anchor link.
  2. If the |Id= parameter is not given, for the |Std=, |Bcp=, |Fyi=, |Rfc=, |Draft=, |Ien=, and |Rtr= parameters given, the template will append the document identifiers STD ## BCP ## FYI ## RFC #### I-D xxxxxx IEN ### RTR ## in this order with the numbers or identifiers passed to these parameters.
  3. If the |Idlink= and |Idlinktype= parameters are given they will be used to create a wikilink for the document type specified by the |Idlinktype= parameter.
  4. The value of |Sep= is used to separate the document identifiers: BCP 14. RFC 2119
  5. No trailing separator is generated; this is added after being passed to {{Citation/core}} from {{Cite IETF}}.
  6. The document identifier and number is separated with a <nowiki /> tag to prevent Rfcurl from automatically linking RFC ####.

Use[edit]

It is invoked as:

{{Cite IETF/doctypes
| Id = <value of |id= parameter>
| Sep = <value of |separator= parameter>
| Std = <value of |std= parameter>
| Bcp = <value of |bcp= parameter>
| Fyi = <value of |fyi= parameter>
| Rfc = <value of |rfc= parameter>
| Draft = <value of |draft= parameter>
| Ien = <value of |ien= parameter>
| Rtr = <value of |rtr= parameter>
| Idlink = create a wikilink using this as the target, can be used to create anchor links
| Idlinktype = document type to be used as the target text for Idlink
}}

Examples[edit]

{{Cite IETF/doctypes |Sep=. |Bcp=14 |Rfc=2119}}

produces "BCP 14. RFC 2119".

{{Cite IETF/doctypes |Sep=. |Bcp=14 |Rfc=2119 |Idlink=#IETF_RFC_2119 |Idlinktype=rfc}}

produces "BCP 14. RFC 2119".

{{Cite IETF/doctypes |Sep=. |Bcp=14 |Rfc=2119 |Idlink=#IETF_BCP_14 |Idlinktype=bcp}}

produces "BCP 14. RFC 2119".