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/3] 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/3] 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. From 7106da99cd2489eade9ff0b4e370d38b0a364924 Mon Sep 17 00:00:00 2001 From: Amro-Dynamsoft Date: Tue, 19 Aug 2025 10:37:03 -0700 Subject: [PATCH 3/3] release 3.0.1 (#32) * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * update to internal commit 20965a62 chore: fix .gitignore feat: GitHub preview CI workflow chore: fix whitespace, EOF newline, and styling fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Staging for v3 of MRZ Scanner (#15) * update to internal commit 20965a62 * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 --------- Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 * Staging (#17) * update to internal commit 20965a62 * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 --------- Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> * Added self-hosting instructions Also trrying to fix the versioning * Staging (#19) * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 * Added self-hosting instructions Also trrying to fix the versioning --------- Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Co-authored-by: Amro Anwer * License edit Also fixing versioning * Fixes Changing poisition of note and fixing the versioning issue * Staging (#23) * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * update to internal commit 20965a62 chore: fix .gitignore feat: GitHub preview CI workflow chore: fix whitespace, EOF newline, and styling fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Staging for v3 of MRZ Scanner (#15) * update to internal commit 20965a62 * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 --------- Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 * Staging (#17) * update to internal commit 20965a62 * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 --------- Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> * Added self-hosting instructions Also trrying to fix the versioning * Staging (#19) * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 * Added self-hosting instructions Also trrying to fix the versioning --------- Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Co-authored-by: Amro Anwer * License edit Also fixing versioning * Fixes Changing poisition of note and fixing the versioning issue --------- Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Co-authored-by: DMGithubPublisher Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent * Update product_version.yml * Staging (#24) * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * update to internal commit 20965a62 chore: fix .gitignore feat: GitHub preview CI workflow chore: fix whitespace, EOF newline, and styling fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Staging for v3 of MRZ Scanner (#15) * update to internal commit 20965a62 * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 --------- Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 * Staging (#17) * update to internal commit 20965a62 * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 --------- Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> * Added self-hosting instructions Also trrying to fix the versioning * Staging (#19) * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 * Added self-hosting instructions Also trrying to fix the versioning --------- Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Co-authored-by: Amro Anwer * License edit Also fixing versioning * Fixes Changing poisition of note and fixing the versioning issue * Update product_version.yml --------- Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Co-authored-by: DMGithubPublisher Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent * Update product_version.yml * Staging (#25) * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * update to internal commit 20965a62 chore: fix .gitignore feat: GitHub preview CI workflow chore: fix whitespace, EOF newline, and styling fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Staging for v3 of MRZ Scanner (#15) * update to internal commit 20965a62 * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 --------- Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 * Staging (#17) * update to internal commit 20965a62 * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 --------- Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> * Added self-hosting instructions Also trrying to fix the versioning * Staging (#19) * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 * Added self-hosting instructions Also trrying to fix the versioning --------- Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Co-authored-by: Amro Anwer * License edit Also fixing versioning * Fixes Changing poisition of note and fixing the versioning issue * Update product_version.yml * Update product_version.yml --------- Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Co-authored-by: DMGithubPublisher Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent * Update product_version.yml * Staging (#26) * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * update to internal commit 20965a62 chore: fix .gitignore feat: GitHub preview CI workflow chore: fix whitespace, EOF newline, and styling fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Staging for v3 of MRZ Scanner (#15) * update to internal commit 20965a62 * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 --------- Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 * Staging (#17) * update to internal commit 20965a62 * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 --------- Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> * Added self-hosting instructions Also trrying to fix the versioning * Staging (#19) * chore: fix .gitignore * feat: GitHub preview CI workflow * chore: fix whitespace, EOF newline, and styling * fix: formatting * v3 deployment All the docs have been updated to v3. What is left will be to fix the versioning for 2.0 and 2.1 * Fixes and versioning Mainly needed to address the mistakes as well as add versioning for 2.1 and 2.0 * Added self-hosting instructions Also trrying to fix the versioning --------- Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Co-authored-by: Amro Anwer * License edit Also fixing versioning * Fixes Changing poisition of note and fixing the versioning issue * Update product_version.yml * Update product_version.yml * Update product_version.yml --------- Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Co-authored-by: DMGithubPublisher Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent * Update product_version.yml * feat: add FAQ * 3.0.1 release update --------- Co-authored-by: dynamsoft-h <172081603+dynamsoft-h@users.noreply.github.com> Co-authored-by: DMGithubPublisher Co-authored-by: Amro Anwer Co-authored-by: DMGithubPublisher <65145280+DMGithubPublisher@users.noreply.github.com> Co-authored-by: Justin-Dynamsoft <33125453+a362758199@users.noreply.github.com> Co-authored-by: Tom Kent --- guides/mrz-scanner-static-image.md | 2 +- guides/mrz-scanner.md | 14 +++++++------- releasenotes/index.md | 7 +++++++ 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/guides/mrz-scanner-static-image.md b/guides/mrz-scanner-static-image.md index f27b8c3..89eeb5d 100644 --- a/guides/mrz-scanner-static-image.md +++ b/guides/mrz-scanner-static-image.md @@ -35,7 +35,7 @@ The first step in making the sample is to define the script references and the H Dynamsoft MRZ Scanner - Use File Input - + diff --git a/guides/mrz-scanner.md b/guides/mrz-scanner.md index ae5306b..f84ed41 100644 --- a/guides/mrz-scanner.md +++ b/guides/mrz-scanner.md @@ -49,21 +49,21 @@ The simplest way to include the SDK is to use either the [**jsDelivr**](https:// - jsDelivr ```html - + ``` - UNPKG ```html - + ``` When using a framework such as **React**, **Vue** or **Angular**, we recommend adding the package as a dependency using a package manager such as **npm** or **yarn**: ```sh - npm i dynamsoft-mrz-scanner@3.0.0 -E + npm i dynamsoft-mrz-scanner@3.0.1 -E # or - yarn add dynamsoft-mrz-scanner@3.0.0 -E + yarn add dynamsoft-mrz-scanner@3.0.1 -E ``` > [!WARNING] @@ -78,7 +78,7 @@ Below is the complete Hello World sample page that uses the precompiled script s Dynamsoft MRZ Scanner - Hello World - + @@ -160,7 +160,7 @@ The first step is to get a copy of the resources. There are two ways which you c - Go to the official [Github repository](https://github.com/Dynamsoft/mrz-scanner-javascript). Download the repository as a ZIP and the library resources are in the *dist* folder. So all you need is just a copy of this *dist* folder. -- If you are using `npm`, you could also install the package and extract the `dist` folder from the package in `node_modules`. Install the package using the command `npm i dynamsoft-mrz-scanner@3.0.0 -E`. Find the `dynamsoft-mrz-scanner` fodler in `node_modules` and the *dist* folder will be inside. +- If you are using `npm`, you could also install the package and extract the `dist` folder from the package in `node_modules`. Install the package using the command `npm i dynamsoft-mrz-scanner@3.0.1 -E`. Find the `dynamsoft-mrz-scanner` fodler in `node_modules` and the *dist* folder will be inside. ### Modify the Build Script @@ -244,7 +244,7 @@ Let's now go through the code of the Hello World sample to understand how the co Dynamsoft MRZ Scanner - Hello World - + diff --git a/releasenotes/index.md b/releasenotes/index.md index 84b5ab4..fc73659 100644 --- a/releasenotes/index.md +++ b/releasenotes/index.md @@ -12,6 +12,13 @@ permalink: /releasenotes/index.html # Release Notes +## 3.0.1 (08/06/2025) + +## Fixes + +- Fixed the file input process error when decoding static file input when `showResultView` is set to `false`. +- Resolved an issue with the `launch()` method throwing an error when there's a different error format thrown. + ## 3.0.0 (06/17/2025) ## Highlighted Features