docs(mespapiers): Add doc for ocrAttributes parameter to config file

cozy · Dec 14, 2023 · 56e2350 · 56e2350
1 parent 2d95154
commit 56e2350
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/packages/cozy-mespapiers-lib/docs/papersDefinitions.md b/packages/cozy-mespapiers-lib/docs/papersDefinitions.md
@@ -29,6 +29,22 @@
 
 ***
 
+## The `ocrAttributes` property:
+
+- `version`: {string} Version of the paper (e.g. "2020.01").
+- `ìllustration`: {string} Illustration of the choice of format displayed to the user.
+- `versionLabel`: {string} Translation key for the name of the format displayed to the user.
+  - `label`: {string} The discriminating label.
+  - `side`: {string} Side where the label is.
+- `front`: {object} All the front panel parameters allowing you to find the information to use.
+  - `referenceRules`: {object\[]} Rules that allow you to define the version of a paper.
+    - `regex`: {string} Regex that will be tested to deduce the paper version. (e.g. "^\[A-Z]")
+    - `[flag]`: {string} Regex flag (e.g. "/gi")
+- `[back]`: {object} All the front panel parameters allowing you to find the information to use.
+  - `referenceRules`: {object\[]} Rules that allow you to define the version of a paper.
+    - `regex`: {string} Regex that will be tested to deduce the paper version. (e.g. "^\[A-Z]")
+    - `[flag]`: {string} Regex flag (e.g. "/gi")
+
 ## Steps of the `acquisitionSteps` property:
 
 - ### Step `scan`: