dynamsoft-docs · tony-xlh · May 21, 2026 · May 9, 2026 · May 9, 2026 · May 9, 2026
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -5,10 +5,10 @@ name: CI BBS
 # Controls when the workflow will run
 on:
   # Triggers the workflow on push events but only for the master branch
-  # push:
-  #   branches: 
-  #   - main 
-    #- preview 
+  push:
+    branches: 
+    - main 
+    - preview 
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -24,10 +24,10 @@ jobs:
       doc-url: batch-barcode-scanner/docs
     secrets: inherit
 
-  # Build-Preview:
-  #   if: ${{ github.ref == 'refs/heads/preview' }}
-  #   uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@preview
-  #   with:
-  #     doc-repo: batch-barcode-scanner-docs
-  #     doc-url: batch-barcode-scanner/docs
-  #   secrets: inherit
+  Build-Preview:
+    if: ${{ github.ref == 'refs/heads/preview' }}
+    uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@preview
+    with:
+      doc-repo: batch-barcode-scanner-docs
+      doc-url: batch-barcode-scanner/docs
+    secrets: inherit
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,54 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
-.DS_Store
-/.vs
+# dependencies
+/node_modules
+.vs
+
+# Layout templates
+_layouts/**
+!_layouts/default-layout-OLD.html
+!_layouts/home-page.html
+!_layouts/search-page-OLD.html
+
+# Assets
+assets/css/
+assets/font-face/
+assets/img-icon/
+assets/js/**
+!assets/js/setLatestVersion.js
+!assets/js/urlRewrite.js
+assets/scripts/
+
+# Includes
+_includes/productNav/
+_includes/auto-version-list.html
+_includes/head.html
+_includes/liquid_autoGenerateHistoryList.html
+_includes/liquid_breadcrumb.html
+_includes/liquid_generateFullTree.html
+_includes/liquid_searchVersionTreeFile.html
+_includes/livehelp.html
+_includes/main-page-head.html
+_includes/page_footer.html
+_includes/page_header.html
+_includes/productNav_OLD.html
+_includes/productNav.html
+_includes/search-input.html
+_includes/trialLicense.html
+
+# Plugins
+_plugins/
+
+# Site resources
+_site/
+
+sitemap.xml
+Hide_Tree_Page.md
+Gemfile.lock
+Gemfile
+
+# Local development workspace
+.dev/
+.bundle/
+.jekyll-cache/
+.sass-cache/
diff --git a/FAQ.md b/FAQ.md
@@ -0,0 +1,23 @@
+---
+layout: default-layout
+title: FAQ
+keywords: FAQ
+breadcrumbText: FAQ
+description: FAQ of Dynamsoft Batch Barcode Scanner
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+noTitleIndex: true
+---
+
+# FAQ
+
+
+* What platforms does Batch Barcode Scanner support?
+
+   The core library is written C++. It can run on mobile/desktop/web. Please contact us if you are interested.
+
+* Will there be an SDK version?
+
+   Currently, we only provide apps. An SDK version is not planned for now.
+
+
diff --git a/_config.yml b/_config.yml
@@ -1,3 +1,4 @@
+title: Dynamsoft Batch Barcode Scanner Documentation
 repositoryUrl: https://github.com/dynamsoft-docs/batch-barcode-scanner-docs/blob/main
 repository: dynamsoft-docs/batch-barcode-scanner-docs
 docFullPath: https://www.dynamsoft.com/batch-barcode-scanner/docs/
@@ -7,6 +8,7 @@ searchIndexName: Crawler-BBS-Docs
 searchNeedFilter: false
 
 bbs_core: /batch-barcode-scanner/docs/
+bbs_app: /batch-barcode-scanner/docs/app/
 bbs_parameters: /batch-barcode-scanner/docs/parameters/
 bbs_release_notes: /batch-barcode-scanner/
 bbs_license_activation: /batch-barcode-scanner/docs/
@@ -35,3 +37,7 @@ plugins:
   - jekyll-seo-tag
 
 url: "https://www.dynamsoft.com" # sitemap root
+relative_links:
+  enabled:     true
+  collections: true
+
diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html
@@ -1,27 +1,27 @@
 <li><a href="{{ site.bbs_core }}introduction.html" class="otherLinkColour">Introduction</a></li>
 
-<li class="category">DEVELOPMENT</li>
-<li><a style="cursor:pointer;color:#3c3c3c">Mobile</a>
+<li><a style="cursor:pointer;color:#3c3c3c">App Guide</a>
     <ul>
-        <li><a style="cursor:pointer;color:#3c3c3c">iOS</a>
-            <ul>
-                <li lang="objectivec-swift" ><a style="cursor:pointer;color:#3c3c3c">User Guide</a>
-                    <ul lang="objectivec-swift" >
-                        <li lang="objectivec-swift" ><a href="{{ site.bbs_ios }}guide/first-scan.html" class="otherLinkColour">Start Your First Scan</a> </li>
-                        <li lang="objectivec-swift" ><a href="{{ site.bbs_ios }}guide/customization.html" class="otherLinkColour">Get Your Scanner Customized</a></li>
-                        <li lang="objectivec-swift" ><a href="{{ site.bbs_ios }}guide/manual.html" class="otherLinkColour">Operation Manual</a></li>
-                        <li lang="objectivec-swift" ><a href="{{ site.bbs_ios }}guide/trouble-shooting.html" class="otherLinkColour">Troubleshooting</a></li>
-                    </ul>
-                </li>
-            </ul>
-        </li>
+        <li><a href="{{ site.bbs_app }}guide/first-scan.html" class="otherLinkColour">Start Your First Scan</a> </li>
+        <li><a href="{{ site.bbs_app }}guide/three-scanning-modes.html" class="otherLinkColour">Three Scanning Modes</a></li>
+        <li><a href="{{ site.bbs_app }}guide/customization.html" class="otherLinkColour">Get Your Scanner Customized</a></li>
+        <li><a href="{{ site.bbs_app }}guide/troubleshooting.html" class="otherLinkColour">Troubleshooting</a></li>
+        <li><a href="{{ site.bbs_app }}guide/extra-features.html" class="otherLinkColour">Extra Features</a></li>
     </ul>
 </li>
-<li class="category">Understanding BBS</li>
 <li><a href="{{ site.bbs_parameters }}" class="otherLinkColour">Parameters</a>
     <ul>
         <li><a href="{{ site.bbs_parameters }}camera-and-ui-settings.html" class="otherLinkColour">Camera and UI Template</a></li>
         <li><a href="{{ site.bbs_parameters }}batch-scan-settings.html" class="otherLinkColour">Batch Scan Template</a></li>
         <li><a target="_blank" href="https://www.dynamsoft.com/barcode-reader/docs/core/parameters/structure-and-interfaces-of-parameters.html" class="otherLinkColour">Capture Vision Template</a></li>
     </ul>
 </li>
+<li><a style="cursor:pointer;color:#3c3c3c">Release Notes</a>
+     <ul>
+         <li><a href="{{ site.bbs_app }}release-notes/ios.html" class="otherLinkColour">iOS App</a></li>
+         <li><a href="{{ site.bbs_app }}release-notes/android.html" class="otherLinkColour">Android App</a></li>
+     </ul>
+</li>
+<li><a href="{{ site.bbs_core }}faq.html" class="otherLinkColour">FAQ</a></li>
+
+
diff --git a/app/guide/customization.md b/app/guide/customization.md
@@ -0,0 +1,59 @@
+---
+layout: default-layout
+title: Customization
+keywords: Customization
+breadcrumbText: Customization
+description: This demostrates how to get your scanner customized.
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+noTitleIndex: true
+---
+
+# Get Your Scanner Customized
+
+The scanning experience in **Dynamsoft Batch Barcode Scanner** is fully customizable. Open the settings page, you can configure it in the following aspects:
+
+* Camera
+* Scanning
+* Barcode Reading
+
+Settings screenshots:
+
+![Settings 1](/assets/images/guide/settings-1.jpg){:width="215"} ![Settings 2](/assets/images/guide/settings-2.jpg){:width="215"}
+
+## Camera
+
+| Settings | Description |
+| --------- | ----------- |
+| Resolution | The resolution of the camera preview. |
+| Camera Type | Available for iOS, where you can select whether to use AR or the default camera with [Dynamsoft Camera Enhancer](https://www.dynamsoft.com/camera-enhancer/overview/) (DCE). Using AR has a smoother tracking experience, but may have trouble scanning close objects or multi-plane objects.|
+
+## Scanning
+
+| Settings | Description |
+| --------- | ----------- |
+| Scan Setting Name | The name of the scanning setting, which is used in the JSON template. |
+| Scan Region  | Specifies the scan region.  |
+| Stitch Level | Specifies how much effort to spend on stitching the images. |
+| Auto Stop | Whether to stop scanning automatically when certain conditions are reached, like barcode count. |
+| Layout | Specifies what layout analysis to enable. When enabled, it can highlight potential unrecognized barcodes based on layout. For example, a 20x20 grid. It is disabled by default. |
+
+
+## Barcode Reading
+
+| Settings | Description |
+| --------- | ----------- |
+| Barcode Setting Name | The name of the barcode reading setting, which is used in the JSON template. |
+| Barcode Colour Options | Configure this to read inverted barcodes. |
+| Barcode Decode Level  | Preset templates to control how much effort to spend on decoding barcodes.  |
+| Barcode Formats | Specifies what formats of barcode to read and output. |
+| Has Duplicate Barcodes | If disabled, it only outputs one of the many duplicate barcodes, which is suitable if one object has many barcodes with the same value. It is enabled by default. |
+| Min Localized Barcode Confidence | The minimum confidence level of the localized barcode. If the value is lower than 100, it will draw barcodes which haven't been recognized but localized on the result image in red. The default value is 100. |
+
+## Import and Export
+
+You can import and export the settings in JSON. The JSON template has more options and the settings specified with the UI has higher priority.
+
+You can [contact support](mailto:support@dynamsoft.com) to specify the default template for your account.
+
+Read the [parameters](/parameters/index.md) page to learn more about the JSON templates.
diff --git a/app/guide/extra-features.md b/app/guide/extra-features.md
@@ -0,0 +1,25 @@
+---
+layout: default-layout
+title: Extra Features
+description: Extra features Dynamsoft Batch Barcode Scanner
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+noTitleIndex: true
+---
+
+
+# Extra Features
+
+There are extra features for different use cases.
+
+## Wanted Barcodes
+
+Currently, the main extra feature is to specify wanted barcodes.
+
+In the live scanning interface, you can specify barcodes via manual input, selecting decoded barcodes on an image, etc.
+
+![setting wanted](/assets/images/guide/setting-wanted.jpg){:width="215"}
+
+In the scanning result, the wanted barcodes will be marked in purple.
+
+![found wanted](/assets/images/guide/found-wanted.jpg){:width="215"}
diff --git a/app/guide/first-scan.md b/app/guide/first-scan.md
@@ -0,0 +1,76 @@
+---
+layout: default-layout
+title: Start Your First Scan
+keywords: guide, first scan
+breadcrumbText: Start Your First Scan
+description: This page introduces how to perform a basic batch barcode scan.
+needAutoGenerateSidebar: false
+needGenerateH3Content: false
+noTitleIndex: true
+---
+
+# Start Your First Scan
+
+Follow these steps to perform a basic batch barcode scan. We are using screenshots on Android for illustration. The iOS version's usage is similar.
+
+1. Open your app and you will see the following page.
+
+   ![home](/assets/images/guide/home.jpg){:width="215"}
+
+2. Enter Field of View (FOV) scanning mode, press the shutter button to capture a photo and start scanning. The app will show the decoding result from the captured photo. Press "Retake" to scan more barcodes.
+
+   ![fov start](/assets/images/guide/fov-start.jpg){:width="215"} ![fov initial result](/assets/images/guide/fov-initial-decoding-result.jpg){:width="215"}
+
+3. After pressing "Retake", the app will reenter the live capturing interface, with the previous decoding result displayed in the bottom‑left corner.
+
+   ![fov live](/assets/images/guide/fov-live.jpg){:width="215"}
+
+   Barcodes will be highlighted in different colors:
+
+   * Already recognized: green.
+   * Newly recognized: light blue.
+
+4. Press the shutter button again. The app will take another photo and try decoding. The recognized barcodes (from the photo as well as camera frames) will be drawn on this last captured photo.
+
+   ![fov second decoding result](/assets/images/guide/fov-second-decoding-result.jpg){:width="215"}
+
+5. Press "Done" to enter the result viewing page. You can view the whole image with recognized barcodes, verify the result and save the result.
+
+   ![fov result](/assets/images/guide/fov-result.jpg){:width="215"}
+
+
+   There are many export options:
+
+   * Save to local folder
+   * Save to OneDrive
+   * Share to third-party apps
+
+   It saves the whole image and a CSV of barcode results.
+
+> [!NOTE]  
+> The export feature requires login.
+
+## Icon Reference
+
+| Icon | Description |
+| --------- | ----------- |
+| ![auto capture](/assets/images/guide/icon/auto_capture.svg) | Auto capture at fixed interval. |
+| ![wanted](/assets/images/guide/icon/wanted.svg)             | Set wanted barcodes. |
+| ![flashlight](/assets/images/guide/icon/flashlight.svg){:height="23"}{:width="24"}     | Toggle flashlight. |
+| ![beep](/assets/images/guide/icon/beep.svg)                 | Beep after successful scanning. |
+| ![vibrate](/assets/images/guide/icon/vibrate.svg)           | Vibrate after successful scanning. |
+| ![settings](/assets/images/guide/icon/settings.svg)         | Go to settings page. |
+| ![add](/assets/images/guide/icon/add.svg)         | Import images and barcodes. |
+| ![refresh](/assets/images/guide/icon/refresh.svg)         | Start a new scanning. |
+| ![capture](/assets/images/guide/icon/capture.svg)         | Capture a photo for decoding. |
+| ![download](/assets/images/guide/icon/download.svg)         | Save the scanning result. |
+| ![results](/assets/images/guide/icon/results.svg)         | Go to the result page. |
+
+
+
+## More Scanning Modes
+
+Continue reading to learn other advanced scanning modes: [Three Scanning Modes](/app/guide/three-scanning-modes.md).
+
+
+