| Next revision | Previous revision |
| rerendering [2022/11/07 10:01] – created sginoza | rerendering [2026/02/12 05:44] (current) – external edit 127.0.0.1 |
|---|
| {{tag> rerender}} | ===== Reissuing a Publication Version of an RFC ===== |
| | |
| ===== Rerendering a publication format ===== | |
| |
| ==== Guidelines ==== | ==== Guidelines ==== |
| | Note: The terms "definitive format" and "publication version" are used as defined in [[https://www.rfc-editor.org/rfc/rfc9720#name-changes-to-rfc-7990|Section 1.1 of RFC 9720]]. |
| |
| As noted in [[https://www.rfc-editor.org/rfc/rfc7990.html#section-10.2|Section 10.2 of RFC 7990]], "The actual rendering engine can go through further review and iteration, as the publication formats may be republished as needed." Below are the criteria for republishing a publication format. To summarize, this is the case where one or more publication formats of an RFC is posted *without* replacing the XML file. | As noted in [[https://www.rfc-editor.org/rfc/rfc9720#section-3|Section 3 of RFC 9720]]: |
| |
| Below, the terms "canonical format" and "publication format" are used as defined in [[https://www.rfc-editor.org/rfc/rfc7990.html#section-3|Section 3 of RFC 7990]] and per [[https://www.rfc-editor.org/rfc/rfc7990.html#section-5|Section 5]] "The final XML file produced by the RFC Editor will be considered the canonical format for RFCs". | > The RPC is permitted but not required to reissue publication versions of an RFC, as described in [[https://www.rfc-editor.org/rfc/rfc9720#section-1.2|Section 1.2]]. In deciding whether to update the publication versions of an RFC, the RPC will take into account both the risk of semantic changes and consistency of the Series. |
| |
| Specifically, a publication format (TXT, HTML, and/or PDF) for a particular RFC may be rerendered if all of the following conditions are true: | Below are the criteria for reissuing a publication version, where one or more publication versions of an RFC is posted *without* replacing the XML file. A publication version (TXT, HTML, and/or PDF) for a particular RFC may be reissued if all of the following conditions are true: |
| |
| * An error materially affects at least one of the rendered outputs (e.g., text is missing). | * An error materially affects at least one of the rendered outputs (e.g., text is missing). |
| * The error is a result of the conversion tools and correction does not require changes to the canonical format. | * The error is a result of the conversion tools and correction does not require changes to the definitive format. |
| * Had the issue been identified earlier, publication of the affected document would have been delayed until the issue was fixed. | * Had the issue been identified earlier, publication of the affected document would have been delayed until the issue was fixed. |
| |
| The defective file will be moved to a separate, publicly available directory https://www.rfc-editor.org/rerendered/, which contains a README explaining the purpose of the directory. The rerendered file will replace the defective file, and the replacement will be announced on the ietf-announce and rfc-dist mailing lists, which are the standard communication channels for announcing the publication of RFCs. | ==== Process ==== |
| | The defective file will be moved to a separate, publicly available directory https://www.rfc-editor.org/in-notes/rerendered/, which contains a README explaining the purpose of the directory. The reissued file will replace the defective file, and the replacement will be announced on the ietf-announce and rfc-dist mailing lists, which are the standard communication channels for announcing the publication of RFCs. A note will be added to the RFC's datatracker History tab. |
| |
| ---- | ---- |
| ==== List of files that have been rerendered ==== | ==== List of files that have been reissued ==== |
| | |
| | ^ RFC number ^ File(s) reissued ^ Date ^ Reason | |
| | | [[https://www.rfc-editor.org/info/rfc8677|RFC 8677]] | PDF | 2024-12-19, [[https://mailarchive.ietf.org/arch/msg/ietf-announce/OoDdFZoM0LJ2fj_LxJu2pjFdX04/|announcement]] | PDF rerendered so that list numbering is corrected in Section 6.2.2. (See https://github.com/ietf-tools/xml2rfc/pull/1055) | |
| | | [[https://www.rfc-editor.org/info/rfc8680|RFC 8680]] | PDF | 2024-12-19, [[https://mailarchive.ietf.org/arch/msg/ietf-announce/DIlpX-W2-pbvtPz2rmfKl4tVbdQ/|announcement]] | PDF rerendered so that list numbering is corrected in Section 4.3. (See https://github.com/ietf-tools/xml2rfc/pull/1055) | |
| | | [[https://www.rfc-editor.org/info/rfc8681|RFC 8681]] | PDF | 2024-12-19, [[https://mailarchive.ietf.org/arch/msg/ietf-announce/gkSR-Dlq0WafA3s6KLZI2oZlqfg/|announcement]] | PDF rerendered so that list numbering is corrected in Section 1.4. (See https://github.com/ietf-tools/xml2rfc/pull/1055) | |
| | | [[https://www.rfc-editor.org/info/rfc8994|RFC 8994]] | PDF | 2024-12-19, [[https://mailarchive.ietf.org/arch/msg/ietf-announce/bkvyrLdqfEF6f1gIPeQX62gl_M0/|announcement]] | PDF rerendered so that list numbering is corrected in Section 6.2.3. (See https://github.com/ietf-tools/xml2rfc/pull/1055) | |
| | | [[https://www.rfc-editor.org/info/rfc9019|RFC 9019]] | PDF | 2022-12-19, [[https://mailarchive.ietf.org/arch/msg/ietf-announce/PJyGNHu2cvEbQrgBA9-Q6OMhRoI/|announcement]] | PDF rerendered so that Figures 2 and 3 are not cut off. (See https://github.com/ietf-tools/xml2rfc/pull/788) | |
| | |
| | |
| | === April 2020 batch reissuing of PDF files === |
| | |
| | [[https://mailarchive.ietf.org/arch/msg/rfc-interest/DkaPpvfbr18sqcht1IQx79dy60k/|Announced on rfc-interest on 1 May 2020]]: |
| | |
| | FYI, the PDF files for the 116 most recent RFCs have been replaced with PDF/A-3. This replacement was necessary due to our error when invoking the conversion to PDF/A-3 since October 2019. |
| | |
| | The files have been replaced in order to follow the recommendations in Section 2 of RFC 7995 -- specifically, providing PDF/A-3 with conformance level "U" and with the XML source file embedded. The new files have the same content, but have been converted to PDF/A-3 using pdfaPilot [1]. See [2] for the list of files; this affects the RFCs published in the new RFC format [3]. |
| | |
| | As an aside, this was a file conversion of the existing PDF, rather than a re-rendering of the PDF (using the current version of xml2rfc), although the latter is explicitly permitted and may be done in the future. |
| |
| ^ RFC number ^ File(s) rerendered ^ Date ^ Reason | | [1] https://www.callassoftware.com/en/products/pdfapilot\\ |
| | RFC 8743 | PDF | YYYY-MM-DD | PDF rerendered so that Figure 22 is not cut off. (See https://github.com/ietf-tools/xml2rfc/pull/788) | | [2] https://www.rfc-editor.org/materials/pdfs_converted_2020-04-17.txt\\ |
| | RFC 9019 | PDF | YYYY-MM-DD | PDF rerendered so that Figures 2 and 3 are not cut off. (See https://github.com/ietf-tools/xml2rfc/pull/788) | | [3] https://www.rfc-editor.org/format-live/ |
