Menu

Reference Guidelines

Reference guidelines

  • Leaving the year off the standard is allowed.
  • Be consistent, if using the year, always use the year. If not using the year, only add the year to the reference if a specific revision is needed for clarity (if, for example, the new version introduces a non-backward compatible change and the functionality required needs the old functionality).
  • For revision statement, but in the base standard then list amendments. Have different standards on a new line.
    • Example: (from ieee802-dot1q-lldp-pbbn-aa-tlv.yang)
      • reference
        “IEEE Std 802.1Q Bridges and Bridged Networks:
        IEEE Std 802.1Q-2022, IEEE Std 802.1Qcz-2023, IEEE Std 802.1Qcw-2023,
        IEEE Std 802.1Qcj-2023.
        IEEE Std 802 Overview and Architecture: IEEE Std 802-2014.”;
  • Use “Clause” before the clause number only if the clause number is a top-level clause. Otherwise just use the subclause number.
    • Example:
      • reference “Clause 12 of IEEE Std 802.1Q-2018”;
      • reference “Clause 12 of IEEE Std 802.1Q”;
  • For references that are not a top-level clause, do not use the word “Clause or sub-clause”
    • Example:
      • reference “12.13.2.1 of IEEE Std 802.1Q-2018”;
      • reference “12.13.2.1 of IEEE Std 802.1Q”;
  • When there are multiple sub-clauses in the same document separate them by commas (or the word “and”) then identify the standard.
    • Examples:
      • reference “12.13.2.1, 12.13.2.2, 12.13.2.3 of IEEE Std 802.1Q”;
      • reference “12.13.2.1, 12.13.2.2 and 12.13.2.3 of IEEE Std 802.1Q”;
  • Limit the number of referenced clause/sub-clauses to no more than two per reference statement.
  • Don’t use ranges (12.13.2.1 through 12.13.2.3), ranges are discouraged by the IEEE Style Manual.
  • References when there are multiple standards in the statement.  Separate references by new line.
    • Example:
    • reference “12.13.2.1 of IEEE Std 802.1Q;”
      “Clause 10 of IEEE Std 802.1ABcu”;
  • For references to Tables or Figures, use the word Table or Figure along with the table or figure number.
    • Example:
      • reference “Table 6-1 of IEEE Std 802.1Q-2018”;
      • reference “Table 6-1 of IEEE Std 802.1Q”;
      • reference “Figure 28-6 of IEEE Std 802.1Q-2018”;
      • reference “Figure 28-6 of IEEE Std 802.1Q”;
  • For references to list items
    • Example:
      • reference “Item b) in 12.10.1.1.3 of IEEE Std 802.1Q-2021”
      • reference “Item b) in 12.10.1.1.3 of IEEE Std 802.1Q”
  • ‘For tables and figures treat them as nouns so ensure Table or Figure is capitalized.
  • Editor’s discretion on above guidelines is allowed but may be commented on during a ballot cycle.
Sidebar