Loosen HTML check in community guideline

[nijel]

We just encountered this problem translating sources for gettext po files. safe-html is flagged on the community localization checklist with a big orange warning symbol. The documentation doesn't say anything about it gratuitously inserting HTML entities into strings that aren't HTML and where they don't belong.

The warning should be removed from the community localization checklist and the documentation for the tag should have a warning that it should be used only for projects in which all translatable strings are HTML or XML.

Originally posted by @jralls in #6490 (comment)

[github-actions]

This issue seems to be a good fit for newbie contributors. You are welcome to contribute to Weblate! Don't hesitate to ask any questions you would have while implementing this.

You can learn about how to get started in our contributors documentation.

[kunjshukla]

hey, I would like to contribute to this issue. Please assign this to me.

[nijel]

@kunjshukla I've just assigned this to you.

This is the current implementation:

weblate/weblate/trans/guide.py

Lines 206 to 234 in b5ca320

	@register
	class SafeHTMLGuideline(Guideline):
	description = gettext_lazy(
	"Add safe-html flag to avoid dangerous HTML from translators."
	)
	url = "settings"
	anchor = "translation"
	def is_relevant(self):
	cache_key = f"guide:safe-html:{self.component.id}"
	result = cache.get(cache_key)
	if result is not None:
	return result
	result = self.component.source_translation.unit_set.filter(
	source__contains="<a "
	).exists()
	cache.set(cache_key, result, 86400)
	return result
	def is_passing(self):
	return (
	"safe-html" in self.component.check_flags
	or self.component.source_translation.unit_set.filter(
	extra_flags__contains="safe-html"
	).exists()
	)
	def get_doc_url(self, user=None):
	return get_doc_url("user/checks", "check-safe-html", user=user)

[juhjuhjuhgian]

Hey @nijel I'm new to open source so I have to ask: if this (or any other issue) has been assigned, does this mean it's off limits to work on by other devs? Having trouble finding one to work on as they're all "spoken for."

Thanks!

[nijel]

@juhjuhjuhgian It is usually a good idea to not waste effort and pick another issue. I think there is enough of unassigned issues in good first issue Opportunity for newcoming contributors.

[github-actions]

Thank you for your report; the issue you have reported has just been fixed.

• In case you see a problem with the fix, please comment on this issue.
• In case you see a similar problem, please open a separate issue.
• If you are happy with the outcome, don’t hesitate to support Weblate by making a donation.