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.

Sign up for GitHub

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

Editorial: Move some members to App Information Note #900

Merged
merged 29 commits into from
Jul 15, 2020
Merged

Editorial: Move some members to App Information Note #900

Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
cea40f0
Adding first pass app information note
aarongustafson Jun 10, 2020
0580dc5
removing categories, description, screenshots, and iarc_rating
aarongustafson Jun 10, 2020
4a1db97
Migrating processing steps
aarongustafson Jun 10, 2020
571153e
tidy
aarongustafson Jun 10, 2020
5a49e30
typo & acknowledgements
aarongustafson Jun 12, 2020
8afc563
Update app-information.html
aarongustafson Jun 12, 2020
223be05
Update app-information.html
aarongustafson Jun 12, 2020
d6830ea
Update app-information.html
aarongustafson Jun 12, 2020
1ca0687
Update app-information.html
aarongustafson Jun 12, 2020
8be594b
Update app-information.html
aarongustafson Jun 12, 2020
cdd6315
Update app-information.html
aarongustafson Jun 12, 2020
55a2e29
Recommended changes
aarongustafson Jun 12, 2020
0351d14
Merge branch 'app-information-note' of github.com:aarongustafson/mani…
aarongustafson Jun 12, 2020
414a4ad
Removing the date
aarongustafson Jun 12, 2020
5d1311a
Change the section reference
aarongustafson Jun 12, 2020
5b68216
Merge branch 'app-information-note' of github.com:aarongustafson/mani…
aarongustafson Jun 12, 2020
1976650
tidy
aarongustafson Jun 12, 2020
c35408d
Removed the intro example
aarongustafson Jun 12, 2020
352b9e9
USVString -> DOMString
aarongustafson Jun 12, 2020
f1a7674
Properly accenting Marcos’ name
aarongustafson Jun 12, 2020
609b7a4
Moved app-info into it’s own repo
aarongustafson Jul 10, 2020
254ac28
typo
aarongustafson Jul 10, 2020
846aa8c
Typo
aarongustafson Jul 10, 2020
a4f31dc
Merge branch 'gh-pages' into app-information-note
aarongustafson Jul 10, 2020
fad555e
Merge branch 'gh-pages' into app-information-note
aarongustafson Jul 14, 2020
beb2e9f
Merge branch 'gh-pages' into app-information-note
aarongustafson Jul 15, 2020
923b38d
Chore: Added note about migrating categories, description, IARC ratin…
aarongustafson Jul 15, 2020
06db21f
Merge branch 'app-information-note' of github.com:aarongustafson/mani…
aarongustafson Jul 15, 2020
875fa1c
Merge branch 'gh-pages' into app-information-note
Jul 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
249 changes: 249 additions & 0 deletions app-information.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>
Web App Manifest - Application Information
</title>
<script src="https://www.w3.org/Tools/respec/respec-w3c" class=
"remove"></script>
<script class='remove'>
var respecConfig = {
mdn: true,
marcoscaceres marked this conversation as resolved.
Show resolved Hide resolved
specStatus: "ED",
noRecTrack: true,
shortName: "appmanifest-appinfo",
prevVersion: "",
previousMaturity: "",
formerEditors: [
{
name: "Rob Dolin",
company: "Microsoft Corporation",
companyURL: "https://www.microsoft.com/en-us/",
},
],
editors: [
{
name: "Aaron Gustafson",
company: "Microsoft Corporation",
companyURL: "https://microsoft.com/",
w3cid: 43672,
},
],
wg: "Web Applications Working Group",
wgURI: "https://www.w3.org/2019/webapps/",
wgPatentURI: "https://www.w3.org/2004/01/pp-impl/114929/status",
github: "https://github.com/w3c/manifest/",
xref: "web-platform",
};
</script>
</head>
<body>
<section id='abstract'>
<p>
This specification defines supplementary members of the Web App
Manifest that provide additional metadata related to how the web
application may be presented in the context of a digital storefront,
installation dialog, or other surfaces where this web application may
be marketed or distributed.
</p>
</section>
<section>
<h2>
Marketable web applications
</h2>
<p>
As web applications become available via more services (e.g., digital
storefronts, search results) where they are presented alongside native
applications, it becomes quite important for them to appear similarly
to their native counterparts. A web application can define both its
{{WebAppManifest/name}} and {{WebAppManifest/icons}} in the manifest,
but those keys do not provide enough information to help users
determine whether they might want to install it. Users have become
accustomed to being offered more details about the applications they
consider installing, and this document defines additional manifest
members that can provide that.
</p>
</section>
<section id="processing">
<h3>
Extension to processing the manifest
</h3>
<p>
The following steps for <dfn>processing application info in a
manifest</dfn> are run during the extension point in [=processing the
manifest=].
</p>
<ol>
<li>Set <var>manifest</var>["<a>categories</a>"] to the result of
running <a>processing the <code>categories</code> member</a> given
<var>manifest</var>["<a>categories</a>"].
</li>
<li>Set <var>manifest</var>["<a>screenshots</a>"] to the result of
running <a>processing `ManifestImageResource` members</a> given
<var>manifest</var>["<a>screenshots</a>"] and <var>manifest URL</var>.
</li>
</ol>
<p class="issue">
The {{WebAppManifestAppInfo/description}} and
{{WebAppManifestAppInfo/iarc_rating_id}} would be set when converting
the manifest JSON to a WebAppManifest dictionary.
</p>
</section>
<section data-dfn-for="WebAppManifestAppInfo" data-link-for=
"WebAppManifestAppInfo">
<h2>
<dfn data-dfn-for="">WebAppManifest</dfn> dictionary
</h2>
<pre class="idl">
aarongustafson marked this conversation as resolved.
Show resolved Hide resolved
partial dictionary WebAppManifest {
sequence&lt;DOMString&gt; categories;
DOMString description;
DOMString iarc_rating_id;
sequence&lt;ManifestImageResource&gt; screenshots;
aarongustafson marked this conversation as resolved.
Show resolved Hide resolved
};
</pre>
<section>
<h3>
<code title="">categories</code> member
</h3>
<p>
The <dfn>categories</dfn> member describes the expected application
categories to which the web application belongs.
</p>
<p>
The <a>categories</a> member is only meant as a hint to catalogs or
stores listing web applications and it is expected that these will
make a best effort to find appropriate categories (or category) under
which to list the web application. Like search engines and meta
keywords, catalogs and stores are not required to honor this hint.
</p>
<p>
The steps for <dfn>processing the <code>categories</code>
member</dfn> are given by the following algorithm. The algorithm
takes a sequence&lt;<a>DOMString</a>&gt; <var>categories</var> as an
argument. This algorithm returns an
<code>Array&lt;DOMString&gt;</code>.
</p>
<ol>
<li>[=list/For each=] <var>category</var> of <var>categories</var>:
<ol>
<li>[=set/Replace=] <var>category</var> within
<var>categories</var> with <var>category</var>, <a>ascii
lowercased</a>.
</li>
</ol>
</li>
<li>Return <var>categories</var>.
</li>
</ol>
<p>
The categories <a>string</a> array is case insensitive and converted
to lower-case by following the processing algorithm. Thus,
<code>sports</code>, <code>Sports</code>, <code>SPORTS</code>, and
<code>SpOrTs</code> are all equivalent.
</p>
<p class="note">
Manifest authors are encouraged to use lower-case.
</p>
<p class="note">
This specification does not define the particular values for
<dfn>DOMString</dfn>s for the <a>categories</a> member. However, the
working group maintains a <a href=
"https://github.com/w3c/manifest/wiki/Categories">list of known
values</a> in our wiki.
</p>
</section>
<section>
<h3>
<code title="">description</code> member
</h3>
<p>
The <dfn>description</dfn> member allows the developer to describe
the purpose of the web application.
</p>
</section>
<section>
<h3>
<code title="">iarc_rating_id</code> member
</h3>
<p>
The <dfn>iarc_rating_id</dfn> member is a <a>string</a> that
represents the <a href="https://www.globalratings.com/">International
Age Rating Coalition (IARC)</a> certification code of the web
application. It is intended to be used to determine which ages the
web application is appropriate for.
</p>
<p class="note">
An IARC certificate can be obtained via participating storefronts,
intended to be used for distributing the web app. The
<a>iarc_rating_id</a> member only takes a single certification code.
The same code can be shared across participating storefronts, as long
as the distributed product remains the same (i.e., doesn’t serve
totally different code paths depending on user agent sniffing and the
like) and the other storefronts support it.
</p>
<div class="informative">
<p>
The following shows a very simple <a>manifest</a> with the
<code>iarc_rating_id</code> member.
</p>
<pre class="example json" title="very simple manifest">
{
"name": "Donate App",
"description": "This app helps you donate to worthy causes.",
"iarc_rating_id": "e84b072d-71b3-4d3e-86ae-31a8ce4e53b7",
"icons": [{
"src": "images/icon.png",
"sizes": "192x192"
}]
}
</pre>
</div>
<p>
More information on the IARC can be found at: <a href=
"https://www.globalratings.com/how-iarc-works.aspx">How IARC
Works</a> and <a href=
"https://www.globalratings.com/for-developers.aspx">How developers
can get their games and apps rated with IARC</a>.
</p>
</section>
<section>
<h3>
<code title="">screenshots</code> member
</h3>
<p>
The <dfn>screenshots</dfn> member is an <a>array</a> of
{{ManifestImageResource}}s, representing the web application in
common usage scenarios.
</p>
<p>
For accessibility purposes, authors MUST provide a
{{ImageResource/label}} for each screenshot.
</p>
</section>
</section>
<section class="appendix">
<h2>
Acknowledgements
aarongustafson marked this conversation as resolved.
Show resolved Hide resolved
</h2>
<p>
Rob Dolin for spearheading a lot of this work and Marcos Càceres and
Kenneth Rohde Christiansen for helping to vet these ideas.
</p>
</section>
<section id="internationalization" class="appendix informative">
<h2>
Internationalization
</h2>
<p>
It is expected that authors will localize the content of all text
strings defined in this document based on <a data-cite=
"MANIFEST#internationalization">the approach(es) outlined in the
Manifest spec</a>.
</p>
</section>
<section id="issue-summary"></section>
<section id="index"></section>
</body>
</html>
Loading