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.

Sign up for GitHub

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

Jump to bottom

Text is truncated in rowspan table cells in text output #1155

Open
1 task done
ajeanmahoney opened this issue Sep 3, 2024 · 4 comments · May be fixed by #1184
Open
1 task done

Text is truncated in rowspan table cells in text output #1155

ajeanmahoney opened this issue Sep 3, 2024 · 4 comments · May be fixed by #1184
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

@ajeanmahoney
Copy link
Collaborator

Describe the issue

In Table 2 (see the txt file), the text in the first column is cut off:

    +--------------------------------------+--------------------------+
    | Put a DevID or Platform Cert in the  | TCG TPM DevID TCG        |
    | TPM                                  | Platform Certificate     |
    |                                      +--------------------------+
    | *  Install an Initial Attestation    | IEEE 802.1AR             |
    +--------------------------------------+--------------------------+

This issue appears in the text output only. The HTML and PDF are fine.

It should look like the following:

    +--------------------------------------+--------------------------+
    | Put a DevID or Platform Cert in the  | TCG TPM DevID TCG        |
    | TPM                                  | Platform Certificate     |
    |                                      +--------------------------+
    | *  Install an Initial Attestation    | IEEE 802.1AR             |
    |    Key at the same time so that      |                          |
    |    Attestation can work out of the   |                          |
    |    box                               |                          |
    |                                      |                          |
    | *  Equipment suppliers and owners    |                          |
    |    may want to implement Local       |                          |
    |    Device ID as well as Initial      |                          |
    |    Device ID                         |                          |
    +--------------------------------------+--------------------------+

Note that when more text is added to the cells on the right, more text appears (see the "tall-rows" files):

    +--------------------------------------+--------------------------+
    | Put a DevID or Platform Cert in the  | TCG TPM DevID TCG        |
    | TPM                                  | Platform Certificate     |
    |                                      |                          |
    | *  Install an Initial Attestation    | The rowspan seems to     |
    |    Key at the same time so that      | truncate due to the      |
    |    Attestation can work out of the   | height of the cell next  |
    |    box                               | to it                    |
    |                                      |                          |
    | *  Equipment suppliers and owners    | Making a tall row here   |
    |    may want to implement Local       +--------------------------+
    |    Device ID as well as Initial      | IEEE 802.1AR             |
    |    Device ID                         |                          |
    |                                      | Making a tall row here   |
    |                                      |                          |
    |                                      | Making a tall row here   |
    +--------------------------------------+--------------------------+

https://www.rfc-editor.org/v3test/draft-ietf-rats-tpm-based-network-device-attest-14.txt
https://www.rfc-editor.org/v3test/draft-ietf-rats-tpm-based-network-device-attest-14.xml
https://www.rfc-editor.org/v3test/draft-ietf-rats-tpm-based-network-device-attest-14.html#name-implementation-notes
https://www.rfc-editor.org/v3test/draft-ietf-rats-tpm-based-network-device-attest-14.pdf
https://www.rfc-editor.org/v3test/draft-ietf-rats-tpm-based-network-device-attest-14-tall-rows.txt
https://www.rfc-editor.org/v3test/draft-ietf-rats-tpm-based-network-device-attest-14-tall-rows.xml

Code of Conduct
@ajeanmahoney ajeanmahoney added the bug Something isn't working label Sep 3, 2024
@kesara kesara added the text Issues in text output label Sep 4, 2024
@ajeanmahoney ajeanmahoney added the rfc waiting An RFC-to-be is in the "Tools Issue" state and cannot be published until the issue is resolved label Nov 13, 2024
@ajeanmahoney
Copy link
Collaborator Author

RFC 9683-to-be is now in TI state

kesara added a commit to kesara/xml2rfc that referenced this issue Nov 14, 2024
@kesara
fix(text): Fix truncated text issue in cells with rowspan
6bc890a 
Fixes ietf-tools#1155
@kesara kesara linked a pull request Nov 14, 2024 that will close this issue
Open
@kesara
Copy link
Member

kesara commented Nov 15, 2024 •
edited
Loading

The proposed fix in #1184, generates following:

@ajeanmahoney
Copy link
Collaborator Author

While #1184 does fix the main issue of truncated text, the layout looks odd. The lower cells in the tall rows (i.e., containing "IEEE 802.1AR" and "TCG PC Client RIM") don't line up with any text in the cells to the left of them, so they look disconnected:

    +--------------------------------------+--------------------------+
    | Put a DevID or Platform Cert in the  | TCG TPM DevID TCG        |
    | TPM                                  | Platform Certificate     |
    |                                      |                          |
    | *  Install an Initial Attestation    |                          |
    |    Key at the same time so that      |                          |
    |    Attestation can work out of the   |                          |
    |    box                               |                          |
    |                                      |                          |
    | *  Equipment suppliers and owners    |                          |
    |    may want to implement Local       |                          |
    |    Device ID as well as Initial      |                          |
    |    Device ID                         |                          |
    |                                      +--------------------------+
    |                                      | IEEE 802.1AR             |
    +--------------------------------------+--------------------------+

Something like this would look better:

    | *  Equipment suppliers and owners    |                          |
    |    may want to implement Local       |                          |
    |    Device ID as well as Initial      +--------------------------+
    |    Device ID                         | IEEE 802.1AR             |
    +--------------------------------------+--------------------------+

Splitting the right cells more evenly would be even better (it's not an exact split, but it's close):

    +--------------------------------------+--------------------------+
    | Put a DevID or Platform Cert in the  | TCG TPM DevID TCG        |
    | TPM                                  | Platform Certificate     |
    |                                      |                          |
    | *  Install an Initial Attestation    |                          |
    |    Key at the same time so that      |                          |
    |    Attestation can work out of the   |                          |
    |    box                               +--------------------------+ 
    |                                      | IEEE 802.1AR             |
    | *  Equipment suppliers and owners    |                          |
    |    may want to implement Local       |                          |
    |    Device ID as well as Initial      |                          |
    |    Device ID                         |                          |
    +--------------------------------------+--------------------------+

@ajeanmahoney
Copy link
Collaborator Author

After talking with the Tools Team regarding this table layout, it's my understanding that #1184 is the best fix available without having to rewrite xml2rfc's text renderer, so I accept the fix. I've asked the authors if they are okay with how the info is presented. If need be, this particular table could probably be reformatted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(text): Fix truncated text issue in cells with rowspan kesara/xml2rfc
2 participants
@kesara @ajeanmahoney