Merge pull request #280 from dynamsoft-docs/preview

Preview

Author: Dynamsoft-Jerson

_includes/sidelist-programming/programming-maui.html

@@ -151,3 +151,8 @@
         <li lang="maui"><a href="{{ site.dbr_maui }}release-notes/maui-10.html" class="otherLinkColour">10.x</a></li>
     </ul>
 </li>
+<li lang="maui"><a class="otherLinkColour">FAQ</a>
+    <ul lang="maui">
+        <li lang="maui"><a href="{{ site.dbr_maui }}faq/common-environment-issues.html" class="otherLinkColour">Common Environment Issues</a></li>
+    </ul>
+</li>

programming/maui/faq/common-environment-issues.md

@@ -0,0 +1,80 @@
+---
+layout: default-layout
+title: Common Environment Issues - Dynamsoft Barcode Reader for MAUI
+description: This page introduce how to solve common environment issues when using Dynamsoft Barcode Reader MAUI SDK.
+keywords: FAQ, maui, common environment issues
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+noTitleIndex: true
+---
+
+# Common Environment Issues
+
+## Failed to install
+
+You might get "Could not find a part of the path 'C:\Users\admin\.nuget\packages\dynamsoft.imageprocessing.ios\2.2.300\lib\net7.0-ios16.1\Dynamsoft.ImageProcessing.iOS.resources\DynamsoftImageProcessing.xcframework\ios-arm64\dSYMs\DynamsoftImageProcessing.framework.dSYM\Contents\Resources\DWARF\DynamsoftImageProcessing'" error when installing the package on a **Windows** PC. That's because the Windows system have a limitation of 260 characters in the path. There are 2 ways to solve this:
+
+### Exclude the iOS platform from the project
+
+The long path belongs to the iOS xcframework of the package. If you only want to run Android on Windows, you can use this solution.
+
+Remove iOS platform from you project via the project file.
+
+```xml
+<PropertyGroup>
+    <!-- Remove iOS and desktop platforms from your TargetFrameworks. -->
+    <!-- <TargetFrameworks>net8.0-android;net8.0-ios;net8.0-maccatalyst</TargetFrameworks> -->
+    <TargetFrameworks>net8.0-android</TargetFrameworks>
+
+    <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'android'">21.0</SupportedOSPlatformVersion>
+    <!-- Remove the iOS platforms from the SupportedOSPlatformVersion. -->
+    <!-- <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'ios'">11.0</SupportedOSPlatformVersion> -->
+</PropertyGroup>
+```
+
+### Add the library via project file instead of **Nuget Package Manager**
+
+Adding the library via project file can ignore the 260 character limitation but you need some additional steps to complete the installation.
+
+```xml
+<Project Sdk="Microsoft.NET.Sdk">
+    ...
+    <ItemGroup>
+        ...
+        <PackageReference Include="Dynamsoft.BarcodeReaderBundle.Maui" Version="10.2.1101" />
+    </ItemGroup>
+</Project>
+```
+
+Open the **Package Manager Console** and run the following commands:
+
+```bash
+dotnet build
+```
+
+## error NU1202: Package Dynamsoft.BarcodeReaderBundle.Maui 10.2.1101 is not compatible with net8.0-windows10.0.19041
+
+You may find similar issues like:
+
+- "not compatible with net8.0-windows10.0.19041"
+- "not compatible with net8.0-maccatalyst17.2"
+
+Currently, `Dynamsoft.BarcodeReaderBundle.Maui` library doesn't support desktop environment. You have to remove them from your project.
+
+```xml
+<PropertyGroup>
+    <!-- Remove ";net8.0-maccatalyst" from your TargetFrameworks. -->
+    <!-- <TargetFrameworks>net8.0-android;net8.0-ios;net8.0-maccatalyst</TargetFrameworks> -->
+    <TargetFrameworks>net8.0-android;net8.0-ios</TargetFrameworks>
+    <!-- Remove "net8.0-windows10.0.19041.0" from your TargetFrameworks. -->
+    <!-- <TargetFrameworks Condition="$([MSBuild]::IsOSPlatform('windows'))">$(TargetFrameworks);net8.0-windows10.0.19041.0</TargetFrameworks> -->
+
+    <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'ios'">11.0</SupportedOSPlatformVersion>
+    <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'android'">21.0</SupportedOSPlatformVersion>
+    <!-- Remove the unsupported platforms from the SupportedOSPlatformVersion. -->
+    <!-- <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'maccatalyst'">13.1</SupportedOSPlatformVersion> -->
+    <!-- <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'windows'">10.0.17763.0</SupportedOSPlatformVersion>
+    <TargetPlatformMinVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'windows'">10.0.17763.0</TargetPlatformMinVersion>
+    <SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'tizen'">6.5</SupportedOSPlatformVersion> -->
+</PropertyGroup>
+```

programming/maui/user-guide.md

