Merge pull request #324 from dynamsoft-docs/preview

Preview

Author: Dynamsoft-Jerson

_includes/sidelist-programming/programming-android.html

@@ -6,7 +6,7 @@
         <li lang="android" ><a href="{{ site.android }}user-guide/configure-barcode-scanner.html" class="otherLinkColour">Configure Barcode Scanner</a>
             <ul lang="android" >
                 <li lang="android" ><a href="{{ site.android }}user-guide/scanner-barcode-formats.html" class="otherLinkColour">Specify Barcode Format</a></li>
-                <li lang="android" ><a href="{{ site.android }}user-guide/scanner-multi-barcodes.html" class="otherLinkColour">Enable Multiple Barcodes Scanning</a></li>
+                <li lang="android" ><a href="{{ site.android }}user-guide/scanner-multi-barcodes.html" class="otherLinkColour">Switch Single & Multiple Scanning Modes</a></li>
                 <li lang="android" ><a href="{{ site.android }}user-guide/scanner-improve-performance.html" class="otherLinkColour">Improve the Performance</a></li>
                 <li lang="android" ><a href="{{ site.android }}user-guide/scanner-customize-ui.html" class="otherLinkColour">Customize the Scanner UI</a></li>
                 <li lang="android" ><a href="{{ site.android }}user-guide/scanner-additional-settings.html" class="otherLinkColour">Add Addtional Settings</a></li>

_includes/sidelist-programming/programming-oc.html

@@ -7,7 +7,7 @@
         <li lang="objectivec-swift" ><a href="{{ site.oc }}user-guide/configure-barcode-scanner.html" class="otherLinkColour">Configure Barcode Scanner</a>
             <ul lang="objectivec-swift" >
                 <li lang="objectivec-swift" ><a href="{{ site.oc }}user-guide/scanner-barcode-formats.html" class="otherLinkColour">Specify Barcode Format</a></li>
-                <li lang="objectivec-swift" ><a href="{{ site.oc }}user-guide/scanner-multi-barcodes.html" class="otherLinkColour">Enable Multiple Barcodes Scanning</a></li>
+                <li lang="objectivec-swift" ><a href="{{ site.oc }}user-guide/scanner-multi-barcodes.html" class="otherLinkColour">Switch Single & Multiple Scanning Modes</a></li>
                 <li lang="objectivec-swift" ><a href="{{ site.oc }}user-guide/scanner-improve-performance.html" class="otherLinkColour">Improve the Performance</a></li>
                 <li lang="objectivec-swift" ><a href="{{ site.oc }}user-guide/scanner-customize-ui.html" class="otherLinkColour">Customize the Scanner UI</a></li>
                 <li lang="objectivec-swift" ><a href="{{ site.oc }}user-guide/scanner-additional-settings.html" class="otherLinkColour">Add Addtional Settings</a></li>

programming/android/index.md

@@ -3,7 +3,8 @@ layout: default-layout
 title: Main Page - Dynamsoft Barcode Reader for Android
 description: This is the main page of Dynamsoft Barcode Reader for Android SDK.
 keywords: android
-needAutoGenerateSidebar: false
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
 breadcrumbText: Android
 permalink: /programming/android/
 ---
@@ -14,29 +15,64 @@ Dynamsoft Barcode Reader (DBR) SDK Android Edition is a barcode reading tool des
 
 You can either get a quick start with the [BarcodeScanner APIs](api-reference/barcode-scanner/index.md) or experience a highly customizable development with the [foundational APIs](api-reference/index.md). Furthermore, DBR provides a powerful [parameter]({{ site.dcvb_parameters}}file/index.html?lang=android) system in order to cope with various scenarios.
 
