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

Processing instructions get treated like elements in idnitsv3 #33

Open
paulehoffman opened this issue Mar 21, 2024 · 5 comments
Open

Processing instructions get treated like elements in idnitsv3 #33

paulehoffman opened this issue Mar 21, 2024 · 5 comments
Labels
bug Something isn't working component: idnits3

Comments

@paulehoffman
Copy link

The current version of kramdown-rfc adds procoessing instructions similar to the following to the XML output:

<?line 57?>

idnits currently flags these with INVALID_ABSTRACT_SECTION_CHILD and INVALID_INTRODUCTION_SECTION_CHILD.

@rjsparks
Copy link
Member

To help clarify:

Are you looking at idnits3 or idnits2? (You must be looking at idnits3 if it's inspecting the xml)?

idnits3 expects v3, not the hybrid v2/v3 that kramdown-rfc currently produces. kramdown-rfc would need to be run through --v2v3 before it would make sense to feed it to idnits3.

@paulehoffman
Copy link
Author

v3, definitely. (Sorry for not being specific; I'm looking at v3 now.)

I will change to using --v2v3, but think the report might still stand: processing instructions are generic to all XML, not just what is produced by kramdown.

@paulehoffman
Copy link
Author

Post-processing with xml2rfc --v2v3 still produces XML with the same processing instructions.

@rjsparks
Copy link
Member

Perhaps we warn that PIs are present but otherwise ignore them?

@paulehoffman
Copy link
Author

That is OK, or not even "warn" that they are present because they will be harmless to xlm2rfc. (That's assuming that xml2rfc ignores them when creating publication versions.)

@paulehoffman paulehoffman changed the title Processing instructions get treated like elements Processing instructions get treated like elements in v3 Mar 22, 2024
@paulehoffman paulehoffman changed the title Processing instructions get treated like elements in v3 Processing instructions get treated like elements in idnitsv3 Mar 22, 2024
@NGPixel NGPixel added component: idnits3 bug Something isn't working labels Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working component: idnits3
Projects
None yet
Development

No branches or pull requests

3 participants