Merge branch 'preview' of https://github.com/dynamsoft-docs/capture-vision-docs-js into preview

Author: Justin-dynamsoft

programming/javascript/api-reference/capture-vision-router/interfaces/captured-result.md

@@ -2,7 +2,7 @@
 layout: default-layout
 title: Interface CapturedResult - Dynamsoft Capture Vision Router Module JS Edition API Reference
 description: This page shows the JS edition of the interface CapturedResult in Dynamsoft Capture Vision Router Module.
-keywords: captured result, JS
+keywords: captured result, JS, capture vision
 needAutoGenerateSidebar: true
 needGenerateH3Content: true
 noTitleIndex: true
@@ -49,4 +49,4 @@ An array of [ProcessedDocumentResultItem]({{ site.ddn_js_api }}interfaces/proces
 
 ## parsedResultItems
 
-An array of [ParsedResultItem]({{ site.dcp_js_api }}interfaces/parsed-result-item.html) objects representing the parsed result items.
+An array of [ParsedResultItem]({{ site.dcp_js_api }}interfaces/parsed-result-item.html) objects representing the parsed result items.

programming/javascript/api-reference/capture-vision-router/multiple-image-processing.md

@@ -236,6 +236,10 @@ resultReceiver.onCapturedResultReceived = (result) => {
 router.addResultReceiver(resultReceiver);
 ```
 
+**See also**
+
+[CapturedResultReceiver](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/capture-vision-router/captured-result-receiver.html)
+
 ## removeResultReceiver
 
 Removes the specified `CapturedResultReceiver` object.
@@ -267,6 +271,10 @@ router.addResultReceiver(resultReceiver);
 router.removeResultReceiver(resultReceiver);
 ```
 
+**See also**
+
+[CapturedResultReceiver](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/capture-vision-router/captured-result-receiver.html)
+
 ## addResultFilter
 
 Adds a `MultiFrameResultCrossFilter` object to filter non-essential results.
@@ -297,7 +305,7 @@ router.addResultFilter(filter);
 
 **See also**
 
-[MultiFrameResultCrossFilter](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/utility/multi-frame-result-cross-filter.html?product=ddn&repoType=web)
+[MultiFrameResultCrossFilter](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/utility/multi-frame-result-cross-filter.html)
 
 ## removeResultFilter
 
@@ -412,4 +420,4 @@ await router.switchCapturingTemplate("ReadBarcodes_ReadRateFirst");
 
 **Remarks**
 
-Introduced in Dynamsoft Barcode Reader Bundle version 11.2.2000 and Dynamsoft Capture Vision Bundle version 3.2.2000.
+Introduced in Dynamsoft Barcode Reader Bundle version 11.2.2000 and Dynamsoft Capture Vision Bundle version 3.2.2000.

programming/javascript/faq/app-switching-issue.md

@@ -0,0 +1,33 @@
+---
+layout: default-layout
+title: How can I prevent my browser from freezing or showing a grey screen when I switch between apps and return to it?
+keywords: Dynamsoft Barcode Reader, FAQ, tech basic, frozen screen, grey screen
+description: How can I prevent my browser from freezing or showing a grey screen when I switch between apps and return to it?
+needAutoGenerateSidebar: false
+---
+
+# How can I prevent my browser from freezing or showing a grey screen when I switch between apps and return to it?
+
+[<< Back to FAQ index](index.md)
+
+When using the camerenhancer sdk, you may encounter an issue where switching to another app and then returning to the browser results in a frozen or grey screen. To address this, utilize a workaround in the form of the following code snippet:
+
+```javascript
+window.addEventListener("visibilitychange", () => {
+    if (document.visibilityState === "hidden") {
+        if (router && cameraEnhancer) {
+            router.stopCapturing().then(() => {
+                cameraEnhancer.close();
+            });
+        }
+    } else if (document.visibilityState === "visible") {
+        if (router && cameraEnhancer) {
+            cameraEnhancer.open().then(status => {
+                router.startCapturing("DetectDocumentBoundaries_Default");
+            });
+        }
+    }
+});
+```
+
+This code essentially closes the camera and releases associated resources when the user exits the browser. It then reopens the camera when the user returns to the browser, ensuring a smoother experience.

programming/javascript/faq/index.md

@@ -0,0 +1,15 @@
+---
+layout: default-layout
+title: JavaScript - Dynamsoft Capture Vision FAQ
+keywords: faq, javascript, dcv
+description: Dynamsoft Capture Vision FAQ - JavaScript
+needAutoGenerateSidebar: false
+permalink: /faq/index.html
+
+---
+
+# FAQ - JavaScript
+
+1. [How can I prevent my browser from freezing or showing a grey screen when I switch between apps and return to it?](app-switching-issue.html)
+
+2. [Why am I encountering errors like "r.taskSet.intermediateResultUnits is not iterable" when using frameworks like React or Angular with Dynamsoft packages?](version-mismatch.html)

programming/javascript/faq/version-mismatch.md

@@ -0,0 +1,47 @@
+---
+layout: default-layout
+title: Why am I encountering errors like "r.taskSet.intermediateResultUnits is not iterable" when using frameworks like React or Angular with Dynamsoft packages?
+keywords: Dynamsoft Capture Vision, FAQ, version, mismatch, taskset
+description: Why am I encountering errors like "r.taskSet.intermediateResultUnits is not iterable" when using frameworks like React or Angular with Dynamsoft packages?
+needAutoGenerateSidebar: false
+---
+
+# Why am I encountering errors like "r.taskSet.intermediateResultUnits is not iterable" when using frameworks like React or Angular with Dynamsoft packages?
+
+[<< Back to FAQ index](index.md)
+
+Topic: Resolving Version Mismatch Issues in Dynamsoft Packages
+
+Resolution:
+
+When using a framework like React or Angular with Dynamsoft packages, it's crucial to ensure that the version number of each Dynamsoft package listed in the `package.json` file matches the version number defined in the `engineResourcePaths` generally found defined in the cvr.ts file if you have followed the samples for developement.
+
+In the `engineResourcePaths` configuration, make sure to include the correct version numbers for each Dynamsoft package mentioned in `package.json`. Here's an example of how to define the engineResourcePaths with the correct version numbers:
+
+```javascript
+Dynamsoft.Core.CoreModule.engineResourcePaths = {
+  std: "https://cdn.jsdelivr.net/npm/dynamsoft-capture-vision-std@<std_version>/dist/",
+  dip: "https://cdn.jsdelivr.net/npm/dynamsoft-image-processing@<dip_version>/dist/",
+  core: "https://cdn.jsdelivr.net/npm/dynamsoft-core@<core_version>/dist/",
+  license: "https://cdn.jsdelivr.net/npm/dynamsoft-license@<license_version>/dist/",
+  cvr: "https://cdn.jsdelivr.net/npm/dynamsoft-capture-vision-router@<cvr_version>/dist/",
+  dbr: "https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader@<dbr_version>/dist/",
+  dce: "https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@<dce_version>/dist/"
+};
+```
+Replace <std_version>, <dip_version>, <core_version>, <license_version>, <cvr_version>, <dbr_version>, and <dce_version> with the appropriate version numbers corresponding to each Dynamsoft package.
+
+```javascript
+//some lines from package.json
+"dependencies": {
+...
+  "dynamsoft-barcode-reader": "<dbr_version>",
+  "dynamsoft-camera-enhancer": "<dce_version>",
+  "dynamsoft-capture-vision-router": "<cvr_version>",
+  "dynamsoft-core": "<core_version>",
+  "dynamsoft-license": "<license_version>",
+  "dynamsoft-utility": "<utility_version>",
+}
+```
+
+By following these steps and maintaining consistency in version numbers between `package.json` and `engineResourcePaths`, you can mitigate version mismatch errors and ensure the proper functioning of Dynamsoft packages within your framework-based application.

programming/javascript/index.md

@@ -59,4 +59,4 @@ This documentation assumes familiarity with the [Architecture of Dynamsoft Captu
 
 ## Contact Us
 
-Feel free to <a href = "https://www.dynamsoft.com/company/customer-service/#contact" target = "_blank">contact us</a> if you have any questions.
+Feel free to <a href = "https://www.dynamsoft.com/company/customer-service/#contact" target = "_blank">contact us</a> if you have any questions.

programming/javascript/user-guide/mrz-scanner.md

@@ -6,6 +6,7 @@ keywords: JavaScript, scan mrz, read mrz, scan passport, read passport, scan id
 needAutoGenerateSidebar: true
 needGenerateH3Content: true
 noTitleIndex: true
+ignore: true
 ---
 
 # MRZ Scanner Solution for Your Website - User Guide
@@ -169,6 +170,8 @@ Dynamsoft.License.LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMD
 
 The key "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" used in this solution (found in the js/init.js file) is a test license valid for 24 hours for any newly authorized browser. If you wish to test the SDK further, you can request a 30-day free trial license through the <a href="https://www.dynamsoft.com/customer/license/trialLicense?product=mrz&utm_source=docs&package=js" target="_blank">Request a Trial License</a> link.
 
+If you have already requested a trial license, please check your email for a message with the subject line "Your MRZ Scanner trial licenses."
+
 #### Load resources in advance
 
 To optimize image processing in a web environment, the algorithms are compiled into WebAssembly modules (files with a .wasm extension). These modules can be quite large, but the SDK can preload them asynchronously to enhance the user experience. For better performance, we recommend using [`loadWasm()`](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/core-module-class.html#loadwasm) to preload the necessary libraries. Since this solution uses DCE, DLR, and DCP, only the relevant resources need to be preloaded (no need to preload .wasm resources for DCE).