feat: add faq for mrz

lyzhang0113 · lyzhang0113 · commit 6dccc5ac41c6 · 2025-08-05T17:13:46.000+08:00
diff --git a/general/index.md b/general/index.md
@@ -1,15 +1,15 @@
 ---
 layout: default-layout
-title: General FAQ - Dynamsoft Barcode Reader FAQ
+title: General FAQ
 keywords: faq, general, dbr, dynamsoft, barcode reader
-description: Dynamsoft Barcode Reader FAQ - General
+description: Dynamsoft Capture Vision FAQ - General
 needAutoGenerateSidebar: false
 noTitleIndex: true
 ---
 
-# Dynamsoft Barcode Reader General FAQ
+# General FAQ
 
-Welcome to the FAQ for Dynamsoft Barcode Reader. Use the links below to find answers to common questions and configuration guidance.
+Please use the links below to find answers to common questions and configuration guidance.
 
 - [How to avoid incorrect barcode results?](avoid-incorrect-barcode-results.html)
 - [How to filter incorrect results with the barcode result length?](avoid-incorrect-results.html)
diff --git a/license/index.md b/license/index.md
@@ -1,15 +1,15 @@
 ---
 layout: default-layout
-title: License FAQ - Dynamsoft Barcode Reader FAQ
+title: License FAQ
 keywords: faq, license, dbr, dynamsoft, barcode reader, configuration
-description: Dynamsoft Barcode Reader FAQ - License
+description: Dynamsoft Capture Vision FAQ - License
 needAutoGenerateSidebar: false
 noTitleIndex: true
 ---
 
-# Dynamsoft Barcode Reader General FAQ
+# License FAQ
 
-Welcome to the FAQ for Dynamsoft Barcode Reader License. Use the links below to find answers to common questions and configuration guidance.
+Please use the links below to find answers to common questions and configuration guidance.
 
 - [Does DBR support PDF?](dbr-supports-pdf.html)
 - [How to ensure no overuse of license?](ensure-no-overuse.html)
