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

[suggestion] catch invalid XML in listings #635

Open
line-o opened this issue Jun 10, 2021 · 1 comment
Open

[suggestion] catch invalid XML in listings #635

line-o opened this issue Jun 10, 2021 · 1 comment

Comments

@line-o
Copy link
Member

line-o commented Jun 10, 2021

Is your feature request related to a problem? Please describe.

As #549 shows it is possible to introduce listing data containing invalid XML.
This will then lead to this listing not being stored on installation in existdb leading to inconsistent documentation.

Describe the solution you'd like

I would like to have a check in place that will warn the editor that a listing is not valid XML.

Describe alternatives you've considered

Alternatively it could be done in a pre-commit hook that will not allow adding invalid XML to version control.

Additional context

This is what a user sees when installing a documentation with invalid XML.

Screenshot 2021-06-10 at 00 20 29

@duncdrum
Copy link
Contributor

As per the Author guidelines, listing.xml should always be well-formed, otherwise xml should be stored as listing.txt. Not well-formed xml fragments as listings can improve article quality by removing clutter, and getting straight to the point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants