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

Document and complement XInclude failures as warnings on translations #196

Merged
merged 2 commits into from
Dec 5, 2024

Conversation

alfsb
Copy link
Member

@alfsb alfsb commented Dec 3, 2024

This PR better document how XInclude failures are treated on translations. It only cares for <xi:include> without <xi:failback>, so it leaves open <xi:failback> usage for other situations.

In fact, I tested this on all languages with doc-en stripped of <xi:failback>.

As an recommendation, I suggest mass removing all mentions of <xi:failback> on doc-en, down to XML comments, after 8.4 doc changes calms down, and possibly further creating an github action/trigger that recuses usage of <xi:failback>, linking this trigger to mention XInclude failures are soft errors on translations. on configure.php. The reason being that failed XInclude leaves different artifacts in the presence and absence of <xi:failback>. Caring for both is very confusing.

@alfsb
Copy link
Member Author

alfsb commented Dec 3, 2024

I would like comments to making code comments and messages into idiomatic English (not my first language).

Also, I was thinking in placing some default message in the patched up nodes, something like %xinclude fail%, that is something small but visible, to indicate patched up nodes into rendered manual. The actual implementation creates empty tags, that may be more confusing that an small error message.

Copy link
Member

@Girgias Girgias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MSTM.

@alfsb
Copy link
Member Author

alfsb commented Dec 4, 2024

Changed the texts a little, I plan to merge this tomorrow.

@alfsb alfsb merged commit dfcbb86 into php:master Dec 5, 2024
11 of 12 checks passed
@alfsb
Copy link
Member Author

alfsb commented Dec 5, 2024

Merged. I expect no breakages, but let me know if are any problems. This enable removing empty <xi:fallback> on all languages, as they are now, and allows for <xi:fallback> be used for other cases.

@alfsb alfsb deleted the xinclude-failures branch December 5, 2024 11:48
@Girgias Girgias mentioned this pull request Dec 5, 2024
32 tasks
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

Successfully merging this pull request may close these issues.

2 participants