ietf-tools / ietf-tools/xml2rfc

better page breaking in PDF file from old prepped input

Open
#950 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement pdf
Dominant language
HTML
Stars
124
Forks
79
Avg merge
6h 30m
Merged PRs (30d)
3

Description

Description

There are 6 extraneous page breaks within the Table of Contents, as compared with the PDF file generated by xml2rfc 2.41.0 (https://www.rfc-editor.org/rfc/rfc8743.pdf).

Seems the many instances of keepWithNext="true" inserted by the preptool yield the extra page breaks -- 159 instances of keepWithNext in the input file. Perhaps xml2rfc could yield better page breaks despite the extraneous keepWithNexts.

Code of Conduct

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the RFC 8743 XML input and compare the xml2rfc 3.15.3 output test8743.pdf with the older RFC 8743 PDF from xml2rfc 2.41.0. Investigate how the 159 keepWithNext="true" instances affect the Table of Contents page breaks. Done means the generated PDF avoids the six extraneous breaks while preserving correct pagination.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.