diff --git a/mrz-scanner/data-validation.md b/mrz-scanner/data-validation.md
@@ -0,0 +1,20 @@
+---
+layout: default-layout
+title: Data Validation of Decoded Results - MRZ Scanner JS FAQs
+keywords: Dynamsoft MRZ Scanner, FAQ, MRZ, validation, check digit, client-side, decoded results
+description: Does the MRZ Scanner perform any data validation on the decoded results? - MRZ Scanner JS FAQs.
+needAutoGenerateSidebar: true
+---
+
+# Does the MRZ Scanner perform any data validation on the decoded results?
+
+[<< Back to FAQ index](index.md)
+
+No. The Dynamsoft MRZ Scanner performs image capture, enhancement, and MRZ parsing entirely on the client device, but it **does not validate** the decoded fields or their contents. 
+
+If your workflow requires additional validation (such as verifying check digits), your application must implement these checks after obtaining the parsed MRZ data.
+
+---
+
+> 💡 **Note**:  
+> Validation logic (e.g., for check digits or document integrity) should be implemented by your application as needed.
diff --git a/mrz-scanner/does-mrz-orientation-matter.md b/mrz-scanner/does-mrz-orientation-matter.md
@@ -0,0 +1,25 @@
+---
+layout: default-layout
+title: MRZ Code Orientation - MRZ Scanner JS FAQs
+keywords: Dynamsoft MRZ Scanner, FAQ, MRZ, orientation, rotated code, readability
+description: Does the orientation of the MRZ code matter? - MRZ Scanner JS FAQs.
+needAutoGenerateSidebar: true
+---
+
+# Does the orientation of the MRZ code matter?
+
+[<< Back to FAQ index](index.md)
+
+Yes. The MRZ code must be presented in the correct orientation—just like regular readable text. Rotated MRZ codes are **not** supported by the scanner.
+
+---
+
+| **Requirement**           | **Supported** |
+|--------------------------|:-------------:|
+| Correct orientation      | Yes           |
+| Rotated orientation      | No            |
+
+---
+
+> 💡 **Note**:  
+> Always ensure the MRZ code is upright and aligned properly to guarantee reliable scanning and accurate results.
diff --git a/mrz-scanner/editing-results.md b/mrz-scanner/editing-results.md
@@ -0,0 +1,36 @@
+---
+layout: default-layout
+title: Editing Parsed MRZ Results - MRZ Scanner JS FAQs
+keywords: Dynamsoft MRZ Scanner, FAQ, edit MRZ result, allowResultEditing, MRZResultViewConfig, result correction
+description: Can users edit the parsed MRZ results? - MRZ Scanner JS FAQs.
+needAutoGenerateSidebar: true
+---
+
+# Can users edit the parsed MRZ results?
+
+[<< Back to FAQ index](index.md)
+
+Yes. The [`MRZResultViewConfig`](https://www.dynamsoft.com/mrz-scanner/docs/web/api/mrz-scanner.html#mrzresultviewconfig) interface includes an `allowResultEditing` property (default: `false`) that enables editing of the parsed MRZ fields. When set to `true`, the result view will display the MRZ data in an editable format, allowing users to correct any errors before proceeding.
+
+For example, to allow result editing:
+
+```js
+const mrzScanner = new Dynamsoft.MRZScanner({
+    license: "YOUR_LICENSE_KEY",
+    resultViewConfig: {
+        allowResultEditing: true, // default: false
+        showOriginalImage: true, // default: true
+    }
+});
+````
+
+---
+
+| **Feature**       | **Property**         | **Default** |
+| ----------------- | -------------------- | ----------- |
+| Allow result edit | `allowResultEditing` | `false`     |
+
+---
+
+> 💡 **Note**:
+> You may choose to allow the user to edit the result fields after cross-checking them with the info present on the document itself by displaying the original document with `showOriginalImage: true`.
diff --git a/mrz-scanner/handling-results.md b/mrz-scanner/handling-results.md
@@ -0,0 +1,39 @@
+---
+layout: default-layout
+title: Handling Scanned Results - MRZ Scanner JS FAQs
+keywords: Dynamsoft MRZ Scanner, FAQ, handle result, onDone, resultViewConfig, MRZResult, callback
+description: How do I handle the scanned results in my application? - MRZ Scanner JS FAQs.
+needAutoGenerateSidebar: true
+---
+
+# How do I handle the scanned results in my application?
+
+[<< Back to FAQ index](index.md)
+
+To handle scanned results, provide an `onDone` callback within [`MRZResultViewConfig`](https://www.dynamsoft.com/mrz-scanner/docs/web/api/mrz-scanner.html#mrzresultviewconfig). When the user clicks the Done button, your callback receives an [`MRZResult`](https://www.dynamsoft.com/mrz-scanner/docs/web/api/mrz-scanner.html#mrzresult) object, which includes status codes, the parsed data, and an image of the MRZ. Your application can then process the fields as needed, such as logging or submitting data.
+
+For example, to log the first name and status code:
+
+```js
+const mrzScanner = new Dynamsoft.MRZScanner({
+    license: "YOUR_LICENSE_KEY",
+    resultViewConfig: {
+        onDone: (result) => {
+            // result: MRZResult
+            console.log("First name:", result.data.firstName);
+            console.log("Status code:", result.status.code);
+        }
+    }
+});
+````
+
+---
+
+| **Callback** | **Location**       | **Description**                                  |
+| ------------ | ------------------ | ------------------------------------------------ |
+| `onDone`     | `resultViewConfig` | Called when user clicks Done; receives MRZResult |
+
+---
+
+> 💡 **Note**:
+> The `MRZResult` object provides the decoded fields, the scan status, and the captured MRZ image. You can implement custom workflows or validation based on these values.
diff --git a/mrz-scanner/index.md b/mrz-scanner/index.md
@@ -0,0 +1,24 @@
+---
+layout: default-layout
+title: MRZ Scanner FAQ
+keywords: faq, license, mrz, dynamsoft, mrz scanner, configuration
+description: Dynamsoft MRZ Scanner FAQ
+needAutoGenerateSidebar: false
+noTitleIndex: true
+---
+
+# MRZ Scanner FAQ
+
+Please use the links below to find answers to common questions and configuration guidance.
+
+- [What MRZ formats does the Dynamsoft MRZ Scanner support?](mrz-formats-supported.html)
+- [Does the MRZ Scanner require HTTPS, and which browsers are supported?](is-https-required.html)
+- [Can the MRZ Scanner process static images or PDFs, or does it only work with a live camera? ](static-image-and-pdf-support.html)
+- [Does the MRZ Scanner perform any data validation on the decoded results?](data-validation.html)
+- [How do I restrict scanning to specific document types (e.g., only passports)?](restrict-to-specific-document-types.html)
+- [How can I customize the scanner UI (hide the scan guide, format selector, upload button, etc.)?](ui-customization.html)
+- [Can users edit the parsed MRZ results?](editing-results.html)
+- [How do I handle the scanned results in my application?](handling-results.html)
+- [Are there any performance options to improve accuracy or speed?](performance-optimization.html)
+- [What is the recommended font height to ensure reliable MRZ readability?](recommended-font-height.html)
+- [Does the orientation of the MRZ code matter?](does-mrz-orientation-matter.html)
diff --git a/mrz-scanner/is-https-required.md b/mrz-scanner/is-https-required.md
@@ -0,0 +1,31 @@
+---
+layout: default-layout
+title: HTTPS Requirement and Browser Support - MRZ Scanner JS FAQs
+keywords: Dynamsoft MRZ Scanner, FAQ, HTTPS, browser support, secure context, WebAssembly, Chrome, Firefox, Safari, Edge
+description: Does the Dynamsoft MRZ Scanner require HTTPS and which browsers are supported? - MRZ Scanner JS FAQs.
+needAutoGenerateSidebar: true
+---
+
+# Does the MRZ Scanner require HTTPS, and which browsers are supported?
+
+[<< Back to FAQ index](index.md)
+
+Yes. The Dynamsoft MRZ Scanner JavaScript edition requires your application to be served over **HTTPS** due to browser restrictions on camera access and licensing requirements. The only exceptions are `localhost` and local file paths during development.
+
+In addition, the scanner depends on several modern browser features, including **WebAssembly**, **Blob**, **URL/createObjectURL**, and **Web Workers**.
+
+---
+
+## Supported Browsers
+
+| **Browser**  | **Minimum Version** |
+|--------------|---------------------|
+| Chrome       | 78                  |
+| Firefox      | 79                  |
+| Safari       | 15                  |
+| Edge         | 92                  |
+
+---
+
+> 💡 **Note**:  
+> Camera access and licensing will not function in unsecured (HTTP) environments. For production deployments, always use HTTPS.
diff --git a/mrz-scanner/mrz-formats-supported.md b/mrz-scanner/mrz-formats-supported.md
@@ -0,0 +1,28 @@
+---
+layout: default-layout
+title: Supported MRZ Formats - MRZ Scanner JS FAQs
+keywords: Dynamsoft MRZ Scanner, FAQ, MRZ, Machine Readable Zone, ICAO, TD1, TD2, TD3, passport, ID
+description: What MRZ formats does the Dynamsoft MRZ Scanner support? - MRZ Scanner JS FAQs.
+needAutoGenerateSidebar: true
+---
+
+# What MRZ formats does the Dynamsoft MRZ Scanner support?
+
+[<< Back to FAQ index](index.md)
+
+The Dynamsoft MRZ Scanner JavaScript edition follows the ICAO (International Civil Aviation Organization) Machine Readable Travel Documents (MRTD) standard and supports three major MRZ (Machine Readable Zone) formats:
+
+---
+
+| **Document Type**            | **Format**                      | **Description**                               |
+|------------------------------|----------------------------------|-----------------------------------------------|
+| **Passport (TD3)**           | 2 lines × 44 characters each     | Standard for passports                        |
+| **ID Card (TD1)**            | 3 lines × 30 characters each     | Used by many national ID cards                |
+| **ID Card (TD2)**            | 2 lines × 36 characters each     | Used by some national ID cards and visas      |
+
+---
+
+These formats cover the MRZ for passports and most national ID cards worldwide.
+
+> 💡 **Note**:  
+> The MRZ Scanner is designed to recognize MRZ zones that conform to the ICAO specifications for TD1, TD2, and TD3 document types.
diff --git a/mrz-scanner/performance-optimization.md b/mrz-scanner/performance-optimization.md
@@ -0,0 +1,35 @@
+---
+layout: default-layout
+title: Performance Options for Accuracy and Speed - MRZ Scanner JS FAQs
+keywords: Dynamsoft MRZ Scanner, FAQ, performance, accuracy, speed, multi frame cross filter, enableMultiFrameCrossFilter
+description: Are there any performance options to improve accuracy or speed? - MRZ Scanner JS FAQs.
+needAutoGenerateSidebar: true
+---
+
+# Are there any performance options to improve accuracy or speed?
+
+[<< Back to FAQ index](index.md)
+
+Yes. The scanner uses a multi-frame result cross filter to enhance accuracy. This filter is enabled by default, which helps reduce recognition errors by cross-verifying results across multiple frames. In [`MRZScannerViewConfig`](https://www.dynamsoft.com/mrz-scanner/docs/web/api/mrz-scanner.html#mrzscannerviewconfig), you can disable it to increase scanning speed, though this may slightly reduce accuracy.
+
+To disable the cross filter:
+
+```js
+const mrzScanner = new Dynamsoft.MRZScanner({
+    license: "YOUR_LICENSE_KEY",
+    scannerViewConfig: {
+        enableMultiFrameCrossFilter: false // default: false
+    }
+});
+````
+
+---
+
+| **Option**                  | **Property**                  | **Default** | **Effect**                                      |
+| --------------------------- | ----------------------------- | ----------- | ----------------------------------------------- |
+| Multi-frame cross filtering | `enableMultiFrameCrossFilter` | `false`      | Improves accuracy; disabling may increase speed |
+
+---
+
+> 💡 **Note**:
+> Disabling multi-frame cross filtering can make scanning faster, but may increase the risk of recognition errors.
diff --git a/mrz-scanner/readme.md b/mrz-scanner/readme.md
diff --git a/mrz-scanner/recommended-font-height.md b/mrz-scanner/recommended-font-height.md
@@ -0,0 +1,24 @@
+---
+layout: default-layout
+title: Recommended Font Height for MRZ Readability - MRZ Scanner JS FAQs
+keywords: Dynamsoft MRZ Scanner, FAQ, MRZ, font height, character size, readability, accuracy
+description: What is the recommended font height to ensure reliable MRZ readability? - MRZ Scanner JS FAQs.
+needAutoGenerateSidebar: true
+---
+
+# What is the recommended font height to ensure reliable MRZ readability?
+
+[<< Back to FAQ index](index.md)
+
+The recommended font height for MRZ (Machine Readable Zone) characters is **greater than 20 pixels**. Using MRZ fonts at this size or larger helps ensure optimal readability and scanning accuracy.
+
+---
+
+| **Parameter**      | **Recommended Value** |
+|--------------------|----------------------|
+| MRZ Font Height    | > 20 pixels          |
+
+---
+
+> 💡 **Note**:  
+> Using MRZ characters smaller than 20 pixels in height may lead to reduced scanning reliability and accuracy.
diff --git a/mrz-scanner/restrict-to-specific-document-types.md b/mrz-scanner/restrict-to-specific-document-types.md
@@ -0,0 +1,36 @@
+---
+layout: default-layout
+title: Restricting Scanning to Specific Document Types - MRZ Scanner JS FAQs
+keywords: Dynamsoft MRZ Scanner, FAQ, restrict document type, passport only, MRZScannerConfig, mrzFormatType
+description: How do I restrict scanning to specific document types (e.g., only passports)? - MRZ Scanner JS FAQs.
+needAutoGenerateSidebar: true
+---
+
+# How do I restrict scanning to specific document types (e.g., only passports)?
+
+[<< Back to FAQ index](index.md)
+
+You can restrict the Dynamsoft MRZ Scanner to only scan specific document types by setting the `mrzFormatType` property of [`MRZScannerConfig`](https://www.dynamsoft.com/mrz-scanner/docs/web/api/mrz-scanner.html#mrzscannerconfig). Specify an array of formats to limit scanning. For example, to allow only passports (TD3) and TD1 ID cards:
+
+```js
+const mrzScanner = new Dynamsoft.MRZScanner({
+    license: "YOUR_LICENSE_KEY",
+    mrzFormatType: ["passport", "td1"]
+});
+````
+
+When only a single format is specified, the format selector UI will not appear.
+
+---
+
+| **Format**     | **Value**  |
+| -------------- | ---------- |
+| Passport (TD3) | "passport" |
+| ID Card (TD1)  | "td1"      |
+| ID Card (TD2)  | "td2"      |
+
+---
+
+> 💡 **Note**:
+> Limiting the format enhances user experience and accuracy by hiding the format selector UI when only one format is allowed.
+
diff --git a/mrz-scanner/static-image-and-pdf-support.md b/mrz-scanner/static-image-and-pdf-support.md
@@ -0,0 +1,30 @@
+---
+layout: default-layout
+title: Static Image and PDF Support - MRZ Scanner JS FAQs
+keywords: Dynamsoft MRZ Scanner, FAQ, static images, PDF, camera, server, desktop, JavaScript, mobile
+description: Can the MRZ Scanner process static images or PDFs, or does it only work with a live camera? - MRZ Scanner JS FAQs.
+needAutoGenerateSidebar: true
+---
+
+# Can the MRZ Scanner process static images or PDFs, or does it only work with a live camera?
+
+[<< Back to FAQ index](index.md)
+
+All editions of the Dynamsoft MRZ Scanner (server/desktop, mobile, and JavaScript) support scanning **static image files** in addition to live camera capture.
+
+However, **only the server and desktop editions support direct PDF processing**. The JavaScript and mobile editions do **not** natively support PDF files; if you need to process a PDF in these editions, you must first convert the PDF into image files using an external tool or library.
+
+---
+
+| **Edition**        | **Static Images** | **PDF Files**     | **Live Camera** |
+|--------------------|:----------------:|:-----------------:|:---------------:|
+| Server/Desktop     | Yes              | Yes               | —               |
+| Mobile             | Yes              | No<sup>†</sup>    | Yes             |
+| JavaScript         | Yes              | No<sup>†</sup>    | Yes             |
+
+<sup>†</sup> *PDF files must be converted to images for use with Mobile and JavaScript editions.*
+
+---
+
+> 💡 **Note**:  
+> If you require PDF processing in the JavaScript or mobile edition, use an external converter to transform PDFs into image formats supported by the MRZ Scanner.
diff --git a/mrz-scanner/ui-customization.md b/mrz-scanner/ui-customization.md
