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

Group Manifest docs into references #37850

Merged
merged 8 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 24 additions & 3 deletions files/en-us/_redirects.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# DO NOT EDIT THIS FILE MANUALLY.
# Use the CLI instead:
#
# yarn content add-redirect <fromURL> <toURL>
# Use the CLI instead.
#
# FROM-URL TO-URL
/en-US/docs/-moz-locale-dir(ltr) /en-US/docs/Web/CSS/:-moz-locale-dir_ltr
Expand Down Expand Up @@ -13217,9 +13215,32 @@
/en-US/docs/Web/JavaScript/Typed_arrays/Uint16Array /en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array
/en-US/docs/Web/JavaScript/Typed_arrays/Uint32Array /en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array
/en-US/docs/Web/JavaScript/Typed_arrays/Uint8Array /en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
/en-US/docs/Web/Manifest/background_color /en-US/docs/Web/Manifest/Reference/background_color
/en-US/docs/Web/Manifest/categories /en-US/docs/Web/Manifest/Reference/categories
/en-US/docs/Web/Manifest/description /en-US/docs/Web/Manifest/Reference/description
/en-US/docs/Web/Manifest/dir /en-US/docs/Web/Manifest
/en-US/docs/Web/Manifest/display /en-US/docs/Web/Manifest/Reference/display
/en-US/docs/Web/Manifest/display_override /en-US/docs/Web/Manifest/Reference/display_override
/en-US/docs/Web/Manifest/file_handlers /en-US/docs/Web/Manifest/Reference/file_handlers
/en-US/docs/Web/Manifest/iarc_rating_id /en-US/docs/Web/Manifest
/en-US/docs/Web/Manifest/icons /en-US/docs/Web/Manifest/Reference/icons
/en-US/docs/Web/Manifest/id /en-US/docs/Web/Manifest/Reference/id
/en-US/docs/Web/Manifest/lang /en-US/docs/Web/Manifest
/en-US/docs/Web/Manifest/launch_handler /en-US/docs/Web/Manifest/Reference/launch_handler
/en-US/docs/Web/Manifest/name /en-US/docs/Web/Manifest/Reference/name
/en-US/docs/Web/Manifest/note_taking /en-US/docs/Web/Manifest/Reference/note_taking
/en-US/docs/Web/Manifest/orientation /en-US/docs/Web/Manifest/Reference/orientation
/en-US/docs/Web/Manifest/prefer_related_applications /en-US/docs/Web/Manifest/Reference/prefer_related_applications
/en-US/docs/Web/Manifest/protocol_handlers /en-US/docs/Web/Manifest/Reference/protocol_handlers
/en-US/docs/Web/Manifest/related_applications /en-US/docs/Web/Manifest/Reference/related_applications
/en-US/docs/Web/Manifest/scope /en-US/docs/Web/Manifest/Reference/scope
/en-US/docs/Web/Manifest/screenshots /en-US/docs/Web/Manifest/Reference/screenshots
/en-US/docs/Web/Manifest/serviceworker /en-US/docs/Web/Manifest/Reference/serviceworker
/en-US/docs/Web/Manifest/share_target /en-US/docs/Web/Manifest/Reference/share_target
/en-US/docs/Web/Manifest/short_name /en-US/docs/Web/Manifest/Reference/short_name
/en-US/docs/Web/Manifest/shortcuts /en-US/docs/Web/Manifest/Reference/shortcuts
/en-US/docs/Web/Manifest/start_url /en-US/docs/Web/Manifest/Reference/start_url
/en-US/docs/Web/Manifest/theme_color /en-US/docs/Web/Manifest/Reference/theme_color
/en-US/docs/Web/MathML/Attribute/Values /en-US/docs/Web/MathML/Values
/en-US/docs/Web/MathML/Element/menclosed /en-US/docs/Web/MathML/Element/menclose
/en-US/docs/Web/MathML/Element/none /en-US/docs/Web/MathML/Element/mmultiscripts
Expand Down
30 changes: 15 additions & 15 deletions files/en-us/_wikihistory.json
Original file line number Diff line number Diff line change
Expand Up @@ -121406,7 +121406,7 @@
"nyx2014"
]
},
"Web/Manifest/background_color": {
"Web/Manifest/Reference/background_color": {
"modified": "2020-10-15T22:19:34.725Z",
"contributors": [
"alattalatta",
Expand All @@ -121418,7 +121418,7 @@
"bershanskiy"
]
},
"Web/Manifest/categories": {
"Web/Manifest/Reference/categories": {
"modified": "2020-10-15T22:19:38.950Z",
"contributors": [
"mfuji09",
Expand All @@ -121428,7 +121428,7 @@
"bershanskiy"
]
},
"Web/Manifest/description": {
"Web/Manifest/Reference/description": {
"modified": "2020-10-15T22:19:35.118Z",
"contributors": [
"mfuji09",
Expand All @@ -121440,11 +121440,11 @@
"bershanskiy"
]
},
"Web/Manifest/display": {
"Web/Manifest/Reference/display": {
"modified": "2020-10-15T22:19:35.572Z",
"contributors": ["mfuji09", "wbamberg", "chrisdavidmills", "bershanskiy"]
},
"Web/Manifest/icons": {
"Web/Manifest/Reference/icons": {
"modified": "2020-10-15T22:19:36.584Z",
"contributors": [
"NotWoods",
Expand All @@ -121455,7 +121455,7 @@
"bershanskiy"
]
},
"Web/Manifest/name": {
"Web/Manifest/Reference/name": {
"modified": "2020-10-15T22:19:34.029Z",
"contributors": [
"mfuji09",
Expand All @@ -121465,11 +121465,11 @@
"bershanskiy"
]
},
"Web/Manifest/orientation": {
"Web/Manifest/Reference/orientation": {
"modified": "2020-10-15T22:19:38.630Z",
"contributors": ["mfuji09", "wbamberg", "chrisdavidmills", "bershanskiy"]
},
"Web/Manifest/prefer_related_applications": {
"Web/Manifest/Reference/prefer_related_applications": {
"modified": "2020-10-15T22:19:35.087Z",
"contributors": [
"mfuji09",
Expand All @@ -121481,7 +121481,7 @@
"bershanskiy"
]
},
"Web/Manifest/related_applications": {
"Web/Manifest/Reference/related_applications": {
"modified": "2020-10-15T22:19:38.718Z",
"contributors": [
"mfuji09",
Expand All @@ -121492,7 +121492,7 @@
"bershanskiy"
]
},
"Web/Manifest/scope": {
"Web/Manifest/Reference/scope": {
"modified": "2020-10-15T22:19:34.717Z",
"contributors": [
"mfuji09",
Expand All @@ -121502,7 +121502,7 @@
"bershanskiy"
]
},
"Web/Manifest/screenshots": {
"Web/Manifest/Reference/screenshots": {
"modified": "2020-10-15T22:19:38.892Z",
"contributors": [
"mfuji09",
Expand All @@ -121513,7 +121513,7 @@
"bershanskiy"
]
},
"Web/Manifest/short_name": {
"Web/Manifest/Reference/short_name": {
"modified": "2020-10-15T22:19:34.266Z",
"contributors": [
"mfuji09",
Expand All @@ -121523,15 +121523,15 @@
"bershanskiy"
]
},
"Web/Manifest/shortcuts": {
"Web/Manifest/Reference/shortcuts": {
"modified": "2020-10-15T22:31:46.728Z",
"contributors": ["bershanskiy"]
},
"Web/Manifest/start_url": {
"Web/Manifest/Reference/start_url": {
"modified": "2020-10-15T22:19:39.071Z",
"contributors": ["mfuji09", "wbamberg", "chrisdavidmills", "bershanskiy"]
},
"Web/Manifest/theme_color": {
"Web/Manifest/Reference/theme_color": {
"modified": "2020-10-15T22:19:39.139Z",
"contributors": ["mfuji09", "wbamberg", "chrisdavidmills", "bershanskiy"]
},
Expand Down
6 changes: 3 additions & 3 deletions files/en-us/glossary/application_context/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ page-type: glossary-definition
It determines how an app's browsing context, such as a tab or a window, is presented and behaves.

Web developers define the application context in the [web app's manifest file](/en-US/docs/Web/Manifest).
They use the [`scope`](/en-US/docs/Web/Manifest/scope) member in the manifest to specify the set of URLs that are considered part of the application context and to which the manifest applies.
They use the [`scope`](/en-US/docs/Web/Manifest/Reference/scope) member in the manifest to specify the set of URLs that are considered part of the application context and to which the manifest applies.

The manifest is applied after the application context is created but before navigation begins to either a start URL or a deep link.
A **start URL** is the initial page of the web app.
Expand All @@ -21,10 +21,10 @@ When an application context is created, browsers must immediately navigate to a
This navigation replaces the current entry in the browsing history.
If the application context is created to navigate to a deep link, the browser navigates directly to that deep link; otherwise, it navigates to the start URL.

Note that the start URL is not necessarily the value of the [`start_url`](/en-US/docs/Web/Manifest/start_url) member in the manifest. Browsers may ignore the specified `start_url` or may allow users to change its value when adding the web app to their device's home screen or bookmarking it.
Note that the start URL is not necessarily the value of the [`start_url`](/en-US/docs/Web/Manifest/Reference/start_url) member in the manifest. Browsers may ignore the specified `start_url` or may allow users to change its value when adding the web app to their device's home screen or bookmarking it.

## See also

- [`scope`](/en-US/docs/Web/Manifest/scope)
- [`scope`](/en-US/docs/Web/Manifest/Reference/scope)
- [Web app manifests](/en-US/docs/Web/Manifest)
- [Progressive web apps (PWA)](/en-US/docs/Web/Progressive_web_apps)
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ This section lists `page-type` values for pages under [Mozilla/Add-ons/WebExtens

This section lists `page-type` values for pages under [Web/Manifest](/en-US/docs/Web/Manifest). Every page in that part of the tree must have a `page-type`, and its value must be one of those listed below or one of the [generic page type](#generic_page_types) values.

- `web-manifest-member`: a member of a manifest, like [`description`](/en-US/docs/Web/Manifest/description).
- `web-manifest-member`: a member of a manifest, like [`description`](/en-US/docs/Web/Manifest/Reference/description).

### XPath page types

Expand Down
6 changes: 3 additions & 3 deletions files/en-us/web/api/launch_handler_api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The **Launch Handler API** allows developers to control how a [progressive web a

## Concepts and usage

You can specify launch behavior for your app by adding the [`launch_handler`](/en-US/docs/Web/Manifest/launch_handler) field to your web app manifest file. This has one sub-field, `client_mode`, which contains a string value specifying how the app should be launched and navigated to. For example:
You can specify launch behavior for your app by adding the [`launch_handler`](/en-US/docs/Web/Manifest/Reference/launch_handler) field to your web app manifest file. This has one sub-field, `client_mode`, which contains a string value specifying how the app should be launched and navigated to. For example:

```json
"launch_handler": {
Expand Down Expand Up @@ -47,12 +47,12 @@ window.launchQueue.setConsumer((launchParams) => {
- {{domxref("LaunchParams")}}
- : Used when implementing custom launch navigation handling in a PWA. When {{domxref("LaunchQueue.setConsumer", "window.launchQueue.setConsumer()")}} is invoked to set up the launch navigation handling functionality, the callback function inside `setConsumer()` is passed a `LaunchParams` object instance.
- {{domxref("LaunchQueue")}}
- : When a [progressive web app](/en-US/docs/Web/Progressive_web_apps) (PWA) is launched with a [`launch_handler`](/en-US/docs/Web/Manifest/launch_handler) `client_mode` value of `focus-existing`, `navigate-new`, or `navigate-existing`, `LaunchQueue` provides access to functionality that allows custom launch navigation handling to be implemented in the PWA. This functionality is controlled by the properties of the {{domxref("LaunchParams")}} object passed into the {{domxref("LaunchQueue.setConsumer", "setConsumer()")}} callback function.
- : When a [progressive web app](/en-US/docs/Web/Progressive_web_apps) (PWA) is launched with a [`launch_handler`](/en-US/docs/Web/Manifest/Reference/launch_handler) `client_mode` value of `focus-existing`, `navigate-new`, or `navigate-existing`, `LaunchQueue` provides access to functionality that allows custom launch navigation handling to be implemented in the PWA. This functionality is controlled by the properties of the {{domxref("LaunchParams")}} object passed into the {{domxref("LaunchQueue.setConsumer", "setConsumer()")}} callback function.

## Extensions to other interfaces

- {{domxref("window.launchQueue")}}
- : Provides access to the {{domxref("LaunchQueue")}} class, which allows custom launch navigation handling to be implemented in a [progressive web app](/en-US/docs/Web/Progressive_web_apps) (PWA), with the handling context signified by the [`launch_handler`](/en-US/docs/Web/Manifest/launch_handler) manifest field `client_mode` value.
- : Provides access to the {{domxref("LaunchQueue")}} class, which allows custom launch navigation handling to be implemented in a [progressive web app](/en-US/docs/Web/Progressive_web_apps) (PWA), with the handling context signified by the [`launch_handler`](/en-US/docs/Web/Manifest/Reference/launch_handler) manifest field `client_mode` value.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/launchparams/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ browser-compat: api.LaunchParams

The **`LaunchParams`** interface of the {{domxref("Launch Handler API", "Launch Handler API", "", "nocode")}} is used when implementing custom launch navigation handling in a PWA. When {{domxref("LaunchQueue.setConsumer", "window.launchQueue.setConsumer()")}} is invoked to set up the launch navigation handling functionality, the callback function inside `setConsumer()` is passed a `LaunchParams` object instance.

Such custom navigation handling is initiated via {{domxref("Window.launchQueue")}} when a PWA has been launched with a [`launch_handler`](/en-US/docs/Web/Manifest/launch_handler) `client_mode` value of `focus-existing`, `navigate-new`, or `navigate-existing`.
Such custom navigation handling is initiated via {{domxref("Window.launchQueue")}} when a PWA has been launched with a [`launch_handler`](/en-US/docs/Web/Manifest/Reference/launch_handler) `client_mode` value of `focus-existing`, `navigate-new`, or `navigate-existing`.

{{InheritanceDiagram}}

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/launchqueue/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ browser-compat: api.LaunchQueue

{{APIRef("Launch Handler API")}}{{SeeCompatTable}}

The **`LaunchQueue`** interface of the {{domxref("Launch Handler API", "Launch Handler API", "", "nocode")}} is available via the {{domxref("Window.launchQueue")}} property. When a [progressive web app](/en-US/docs/Web/Progressive_web_apps) (PWA) is launched with a [`launch_handler`](/en-US/docs/Web/Manifest/launch_handler) `client_mode` value of `focus-existing`, `navigate-new`, or `navigate-existing`, `LaunchQueue` provides access to functionality that allows custom launch navigation handling to be implemented in the PWA. This functionality is controlled by the properties of the {{domxref("LaunchParams")}} object passed into the {{domxref("LaunchQueue.setConsumer", "setConsumer()")}} callback function.
The **`LaunchQueue`** interface of the {{domxref("Launch Handler API", "Launch Handler API", "", "nocode")}} is available via the {{domxref("Window.launchQueue")}} property. When a [progressive web app](/en-US/docs/Web/Progressive_web_apps) (PWA) is launched with a [`launch_handler`](/en-US/docs/Web/Manifest/Reference/launch_handler) `client_mode` value of `focus-existing`, `navigate-new`, or `navigate-existing`, `LaunchQueue` provides access to functionality that allows custom launch navigation handling to be implemented in the PWA. This functionality is controlled by the properties of the {{domxref("LaunchParams")}} object passed into the {{domxref("LaunchQueue.setConsumer", "setConsumer()")}} callback function.

{{InheritanceDiagram}}

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/launchqueue/setconsumer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ browser-compat: api.LaunchQueue.setConsumer

{{APIRef("Launch Handler API")}}{{SeeCompatTable}}

The **`setConsumer()`** method of the {{domxref("LaunchQueue")}} interface is used to declare the callback that will handle custom launch navigation handling in a [progressive web app](/en-US/docs/Web/Progressive_web_apps) (PWA). Such custom navigation is initiated via {{domxref("Window.launchQueue")}} when a PWA has been launched with a [`launch_handler`](/en-US/docs/Web/Manifest/launch_handler) `client_mode` value of `focus-existing`, `navigate-new`, or `navigate-existing`.
The **`setConsumer()`** method of the {{domxref("LaunchQueue")}} interface is used to declare the callback that will handle custom launch navigation handling in a [progressive web app](/en-US/docs/Web/Progressive_web_apps) (PWA). Such custom navigation is initiated via {{domxref("Window.launchQueue")}} when a PWA has been launched with a [`launch_handler`](/en-US/docs/Web/Manifest/Reference/launch_handler) `client_mode` value of `focus-existing`, `navigate-new`, or `navigate-existing`.

## Syntax

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The **`getInstalledRelatedApps()`** method returns a promise that resolves with

To associate the invoking web app with a platform-specific app or PWA, two things must be done:

1. The invoking web app must be specified in the [`related_applications`](/en-US/docs/Web/Manifest/related_applications) member of its [manifest file](/en-US/docs/Web/Manifest).
1. The invoking web app must be specified in the [`related_applications`](/en-US/docs/Web/Manifest/Reference/related_applications) member of its [manifest file](/en-US/docs/Web/Manifest).
2. The platform-specific app or PWA must have its relationship with the invoking app defined.

Defining the relationship is done in a different way depending on the type of app:
Expand Down Expand Up @@ -67,7 +67,7 @@ A {{JSxRef("Promise")}} that fulfills with an array of objects representing any
- `version` {{optional_inline}}
- : A string representing the related app's version.

The related app information must have been previously specified in the [`related_applications`](/en-US/docs/Web/Manifest/related_applications) member of the invoking web app's [manifest file](/en-US/docs/Web/Manifest).
The related app information must have been previously specified in the [`related_applications`](/en-US/docs/Web/Manifest/Reference/related_applications) member of the invoking web app's [manifest file](/en-US/docs/Web/Manifest).

### Exceptions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ information about the title bar geometry in desktop Progressive Web Apps that us

Progressive Web Apps installed on desktop Operating Systems can opt-in to the
Window Controls Overlay feature by using the `window-controls-overlay` value in the
[`display_override`](/en-US/docs/Web/Manifest/display_override) web app manifest member.
[`display_override`](/en-US/docs/Web/Manifest/Reference/display_override) web app manifest member.

Doing so hides the default window title bar and gives the app access to the full area
of the app window.
Expand Down
Loading