Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

missing number in text output of <ol> #1135

Open
1 task done
mchurch-rpc opened this issue Jul 5, 2024 · 4 comments · May be fixed by #1137
Open
1 task done

missing number in text output of <ol> #1135

mchurch-rpc opened this issue Jul 5, 2024 · 4 comments · May be fixed by #1137
Labels
bug Something isn't working rfc waiting An RFC-to-be is in the "Tools Issue" state and cannot be published until the issue is resolved text Issues in text output

Comments

@mchurch-rpc
Copy link

mchurch-rpc commented Jul 5, 2024

Describe the issue

In Section 4.6 of RFC-to-be-9599, the <ol> tag contains two <li> tags, but the "2" for the second <li> tag does not appear in the text output.

Input:
input

Desired output:
desired output
(which is how it looks in the HTML and PDF outputs)

Actual output (not desired):
actual output (not desired)

Various workarounds have been tried by the author and the RPC without success.

Code of Conduct

@mchurch-rpc mchurch-rpc added the bug Something isn't working label Jul 5, 2024
@kesara kesara added the rfc waiting An RFC-to-be is in the "Tools Issue" state and cannot be published until the issue is resolved label Jul 9, 2024
@kesara
Copy link
Member

kesara commented Jul 9, 2024

HTML on Safari (both macOS and iOS) is not looking good either:
Screenshot 2024-07-09 at 13 30 39

Renders correctly on Firefox and Google Chrome.
EDIT: Created #1136 for this issue.

@kesara kesara added the text Issues in text output label Jul 9, 2024
@kesara
Copy link
Member

kesara commented Jul 9, 2024

@mchurch-rpc, As a workaround text content inside <li> can be encapsulated with a <t> tag.
For example:

<ol spacing="normal" type="1">
  <li anchor="ecnencap_reframing_goal_presence">approximate
    preservation of the presence (and therefore timing) of congestion
    marks on the L2 frames used to construct an IP packet;
  </li>
  <li anchor="ecnencap_reframing_goal_proportion">
    <ol spacing="normal" type="a">
      <li>
        <t>at high frequency of congestion marking, approximate
          preservation of the proportion of congestion marks arriving
          and departing;
        </t>
      </li>
      <li>
        <t>at low frequency of congestion marking, approximate
          preservation of the timing of congestion marks arriving and
          departing.
        </t>
      </li>
    </ol>
  </li>
</ol>

@kesara
Copy link
Member

kesara commented Jul 9, 2024

Another option is to use type="%p%c" in inner <ol>1.

Example:

<ol spacing="normal" type="1">
  <li anchor="ecnencap_reframing_goal_presence">
    approximate preservation of the presence (and therefore timing) of congestion marks on the L2 frames used to construct an IP packet;
  </li>
  <li anchor="ecnencap_reframing_goal_proportion">
    <ol spacing="normal" type="%p%c">
      <li>
        at high frequency of congestion marking, approximate preservation of the proportion of congestion marks arriving and departing;
      </li>
      <li>
        at low frequency of congestion marking, approximate preservation of the timing of congestion marks arriving and departing.
      </li>
    </ol>
  </li>
</ol>

Output:

   1.  approximate preservation of the presence (and therefore timing)
       of congestion marks on the L2 frames used to construct an IP
       packet;

       2.a  at high frequency of congestion marking, approximate
            preservation of the proportion of congestion marks arriving
            and departing;

       2.b  at low frequency of congestion marking, approximate
            preservation of the timing of congestion marks arriving and
            departing.

Footnotes

  1. https://ietf-tools.github.io/xml2rfc/#name-type-attribute-2

kesara added a commit to kesara/xml2rfc that referenced this issue Jul 9, 2024
kesara added a commit to kesara/xml2rfc that referenced this issue Jul 9, 2024
@kesara kesara linked a pull request Jul 9, 2024 that will close this issue
@kesara
Copy link
Member

kesara commented Jul 9, 2024

Another example of this bug is

      <ol spacing="normal" type="A">
        <li>
          <ol spacing="normal" type="I">
            <li>
              Item A_I
            </li>
            <li>
              Item A_II
            </li>
          </ol>
        </li>
        <li>
          <t>Item B</t>
        </li>
      </ol>

generates:

       I.   Item A_I

       II.  Item A_II

   B.  Item B

@kesara kesara mentioned this issue Jul 10, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working rfc waiting An RFC-to-be is in the "Tools Issue" state and cannot be published until the issue is resolved text Issues in text output
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants