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

Initial draft of 'developing localizable manifests' #302

Merged
merged 11 commits into from
Jul 12, 2021

Conversation

aphillips
Copy link
Contributor

[I18N-ACTION-1033]

@aphillips aphillips requested review from xfq and r12a June 7, 2021 20:56
<script class="remove">
var respecConfig = {
specStatus: "ED",
edDraftURI: "https://w3c.github.io/i18n-drafts/techniques/developing-localizable-manifests.en.html",
Copy link
Member

Choose a reason for hiding this comment

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

Will this be an article or a document on /TR (like string-meta and specdev)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a good question. I used Respec with the idea that it would probably become a note, but I used the i18n-drafts repo instead of creating a new, separate, repo. The other "techniques" documents are actually indexes, so this doesn't really fit as well as I thought it might.

Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't belong in the drafts/techniques directory, for sure. It should probably have its own repo, so that we can publish it as a Note in the future.


<p>Some examples of specifications like this include Webapp [[APPMANIFEST]], Miniapp [[MINIAPP-MANIFEST]], and ePub [[EPUB-33]].</p>

<p>Manifest files generally contain a mix of <a href="https://w3c.github.io/i18n-glossary/#def_localizable_content">localizable content</a> and <a href="https://w3c.github.io/i18n-glossary/#def_syntactic_content">syntactic</a> or <a href="https://w3c.github.io/i18n-glossary/#def_user_supplied_value">user-supplied values</a> that are not localizable. A specification that defines such a format needs to provide a means for users to localize the manifest into different languages. This document covers the pros and cons of common designs, along with some best practices related to building and managing manifests.</p>
Copy link
Member

Choose a reason for hiding this comment

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

Would it be better to change "Manifest files generally" to something like "Some manifest files"?

For example, it seems that there is no human-readable text in Payment Method Manifest or the origin policy manifest.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good callout. See what you think of the updated text.

@xfq
Copy link
Member

xfq commented Jun 8, 2021

Do we want to add some examples of hybrid approaches?

FYI - this proposal for MiniApps Manifest looks like one such example: https://pr-preview.s3.amazonaws.com/MichaelWangzitao/miniapp-manifest/pull/12.html#i18n-solution-i18n

- Added a hybrid example
- Changed wording about mixed localizable/non-localizable content
- Added temporary reference to i18n-glossary
- Fixed small typos (missing commas in examples, a few stray quotes from
  pasting from Word)
@xfq
Copy link
Member

xfq commented Jun 9, 2021

BTW, we can use <pre class="json"> to syntax highlight the content inside pre elements.

@aphillips aphillips merged commit 94b9db5 into w3c:gh-pages Jul 12, 2021
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.

None yet

3 participants