-## Using the SDK
+|    | Develop with BarcodeScanner APIs | Develop with Foundational APIs |
+| -- | ------------------------------ | ------------------------------ |
+| Code | 15+ lines | 60+ lines |
+| UI | Preset | Full customizable |
+| Decode from Live Video | ✔ | ✔ |
+| Decode from a Image | X | ✔ |
+| Performance Customization | ✔ | ✔ |
+| Camera Control | Limited | ✔ |
+| Intermediate Results | X | ✔ |
 
-### System Requirements
+## Develop with BarcodeScanner APIs
 
-- Supported OS: Android 5.0 (API Level 21) or higher.
-- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**.
-- Development Environment: Android Studio 2022.2.1 or higher.
+`BarcodeScanner` is a component with the following features:
+
+- Minimal Code: High-level APIs achieve full functionality with one line of code.
+- Ready-to-Use UI: Pre-integrated components and UI enable quick setup.
+- Common Customization: Configuration objects simplify typical algorithm and UI setups.
+
+`BarcodeScanner` supports 2 different Scanning Modes
+
+- Single Barcode Scanning Mode
+  1. Scans any number of barcodes but returns only one result.
+  2. Speed prioritized.
+  3. Requires user to select one as the result when scanned multiple barcodes.
+- Multiple Barcodes Scanning Mode
+  1. Scans multiple barcodes and returns all scanned results.
+  2. Read-rate prioritized.
+
+<div align="center">
+    <p><img src="../assets/single-vs-multiple.png" width="100%" alt="barcode-scanner"></p>
+</div>
 
