RFC 7995
RFC 7995
RFC 7995
Abstract
Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved.
Table of Contents
1. Introduction ....................................................3
2. Choosing PDF Versions and Standards .............................3
3. Options and Requirements for PDF RFCs ...........................4
3.1. "Visible" Requirements .....................................5
3.1.1. General Visible Requirements ........................5
3.1.2. Page Size and Margins ...............................5
3.1.3. Headers and Footers .................................5
3.1.4. Paragraph Numbering .................................6
3.1.5. Paged Content Layout ................................6
3.1.6. Typeface Choices ....................................7
3.1.7. Hyphenation and Line Breaks .........................8
3.1.8. Hyperlinks ..........................................8
3.1.9. Similarity to Other Outputs .........................9
3.2. "Invisible" Options and Requirements ......................10
3.2.1. Internal Text Representation .......................10
3.2.2. Unicode Support ....................................11
3.2.3. Image Processing (Artwork) .........................12
3.2.4. Text Description of Images (Alt-Text) ..............12
3.2.5. Metadata Support ...................................12
3.2.6. Document Structure Support .........................13
3.2.7. Embedded Files .....................................13
3.3. Digital Signatures ........................................14
4. Security Considerations ........................................15
5. References .....................................................16
5.1. Normative References ......................................16
5.2. Informative References ....................................17
Appendix A. History and Current Use of PDF with RFCs and
Internet-Drafts .......................................18
A.1. RFCs .......................................................18
A.2. Internet-Drafts ............................................18
Appendix B. Paged Content Layout Quality ..........................18
Appendix C. Tooling ...............................................19
C.1. PDF Viewers ................................................19
C.2. Printers ...................................................19
C.3. PDF Generation Libraries ...................................20
C.4. Typefaces ..................................................20
C.5. Other Tools ................................................20
IAB Members at the Time of Approval ...............................21
Acknowledgements ..................................................21
Authors’ Addresses ................................................22
1. Introduction
The PDF format and the tools to manipulate it are not as well known
as those for the other RFC formats, at least in the IETF community.
This document discusses some of the processes for creating and using
PDFs using both open source and commercial products.
PDF [PDF] has gone through several revisions, primarily for the
addition of features. PDF features have generally been added in a
way that older viewers "fail gracefully", but even so, the older the
PDF version produced, the more legacy viewers will support that
version but the fewer features will be enabled.
Recommendations:
This section lays out options and requirements for PDFs produced by
the RFC Editor for RFCs. There are two subsections: Section 3.1
covers "visible" requirements related to how the PDF normally appears
when it is viewed with a PDF viewer; Section 3.2 covers "invisible"
options and requirements, which primarily affect the ability to
process PDFs in other ways but do not ordinarily control the way the
document appears. (Of course, a viewer UI might display processing
capabilities, such as showing whether a document has been digitally
signed.)
For a consistent "look" of RFCs and good style, the PDFs produced by
the RFC Editor should have a clear, consistent, identifiable, and
easy-to-read style. They should print well on the widest range of
printers and should look good on displays of varying resolution.
PDF files are laid out for a particular size of page and margins.
There are two paper sizes in common use: "US Letter" (8.5x11 inches,
216x279 mm, in popular use in North America) and "A4" (210x297 mm,
8.27x11.7 inches, standard for the rest of the world). Usually, PDF
printing software is used in a "shrink to fit" mode where the
printing is adjusted to fit the paper in the printer. There is some
controversy, but the argument that A4 is an international standard is
compelling. However, if the margins and header positioning are
chosen appropriately, the document can be printed without any
scaling.
Page headers and footers are part of the page layout. There are a
variety of options. Note that page headers and footers in PDF can be
typeset in a way that the entire (longer) title might fit.
Recommendations:
Recommendations:
3.1.8. Hyperlinks
Recommendations:
There is some advantage to having the PDF files look like the text or
HTML renderings of the same document. Even so, there are several
options. The PDF
2. could look like the text version of the document but with
pictures rendered as pictures instead of using their ASCII art
equivalent, or
Most of the choices used for the renderings per [RFC7992] and
[RFC7993] are thus applicable. See those documents for specifics on
the rendering of the specific XML elements. Some notes:
o The running header in one line (on page 2 and all subsequent
pages) has the RFC number on the left (RFC NNNN), the (possibly
shortened form) title centered, and the date (Month Year) on the
right. The text is rendered in a way that is visually
unobtrusive.
o The running footer in one line (on all pages) has the author’s
last name on the left, category centered, and the page number on
the right ([Page N]). The text is rendered in a way that is
visually unobtrusive.
PDF offers a number of features that improve the utility of PDF files
in a variety of workflows, at the cost of extra effort in the xml2rfc
conversion process; the trade-offs may be different for the
RFC Editor production of RFCs and for Internet-Drafts.
The contents of a PDF file can be represented in many ways. The PDF
file could be generated:
Recommendations:
PDF itself does not require the use of Unicode. Text is represented
as a sequence of glyphs that can then be mapped to Unicode.
Recommendations:
o PDF files generated must have the full text, as it appears in the
original XML.
o Text within SVG for SVG images should also have Unicode mappings.
The XML allows both ASCII art and SVG to be used for artwork.
Recommendations:
o If both ASCII art and SVG are available for a picture, the SVG
artwork should be preferred over the ASCII artwork.
The section structure of an RFC can be mapped into the PDF elements
for the document structure. This will allow the bookmark feature of
PDF readers to be used to quickly access sections of the document.
PDF has the capability of including other files; the files may be
labeled by both a media type and a role, the AFRelationship key
[PDFA3]. In this way, the PDF file also acts as a container.
Many PDF viewers support the ability to view and extract embedded
files, although this capability is not universal.
Embedding content in the PDF file allows the PDF to act as a complete
package that can be transformed, archived, and digitally signed.
(Some sample code illustrating how items can be attached to a PDF
file and subsequently extracted can be found at
<https://github.com/Aiybe/xmptest>.) Useful possibilities:
o Embed the source XML input file itself within the PDF. If the
source SVG and images for illustrations are also embedded, this
would make the PDF file totally self-referential.
Recommendations:
The RFC Editor and staff are at times called to provide evidence that
a particular RFC is the "original" and has not been modified; digital
signatures can provide that verification. As signatures also apply
to embedded content, embedding the XML source will provide a way of
signing the source XML that was used to produce the PDF file as well.
PDF has supported digital signatures since PDF 1.2, and there are
multiple methods and options available for signing PDF files. The
method chosen for the signing of Internet-Drafts and RFCs will be
determined by separate policy.
4. Security Considerations
Threats:
Mitigations:
5. References
[RFC3778] Taft, E., Pravetz, J., Zilles, S., and L. Masinter, "The
application/pdf Media Type", RFC 3778,
DOI 10.17487/RFC3778, May 2004,
<http://www.rfc-editor.org/info/rfc3778>.
[APP-PDF] Hardy, M., Masinter, L., Markovic, D., Johnson, D., and M.
Bailey, "The application/pdf Media Type", Work in
Progress, draft-hardy-pdf-mime-04, September 2016.
A.1. RFCs
The RFC Series has for a long time accepted Postscript renderings of
RFCs, either in addition to or instead of the text renderings of
those same RFCs. These have usually been produced when there was a
complicated figure or mathematics within the document. For example,
consider the figures and mathematics found in RFCs 1119 and 1142, and
compare the figures found in the text version of RFC 3550 with those
in the Postscript version. The RFC Editor has provided a PDF
rendering of RFCs. Usually, this has been a print of the text file
that does not take advantage of any of the broader PDF functionality,
unless there was a Postscript version of the RFC, which would then be
used by the RFC Editor to generate the PDF.
A.2. Internet-Drafts
Headers for Long Tables after Page Breaks: Another common option in
producing paginated documents is to include the column headings of
a table if the table cannot be displayed on a single page.
Similarly, tables should not be split from the table titles.
Appendix C. Tooling
As with most file formats, PDF files are experienced through a reader
or viewer of PDF files. For most of the common platforms in use
(iOS, OS X, Windows, Android, ChromeOS, Kindle) and for most browsers
(Edge, Safari, Chrome, Firefox), PDF viewing is built in. In
addition there are many PDF viewers available for download and
installation.
C.2. Printers
While almost all viewers also support the printing of PDF files,
printing is one of the most important use cases for PDFs. Some
printers have direct PDF support.
C.4. Typefaces
Another font that looks promising for its broad Unicode support is
Skolar <https://www.rosettatype.com/Skolar>, but it requires
licensing.
The IAB members at the time this memo was approved were
(in alphabetical order):
Jari Arkko
Ralph Droms
Ted Hardie
Joe Hildebrand
Russ Housley
Lee Howard
Erik Nordmark
Robert Sparks
Andrew Sullivan
Dave Thaler
Martin Thomson
Brian Trammell
Suzanne Woolf
Acknowledgements
Authors’ Addresses
Email: tony@att.com
Larry Masinter
Adobe
345 Park Ave.
San Jose, CA 95110
United States of America
Email: masinter@adobe.com
URI: http://larrymasinter.net
Matthew Hardy
Adobe
345 Park Ave.
San Jose, CA 95110
United States of America
Email: mahardy@adobe.com