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

Languages of service-doc? #1412

Closed
aphillips opened this issue Mar 1, 2022 · 5 comments
Closed

Languages of service-doc? #1412

aphillips opened this issue Mar 1, 2022 · 5 comments
Assignees
Labels
i18n-needs-resolution Issue the Internationalization Group has raised and looks for a response on. PR available V1.1 should be resolved in v1.1

Comments

@aphillips
Copy link

Example 27
https://w3c.github.io/wot-thing-description/#example-link-to-developer-documentation

To point to a developer documentation of a Thing the value service-doc can be used:

"links": [{
    "rel": "service-doc",
    "href": "https://example.com/howTo",
    "type": "application/pdf"
}]

The example shows how to link to service documentation. Perhaps this should include an affordance for indicating the language(s) of the documentation and/or ways to indicate different language versions of the documentation?

@aphillips aphillips added the i18n-needs-resolution Issue the Internationalization Group has raised and looks for a response on. label Mar 1, 2022
@egekorkan
Copy link
Contributor

egekorkan commented Mar 2, 2022

That is a valid concern, generally devices come with:

  1. A single pdf (or other document formats) with multiple languages: This would be a single link with an array of languages
  2. Different pdf for different languages: This would be an array of links with a language tag for each
  3. Multiple pdfs with each containing multiple languages: Combination of the two above

@egekorkan
Copy link
Contributor

Call of 02.03.2022:

  • We would need an annotation that can be a single string or an array. There is an HTML attribute that can provide this

@sebastiankb
Copy link
Contributor

sebastiankb commented Mar 9, 2022

From today's TD call:
we should evaluate the following aspects:

  • we should check if the web linking (rfc8288) already provides such a hint in links definition
  • how html is handle this if links points to a pdf documents as example (it seems that there is tag about this, i.e hreflang="lang_code")
  • how is the relation of the underlying protocol like HTTP (language negation)

@sebastiankb sebastiankb added the Needs discussion more discussion is needed before getting to a solution label Mar 9, 2022
@aphillips
Copy link
Author

@sebastiankb

The HTML attribute is hreflang and can be used on link and a elements in HTML. You might include an optional field or fields hreflang into the link structure. The hreflang can indicate the language of any target: they don't have to be HTML pages, any old mimetype will do.

RFC8288 supports hreflang. Here's one quote:

The "hreflang" attribute, when present, is a hint indicating what the language of the result of dereferencing the link should be. Note that this is only a hint; for example, it does not override the Content-Language header field of a HTTP response obtained by actually following the link. Multiple hreflang attributes on a single link-value indicate that multiple languages are available from the indicated resource.

The attribute doesn't participate in or affect HTTP; there is no guarantee that the tag is at all accurate. Language negotiation could still take place in addition to/in spite of the attribute.

sebastiankb added a commit that referenced this issue Mar 28, 2022
@sebastiankb sebastiankb assigned sebastiankb and unassigned egekorkan Mar 28, 2022
@sebastiankb sebastiankb removed the Needs discussion more discussion is needed before getting to a solution label Apr 6, 2022
@egekorkan egekorkan added the V1.1 should be resolved in v1.1 label Apr 20, 2022
@egekorkan
Copy link
Contributor

Closing after #1449

@sebastiankb sebastiankb removed the i18n-needs-resolution Issue the Internationalization Group has raised and looks for a response on. label Nov 23, 2022
@w3cbot w3cbot added the i18n-needs-resolution Issue the Internationalization Group has raised and looks for a response on. label Nov 24, 2022
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. PR available V1.1 should be resolved in v1.1
Projects
None yet
Development

No branches or pull requests

4 participants