-### User Guide
+> Note: If you are looking for a solution to scan large batches of barcodes, please refer to the [`BatchBarcodeScanner`](https://www.dynamsoft.com/use-cases/batch-barcode-scanning/){:target="_blank"}. The `BatchBarcodeScanner` has much higher ability on scanning large number of barcodes. It also provides you a highly interactable UI for result previewing, editing, saving, reusing and sharing.
 
 - [Build your First APP](user-guide.md)
-- [Configure your barcode scanner](user-guide/configure-barcode-scanner.md)
-- [Build your APP with foundational APIs](foundational-guide.md).
+- [Configure Your Barcode Scanner](user-guide/configure-barcode-scanner.md)
+- [View BarcodeScanner API References](./api-reference/barcode-scanner/index.md)
+- [Check out BarcodeScanner Samples on GitHub](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/BarcodeScannerAPISamples)
+
+## Develop with Foundational APIs
+
+If you are looking for a fully customizable barcode decoding library, you are welcome to use the Foundational APIs.
+
+- [Build your APP with foundational APIs](foundational-guide.md)
 - [Explore Features](user-guide/explore-features/index.md)
+- [View Foundation API References](./api-reference/index.md)
+- [Check out Foundational API Samples on GitHub](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/FoundationalAPISamples)
 
-### Samples and Demos
+## System Requirements
 
-- [Samples & Demos](samples/index.md)
+- Supported OS: Android 5.0 (API Level 21) or higher.
+- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**.
+- Development Environment: Android Studio 2022.2.1 or higher.
 
-### API Reference
+## Download Demo App
 
-- [BarcodeScanner APIs](./api-reference/barcode-scanner/index.md)
-- [Foundation APIs](./api-reference/index.md)
+- [View in Google Play Store](https://play.google.com/store/apps/details?id=com.dynamsoft.demo.dynamsoftbarcodereaderdemo&pli=1){:target="_blank"}
+- [Download APK](https://download2.dynamsoft.com/dbr/android/DynamsoftBarcodeReaderDemoAndroid.apk){:target="_blank"}
 
 ## Release Notes
 

programming/android/user-guide.md

@@ -51,7 +51,7 @@ There are two ways in which you can include the `dynamsoftbarcodereaderbundle` l
    }
    ```
    2. 
-   ```kts
+   ```kotlin
    dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
@@ -79,7 +79,7 @@ There are two ways in which you can include the `dynamsoftbarcodereaderbundle` l
    }
    ```
    2. 
-   ```kts
+   ```kotlin
    dependencies {
       implementation("com.dynamsoft:dynamsoftbarcodereaderbundle:10.4.3001")
    }
@@ -120,7 +120,7 @@ There are two ways in which you can include the `dynamsoftbarcodereaderbundle` l
    }
    ```
    2. 
-   ```kts
+   ```kotlin
    val camerax_version = "1.1.0"
    dependencies {
       implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.aar"))))

programming/android/user-guide/configure-barcode-scanner.md

@@ -14,7 +14,7 @@ needAutoGenerateSidebar: true
 When developing with [`BarcodeScannerActivity`](../api-reference/barcode-scanner/barcode-scanner-activity.md), you can add configurations via the [`BarcodeScannerConfig`](../api-reference/barcode-scanner/barcode-scanner-config.md) class. These articles will guide you on how to configure the settings.
 
 - [Specify Barcode Formats](scanner-barcode-formats.md)
-- [Enable Multiple Barcodes Scanning](scanner-multi-barcodes.md)
+- [Switch Single & Multiple Scanning Modes](scanner-multi-barcodes.md)
 - [Improve the Performance](scanner-improve-performance.md)
 - [Customize Scanner UI](scanner-customize-ui.md)
 - [Add Additional Settings](scanner-additional-settings.md)

programming/android/user-guide/index.md

@@ -19,6 +19,11 @@ Develop a barcode scanner by using the ready-to-use UI, `BarcodeScannerActivity`
 
 - [Build your First APP](../user-guide.md)
 - [Configure your barcode scanner](configure-barcode-scanner.md)
+  - [Specify Barcode Formats](scanner-barcode-formats.md)
+  - [Switch Single & Multiple Scanning Modes](scanner-multi-barcodes.md)
+  - [Improve the Performance](scanner-improve-performance.md)
+  - [Customize Scanner UI](scanner-customize-ui.md)
+  - [Add Additional Settings](scanner-additional-settings.md)
 
 ## Build Your APP with Foundational API
 

programming/android/user-guide/scanner-multi-barcodes.md

@@ -8,11 +8,11 @@ needGenerateH3Content: true
 noTitleIndex: true
 ---
 
-# Scan multiple barcodes
+# Switch Scanning Modes
 
-This article will show you how to configure your barcode scanner to scan multiple barcodes.
+This article will show you how to switch between the single barcode scanning mode and the multiple barcodes scanning mode.
 
-## Enable multi-barcode scanning
+## How to Switch Scanning Modes
 
 You can use method `setScanningMode` to switch between single-barcode and multi-barcode scanning modes.
 
@@ -26,9 +26,9 @@ BarcodeScannerConfig config = new BarcodeScannerConfig();
 config.setScanningMode(EnumScanningMode.SM_MULTIPLE);
 ```
 
-## Configure the auto-stop conditions
+## Configure the Auto-Stop Conditions
 
-There are two automatic stop conditions for multi-code scanning:
+For multi-barcode scanning, there are two automatic stop conditions:
 
 - The number of successfully decoded barcodes reaches the `expectedBarcodesCount`.
 - There are no new decoding results for N consecutive frames. The value of N can be set using `setMaxConsecutiveStableFramesToExit`.
@@ -49,3 +49,42 @@ If there are at least 10 barcodes decoded, it will stop scanning. Otherwise, it
 - [`setScanningMode`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanningmode)
 - [`setExpectedBarcodesCount`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setexpectedbarcodescount)
 - [`setMaxConsecutiveStableFramesToExit`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setmaxconsecutivestableframestoexit)
+
+## Comparisons
+
+If you are looking for a solution to scan large batches of barcodes, please refer to the [`BatchBarcodeScanner`](https://www.dynamsoft.com/use-cases/batch-barcode-scanning/){:target="_blank"}. The `BatchBarcodeScanner` has much higher ability on scanning large number of barcodes. It also provides you a highly interactable UI for result previewing, editing, saving, reusing and sharing.
+
+<table style = "text-align:left">
+    <thead>
+        <tr>
+            <th nowrap="nowrap"></th>
+            <th nowrap="nowrap">BarcodeScanner Single Mode</th>
+            <th nowrap="nowrap">BarcodeScanner Multi Mode</th>
+            <th nowrap="nowrap">BatchBarcodeScanner</th>
+        </tr>
+    </thead>
+    <tr>
+        <td style="vertical-align:text-top">Dependencies</td>
+        <td style="vertical-align:text-top">DynamsoftBarcodeReaderBundle</td>
+        <td style="vertical-align:text-top">DynamsoftBarcodeReaderBundle</td>
+        <td style="vertical-align:text-top">DynamsoftBatchBarcodeReaderBundle</td>
+    </tr>
+    <tr>
+        <td style="vertical-align:text-top">Scan Ability</td>
+        <td style="vertical-align:text-top">Decodes at lease one barcode that available on the latest frame.</td>
+        <td style="vertical-align:text-top">Decodes all barcodes that available on the latest frame.</td>
+        <td style="vertical-align:text-top">Decodes all barcodes that available on the latest frame. (TTL Overlap Mode)<br>or<br>Decodes all barcodes that available on the first frame. (TTS Ovarlap Mode)<br>or<br>Decodes all barcodes that ever exists while capturing. (Panorama Mode)</td>
+    </tr>
+    <tr>
+        <td style="vertical-align:text-top">Result</td>
+        <td style="vertical-align:text-top">Always returns one barcode result. If decoded more than one barcodes, users will be asked to select one.</td>
+        <td style="vertical-align:text-top">All decoded barcodes</td>
+        <td style="vertical-align:text-top">All decoded barcodes as well as a PanoramicImage that highlighting all these barcodes on it.</td>
+    </tr>
+    <tr>
+        <td style="vertical-align:text-top">Result Editor</td>
+        <td style="vertical-align:text-top">Not available</td>
+        <td style="vertical-align:text-top">Not available</td>
+        <td style="vertical-align:text-top">Supports the following operations<br>1. Extend the current result with all kinds of available image source.<br>2. Manual input new results or edit the existing results<br>3. Save as history<br>4. Export as file (.png, .csv, etc.)</td>
+    </tr>
+</table>

programming/assets/single-vs-multiple.png

@@ -3,7 +3,7 @@ layout: default-layout
 title: Main Page - Dynamsoft Barcode Reader for iOS
 description: This is the main page of Dynamsoft Barcode Reader for iOS SDK.
 keywords: objective-c, oc, swift
-needAutoGenerateSidebar: false
+needAutoGenerateSidebar: true
 needGenerateH3Content: true
 breadcrumbText: iOS
 permalink: /programming/objectivec-swift/
@@ -15,29 +15,63 @@ Dynamsoft Barcode Reader (DBR) SDK iOS Edition is a barcode reading tool designe
 
 You can either get a quick start with the [BarcodeScanner APIs](api-reference/barcode-scanner/index.md) or experience a highly customizable development with the [foundational APIs](api-reference/index.md). Furthermore, DBR provides a powerful [parameter]({{ site.dcvb_parameters}}file/index.html?lang=objc,swift) system in order to cope with various scenarios.
 
-## Using the SDK
+|    | Develop with BarcodeScanner APIs | Develop with Foundational APIs |
+| -- | ------------------------------ | ------------------------------ |
+| Code | 15+ lines | 60+ lines |
+| UI | Preset | Full customizable |
+| Decode from Live Video | ✔ | ✔ |
+| Decode from a Image | X | ✔ |
+| Performance Customization | ✔ | ✔ |
+| Camera Control | Limited | ✔ |
+| Intermediate Results | X | ✔ |
 
-### System Requirements
+## Develop with BarcodeScanner APIs
 
-- Supported OS: iOS 11+ (iOS 13+ recommended).
-- Supported ABI: arm64 and x86_64.
-- Development Environment: Xcode 13+ (Xcode 14.1+ recommended).
+`BarcodeScanner` is a component with the following features:
+
+- Minimal Code: High-level APIs achieve full functionality with one line of code.
+- Ready-to-Use UI: Pre-integrated components and UI enable quick setup.
+- Common Customization: Configuration objects simplify typical algorithm and UI setups.
+
+`BarcodeScanner` supports 2 different Scanning Modes
+
+- Single Barcode Scanning Mode
+  1. Scans any number of barcodes but returns only one result.
+  2. Speed prioritized.
+  3. Requires user to select one as the result when scanned multiple barcodes.
+- Multiple Barcodes Scanning Mode
+  1. Scans multiple barcodes and returns all scanned results.
+  2. Read-rate prioritized.
+
+<div align="center">
+    <p><img src="../assets/single-vs-multiple.png" width="100%" alt="barcode-scanner"></p>
+</div>
 
-### User Guide
+> Note: If you are looking for a solution to scan large batches of barcodes, please refer to the [`BatchBarcodeScanner`](https://www.dynamsoft.com/use-cases/batch-barcode-scanning/){:target="_blank"}. The `BatchBarcodeScanner` has much higher ability on scanning large number of barcodes. It also provides you a highly interactable UI for result previewing, editing, saving, reusing and sharing.
 
 - [Build your First APP](user-guide.md)
-- [Configure your barcode scanner](user-guide/configure-barcode-scanner.md)
-- [Build your APP with foundational APIs](foundational-guide.md).
+- [Configure your Barcode Scanner](user-guide/configure-barcode-scanner.md)
+- [View BarcodeScanner API References](./api-reference/barcode-scanner/index.md)
+- [Check out BarcodeScanner Samples on GitHub](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/ios/BarcodeScannerAPISamples)
+
+## Develop with Foundational APIs
+
+If you are looking for a fully customizable barcode decoding library, you are welcome to use the Foundational APIs.
+
+- [Build your APP with foundational APIs](foundational-guide.md)
 - [Explore Features](user-guide/explore-features/index.md)
+- [View Foundation API References](./api-reference/index.md)
+- [Check out Foundational API Samples on GitHub](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/ios/FoundationalAPISamples)
 
-### Samples and Demos
+## System Requirements
 
-- [Samples & Demos](samples/index.md)
+- Supported OS: iOS 11+ (iOS 13+ recommended).
+- Supported ABI: arm64 and x86_64.
+- Development Environment: Xcode 13+ (Xcode 14.1+ recommended).
 
-### API Reference
+## Download Demo App
 
-- [BarcodeScanner APIs](./api-reference/barcode-scanner/index.md)
-- [Foundation APIs](./api-reference/index.md)
+- [View in Apple Store](https://apps.apple.com/us/app/dynamsoft-barcode-scanner-demo/id1120581630){:target="_blank"}
 
 ## Release Notes
 

programming/objectivec-swift/index.md

@@ -14,7 +14,7 @@ needAutoGenerateSidebar: true
 When developing with [`BarcodeScannerViewController`](../api-reference/barcode-scanner/barcode-scanner-view-controller.md), you can add configurations via the [`BarcodeScannerConfig`](../api-reference/barcode-scanner/barcode-scanner-config.md) class. This page will guide you on how to configure the settings.
 
 - [Specify Barcode Formats](scanner-barcode-formats.md)
-- [Enable Multiple Barcodes Scanning](scanner-multi-barcodes.md)
+- [Switch Single & Multiple Scanning Modes](scanner-multi-barcodes.md)
 - [Improve the Performance](scanner-improve-performance.md)
 - [Customize Scanner UI](scanner-customize-ui.md)
 - [Add Additional Settings](scanner-additional-settings.md)