@@ -14,30 +14,30 @@ noTitleIndex: true
 ## Table of Contents
 
 - [Getting Started with MAUI](#getting-started-with-maui)
-	- [Table of Contents](#table-of-contents)
-	- [System Requirements](#system-requirements)
-		- [.Net](#net)
-		- [Android](#android)
-		- [iOS](#ios)
-	- [Installation](#installation)
-	- [Build Your Barcode Scanner App](#build-your-barcode-scanner-app)
-		- [Set up Development Environment](#set-up-development-environment)
-		- [Initialize the Project](#initialize-the-project)
-			- [Visual Studio](#visual-studio)
-			- [Visual Studio for Mac](#visual-studio-for-mac)
-		- [Include the Library](#include-the-library)
-		- [Initialize MauiProgram](#initialize-mauiprogram)
-		- [License Activation](#license-activation)
-		- [Add the CameraView in the Main Page](#add-the-cameraview-in-the-main-page)
-		- [Open the Camera and Start Barcode Decoding](#open-the-camera-and-start-barcode-decoding)
-		- [Obtaining Barcode Results](#obtaining-barcode-results)
-		- [Add Camera Permission](#add-camera-permission)
-		- [Run the Project](#run-the-project)
-	- [Customizing the Barcode Reader](#customizing-the-barcode-reader)
-		- [Switching Preset Templates](#switching-preset-templates)
-		- [Configuring the SimplifiedBarcodeReaderSettings](#configuring-the-simplifiedbarcodereadersettings)
-		- [Customizing the Scan Region](#customizing-the-scan-region)
-	- [Licensing](#licensing)
+  - [Table of Contents](#table-of-contents)
+  - [System Requirements](#system-requirements)
+    - [.Net](#net)
+    - [Android](#android)
+    - [iOS](#ios)
+  - [Installation](#installation)
+  - [Build Your Barcode Scanner App](#build-your-barcode-scanner-app)
+    - [Set up Development Environment](#set-up-development-environment)
+    - [Initialize the Project](#initialize-the-project)
+      - [Visual Studio](#visual-studio)
+      - [Visual Studio for Mac](#visual-studio-for-mac)
+    - [Include the Library](#include-the-library)
+    - [Initialize MauiProgram](#initialize-mauiprogram)
+    - [License Activation](#license-activation)
+    - [Add the CameraView in the Main Page](#add-the-cameraview-in-the-main-page)
+    - [Open the Camera and Start Barcode Decoding](#open-the-camera-and-start-barcode-decoding)
+    - [Obtaining Barcode Results](#obtaining-barcode-results)
+    - [Add Camera Permission](#add-camera-permission)
+    - [Run the Project](#run-the-project)
+  - [Customizing the Barcode Reader](#customizing-the-barcode-reader)
+    - [Switching Preset Templates](#switching-preset-templates)
+    - [Configuring the SimplifiedBarcodeReaderSettings](#configuring-the-simplifiedbarcodereadersettings)
+    - [Customizing the Scan Region](#customizing-the-scan-region)
+  - [Licensing](#licensing)
 
 ## System Requirements
 
@@ -60,11 +60,33 @@ noTitleIndex: true
 
 ## Installation
 
+### Visual Studio for Mac
+
 In the **NuGet Package Manager>Manage Packages for Solution** of your project, search for **Dynamsoft.BarcodeReaderBundle.Maui**. Select it and click **install**.
 
-> Note: If you are developing Android on Visual Studio Windows, you have to mannually exclude iOS and Windows platforms. Otherwise, the package installation will be failed ("Could not find a part of the path" error).
+### Visual Studio for Windows
 
-![Exclude iOS and Windows from targets](../assets/maui-exclude.png)
+You have to Add the library via the project file and do some additional steps to complete the installation.
+
+1. Add the library in the project file:
+
+    ```xml
+    <Project Sdk="Microsoft.NET.Sdk">
+        ...
+        <ItemGroup>
+            ...
+            <PackageReference Include="Dynamsoft.BarcodeReaderBundle.Maui" Version="10.2.1101" />
+        </ItemGroup>
+    </Project>
+    ```
+
+2. Open the **Package Manager Console** and run the following commands:
+
+    ```bash
+    dotnet build
+    ```
+
+> Note: Windows system have a limitation of 260 characters in the path. If you don't use console to install the package, you will receive error "Could not find a part of the path 'C:\Users\admin\.nuget\packages\dynamsoft.imageprocessing.ios\2.2.300\lib\net7.0-ios16.1\Dynamsoft.ImageProcessing.iOS.resources\DynamsoftImageProcessing.xcframework\ios-arm64\dSYMs\DynamsoftImageProcessing.framework.dSYM\Contents\Resources\DWARF\DynamsoftImageProcessing'"
 
 ## Build Your Barcode Scanner App
 

programming/objectivec-swift/user-guide.md

@@ -100,9 +100,9 @@ Add the SDK to your new project. There are several ways to do this, all of which
 
 ### Initialize the License
 
-Dynamsoft Barcode Reader needs a valid license to work. It is recommended to put the license activation code in the **AppDelegate** file.
+Dynamsoft Barcode Reader needs a valid license to work.
 
-1. Implement the protocol `LicenseVerificationListener` through class **AppDelegate**:
+1. Implement the protocol `LicenseVerificationListener` through class **ViewController**:
 
    <div class="sample-code-prefix"></div>
    >- Objective-C
@@ -111,13 +111,12 @@ Dynamsoft Barcode Reader needs a valid license to work. It is recommended to put
    >1. 
    ```objc
    #import <DynamsoftLicense/DynamsoftLicense.h>
-   @interface AppDelegate ()<DSLicenseVerificationListener>
+   @interface ViewController () <DSLicenseVerificationListener>
    ```
    2. 
    ```swift
    import DynamsoftLicense
-   @main
-   class AppDelegate: LicenseVerificationListener
+   class ViewController: UIViewController, LicenseVerificationListener
    ```
 
 2. Add the following code to initialize the license in method `application:didFinishLaunchingWithOptions:` and receive the callback message :
@@ -128,33 +127,26 @@ Dynamsoft Barcode Reader needs a valid license to work. It is recommended to put
    >
    >1. 
    ```objc
-   @implementation AppDelegate
+   - (void)setLicense {
+      [DSLicenseManager initLicense:@"DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" verificationDelegate:self];
+   }
    - (void)onLicenseVerified:(BOOL)isSuccess error:(nullable NSError *)error {
       if (!isSuccess && error != nil) {
-             NSLog(@"%@", error);
+         NSLog(@"error: %@", error);
       }
    }
-   - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *) launchOptions {
-      /**Override point for customization after application launch.*/
-      [DSLicenseManager initLicense:@"DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" verificationDelegate:self];
-      return YES;
-   }
    ```
    2. 
    ```swift
-   class AppDelegate: UIResponder, UIApplicationDelegate, LicenseVerificationListener {
-      func onLicenseVerified(_ isSuccess: Bool, error: Error?) {
-             if !isSuccess {
-                if let error = error {
-                   print("\(error.localizedDescription)")
-                }
+   func setLicense() {
+      LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", verificationDelegate: self)
+   }
+   func onLicenseVerified(_ isSuccess: Bool, error: Error?) {
+      if !isSuccess {
+             if let error = error {
+                print("\(error.localizedDescription)")
              }
       }
-      func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
-             /**Override point for customization after application launch.*/
-             LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", verificationDelegate: self)
-             return true
-      }
    }
    ```
 
@@ -196,7 +188,7 @@ Dynamsoft Barcode Reader needs a valid license to work. It is recommended to put
    >
    >1. 
    ```objc
-   @interface ViewController ()
+   @interface ViewController () <DSLicenseVerificationListener>
    @property (nonatomic, strong) DSCameraView *cameraView;
    @property (nonatomic, strong) DSCameraEnhancer *dce;
    @end
@@ -234,7 +226,7 @@ Dynamsoft Barcode Reader needs a valid license to work. It is recommended to put
    >
    >1. 
    ```objc
-   @interface ViewController ()
+   @interface ViewController () <DSLicenseVerificationListener>
    @property (nonatomic, strong) DSCaptureVisionRouter *cvr;
    @end
    ...
@@ -266,7 +258,7 @@ Dynamsoft Barcode Reader needs a valid license to work. It is recommended to put
    >1. 
    ```objc
    /**Add CapturedResultReceiver to your ViewController.*/
-   @interface ViewController () <DSCapturedResultReceiver>
+   @interface ViewController () <DSLicenseVerificationListener, DSCapturedResultReceiver>
    ...
    - (void)setUpDCV {
       ...
@@ -300,7 +292,7 @@ Dynamsoft Barcode Reader needs a valid license to work. It is recommended to put
    2. 
    ```swift
    /**Add CapturedResultReceiver to your ViewController.*/
-   class ViewController: UIViewController, CapturedResultReceiver {
+   class ViewController: UIViewController, CapturedResultReceiver, LicenseVerificationListener {
       ...
       func setUpDCV() {
              ...
@@ -345,6 +337,7 @@ Now that all of the main functions are defined and configured, let's finish thin
 - (void)viewDidLoad {
    [super viewDidLoad];
    /**Do any additional setup after loading the view.*/
+   [self setLicense];
    [self setUpCamera];
    [self setUpDCV];
 }
@@ -369,6 +362,7 @@ Now that all of the main functions are defined and configured, let's finish thin
 override func viewDidLoad() {
    super.viewDidLoad()
    /**Do any additional setup after loading the view.*/
+   setLicense()
    setUpCamera()
    setUpDCV()
 }