Merge pull request #74 from dynamsoft-docs/preview

DMGithubPublisher · web-flow · commit 9a687d2aae13 · 2025-05-06T02:13:33.000-07:00
Preview
diff --git a/_includes/sidelist-programming/programming-cpp.html b/_includes/sidelist-programming/programming-cpp.html
@@ -254,14 +254,23 @@
         </li>
         <li><a>DynamsoftUtility</a>
             <ul>
-                <li><a href="{{ site.dcvb_cpp_api }}utility/directory-fetcher.html" class="otherLinkColour">CDirectoryFetcher</a></li>
-                <li><a href="{{ site.dcvb_cpp_api }}utility/file-fetcher.html" class="otherLinkColour">CFileFetcher</a></li>
-                <li><a href="{{ site.dcvb_cpp_api }}utility/image-io.html" class="otherLinkColour">CImageIO</a></li>
-                <li><a href="{{ site.dcvb_cpp_api }}utility/image-processor.html" class="otherLinkColour">CImageProcessor</a></li>
-                <li><a href="{{ site.dcvb_cpp_api }}utility/image-drawer.html" class="otherLinkColour">CImageDrawer</a></li>
-                <li><a href="{{ site.dcvb_cpp_api }}utility/multi-frame-result-cross-filter.html" class="otherLinkColour">CMultiFrameResultCrossFilter</a></li>
-                <li><a href="{{ site.dcvb_cpp_api }}utility/proactive-image-source-adapter.html" class="otherLinkColour">CProactiveImageSourceAdapter</a></li>
-                <li><a href="{{ site.dcvb_cpp_api }}utility/utility-module.html" class="otherLinkColour">CUtilityModule</a></li>
+                <li><a>Classes</a>
+                    <ul>
+                        <li><a href="{{ site.dcvb_cpp_api }}utility/directory-fetcher.html" class="otherLinkColour">CDirectoryFetcher</a></li>
+                        <li><a href="{{ site.dcvb_cpp_api }}utility/file-fetcher.html" class="otherLinkColour">CFileFetcher</a></li>
+                        <li><a href="{{ site.dcvb_cpp_api }}utility/image-io.html" class="otherLinkColour">CImageIO</a></li>
+                        <li><a href="{{ site.dcvb_cpp_api }}utility/image-processor.html" class="otherLinkColour">CImageProcessor</a></li>
+                        <li><a href="{{ site.dcvb_cpp_api }}utility/image-drawer.html" class="otherLinkColour">CImageDrawer</a></li>
+                        <li><a href="{{ site.dcvb_cpp_api }}utility/multi-frame-result-cross-filter.html" class="otherLinkColour">CMultiFrameResultCrossFilter</a></li>
+                        <li><a href="{{ site.dcvb_cpp_api }}utility/proactive-image-source-adapter.html" class="otherLinkColour">CProactiveImageSourceAdapter</a></li>
+                        <li><a href="{{ site.dcvb_cpp_api }}utility/utility-module.html" class="otherLinkColour">CUtilityModule</a></li>
+                    </ul>
+                </li>
+                <li><a>Enums</a>
+                    <ul>
+                        <li><a href="{{ site.dcvb_cpp_api }}utility/enum-filter-type.html" class="otherLinkColour">FilterType</a></li>
+                    </ul>
+                </li>
             </ul>
         </li>
         <li><a>DynamsoftLicense</a>
