Skip to content

Commit db88c85

Browse files
mgiucamgiuca
authored
Fix all errors and warnings (#96)
Miscellaneous editorial pass over the document to fix errors and warnings. Semi-major changes: * Added explicit algorithm calling all the processing steps defined in this spec. * Removed unused definitions of "Additional Window Controls" and "Isolated Web App". (Neither of these terms were referenced, and shouldn't be defined here anyway.) * Add prose invoking launch the new_note_url. * Fix all uses of "URL" to link to the URL spec instead of protocol_handlers.url. Minor fixes: * Fix broken links to fs and web-app-launch specs. * Link to protocol_handlers. * Protocol handlers algorithm: use variables rather than definitions. * Properly define PromptResponseObject/userChoice. * Fix definition of onbeforeinstallprompt.
1 parent a6ffc2b commit db88c85

File tree

1 file changed

+86
-68
lines changed

1 file changed

+86
-68
lines changed

‎index.html

Lines changed: 86 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@
2222
"appmanifest",
2323
"dom",
2424
"file-system-access",
25+
"fs",
2526
"mimesniff",
27+
"web-app-launch",
2628
"window-controls-overlay"
2729
],
2830
profile: "web-platform",
@@ -111,17 +113,6 @@ <h3>
111113
to control the application. Common actions in the [=window
112114
controls=] include minimize, maximize/restore, and close buttons.
113115
</li>
114-
<li>
115-
<dfn>Additional Window Controls</dfn>: feature to replace [=window
116-
controls=] by calling the minimize/maximize/close etc APIs directly
117-
without the need to use browser's native window controls.
118-
</li>
119-
<li>
120-
<dfn data-lt="IWA">Isolated Web App</dfn>: feature for installed
121-
and signed web applications which are packaged as Web Bundles and
122-
can be used offline instead of being fetched over HTTPS. See
123-
<a href="https://github.com/WICG/isolated-web-apps">explainer</a>.
124-
</li>
125116
</ul>
126117
</section>
127118
<section>
@@ -202,6 +193,31 @@ <h3>
202193
</ul>
203194
</section>
204195
</section>
196+
<section>
197+
<h2>
198+
Extensions to processing the manifest
199+
</h2>
200+
<p>
201+
To facilitate all of the new extension and incubation features added by
202+
this specification, the user agent SHOULD run the following during the
203+
<a data-cite=
204+
"appmanifest#dfn-processing-extension-point-of-web-manifest">extension
205+
point</a> in [=processing a manifest=] (having access to [=URL=]
206+
|document URL:URL|, [=URL=] |manifest URL:URL|, [=ordered map=]
207+
|json:ordered map|, and [=ordered map=] |manifest:ordered map|):
208+
</p>
209+
<ol>
210+
<li>[=Process the `note_taking` member=], passing |json|, |manifest|
211+
and |manifest URL|.
212+
</li>
213+
<li>[=Process the `protocol_handlers` member=], passing |json| and
214+
|manifest|.
215+
</li>
216+
<li>[=Process the `file_handlers` member=], passing |json|, |manifest|
217+
and |manifest URL|.
218+
</li>
219+
</ol>
220+
</section>
205221
<section>
206222
<h2>
207223
`share_target` member
@@ -358,6 +374,11 @@ <h3>
358374
|manifest|["note_taking"]["new_note_url"].
359375
</li>
360376
</ol>
377+
<p>
378+
The user agent MAY [=launch the `new_note_url`=] for a given
379+
[=installed web application=] at any time, typically in response to a
380+
user affordance.
381+
</p>
361382
</section>
362383
</section>
363384
<section>
@@ -412,18 +433,18 @@ <h3>
412433
<li>If |protocol_handler|["protocol"] or
413434
|protocol_handler|["url"] is undefined, [=iteration/continue=].
414435
</li>
415-
<li>Let (<dfn>normalizedProtocol</dfn>, <dfn>normalizedUrl</dfn>)
416-
be the result of running [=normalize protocol handler
417-
parameters=] with |protocol_handler|["protocol"], |
418-
protocol_handler|["url"] using |manifest URL| as the base URL,
419-
and [=this=]'s relevant [=environment settings object=]. If the
420-
result is failure, [=iteration/continue=].
436+
<li>Let (|normalizedProtocol:string|, |normalizedUrl:URL|) be the
437+
result of running [=normalize protocol handler parameters=] with
438+
|protocol_handler|["protocol"], | protocol_handler|["url"] using
439+
|manifest URL| as the base URL, and [=this=]'s relevant
440+
[=environment settings object=]. If the result is failure,
441+
[=iteration/continue=].
421442
</li>
422-
<li>If [=normalizedUrl=] is not [=manifest/within scope=] of
443+
<li>If |normalizedUrl| is not [=manifest/within scope=] of
423444
|manifest|, [=iteration/continue=].
424445
</li>
425446
<li>If |processedProtocolHandlers| [=list/contains=] the
426-
[=normalizedUrl=], [=iteration/continue=].
447+
|normalizedUrl|, [=iteration/continue=].
427448
</li>
428449
<li>[=List/Append=] |protocol_handler| to
429450
|processedProtocolHandlers|.
@@ -479,17 +500,18 @@ <h3>
479500
</section>
480501
<section>
481502
<h2>
482-
ProtocolHandler items
503+
Protocol handler items
483504
</h2>
484505
<p>
485506
Each <dfn>protocol handler description</dfn> is an [=object=] that
486-
represents a protocol that the web application wants to handle. It
487-
has the following members:
507+
represents a protocol that the web application wants to handle,
508+
corresponding to the [=manifest/protocol_handlers=] member. It has
509+
the following members:
488510
</p>
489511
<ul>
490-
<li>[=`protocol`=]
512+
<li>[=protocol handler description/protocol=]
491513
</li>
492-
<li>[=`url`=]
514+
<li>[=protocol handler description/url=]
493515
</li>
494516
</ul>
495517
<p>
@@ -501,40 +523,46 @@ <h2>
501523
<p class="note">
502524
[[HTML]]'s {{NavigatorContentUtils/registerProtocolHandler()}} allows
503525
web sites to register themselves as possible handlers for particular
504-
protocols. What constitutes valid <code>protocol</code> and
505-
<code>url</code> values for <a>protocol handler description</a>s is
506-
defined in that API. Also note that the [[HTML]] API uses
507-
[=url/scheme=] where we use <code>protocol</code> but the same
526+
protocols. What constitutes valid [=protocol handler
527+
description/protocol=] and [=protocol handler description/url=]
528+
values for <a>protocol handler description</a>s is defined in that
529+
API. Also note that the [[HTML]] API uses <code>scheme</code> where
530+
we use [=protocol handler description/protocol=] but the same
508531
restrictions apply.
509532
</p>
510533
<section>
511534
<h3>
512535
`protocol` member
513536
</h3>
514537
<p>
515-
The <dfn>protocol</dfn> member of a <a>protocol handler
516-
description</a> is a <a>string</a> that represents the protocol to
517-
be handled, such as `mailto` or `web+auth`.
538+
The <code><dfn data-dfn-for=
539+
"protocol handler description">protocol</dfn></code> member of a
540+
<a>protocol handler description</a> is a <a>string</a> that
541+
represents the protocol to be handled, such as `mailto` or
542+
`web+auth`.
518543
</p>
519544
<p>
520-
The <a>protocol</a> member of a <a>protocol handler description</a>
521-
is equivalent to
522-
{{NavigatorContentUtils/registerProtocolHandler()}}'s |scheme|
523-
argument defined in [[HTML]].
545+
The [=protocol handler description/protocol=] member of a
546+
<a>protocol handler description</a> is equivalent to
547+
{{NavigatorContentUtils/registerProtocolHandler()}}'s
548+
<code>scheme</code> argument defined in [[HTML]].
524549
</p>
525550
</section>
526551
<section>
527552
<h3>
528553
`url` member
529554
</h3>
530555
<p>
531-
The <dfn>url</dfn> member of a <a>protocol handler description</a>
532-
is the <a>URL</a> [=manifest/within scope=] of the application that
533-
opens when the associated protocol is activated.
556+
The <code><dfn data-dfn-for=
557+
"protocol handler description">url</dfn></code> member of a
558+
<a>protocol handler description</a> is the <a>URL</a>
559+
[=manifest/within scope=] of the application that opens when the
560+
associated protocol is activated.
534561
</p>
535562
<p>
536-
The <a>url</a> member of a <a>protocol handler description</a> is
537-
equivalent to {{NavigatorContentUtils/registerProtocolHandler()}}'s
563+
The [=protocol handler description/url=] member of a <a>protocol
564+
handler description</a> is equivalent to
565+
{{NavigatorContentUtils/registerProtocolHandler()}}'s
538566
<code>url</code> argument defined in [[HTML]].
539567
</p>
540568
</section>
@@ -601,9 +629,9 @@ <h3>
601629
applications is at the discretion of the operating system.
602630
</p>
603631
<p>
604-
To <dfn class="lint-ignore">process the `file_handlers` member</dfn>,
605-
given [=ordered map=] |json:ordered map|, [=ordered map=]
606-
|manifest:ordered map|, [=URL=] |manifest_url:URL|:
632+
To <dfn>process the `file_handlers` member</dfn>, given [=ordered map=]
633+
|json:ordered map|, [=ordered map=] |manifest:ordered map|, [=URL=]
634+
|manifest_url:URL|:
607635
</p>
608636
<ol class="algorithm">
609637
<li>Let |processedFileHandlers:list| be a new [=list=].
@@ -930,38 +958,27 @@ <h2>
930958
<ol>
931959
<li>[=list/for each=] |file| of |files|
932960
<ol>
933-
<li>Let |params:LaunchParams| be a new <a href=
934-
"https://wicg.github.io/web-app-launch/#dom-launchparams">
935-
LaunchParams</a> with <a href=
936-
"https://wicg.github.io/web-app-launch/#dom-launchparams-files">
937-
files</a> set to a {{FrozenArray}} with a single
938-
element that is a {{FileSystemHandle}} corresponding to
939-
|file|.
961+
<li>Let |params:LaunchParams| be a new {{LaunchParams}}
962+
with {{LaunchParams/files}} set to a {{FrozenArray}} with
963+
a single element that is a {{FileSystemHandle}}
964+
corresponding to |file|.
940965
</li>
941-
<li>
942-
<a href=
943-
"https://wicg.github.io/web-app-launch/#dfn-launching-a-web-application-with-handling">
944-
Launch a web application with handling</a> passing
945-
|manifest| and |params|.
966+
<li>[=Launch a web application with handling=], passing
967+
|manifest| and |params|.
946968
</li>
947969
</ol>
948970
</li>
949971
</ol>
950972
</li>
951973
<li>Else,
952974
<ol>
953-
<li>Let |params:LaunchParams| be a new <a href=
954-
"https://wicg.github.io/web-app-launch/#dom-launchparams">LaunchParams</a>
955-
with <a href=
956-
"https://wicg.github.io/web-app-launch/#dom-launchparams-files">
957-
files</a> set to a {{FrozenArray}} of {{FileSystemHandle}}s
958-
that correspond to the file paths named by |files|.
975+
<li>Let |params:LaunchParams| be a new {{LaunchParams}} with
976+
{{LaunchParams/files}} set to a {{FrozenArray}} of
977+
{{FileSystemHandle}}s that correspond to the file paths named
978+
by |files|.
959979
</li>
960-
<li>
961-
<a href=
962-
"https://wicg.github.io/web-app-launch/#dfn-launching-a-web-application-with-handling">
963-
Launch a web application with handling</a> passing
964-
|manifest| and |params|.
980+
<li>[=Launch a web application with handling=], passing
981+
|manifest| and |params|.
965982
</li>
966983
</ol>
967984
</li>
@@ -1288,7 +1305,8 @@ <h3>
12881305
<p>
12891306
The <dfn>PromptResponseObject</dfn> contains the result of calling
12901307
{{BeforeInstallPromptEvent/prompt()}}. It contains one member,
1291-
<dfn>userChoice</dfn>, which states the user's chosen outcome.
1308+
<dfn data-dfn-for="PromptResponseObject">userChoice</dfn>, which
1309+
states the user's chosen outcome.
12921310
</p>
12931311
<p>
12941312
An instance of a {{BeforeInstallPromptEvent}} has the following
@@ -1439,7 +1457,7 @@ <h4>
14391457
handles "<dfn class="event">appinstalled</dfn>" events.
14401458
</p>
14411459
</section>
1442-
<section>
1460+
<section data-dfn-for="Window">
14431461
<h4>
14441462
<code>onbeforeinstallprompt</code> attribute
14451463
</h4>

0 commit comments

Comments
 (0)