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

Unclear character set constraints and non-UTF-8 html #386

Open
himorin opened this issue Apr 7, 2023 · 0 comments
Open

Unclear character set constraints and non-UTF-8 html #386

himorin opened this issue Apr 7, 2023 · 0 comments
Labels
i18n-needs-resolution Issue the Internationalization Group has raised and looks for a response on. Profile-1.0

Comments

@himorin
Copy link

himorin commented Apr 7, 2023

Section 6. Links is not clear and unorganized on several points:

  1. Link relation type is strongly connected with media types as constraints, but these mime types have additional constraints to these, which results in scattered descriptions and writings of specification.
  2. Constraint for service-doc link relation type is written as

human readable documentation, supported formats are Unicode Text, markdown, HTML and PDF.

but wording Unicode is not clear. Considering restrictions placed at mime types, it should be clearly stated with UTF-8 is mandatory over all applicable types.
3. hreflang is marked as optional, but should be mandatory for text/plain, text/markdown, and possibly on text/html.

We would propose to rewrite this section into one table for clarification and ease for noticing all of constraints with reorganizing all of attached text for description totally, something like:

Relation-Type Supported Media Types Constraints Remarks
icon image/png, image/jpeg
service-doc text/plain, text/html, text/markdown, text/pdf Linked files MUST use the UTF-8 character encoding. hreflang is mandatory for text/plain and text/markdown Human readable documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
i18n-needs-resolution Issue the Internationalization Group has raised and looks for a response on. Profile-1.0
Projects
None yet
Development

No branches or pull requests

2 participants