From 574b66d49349acd31f376bd4220fd3663871c8fe Mon Sep 17 00:00:00 2001 From: h-dynamsoft <172081603+dynamsoft-h@users.noreply.github.com> Date: Tue, 15 Jul 2025 17:17:20 -0700 Subject: [PATCH 1/2] feat: add FAQ (#29) --- _data/full_tree.yml | 3 ++- _includes/sidelist-full-tree.html | 3 ++- index.md | 1 + 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/_data/full_tree.yml b/_data/full_tree.yml index 4dc8269..fab0c01 100644 --- a/_data/full_tree.yml +++ b/_data/full_tree.yml @@ -4,10 +4,11 @@ tree_file_list: - sidelist-introduction.html - sidelist-guides.html - sidelist-releasenotes.html + - sidelist-faq.html - sidelist-full-tree.html - sidelist-api-v1.1.html - sidelist-codegallery-v1.1.html - sidelist-introduction-v1.1.html - sidelist-guides-v1.1.html - sidelist-releasenotes-v1.1.html - - sidelist-full-tree-v1.1.html \ No newline at end of file + - sidelist-full-tree-v1.1.html diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html index f3b6807..1122e13 100644 --- a/_includes/sidelist-full-tree.html +++ b/_includes/sidelist-full-tree.html @@ -3,4 +3,5 @@ {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery.html" -%} {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-api.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes.html" -%} \ No newline at end of file +{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes.html" -%} +{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-faq.html" -%} diff --git a/index.md b/index.md index faab994..7e7f913 100644 --- a/index.md +++ b/index.md @@ -19,3 +19,4 @@ description: MRZ Scanner JavaScript Edition Documentation Homepage - [Code Gallery]({{ site.codegallery }}index.html) - [API Reference]({{ site.api }}index.html) - [Release Notes]({{ site.releasenotes }}index.html) +- [FAQ](/mrz-scanner/docs/web/faq/index.html) From f6040311973c180bafe4a14a8d3aa792da227076 Mon Sep 17 00:00:00 2001 From: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Date: Tue, 15 Jul 2025 17:24:30 -0700 Subject: [PATCH 2/2] feat: add FAQ --- _includes/sidelist-faq.html | 2 ++ faq/index.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 _includes/sidelist-faq.html create mode 100644 faq/index.md diff --git a/_includes/sidelist-faq.html b/_includes/sidelist-faq.html new file mode 100644 index 0000000..ea87492 --- /dev/null +++ b/_includes/sidelist-faq.html @@ -0,0 +1,2 @@ +
  • FAQ +
    • diff --git a/faq/index.md b/faq/index.md new file mode 100644 index 0000000..fa7c4ab --- /dev/null +++ b/faq/index.md @@ -0,0 +1,30 @@ +--- +layout: default-layout +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: false +title: MRZ Scanner JavaScript Edition - FAQ +keywords: Documentation, MRZ Scanner JavaScript Edition, FAQ, Frequently Asked Questions +breadcrumbText: FAQ +description: MRZ Scanner JavaScript Edition Documentation Frequently Asked Questions +permalink: /faq/index.html +--- + +# Frequently Asked Questions + +1. [Can the MRZ Scanner process static images, or does it only work with live cameras?](#can-the-mrz-scanner-process-static-images-or-does-it-only-work-with-live-cameras) +2. [Does MRZ Scanner perform data validation?](#does-the-mrz-scanner-perform-data-validation) +3. [How do I use the scanned result?](#how-do-i-use-the-scanned-result) + +## Can the MRZ Scanner process static images, or does it only work with live cameras? + +Yes, the MRZ Scanner can read from static images and image files, along with the typical use case of scanning from a live camera feed. + +## Does the MRZ Scanner perform data validation? + +**No**. MRZ Scanner JavaScript Edition performs all image capture, image enhancement, and MRZ parsing on-device, to give you full control of your data. The MRZ Scanner processes the data on the client device without passing the data to external servers. Your application must implement data validation on the decoded MRZ data after reading with the MRZ Scanner if your use case requires data validation. + + +## How do I use the scanned result? + +The simplest implementation uses the default UI and does not take action after scanning. You can customize the behavior by handling callbacks provided by the API. The [`launch()`]({{ site.api }}mrz-scanner.html#launch) method returns the scanned result as the type [`MRZResult`]({{ site.api }}mrz-scanner.html#mrzresult), which includes the image of the document, as well as the parsed MRZ data separated into fields.