diff --git a/docs/xml/metainfo-component.xml b/docs/xml/metainfo-component.xml index 893d396ce..a9c22b672 100644 --- a/docs/xml/metainfo-component.xml +++ b/docs/xml/metainfo-component.xml @@ -1203,30 +1203,31 @@ The <screenshots/> tag contains multiple <screenshot/> children, where at least one of them must have the property - type="default" to indicate the primary screenshot of the software. Every <screenshot/> tag must have at least - one <image/> or <video/> child, but never an image and - video at the same time. - - - Screenshots containing videos must not be the default screenshot. + type="default" to indicate the primary and most representative screenshot of the software. Optionally, a screenshot may also have an environment property. - This string property denotes the GUI environment the screenshot was recorded in, in the form of <env>:<style>, - where env is a desktop-environment name in lowercase - and style is a specific style that the desktop environment recognizes, e.g. light and dark for light - and dark themes. See desktop-style-ids.txt for a list + This string property denotes the GUI environment the screenshot was recorded in, in the form of {env}:{style}, + where {env} is a desktop-environment name in lowercase and {style} is a specific style + that the desktop environment recognizes, e.g. light and dark for light and dark themes. + See desktop-style-ids.txt for a list of currently recognized environment and style combinations. - Software centers displaying the component will prefer screenshots of the current environment and style first, will then fall back to - screenshots of the current environment (without style), and if none of those are available either they will use the environment of the - screenshot marked as type="default" (which may be intentionally empty). - That way, there will always be a screenshot displayed. + Software centers displaying the component will usually prefer screenshots of the current environment and style, and display them first, + even before the screenshot marked as default. In general, screenshots should be displayed in the order the are defined in in their screenshots block - for the respective component. + for the respective component on a per-environment basis (all screenshots of the same environment/style will be displayed in the order + they are listed in the XML, but may be moved to the front of the list as a whole depending on the current environment). + + + Every <screenshot/> element must have at least one <image/> or <video/> child, + but never an image and video at the same time. + + + Screenshots containing videos must not be the default screenshot. The value of the <image/> tag is a direct HTTP/HTTPS URL to a screenshot uploaded to a public location on the web.