diff --git a/programming/cplusplus/user-guide/document-scanner.md b/programming/cplusplus/user-guide/document-scanner.md
@@ -19,7 +19,8 @@ In this guide, you will learn step by step on how to build a document scanner so
       - [For Windows](#for-windows)
       - [For Linux](#for-linux)
     - [Include the Library](#include-the-library)
-    - [Initialize a Capture Vision Router Instance](#initialize-a-capture-vision-router-instance)
+    - [Initialize the License Key](#initialize-the-license-key)
+    - [Create a CaptureVisionRouter Instance](#create-a-capturevisionrouter-instance)
     - [Detect and Save the Normalized Document](#detect-and-save-the-normalized-document)
     - [Release the Allocated Memory](#release-the-allocated-memory)
     - [Build and Run the Project](#build-and-run-the-project)
@@ -34,12 +35,14 @@ To find out whether your environment is supported, please read the [System Requi
 
 If you haven't downloaded the SDK yet, <a href="https://download2.dynamsoft.com/dcv/dynamsoft-capture-vision-cpp-3.0.1000.250304.zip" target="_blank">download the `C/C++ Package`</a> now and unpack the package into a directory of your choice.
 
+> [!IMPORTANT]
 > For this tutorial, we unpack it to a pseudo directory `[INSTALLATION FOLDER]`, change it to your unpacking path for the following content.
 
 ## Build Your Own Application
 
 In this section, we'll walk through the key steps needed to build an application that capture a document from an image file.
 
+> [!TIP]
 >You can download the complete source code from [here](https://github.com/Dynamsoft/capture-vision-cpp-samples/tree/main/Samples/DocumentScanner).
 
 ### Create A New Project
@@ -86,7 +89,8 @@ In this section, we'll walk through the key steps needed to build an application
         rm -f $(OBJECT) $(TARGET) -r $(DS_LIB_PATH)/Templates
     ```
 
-    >Note: The variable `DS_LIB_PATH` should be set to the correct directory where the library files are located. 
+    > [!IMPORTANT]
+    > The variable `DS_LIB_PATH` should be set to the correct directory where the library files are located. 
 
 ### Include the Library
 
@@ -120,32 +124,36 @@ In this section, we'll walk through the key steps needed to build an application
     #endif
     ```
 
-### Initialize a Capture Vision Router Instance
+### Initialize the License Key
 
-1. Initialize the license key
+If this is your first time using the library, you will need to obtain a trial license key. We recommend getting your own 30-day trial license through the following modal:
 
-    ```cpp
-    int errorcode = 0;
-    char error[512];
-    errorcode = CLicenseManager::InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", error, 512);
-    if (errorcode != ErrorCode::EC_OK && errorcode != ErrorCode::EC_LICENSE_CACHE_USED)
-    {
-        cout << "License initialization failed: ErrorCode: " << errorcode << ", ErrorString: " << error << endl;
-    }
-    else
-    {
-        // codes from following steps...
-    }
-    ```
+{% include trialLicense.html %}
 
-    >Note:
-    > The string "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" here is a free public trial license. Note that network connection is required for this license to work. When it expires, you can request a 30-day free trial license from the <a href="https://www.dynamsoft.com/customer/license/trialLicense?utm_source=guide&product=dcv&package=c_cpp" target="_blank">Customer Portal</a>.
+Open the `DocumentScanner.cpp` file and add the following code inside the `Main` method to initialize the license for using the SDK in the application:
 
-2. Create an instance of Dynamsoft Capture Vision Router
+```cpp
+int errorcode = 0;
+char error[512];
+errorcode = CLicenseManager::InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", error, 512);
+if (errorcode != ErrorCode::EC_OK && errorcode != ErrorCode::EC_LICENSE_CACHE_USED)
+{
+    cout << "License initialization failed: ErrorCode: " << errorcode << ", ErrorString: " << error << endl;
+}
+else
+{
+    // codes from following steps...
+}
+```
 
-    ```cpp
-    CCaptureVisionRouter* router = new CCaptureVisionRouter();
-    ```
+> [!NOTE]
+> The string "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" here is a free public trial license. Note that network connection is required for this license to work. Please replace it with your own 30-day trial license.
+
+### Create a CaptureVisionRouter Instance
+
+```cpp
+CCaptureVisionRouter* router = new CCaptureVisionRouter();
+```
 
 ### Detect and Save the Normalized Document
 
@@ -156,6 +164,7 @@ In this section, we'll walk through the key steps needed to build an application
     CCapturedResult* result = router->Capture(imageFile.c_str(), CPresetTemplate::PT_DETECT_AND_NORMALIZE_DOCUMENT);
     ```
 
+    > [!IMPORTANT]
     > Please change the `[PATH-TO-THE-IMAGE-FILE]` to a real image file path.
 
 2. Save the normalized result as an image file
@@ -230,6 +239,5 @@ delete router, router = NULL;
     ```
 
 
-> Note:
-> 
+> [!IMPORTANT]
 > Please change all `[INSTALLATION FOLDER]` in above code snippet to your unpacking path.
diff --git a/programming/cplusplus/user-guide/mrz-scanner.md b/programming/cplusplus/user-guide/mrz-scanner.md
@@ -41,12 +41,14 @@ To find out whether your environment is supported, please read the [System Requi
 
 If you haven't downloaded the SDK yet, <a href="https://download2.dynamsoft.com/dcv/dynamsoft-capture-vision-cpp-3.0.1000.250304.zip" target="_blank">download the `C/C++ Package`</a> now and unpack the package into a directory of your choice.
 
+> [!IMPORTANT]
 > For this tutorial, we unpack it to a pseudo directory `[INSTALLATION FOLDER]`, change it to your unpacking path for the following content.
 
 ## Build Your Own Application
 
 In this section, we’ll walk through the key steps needed to build an application that reads the machine-readable zone (MRZ) from an image file.
 
+> [!TIP]
 >You can download the complete source code from [here](https://github.com/Dynamsoft/capture-vision-cpp-samples/tree/main/Samples/MRZScanner).
 
 ### Create A New Project
@@ -105,105 +107,110 @@ In this section, we’ll walk through the key steps needed to build an applicati
 
 Add headers and libs in `MRZScanner.cpp`.
 
-    ```cpp
-    #include <iostream>
-    #include <string>
-    #include "[INSTALLATION FOLDER]/Include/DynamsoftCaptureVisionRouter.h"
-    #include "[INSTALLATION FOLDER]/Include/DynamsoftUtility.h"
-
-    using namespace std;
-    using namespace dynamsoft::cvr;
-    using namespace dynamsoft::dlr;
-    using namespace dynamsoft::dcp;
-    using namespace dynamsoft::license;
-    using namespace dynamsoft::utility;
-
-    // The following code only applies to Windows.
-    #if defined(_WIN64) || defined(_WIN32)
-        #ifdef _WIN64
-            #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x64/DynamsoftCaptureVisionRouterx64.lib")
-            #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x64/DynamsoftCorex64.lib")
-            #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x64/DynamsoftLicensex64.lib")
-            #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x64/DynamsoftUtilityx64.lib")
-        #else
-            #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x86/DynamsoftCaptureVisionRouterx86.lib")
-            #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x86/DynamsoftCorex86.lib")
-            #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x86/DynamsoftLicensex86.lib")
-            #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x86/DynamsoftUtilityx86.lib")
-        #endif
+```cpp
+#include <iostream>
+#include <string>
+#include "[INSTALLATION FOLDER]/Include/DynamsoftCaptureVisionRouter.h"
+#include "[INSTALLATION FOLDER]/Include/DynamsoftUtility.h"
+
+using namespace std;
+using namespace dynamsoft::cvr;
+using namespace dynamsoft::dlr;
+using namespace dynamsoft::dcp;
+using namespace dynamsoft::license;
+using namespace dynamsoft::utility;
+
+// The following code only applies to Windows.
+#if defined(_WIN64) || defined(_WIN32)
+    #ifdef _WIN64
+        #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x64/DynamsoftCaptureVisionRouterx64.lib")
+        #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x64/DynamsoftCorex64.lib")
+        #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x64/DynamsoftLicensex64.lib")
+        #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x64/DynamsoftUtilityx64.lib")
+    #else
+        #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x86/DynamsoftCaptureVisionRouterx86.lib")
+        #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x86/DynamsoftCorex86.lib")
+        #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x86/DynamsoftLicensex86.lib")
+        #pragma comment(lib, "[INSTALLATION FOLDER]/Dist/Lib/Windows/x86/DynamsoftUtilityx86.lib")
     #endif
-    ```
+#endif
+```
 
 ### Initialize the License Key
 
+If this is your first time using the library, you will need to obtain a trial license key. We recommend getting your own 30-day trial license through the following modal:
+
+{% include trialLicense.html %}
+
 Open the `MRZScanner.cpp` file and add the following code inside the `Main` method to initialize the license for using the SDK in the application:
 
-    ```cpp
-    int errorcode = 0;
-    char error[512];
-    errorcode = CLicenseManager::InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", error, 512);
-    if (errorcode != ErrorCode::EC_OK && errorcode != ErrorCode::EC_LICENSE_CACHE_USED)
-    {
-        cout << "License initialization failed: ErrorCode: " << errorcode << ", ErrorString: " << error << endl;
-    }
-    else
-    {
-        // codes from following steps...
-    }
-    ```
+```cpp
+int errorcode = 0;
+char error[512];
+errorcode = CLicenseManager::InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", error, 512);
+if (errorcode != ErrorCode::EC_OK && errorcode != ErrorCode::EC_LICENSE_CACHE_USED)
+{
+    cout << "License initialization failed: ErrorCode: " << errorcode << ", ErrorString: " << error << endl;
+}
+else
+{
+    // codes from following steps...
+}
+```
 
-    >Note:
-    > The string "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" here is a free public trial license. Note that network connection is required for this license to work. When it expires, you can request a 30-day free trial license from the <a href="https://www.dynamsoft.com/customer/license/trialLicense?utm_source=guide&product=mrz&package=c_cpp" target="_blank">Customer Portal</a>.
+> [!NOTE]
+> The string "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" here is a free public trial license. Note that network connection is required for this license to work. Please replace it with your own 30-day trial license.
 
 ### Create a CaptureVisionRouter Instance
 
-    ```cpp
-    CCaptureVisionRouter* router = new CCaptureVisionRouter();
-    ```
+```cpp
+CCaptureVisionRouter* router = new CCaptureVisionRouter();
+```
 
 ### Invoke the Capturing
 
-    ```cpp
-    string imageFile = "[PATH-TO-THE-IMAGE-FILE]";
-    CCapturedResult* result = router->Capture(imageFile.c_str(), "ReadPassportAndId");
-    ```
+```cpp
+string imageFile = "[PATH-TO-THE-IMAGE-FILE]";
+CCapturedResult* result = router->Capture(imageFile.c_str(), "ReadPassportAndId");
+```
 
-    > Please change the `[PATH-TO-THE-IMAGE-FILE]` to a real image file path.
+> [!IMPORTANT]
+> Please change the `[PATH-TO-THE-IMAGE-FILE]` to a real image file path.
 
 ### Filter and Get MRZ Details
 
-    ```cpp
-    cout << "File: " << imageFile << endl;
-    if (result->GetErrorCode() != 0) {
-        cout << "Error: " << result->GetErrorCode() << "," << result->GetErrorString() << endl;
-    }
-    CParsedResult* dcpResult = result->GetParsedResult();
-    if (dcpResult == NULL || dcpResult->GetItemsCount() == 0)
-    {
-        cout << "No MRZ results." << endl;
-    }
-    else
+```cpp
+cout << "File: " << imageFile << endl;
+if (result->GetErrorCode() != 0) {
+    cout << "Error: " << result->GetErrorCode() << "," << result->GetErrorString() << endl;
+}
+CParsedResult* dcpResult = result->GetParsedResult();
+if (dcpResult == NULL || dcpResult->GetItemsCount() == 0)
+{
+    cout << "No MRZ results." << endl;
+}
+else
+{
+    int lCount = dcpResult->GetItemsCount();
+    cout << "Detected " << lCount << " MRZ Result(s)." << endl;
+    for (int i = 0; i < lCount; i++)
     {
-        int lCount = dcpResult->GetItemsCount();
-        cout << "Detected " << lCount << " MRZ Result(s)." << endl;
-        for (int i = 0; i < lCount; i++)
+        const CParsedResultItem *item = dcpResult->GetItem(i);
+        string docType = item->GetCodeType();
+        cout << "DocumentType: " << docType << endl;
+        if (docType == "MRTD_TD3_PASSPORT")
+        {
+            cout << "DocumentID: " << item->GetFieldValue("passportNumber") << endl;
+        }
+        else
         {
-            const CParsedResultItem *item = dcpResult->GetItem(i);
-            string docType = item->GetCodeType();
-            cout << "DocumentType: " << docType << endl;
-            if (docType == "MRTD_TD3_PASSPORT")
-            {
-                cout << "DocumentID: " << item->GetFieldValue("passportNumber") << endl;
-            }
-            else
-            {
-                cout << "DocumentID: " << item->GetFieldValue("documentNumber") << endl;
-            }
-            //get more field values
-            //cout << "DocumentID: " << item->GetFieldValue("[FIELD-NAME]") << endl;
+            cout << "DocumentID: " << item->GetFieldValue("documentNumber") << endl;
         }
+        //get more field values
+        //cout << "DocumentID: " << item->GetFieldValue("[FIELD-NAME]") << endl;
     }
-    ```
+}
+```
 
 ### Release the Allocated Memory
 
@@ -247,6 +254,5 @@ delete router, router = NULL;
     >./MRZScanner
     ```
 
-> Note:
-> 
+> [!IMPORTANT]
 > Please change all `[INSTALLATION FOLDER]` in above code snippet to your unpacking path.
diff --git a/programming/dotnet/user-guide/mrz-scanner.md b/programming/dotnet/user-guide/mrz-scanner.md
@@ -61,6 +61,10 @@ using Dynamsoft.DCP;
 
 ### Initialize the License Key
 
+If this is your first time using the library, you will need to obtain a trial license key. We recommend getting your own 30-day trial license through the following modal:
+
+{% include trialLicense.html %}
+
 Open the `Program.cs` file and add the following code inside the `Main` method to initialize the license for using the SDK in the application:
 
 ```csharp
@@ -71,7 +75,7 @@ if (errorCode != (int)EnumErrorCode.EC_OK && errorCode != (int)EnumErrorCode.EC_
     Console.WriteLine("License initialization error: " + errorMsg);
 ```
 
-> The string "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" here is a free public trial license. Note that network connection is required for this license to work. When it expires, you can request a 30-day free trial license from the <a href="https://www.dynamsoft.com/customer/license/trialLicense?utm_source=guide&product=mrz&package=dotnet" target="_blank">Customer Portal</a>.
+> The string "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" here is a free public trial license. Note that network connection is required for this license to work. Please replace it with your own 30-day trial license.
 
 ### Create a CaptureVisionRouter Instance
 
diff --git a/programming/python/release-notes/python-3.md b/programming/python/release-notes/python-3.md
@@ -1,7 +1,7 @@
 ---
 layout: default-layout
-title: Release Notes v2.x - Dynamsoft Capture Vision Bundle Python Edition
-description: This is the release notes page of Dynamsoft Capture Vision Bundle Python Edition v2.x.
+title: Release Notes v3.x - Dynamsoft Capture Vision Bundle Python Edition
+description: This is the release notes page of Dynamsoft Capture Vision Bundle Python Edition v3.x.
 keywords: release notes, python
 needGenerateH3Content: false
 ---
diff --git a/programming/python/user-guide/mrz-scanner.md b/programming/python/user-guide/mrz-scanner.md
