Skip to content

Commit 4e88787

Browse files
committed
docs: table-check-integrity documentation
1 parent 9ea0d5a commit 4e88787

File tree

2 files changed

+53
-5
lines changed

2 files changed

+53
-5
lines changed

fj-doc-guide/src/main/docs/asciidoc/chapters/03_5_doc_extra_feature.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
Some extra features are available on the Venus Doc Format. Here is a listing.
55

6+
[#doc-format-entry-point-extra-feature-table-check-integrity]
67
==== Table Check Integrity
78

89
Sometimes using table with wrong number of columns and rows anc lead to unexpected behaviour or errors.
@@ -14,6 +15,8 @@ Using the doc info 'table-check-integrity' can solve this issue, for instance :
1415
<info name="table-check-integrity">fail</info>
1516
----
1617

18+
link:https://venusdocs.fugerit.org/docs/html/doc_meta_info.html#table-check-integrity[Here is 'table-check-integrity' documentation].
19+
1720
Accepted values are :
1821

1922
* 'disabled' - no check (default value)
@@ -43,3 +46,24 @@ Here is an example of a table where there is an extra column on the second row.
4346
</row>
4447
</table>
4548
----
49+
50+
When using xref:#doc-freemarker-config[FreemarkerDocProcessConfig]
51+
it is also possible to set a global configuration on
52+
link:https://venusdocs.fugerit.org/fj-doc-freemarker/src/main/docs/fdp_xsd_config_ref.html#freemarker-doc-process-config[freemarker-doc-process-config] :
53+
54+
[source,xml]
55+
----
56+
<?xml version="1.0" encoding="utf-8"?>
57+
<freemarker-doc-process-config
58+
xmlns="https://freemarkerdocprocess.fugerit.org"
59+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
60+
xsi:schemaLocation="https://freemarkerdocprocess.fugerit.org https://www.fugerit.org/data/java/doc/xsd/freemarker-doc-process-1-0.xsd"
61+
table-check-integrity="warn">
62+
<!-- ... further configuration ... -->
63+
</freemarker-doc-process-config>
64+
----
65+
66+
Priority order is :
67+
68+
* document level configuration (info tag)
69+
* global configuration (taken into account only if info tag not set)

fj-doc-guide/src/main/docs/asciidoc/chapters/04_1_doc_freemarker_config.adoc

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,41 @@ This is the root configuration element :
2121
xsi:schemaLocation="https://freemarkerdocprocess.fugerit.org https://www.fugerit.org/data/java/doc/xsd/freemarker-doc-process-1-0.xsd"
2222
validating="true"
2323
failOnValidate="true"
24-
cleanSource="true">
24+
cleanSource="true"
25+
table-check-integrity="warn">
2526
----
2627

2728
Aside from namespace declaration, it is possible to set some general attribute for the configuration :
2829

2930
[cols="1,1,1,7", options="header"]
3031
|========================================================================================================================================
31-
| name | type | default | description
32-
| *validating* anchor:doc-freemarker-config-attributes-validating[] | _boolean_ | _false_ | If set to 'true' the FreemarkerDocProcessConfig will try to validate the source. (since 8.9.1), NOTE: if active, source reader will be buffered, potentially resulting in higher memory usage. See also xref:#doc-faq-validate-document[FAQ].
33-
| *failOnValidate* anchor:doc-freemarker-config-attributes-failOnValidate[] | _boolean_ | _false_ | If set to 'true' the FreemarkerDocProcessConfig will fail in case of validation errors, if 'false' will just print the result as warning. (since 8.9.1), NOTE: 'validating' is set to true, this attribute is ignored. See also xref:#doc-faq-validate-document[FAQ]
34-
| *cleanSource* anchor:doc-freemarker-config-attributes-cleanSource[] | _boolean_ | _false_ | If set to 'true' the FreemarkerDocProcessConfig will try to clean the source (i.e. DocXmlUtils.cleanXml()). (since 8.9.1), NOTE: if active, source reader will be buffered, potentially resulting in higher memory usage. See also xref:#doc-faq-clean-source-document[FAQ]
32+
33+
| name
34+
| type
35+
| default
36+
| description
37+
38+
| *validating* anchor:doc-freemarker-config-attributes-validating[]
39+
| _boolean_
40+
| _false_
41+
| If set to 'true' the FreemarkerDocProcessConfig will try to validate the source. (since 8.9.1), NOTE: if active, source reader will be buffered, potentially resulting in higher memory usage. See also xref:#doc-faq-validate-document[FAQ].
42+
43+
| *failOnValidate* anchor:doc-freemarker-config-attributes-failOnValidate[]
44+
| _boolean_
45+
| _false_
46+
| If set to 'true' the FreemarkerDocProcessConfig will fail in case of validation errors, if 'false' will just print the result as warning. (since 8.9.1), NOTE: 'validating' is set to true, this attribute is ignored. See also xref:#doc-faq-validate-document[FAQ]
47+
48+
| *cleanSource* anchor:doc-freemarker-config-attributes-cleanSource[]
49+
| _boolean_
50+
| _false_
51+
| If set to 'true' the FreemarkerDocProcessConfig will try to clean the source (i.e. DocXmlUtils.cleanXml()). (since 8.9.1), NOTE: if active, source reader will be buffered, potentially resulting in higher memory usage. See also xref:#doc-faq-clean-source-document[FAQ]
52+
53+
| *table-check-integrity* anchor:doc-freemarker-config-attributes-table-check-integrity[]
54+
| _string_
55+
| _disabled_
56+
| Global default for 'table-check-integrity', it will check the integrity of a table, correct number of columns per row. (since 8.15.0) Allowed values : 'disabled' (default value), 'warn', 'fail'. NOTE: If set at info tag level on document, the global property is ignored. See
57+
xref:#doc-format-entry-point-extra-feature-table-check-integrity[table-check-integrity feature] for further information. (since 8.15.0)
58+
3559
|========================================================================================================================================
3660

3761
==== Element docHandlerConfig

0 commit comments

Comments
 (0)