Skip to content

Commit 4e2cf3e

Browse files
committed
Sync documentation of main branch
1 parent 30de429 commit 4e2cf3e

16 files changed

+193
-75
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"java.util.regex.Pattern","key":".no-restart-templates","additionalKeys":[],"configDoc":"By default, a template modification results in an application restart that triggers build-time validations.\n\nThis regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.\n\nThe matched input is the template path relative from the `templates` directory and the `/` is used as a path separator. For example, `templates/foo.html`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"no-restart-templates","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"string","key":"quarkus.qute.suffixes","additionalKeys":[],"configDoc":"The list of suffixes used when attempting to locate a template file.\n\nBy default, `engine.getTemplate(\"foo\")` would result in several lookups: `foo`, `foo.html`, `foo.txt`, etc.","withinAMap":false,"defaultValue":"qute.html,qute.txt,html,txt","javaDocSiteLink":"","docMapKey":"suffixes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":"quarkus.qute.content-types","additionalKeys":[],"configDoc":"The additional map of suffixes to content types. This map is used when working with template variants. By default, the `java.net.URLConnection++#++getFileNameMap()` is used to determine the content type of a template file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"content-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.type-check-excludes","additionalKeys":[],"configDoc":"The list of exclude rules used to intentionally ignore some parts of an expression when performing type-safe validation.\n\nAn element value must have at least two parts separated by dot. The last part is used to match the property/method name. The prepended parts are used to match the class name. The value `++*++` can be used to match any name.\n\nExamples:\n\n - `org.acme.Foo.name` - exclude the property/method `name` on the `org.acme.Foo` class\n - `org.acme.Foo.++*++` - exclude any property/method on the `org.acme.Foo` class\n - `++*++.age` - exclude the property/method `age` on any class","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"type-check-excludes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.qute.template-path-exclude","additionalKeys":[],"configDoc":"This regular expression is used to exclude template files from the `templates` directory. Excluded templates are neither parsed nor validated during build and are not available at runtime.\n\nThe matched input is the file path relative from the `templates` directory and the `/` is used as a path separator.\n\nBy default, the hidden files are excluded. The name of a hidden file starts with a dot.","withinAMap":false,"defaultValue":"^\\..*|.*\\/\\..*$","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"template-path-exclude","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.iteration-metadata-prefix","additionalKeys":[],"configDoc":"The prefix is used to access the iteration metadata inside a loop section.\n\nA valid prefix consists of alphanumeric characters and underscores. Three special constants can be used:\n\n - `<alias_>` - the alias of an iterated element suffixed with an underscore is used, e.g. `item_hasNext` and `it_count`\n - `<alias?>` - the alias of an iterated element suffixed with a question mark is used, e.g. `item?hasNext` and `it?count`\n - `<none>` - no prefix is used, e.g. `hasNext` and `count` By default, the `<alias_>` constant is set.","withinAMap":false,"defaultValue":"<alias_>","javaDocSiteLink":"","docMapKey":"iteration-metadata-prefix","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.escape-content-types","additionalKeys":[],"configDoc":"The list of content types for which the `'`, `\"`, `<`, `>` and `&` characters are escaped if a template variant is set.","withinAMap":false,"defaultValue":"text/html,text/xml,application/xml,application/xhtml+xml","javaDocSiteLink":"","docMapKey":"escape-content-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.nio.charset.Charset","key":"quarkus.qute.default-charset","additionalKeys":[],"configDoc":"The default charset of the templates files.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html","docMapKey":"default-charset","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}}]
1+
[{"configDocKey":{"type":"string","key":"quarkus.qute.suffixes","additionalKeys":[],"configDoc":"The list of suffixes used when attempting to locate a template file.\n\nBy default, `engine.getTemplate(\"foo\")` would result in several lookups: `foo`, `foo.html`, `foo.txt`, etc.","withinAMap":false,"defaultValue":"qute.html,qute.txt,html,txt","javaDocSiteLink":"","docMapKey":"suffixes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":"quarkus.qute.content-types","additionalKeys":[],"configDoc":"The additional map of suffixes to content types. This map is used when working with template variants. By default, the `java.net.URLConnection++#++getFileNameMap()` is used to determine the content type of a template file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"content-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.type-check-excludes","additionalKeys":[],"configDoc":"The list of exclude rules used to intentionally ignore some parts of an expression when performing type-safe validation.\n\nAn element value must have at least two parts separated by dot. The last part is used to match the property/method name. The prepended parts are used to match the class name. The value `++*++` can be used to match any name.\n\nExamples:\n\n - `org.acme.Foo.name` - exclude the property/method `name` on the `org.acme.Foo` class\n - `org.acme.Foo.++*++` - exclude any property/method on the `org.acme.Foo` class\n - `++*++.age` - exclude the property/method `age` on any class","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"type-check-excludes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.qute.template-path-exclude","additionalKeys":[],"configDoc":"This regular expression is used to exclude template files from the `templates` directory. Excluded templates are neither parsed nor validated during build and are not available at runtime.\n\nThe matched input is the file path relative from the `templates` directory and the `/` is used as a path separator.\n\nBy default, the hidden files are excluded. The name of a hidden file starts with a dot.","withinAMap":false,"defaultValue":"^\\..*|.*\\/\\..*$","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"template-path-exclude","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.iteration-metadata-prefix","additionalKeys":[],"configDoc":"The prefix is used to access the iteration metadata inside a loop section.\n\nA valid prefix consists of alphanumeric characters and underscores. Three special constants can be used:\n\n - `<alias_>` - the alias of an iterated element suffixed with an underscore is used, e.g. `item_hasNext` and `it_count`\n - `<alias?>` - the alias of an iterated element suffixed with a question mark is used, e.g. `item?hasNext` and `it?count`\n - `<none>` - no prefix is used, e.g. `hasNext` and `count` By default, the `<alias_>` constant is set.","withinAMap":false,"defaultValue":"<alias_>","javaDocSiteLink":"","docMapKey":"iteration-metadata-prefix","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.qute.escape-content-types","additionalKeys":[],"configDoc":"The list of content types for which the `'`, `\"`, `<`, `>` and `&` characters are escaped if a template variant is set.","withinAMap":false,"defaultValue":"text/html,text/xml,application/xml,application/xhtml+xml","javaDocSiteLink":"","docMapKey":"escape-content-types","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.nio.charset.Charset","key":"quarkus.qute.default-charset","additionalKeys":[],"configDoc":"The default charset of the templates files.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html","docMapKey":"default-charset","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.qute","enum":false}},{"configDocKey":{"type":"java.util.regex.Pattern","key":"quarkus.qute.dev-mode.no-restart-templates","additionalKeys":[],"configDoc":"By default, a template modification results in an application restart that triggers build-time validations.\n\nThis regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.\n\nThe matched input is the template path relative from the `templates` directory and the `/` is used as a path separator. For example, `templates/foo.html`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html","docMapKey":"no-restart-templates","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.qute","enum":false}}]

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57223,6 +57223,28 @@ endif::add-copy-button-to-env-var[]
5722357223
|`UTF-8`
5722457224

5722557225

57226+
a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus.qute.dev-mode.no-restart-templates]]`link:#quarkus-qute_quarkus.qute.dev-mode.no-restart-templates[quarkus.qute.dev-mode.no-restart-templates]`
57227+
57228+
57229+
[.description]
57230+
--
57231+
By default, a template modification results in an application restart that triggers build-time validations.
57232+
57233+
This regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.
57234+
57235+
The matched input is the template path relative from the `templates` directory and the `/` is used as a path separator. For example, `templates/foo.html`.
57236+
57237+
ifdef::add-copy-button-to-env-var[]
57238+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++[]
57239+
endif::add-copy-button-to-env-var[]
57240+
ifndef::add-copy-button-to-env-var[]
57241+
Environment variable: `+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++`
57242+
endif::add-copy-button-to-env-var[]
57243+
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html[Pattern]
57244+
57245+
|
57246+
57247+
5722657248
a| [[quarkus-qute_quarkus.qute.property-not-found-strategy]]`link:#quarkus-qute_quarkus.qute.property-not-found-strategy[quarkus.qute.property-not-found-strategy]`
5722757249

5722857250

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
:summaryTableId: quarkus-qute-config-group-qute-dev-mode-config
3+
[.configuration-legend]
4+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
5+
[.configuration-reference, cols="80,.^10,.^10"]
6+
|===
7+
8+
h|[[quarkus-qute-config-group-qute-dev-mode-config_configuration]]link:#quarkus-qute-config-group-qute-dev-mode-config_configuration[Configuration property]
9+
10+
h|Type
11+
h|Default
12+
13+
a|icon:lock[title=Fixed at build time] [[quarkus-qute-config-group-qute-dev-mode-config_quarkus.qute.dev-mode.no-restart-templates]]`link:#quarkus-qute-config-group-qute-dev-mode-config_quarkus.qute.dev-mode.no-restart-templates[quarkus.qute.dev-mode.no-restart-templates]`
14+
15+
16+
[.description]
17+
--
18+
By default, a template modification results in an application restart that triggers build-time validations.
19+
20+
This regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.
21+
22+
The matched input is the template path relative from the `templates` directory and the `/` is used as a path separator. For example, `templates/foo.html`.
23+
24+
ifdef::add-copy-button-to-env-var[]
25+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++[]
26+
endif::add-copy-button-to-env-var[]
27+
ifndef::add-copy-button-to-env-var[]
28+
Environment variable: `+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++`
29+
endif::add-copy-button-to-env-var[]
30+
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html[Pattern]
31+
32+
|
33+
34+
|===
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
:summaryTableId: quarkus-qute-general-config-items
3+
[.configuration-legend]
4+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
5+
[.configuration-reference, cols="80,.^10,.^10"]
6+
|===
7+
8+
h|[[quarkus-qute-general-config-items_configuration]]link:#quarkus-qute-general-config-items_configuration[Configuration property]
9+
10+
h|Type
11+
h|Default
12+
13+
a|icon:lock[title=Fixed at build time] [[quarkus-qute-general-config-items_quarkus.qute.dev-mode.no-restart-templates]]`link:#quarkus-qute-general-config-items_quarkus.qute.dev-mode.no-restart-templates[quarkus.qute.dev-mode.no-restart-templates]`
14+
15+
16+
[.description]
17+
--
18+
By default, a template modification results in an application restart that triggers build-time validations.
19+
20+
This regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.
21+
22+
The matched input is the template path relative from the `templates` directory and the `/` is used as a path separator. For example, `templates/foo.html`.
23+
24+
ifdef::add-copy-button-to-env-var[]
25+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++[]
26+
endif::add-copy-button-to-env-var[]
27+
ifndef::add-copy-button-to-env-var[]
28+
Environment variable: `+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++`
29+
endif::add-copy-button-to-env-var[]
30+
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html[Pattern]
31+
32+
|
33+
34+
|===

_generated-doc/main/config/quarkus-qute-qute-config.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,28 @@ endif::add-copy-button-to-env-var[]
134134
|`UTF-8`
135135

136136

137+
a|icon:lock[title=Fixed at build time] [[quarkus-qute-qute-config_quarkus.qute.dev-mode.no-restart-templates]]`link:#quarkus-qute-qute-config_quarkus.qute.dev-mode.no-restart-templates[quarkus.qute.dev-mode.no-restart-templates]`
138+
139+
140+
[.description]
141+
--
142+
By default, a template modification results in an application restart that triggers build-time validations.
143+
144+
This regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.
145+
146+
The matched input is the template path relative from the `templates` directory and the `/` is used as a path separator. For example, `templates/foo.html`.
147+
148+
ifdef::add-copy-button-to-env-var[]
149+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++[]
150+
endif::add-copy-button-to-env-var[]
151+
ifndef::add-copy-button-to-env-var[]
152+
Environment variable: `+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++`
153+
endif::add-copy-button-to-env-var[]
154+
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html[Pattern]
155+
156+
|
157+
158+
137159
a|icon:lock[title=Fixed at build time] [[quarkus-qute-qute-config_quarkus.qute.content-types-content-types]]`link:#quarkus-qute-qute-config_quarkus.qute.content-types-content-types[quarkus.qute.content-types]`
138160

139161

_generated-doc/main/config/quarkus-qute.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,28 @@ endif::add-copy-button-to-env-var[]
134134
|`UTF-8`
135135

136136

137+
a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus.qute.dev-mode.no-restart-templates]]`link:#quarkus-qute_quarkus.qute.dev-mode.no-restart-templates[quarkus.qute.dev-mode.no-restart-templates]`
138+
139+
140+
[.description]
141+
--
142+
By default, a template modification results in an application restart that triggers build-time validations.
143+
144+
This regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.
145+
146+
The matched input is the template path relative from the `templates` directory and the `/` is used as a path separator. For example, `templates/foo.html`.
147+
148+
ifdef::add-copy-button-to-env-var[]
149+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++[]
150+
endif::add-copy-button-to-env-var[]
151+
ifndef::add-copy-button-to-env-var[]
152+
Environment variable: `+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++`
153+
endif::add-copy-button-to-env-var[]
154+
--|link:https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html[Pattern]
155+
156+
|
157+
158+
137159
a| [[quarkus-qute_quarkus.qute.property-not-found-strategy]]`link:#quarkus-qute_quarkus.qute.property-not-found-strategy[quarkus.qute.property-not-found-strategy]`
138160

139161

0 commit comments

Comments
 (0)