[rfc-i] <format> element

Julian Reschke julian.reschke at gmx.de
Sun Feb 21 23:23:55 PST 2021


So I did a few tests with the <format> element, documented in
<https://greenbytes.de/tech/webdav/rfc7749.html#element.format> and
<https://greenbytes.de/tech/webdav/rfc7991.html#element.format>.

(test input and output attached)

Observations:

1) xml2rfc v1's text output ignores <format> and uses @target when
present to add the URI to the end of the reference.

2) xml2rfc v1's HTML output uses @target when present to hyperlink the
doc title. When absent, it uses <format> instead, if there is a single
one. If there are multiple ones, they are all added to the end of the
reference.

3) xml2rfc current, in v2 mode, ignores <format>.

4) xml2rfc current, in v3 mode, uses the *first* <format> element as a
fallback for a missing @target attribute, otherwise ignores <format>
completely.

5) rfc2629.xslt igores <format>

6) xml2rfc''s prep-tool format preserves <format>, which is a bug
according to
<https://greenbytes.de/tech/webdav/rfc7998.html#rfc.section.5.6.6>.

Recommendations:

a) Public IETF <reference> resources should not use <format> at all.

b) xml2rfc's preptool should be fixed to remove those.

c) xml2rfc's v3 output mode should be fixed to ignore those.

Best regards, Julian
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.rfc-editor.org/pipermail/rfc-interest/attachments/20210222/63feb92d/attachment-0003.html>
-------------- next part --------------




Network Working Group                                         J. Reschke
Internet-Draft                                          22 February 2021
Intended status: Informational                                          
Expires: 26 August 2021


                       Tests for <format> element
                            ref-target-test

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on 26 August 2021.

Copyright Notice

   Copyright (c) 2021 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents (https://trustee.ietf.org/
   license-info) in effect on the date of publication of this document.
   Please review these documents carefully, as they describe your rights
   and restrictions with respect to this document.  Code Components
   extracted from this document must include Simplified BSD License text
   as described in Section 4.e of the Trust Legal Provisions and are
   provided without warranty as described in the Simplified BSD License.

Table of Contents

   1.  Test  . . . . . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   2
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   2






Reschke                  Expires 26 August 2021                 [Page 1]


Internet-Draft         Tests for <format> element          February 2021


1.  Test

   Test.

2.  References

   [t1]       Foo, "No target attribute, no <format> elements".

   [t2]       Foo, "Target attribute, no <format> elements",
              <t2.target>.

   [t3]       Foo, "One <format> element", <one.html>.

   [t4]       Foo, "Two <format> elements", <one.html>.

   [t5]       Foo, "Two <format> elements, reversed", <two.txt>.

   [t6]       Foo, "Three <format> elements", <one.html>.

   [t7]       Foo, "Three <format> elements, with target attribute",
              <target.html>.

Author's Address

   Julian Reschke


























Reschke                  Expires 26 August 2021                 [Page 2]
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.rfc-editor.org/pipermail/rfc-interest/attachments/20210222/63feb92d/attachment-0004.html>
-------------- next part --------------




Network Working Group                                         J. Reschke
Internet-Draft                                         February 22, 2021
Intended status: Informational
Expires: August 26, 2021


                       Tests for <format> element
                            ref-target-test

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on August 26, 2021.

Copyright Notice

   Copyright (c) 2021 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (https://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

1.  Test

   Test.







Reschke                  Expires August 26, 2021                [Page 1]


Internet-Draft         Tests for <format> element          February 2021


2.  References

   [t1]       Foo, "No target attribute, no <format> elements".

   [t2]       Foo, "Target attribute, no <format> elements",
              <t2.target>.

   [t3]       Foo, "One <format> element".

   [t4]       Foo, "Two <format> elements".

   [t5]       Foo, "Two <format> elements, reversed".

   [t6]       Foo, "Three <format> elements".

   [t7]       Foo, "Three <format> elements, with target attribute",
              <target.html>.

Author's Address

   Julian Reschke






























Reschke                  Expires August 26, 2021                [Page 2]
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.rfc-editor.org/pipermail/rfc-interest/attachments/20210222/63feb92d/attachment-0005.html>
-------------- next part --------------



Network Working Group                                         J. Reschke
Internet-Draft                                         February 22, 2021
Intended status: Informational
Expires: August 26, 2021


                       Tests for <format> element
                            ref-target-test


Status of this Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on August 26, 2021.

Copyright Notice

   Copyright (c) 2021 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.










Reschke                  Expires August 26, 2021                [Page 1]


Internet-Draft         Tests for <format> element          February 2021


1.  Test

   Test.
















































Reschke                  Expires August 26, 2021                [Page 2]


Internet-Draft         Tests for <format> element          February 2021


2.  References

   [t1]  Foo, "No target attribute, no <format> elements".

   [t2]  Foo, "Target attribute, no <format> elements", <t2.target>.

   [t3]  Foo, "One <format> element".

   [t4]  Foo, "Two <format> elements".

   [t5]  Foo, "Two <format> elements, reversed".

   [t6]  Foo, "Three <format> elements".

   [t7]  Foo, "Three <format> elements, with target attribute",
         <target.html>.



































Reschke                  Expires August 26, 2021                [Page 3]


Internet-Draft         Tests for <format> element          February 2021


Author's Address

   Julian Reschke
















































Reschke                  Expires August 26, 2021                [Page 4]


-------------- next part --------------
A non-text attachment was scrubbed...
Name: ref-format-test.xml
Type: text/xml
Size: 2758 bytes
Desc: not available
URL: <http://www.rfc-editor.org/pipermail/rfc-interest/attachments/20210222/63feb92d/attachment-0002.xml>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ref-format-test.prepped.xml
Type: text/xml
Size: 7686 bytes
Desc: not available
URL: <http://www.rfc-editor.org/pipermail/rfc-interest/attachments/20210222/63feb92d/attachment-0003.xml>


More information about the rfc-interest mailing list