Inline language code info boxes
authorMatthias Schmidt <gravatronics@live.com>
Mon, 28 Dec 2020 15:11:22 +0000 (16:11 +0100)
committerMatthias Schmidt <gravatronics@live.com>
Mon, 28 Dec 2020 15:11:22 +0000 (16:11 +0100)
docs/package_pip_box.md
docs/package_pip_cronjob.md
docs/package_pip_language.md
docs/package_pip_menu-item.md
docs/package_pip_menu.md
docs/package_pip_page.md

index 64f17779434860d2f7313735b647d7523bc5eeb2..61f88c596974cad55e06fd9d7af317b273c0c8cc 100644 (file)
@@ -8,7 +8,7 @@ Each item is described as a `<box>` element with the mandatory attribute `name`
 
 ### `<name>`
 
-{% include languageCode.html %}
+!!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
 
 The internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple `<name>` elements.
 
@@ -43,7 +43,7 @@ The default display position of this box, can be any of the following:
 
 #### Placeholder Positions
 
-{% include image.html file="boxPlaceholders.png" alt="Visual illustration of placeholder positions" %}
+--8<-- "image.html file="boxPlaceholders.png" alt="Visual illustration of placeholder positions""
 
 ### `<showHeader>`
 
@@ -63,7 +63,8 @@ Provide a custom CSS class name that is added to the menu container, allowing fu
 
 ### `<content>`
 
-{% include languageCode.html %}
+!!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
+
 #### `<title>`
 
 The title element is required and controls the box title shown to the end users.
index faf9d2d9e70e19efa616c7535763af997091706b..da722dc25c693ce89dbd2a8d90d3f9dbc345c389 100644 (file)
@@ -16,7 +16,7 @@ the class has to implement the `wcf\system\cronjob\ICronjob` interface.
 
 ### `<description>`
 
-{% include languageCode.html requirement="optional" %}
+!!! info "The `language` attribute is optional and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
 
 Provides a human readable description for the administrator.
 
index fdc1e2eb8fcb3bdcbda02daafe1d01ba66ab576e..182088877b34bc52bb21b242c49f16ca717b7557 100644 (file)
@@ -4,7 +4,7 @@ Registers new language items.
 
 ## Components
 
-{% include languageCode.html attribute="languagecode" %}
+!!! info "The `languagecode` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
 
 The top level `<language>` node must contain a `languagecode` attribute.
 
@@ -16,8 +16,8 @@ Each category must contain a `name` attribute containing two or three components
 
 Each language item must contain a `name` attribute containing at least three components consisting of alphanumeric character only, separated by a single full stop (`.`, U+002E). The `name` of the parent `<category>` node followed by a full stop must be a prefix of the `<item>`’s `name`.
 
-{% include tip.html content="Wrap the text content inside a CDATA to avoid escaping of special characters." %}
-{% include warning.html content="Do not use the `{lang}` tag inside a language item." %}
+!!! info "Wrap the text content inside a CDATA to avoid escaping of special characters."
+!!! warning "Do not use the `{lang}` tag inside a language item."
 
 The text content of the `<item>` node is the value of the language item. Language items that are not in the `wcf.global` category support template scripting.
 
index 2a742d6daffadeff074d0bbf39f52f9aa9bcd449..da6552374f41599de0bfcfbc893fa03af351928b 100644 (file)
@@ -12,7 +12,7 @@ The target menu that the item should be added to, requires the internal identifi
 
 ### `<title>`
 
-{% include languageCode.html %}
+!!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
 
 The title is displayed as the link title of the menu item and can be fully customized by the administrator, thus is immutable after deployment. Supports multiple `<title>` elements to provide localized values.
 
index 63c0feacacb4a29b7ed3102febac6bf03a7b7182..8d7076ab7f425a00d443b9a8d70ea05295b9bc52 100644 (file)
@@ -8,7 +8,7 @@ Each item is described as a `<menu>` element with the mandatory attribute `ident
 
 ### `<title>`
 
-{% include languageCode.html %}
+!!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
 
 The internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple `<title>` elements.
 
index a6c48bc2d8494b3df8aa9546665f8029d52687e5..fb562b21e45277368508526bf87b4a849ecc2a2d 100644 (file)
@@ -26,7 +26,7 @@ Fully qualified class name that can be optionally set to provide additional meth
 
 ### `<name>`
 
-{% include languageCode.html %}
+!!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
 
 The internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple `<name>` elements.
 
@@ -61,7 +61,7 @@ Set this to `1` to prevent this page from becoming a landing page ever.
 
 ### `<content>`
 
-{% include languageCode.html %}
+!!! info "The `language` attribute is required and should specify the [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code."
 
 #### `<title>`