From 503dc95d71f93b522693c93714f1a33aae9c3162 Mon Sep 17 00:00:00 2001 From: Micky Date: Mon, 8 Jan 2024 22:57:26 +0100 Subject: [PATCH] Add documentation to EditorExportPlatformWeb (cherry picked from commit 7ffacb5d49c32fe89ea793164118545284456fdd) --- .../doc_classes/EditorExportPlatformWeb.xml | 40 +++++++++++++++++-- 1 file changed, 37 insertions(+), 3 deletions(-) diff --git a/platform/web/doc_classes/EditorExportPlatformWeb.xml b/platform/web/doc_classes/EditorExportPlatformWeb.xml index 04df995e421..2086de83856 100644 --- a/platform/web/doc_classes/EditorExportPlatformWeb.xml +++ b/platform/web/doc_classes/EditorExportPlatformWeb.xml @@ -4,6 +4,8 @@ Exporter for the Web. + The Web exporter customizes how a web build is handled. In the editor's "Export" window, it is created when adding a new "Web" preset. + [b]Note:[/b] Godot on Web is rendered inside a [code]<canvas>[/code] tag. Normally, the canvas cannot be positioned or resized manually, but otherwise acts as the main [Window] of the application. $DOCS_URL/tutorials/export/exporting_for_web.html @@ -11,45 +13,77 @@ - Path to the custom export template. If left empty, default template is used. + File path to the custom export template used for debug builds. If left empty, the default template is used. - Path to the custom export template. If left empty, default template is used. + File path to the custom export template used for release builds. If left empty, the default template is used. - The canvas resize policy determines how the canvas should be resized by Godot. + Determines how the canvas should be resized by Godot. + - [b]None:[/b] The canvas is not automatically resized. + - [b]Project:[/b] The size of the canvas is dependent on the [ProjectSettings]. + - [b]Adaptive:[/b] The canvas is automatically resized to fit as much of the web page as possible. + The custom HTML page that wraps the exported web build. If left empty, the default HTML shell is used. + For more information, see the [url=$DOCS_URL/tutorials/platform/web/customizing_html5_shell.html]Customizing HTML5 Shell[/url] tutorial. + If [code]true[/code], embeds support for a virtual keyboard into the web page, which is shown when necessary on touchscreen devices. + [b]Warning:[/b] This feature is experimental and may be changed in a future release. + If [code]true[/code], the project icon will be used as the favicon for this application's web page. + If [code]true[/code], the canvas will be focused as soon as the application is loaded, if the browser window is already in focus. + Additional HTML tags to include inside the [code]<head>[/code], such as [code]<meta>[/code] tags. + [b]Note:[/b] You do not need to add a [code]<title>[/code] tag, as it is automatically included based on the project's name. + The background color used behind the web application. + The [url=https://developer.mozilla.org/en-US/docs/Web/Manifest/display/]display mode[/url] to use for this progressive web application. Different browsers and platforms may not behave the same. + - [b]Fullscreen:[/b] Displays the app in fullscreen and hides all of the browser's UI elements. + - [b]Standalone:[/b] Displays the app in a separate window and hides all of the browser's UI elements. + - [b]Minimal UI:[/b] Displays the app in a separate window and only shows the browser's UI elements for navigation. + - [b]Browser:[/b] Displays the app as a normal web page. + If [code]true[/code], turns this web build into a [url=https://en.wikipedia.org/wiki/Progressive_web_app]progressive web application[/url] (PWA). + File path to the smallest icon for this web application. If not defined, defaults to the project icon. + [b]Note:[/b] If the icon is not 144x144, it will be automatically resized for the final build. + File path to the small icon for this web application. If not defined, defaults to the project icon. + [b]Note:[/b] If the icon is not 180x180, it will be automatically resized for the final build. + File path to the smallest icon for this web application. If not defined, defaults to the project icon. + [b]Note:[/b] If the icon is not 512x512, it will be automatically resized for the final build. + The page to display, should the server hosting the page not be available. This page is saved in the client's machine. + The orientation to use when the web application is run through a mobile device. + - [b]Any:[/b] No orientation is forced. + - [b]Landscape:[/b] Forces a horizontal layout (wider than it is taller). + - [b]Portrait:[/b] Forces a vertical layout (taller than it is wider). + If [code]true[/code] enables [GDExtension] support for this web build. + If [code]true[/code], allows textures to be optimized for desktop through the S3TC algorithm. + If [code]true[/code] allows textures to be optimized for mobile through the ETC2 algorithm.