From 76687681653d703f68f576ec5394dd587bff976b Mon Sep 17 00:00:00 2001 From: Aaron Gustafson Date: Wed, 15 Jul 2020 08:16:24 -0700 Subject: [PATCH 1/3] Editorial: Move some members to App Information Note (#900) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Adding first pass app information note * removing categories, description, screenshots, and iarc_rating * Migrating processing steps * tidy * typo & acknowledgements * Update app-information.html Co-authored-by: Christian Liebel * Update app-information.html Co-authored-by: Marcos Cáceres * Update app-information.html Co-authored-by: Marcos Cáceres * Update app-information.html Co-authored-by: Marcos Cáceres * Update app-information.html Co-authored-by: Marcos Cáceres * Update app-information.html Co-authored-by: Marcos Cáceres * Recommended changes * Removing the date Co-authored-by: Marcos Cáceres * Change the section reference * tidy * Removed the intro example Switched USVString to DOMString * USVString -> DOMString * Properly accenting Marcos’ name * Moved app-info into it’s own repo https://github.com/w3c/manifest-app-info * typo * Typo * Chore: Added note about migrating categories, description, IARC rating, and screenshots to Application Information Co-authored-by: Christian Liebel Co-authored-by: Marcos Cáceres Co-authored-by: Marcos Cáceres --- CONTRIBUTING.md | 3 +- index.html | 164 ++++++++---------------------------------------- 2 files changed, 27 insertions(+), 140 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f30f4f41..da0b98a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,11 +44,12 @@ instructions on running HTML5 tidy, see below. # Running HTML5 Tidy Please make sure you have HTML5 tidy installed, instead of -the the one that ships with *nix systems. You can comfirm this by running: +the the one that ships with *nix systems. You can confirm this by running: ```bash tidy --version #HTML Tidy for HTML5 (experimental) for ... ``` + Once you have confirmed (make sure you have committed your changes before running tidy, as the changes are destructive ... in a good way:)): diff --git a/index.html b/index.html index cd79ef1e..e28cb104 100644 --- a/index.html +++ b/index.html @@ -178,7 +178,6 @@

"lang": "en", "dir": "ltr", "name": "Super Racer 3000", - "description": "The ultimate futuristic racing game from the future!", "short_name": "Racer3K", "icons": [{ "src": "icon/lowres.webp", @@ -196,16 +195,7 @@

"display": "fullscreen", "orientation": "landscape", "theme_color": "aliceblue", - "background_color": "red", - "screenshots": [{ - "src": "screenshots/in-game-1x.jpg", - "sizes": "640x480", - "type": "image/jpeg" - },{ - "src": "screenshots/in-game-2x.jpg", - "sizes": "1280x920", - "type": "image/jpeg" - }] + "background_color": "red" } @@ -907,18 +897,10 @@

of running processing a color member given json["background_color"]. -
  • Set manifest["categories"] to the result of - running processing the categories member given - json["categories"]. -
  • Set manifest["icons"] to the result of running processing `ManifestImageResource` members given json["icons"] and manifest URL.
    • -
  • Set manifest["screenshots"] to the result of - running processing `ManifestImageResource` members given - manifest["screenshots"] and manifest URL. -
  • Set manifest["related_applications"] to the result of running processing the related_applications member given json["related_applications"]. @@ -1037,11 +1019,7 @@

    DOMString lang; USVString name; USVString short_name; - USVString description; sequence<ManifestImageResource> icons; - sequence<ManifestImageResource> screenshots; - sequence<USVString> categories; - DOMString iarc_rating_id; USVString start_url; DisplayModeType display = "browser"; OrientationLockType orientation; @@ -1224,15 +1202,6 @@

    the web application.

    -
    -

    - description member -

    -

    - The description member allows the developer to describe - the purpose of the web application. -

    -

    scope member @@ -1627,112 +1596,6 @@

    "@media">prefers-color-scheme.

    -
    -

    - categories member -

    -

    - The categories member describes the expected application - categories to which the web application belongs. -

    -

    - The categories 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. -

    -

    - The steps for processing the categories - member are given by the following algorithm. The algorithm - takes a sequence<USVString> categories as an - argument. This algorithm returns an - Array<USVString>. -

    -
      -
    1. [=list/For each=] category of categories: -
        -
      1. [=set/Replace=] category within - categories with category, ascii - lowercased. -
        2. -
      -
      2. -
    2. Return categories. -
      3. -
    -

    - The categories string array is case insensitive and converted - to lower-case by following the processing algorithm. Thus, - sports, Sports, SPORTS, and - SpOrTs are all equivalent. -

    -

    - Manifest authors are encouraged to use lower-case. -

    -

    - This specification does not define the particular values for - USVStrings for the categories member. However, the - working group maintains a list of known - values in our wiki. -

    -
    -
    -

    - screenshots member -

    -

    - The screenshots member is an array of - {{ManifestImageResource}}s, representing the web application in - common usage scenarios. -

    -
    -
    -

    - iarc_rating_id member -

    -

    - The iarc_rating_id member is a string that - represents the International - Age Rating Coalition (IARC) certification code of the web - application. It is intended to be used to determine which ages the - web application is appropriate for. -

    -

    - An IARC certificate can be obtained via participating storefronts, - intended to be used for distributing the web app. The - iarc_rating_id 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. -

    -
    -

    - The following shows a very simple manifest with the - iarc_rating_id member. -

    - 
    -          {
-            "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"
-            }]
-          }
-
    -
    -

    - More information on the IARC can be found at: How IARC - Works and How developers - can get their games and apps rated with IARC. -

    -

    shortcuts member @@ -2788,7 +2651,7 @@

    consistent.

    - To allow the community can easily find extensions, please add your + To allow the community to easily find extensions, please add your extensions to the Extensions Registry. @@ -2882,6 +2745,29 @@

    +
    +

    + Application Information +

    +

    + Several members of the Web App Manifest 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. In an effort to support + these use cases better, the following members have been moved into + {{WebAppManifestAppInfo}}: +

    +
      +
    • {{WebAppManifestAppInfo/categories}} +
      • +
    • {{WebAppManifestAppInfo/description}} +
      • +
    • {{WebAppManifestAppInfo/iarc_rating_id}} +
      • +
    • {{WebAppManifestAppInfo/screenshots}} +
      • +
    +

    Relationship to HTML's link and meta elements From ff54ae7049dda6c4ef194ab04144f5b2f3ec7195 Mon Sep 17 00:00:00 2001 From: Aaron Gustafson Date: Mon, 20 Jul 2020 17:30:49 -0700 Subject: [PATCH 2/3] Updating the link to the App Info spec MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Marcos Cáceres --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index e28cb104..6a40ae00 100644 --- a/index.html +++ b/index.html @@ -2755,7 +2755,7 @@

    digital storefront, installation dialog, or other surfaces where this web application may be marketed or distributed. In an effort to support these use cases better, the following members have been moved into - {{WebAppManifestAppInfo}}: + [[[manifest-app-info]]]:

    • {{WebAppManifestAppInfo/categories}} From df9f4917a7079b8c318cf1b15634226a8b3fea4a Mon Sep 17 00:00:00 2001 From: Aaron Gustafson Date: Mon, 20 Jul 2020 17:31:12 -0700 Subject: [PATCH 3/3] Removing links that are not exported. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Marcos Cáceres --- index.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/index.html b/index.html index 6a40ae00..31e290d4 100644 --- a/index.html +++ b/index.html @@ -2758,13 +2758,13 @@

      [[[manifest-app-info]]]:

        -
      • {{WebAppManifestAppInfo/categories}} +
      • `categories`
        • -
      • {{WebAppManifestAppInfo/description}} +
      • `description`
        • -
      • {{WebAppManifestAppInfo/iarc_rating_id}} +
      • `iarc_rating_id`
        • -
      • {{WebAppManifestAppInfo/screenshots}} +
      • `screenshots`