Add a warning when include PI (processing instructions) are used with v3

ietf-tools / xml2rfc

Generate RFCs and IETF drafts from document source in XML according to the IETF xml2rfc v2 and v3 vocabularies

https://ietf-tools.github.io/xml2rfc/

BSD 3-Clause "New" or "Revised" License

65 stars 38 forks source link

Add a warning when include PI (processing instructions) are used with v3 #1006

Closed kesara closed 1 year ago

kesara commented 1 year ago

Description

XInclude should be used instead of ENTITY references and XML Processing Instructions (PIs) that allow external inclusions. [1]

Add a warning when include PIs (<?rfc include='<reference>' ?>) are used with xml2rfc v3.

[1] https://datatracker.ietf.org/doc/html/rfc7991#appendix-B.1

Code of Conduct

[X] I agree to follow the IETF's Code of Conduct

reschke commented 1 year ago

FWIW, I disagree with the part "XInclude should be used instead of ENTITY references". ENTIRY references are a standard XML feature. We should not profile XML. (And yes, the other part about warning about the PI is good).