Skip to content

Commit 14bc10a

Browse files
tony-xlhtony-xlh
authored
Merge pull request #2 from dynamsoft-docs/preview
update to 3.0
2 parents 97a12e1 + 0bfa84d commit 14bc10a

54 files changed

Lines changed: 583 additions & 667 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/main.yml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ name: CI BBS
55
# Controls when the workflow will run
66
on:
77
# Triggers the workflow on push events but only for the master branch
8-
# push:
9-
# branches:
10-
# - main
11-
#- preview
8+
push:
9+
branches:
10+
- main
11+
- preview
1212

1313
# Allows you to run this workflow manually from the Actions tab
1414
workflow_dispatch:
@@ -24,10 +24,10 @@ jobs:
2424
doc-url: batch-barcode-scanner/docs
2525
secrets: inherit
2626

27-
# Build-Preview:
28-
# if: ${{ github.ref == 'refs/heads/preview' }}
29-
# uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@preview
30-
# with:
31-
# doc-repo: batch-barcode-scanner-docs
32-
# doc-url: batch-barcode-scanner/docs
33-
# secrets: inherit
27+
Build-Preview:
28+
if: ${{ github.ref == 'refs/heads/preview' }}
29+
uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@preview
30+
with:
31+
doc-repo: batch-barcode-scanner-docs
32+
doc-url: batch-barcode-scanner/docs
33+
secrets: inherit

‎.gitignore‎

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,54 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
12

2-
.DS_Store
3-
/.vs
3+
# dependencies
4+
/node_modules
5+
.vs
6+
7+
# Layout templates
8+
_layouts/**
9+
!_layouts/default-layout-OLD.html
10+
!_layouts/home-page.html
11+
!_layouts/search-page-OLD.html
12+
13+
# Assets
14+
assets/css/
15+
assets/font-face/
16+
assets/img-icon/
17+
assets/js/**
18+
!assets/js/setLatestVersion.js
19+
!assets/js/urlRewrite.js
20+
assets/scripts/
21+
22+
# Includes
23+
_includes/productNav/
24+
_includes/auto-version-list.html
25+
_includes/head.html
26+
_includes/liquid_autoGenerateHistoryList.html
27+
_includes/liquid_breadcrumb.html
28+
_includes/liquid_generateFullTree.html
29+
_includes/liquid_searchVersionTreeFile.html
30+
_includes/livehelp.html
31+
_includes/main-page-head.html
32+
_includes/page_footer.html
33+
_includes/page_header.html
34+
_includes/productNav_OLD.html
35+
_includes/productNav.html
36+
_includes/search-input.html
37+
_includes/trialLicense.html
38+
39+
# Plugins
40+
_plugins/
41+
42+
# Site resources
43+
_site/
44+
45+
sitemap.xml
46+
Hide_Tree_Page.md
47+
Gemfile.lock
48+
Gemfile
49+
50+
# Local development workspace
51+
.dev/
52+
.bundle/
53+
.jekyll-cache/
54+
.sass-cache/

‎FAQ.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: default-layout
3+
title: FAQ
4+
keywords: FAQ
5+
breadcrumbText: FAQ
6+
description: FAQ of Dynamsoft Batch Barcode Scanner
7+
needAutoGenerateSidebar: true
8+
needGenerateH3Content: true
9+
noTitleIndex: true
10+
---
11+
12+
# FAQ
13+
14+
15+
* What platforms does Batch Barcode Scanner support?
16+
17+
The core library is written C++. It can run on mobile/desktop/web. Please contact us if you are interested.
18+
19+
* Will there be an SDK version?
20+
21+
Currently, we only provide apps. An SDK version is not planned for now.
22+
23+

‎_config.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
title: Dynamsoft Batch Barcode Scanner Documentation
12
repositoryUrl: https://github.com/dynamsoft-docs/batch-barcode-scanner-docs/blob/main
23
repository: dynamsoft-docs/batch-barcode-scanner-docs
34
docFullPath: https://www.dynamsoft.com/batch-barcode-scanner/docs/
@@ -7,6 +8,7 @@ searchIndexName: Crawler-BBS-Docs
78
searchNeedFilter: false
89

910
bbs_core: /batch-barcode-scanner/docs/
11+
bbs_app: /batch-barcode-scanner/docs/app/
1012
bbs_parameters: /batch-barcode-scanner/docs/parameters/
1113
bbs_release_notes: /batch-barcode-scanner/
1214
bbs_license_activation: /batch-barcode-scanner/docs/
@@ -35,3 +37,7 @@ plugins:
3537
- jekyll-seo-tag
3638

3739
url: "https://www.dynamsoft.com" # sitemap root
40+
relative_links:
41+
enabled: true
42+
collections: true
43+

‎_includes/sidelist-full-tree.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
<li><a href="{{ site.bbs_core }}introduction.html" class="otherLinkColour">Introduction</a></li>
22

3-
<li class="category">DEVELOPMENT</li>
4-
<li><a style="cursor:pointer;color:#3c3c3c">Mobile</a>
3+
<li><a style="cursor:pointer;color:#3c3c3c">App Guide</a>
54
<ul>
6-
<li><a style="cursor:pointer;color:#3c3c3c">iOS</a>
7-
<ul>
8-
<li lang="objectivec-swift" ><a style="cursor:pointer;color:#3c3c3c">User Guide</a>
9-
<ul lang="objectivec-swift" >
10-
<li lang="objectivec-swift" ><a href="{{ site.bbs_ios }}guide/first-scan.html" class="otherLinkColour">Start Your First Scan</a> </li>
11-
<li lang="objectivec-swift" ><a href="{{ site.bbs_ios }}guide/customization.html" class="otherLinkColour">Get Your Scanner Customized</a></li>
12-
<li lang="objectivec-swift" ><a href="{{ site.bbs_ios }}guide/manual.html" class="otherLinkColour">Operation Manual</a></li>
13-
<li lang="objectivec-swift" ><a href="{{ site.bbs_ios }}guide/trouble-shooting.html" class="otherLinkColour">Troubleshooting</a></li>
14-
</ul>
15-
</li>
16-
</ul>
17-
</li>
5+
<li><a href="{{ site.bbs_app }}guide/first-scan.html" class="otherLinkColour">Start Your First Scan</a> </li>
6+
<li><a href="{{ site.bbs_app }}guide/three-scanning-modes.html" class="otherLinkColour">Three Scanning Modes</a></li>
7+
<li><a href="{{ site.bbs_app }}guide/customization.html" class="otherLinkColour">Get Your Scanner Customized</a></li>
8+
<li><a href="{{ site.bbs_app }}guide/troubleshooting.html" class="otherLinkColour">Troubleshooting</a></li>
9+
<li><a href="{{ site.bbs_app }}guide/extra-features.html" class="otherLinkColour">Extra Features</a></li>
1810
</ul>
1911
</li>
20-
<li class="category">Understanding BBS</li>
2112
<li><a href="{{ site.bbs_parameters }}" class="otherLinkColour">Parameters</a>
2213
<ul>
2314
<li><a href="{{ site.bbs_parameters }}camera-and-ui-settings.html" class="otherLinkColour">Camera and UI Template</a></li>
2415
<li><a href="{{ site.bbs_parameters }}batch-scan-settings.html" class="otherLinkColour">Batch Scan Template</a></li>
2516
<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>
2617
</ul>
2718
</li>
19+
<li><a style="cursor:pointer;color:#3c3c3c">Release Notes</a>
20+
<ul>
21+
<li><a href="{{ site.bbs_app }}release-notes/ios.html" class="otherLinkColour">iOS App</a></li>
22+
<li><a href="{{ site.bbs_app }}release-notes/android.html" class="otherLinkColour">Android App</a></li>
23+
</ul>
24+
</li>
25+
<li><a href="{{ site.bbs_core }}faq.html" class="otherLinkColour">FAQ</a></li>
26+
27+

‎app/guide/customization.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: default-layout
3+
title: Customization
4+
keywords: Customization
5+
breadcrumbText: Customization
6+
description: This demostrates how to get your scanner customized.
7+
needAutoGenerateSidebar: true
8+
needGenerateH3Content: true
9+
noTitleIndex: true
10+
---
11+
12+
# Get Your Scanner Customized
13+
14+
The scanning experience in **Dynamsoft Batch Barcode Scanner** is fully customizable. Open the settings page, you can configure it in the following aspects:
15+
16+
* Camera
17+
* Scanning
18+
* Barcode Reading
19+
20+
Settings screenshots:
21+
22+
![Settings 1](/assets/images/guide/settings-1.jpg){:width="215"} ![Settings 2](/assets/images/guide/settings-2.jpg){:width="215"}
23+
24+
## Camera
25+
26+
| Settings | Description |
27+
| --------- | ----------- |
28+
| Resolution | The resolution of the camera preview. |
29+
| 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.|
30+
31+
## Scanning
32+
33+
| Settings | Description |
34+
| --------- | ----------- |
35+
| Scan Setting Name | The name of the scanning setting, which is used in the JSON template. |
36+
| Scan Region | Specifies the scan region. |
37+
| Stitch Level | Specifies how much effort to spend on stitching the images. |
38+
| Auto Stop | Whether to stop scanning automatically when certain conditions are reached, like barcode count. |
39+
| 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. |
40+
41+
42+
## Barcode Reading
43+
44+
| Settings | Description |
45+
| --------- | ----------- |
46+
| Barcode Setting Name | The name of the barcode reading setting, which is used in the JSON template. |
47+
| Barcode Colour Options | Configure this to read inverted barcodes. |
48+
| Barcode Decode Level | Preset templates to control how much effort to spend on decoding barcodes. |
49+
| Barcode Formats | Specifies what formats of barcode to read and output. |
50+
| 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. |
51+
| 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. |
52+
53+
## Import and Export
54+
55+
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.
56+
57+
You can [contact support](mailto:support@dynamsoft.com) to specify the default template for your account.
58+
59+
Read the [parameters](/parameters/index.md) page to learn more about the JSON templates.

‎app/guide/extra-features.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default-layout
3+
title: Extra Features
4+
description: Extra features Dynamsoft Batch Barcode Scanner
5+
needAutoGenerateSidebar: true
6+
needGenerateH3Content: true
7+
noTitleIndex: true
8+
---
9+
10+
11+
# Extra Features
12+
13+
There are extra features for different use cases.
14+
15+
## Wanted Barcodes
16+
17+
Currently, the main extra feature is to specify wanted barcodes.
18+
19+
In the live scanning interface, you can specify barcodes via manual input, selecting decoded barcodes on an image, etc.
20+
21+
![setting wanted](/assets/images/guide/setting-wanted.jpg){:width="215"}
22+
23+
In the scanning result, the wanted barcodes will be marked in purple.
24+
25+
![found wanted](/assets/images/guide/found-wanted.jpg){:width="215"}

‎app/guide/first-scan.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
layout: default-layout
3+
title: Start Your First Scan
4+
keywords: guide, first scan
5+
breadcrumbText: Start Your First Scan
6+
description: This page introduces how to perform a basic batch barcode scan.
7+
needAutoGenerateSidebar: false
8+
needGenerateH3Content: false
9+
noTitleIndex: true
10+
---
11+
12+
# Start Your First Scan
13+
14+
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.
15+
16+
1. Open your app and you will see the following page.
17+
18+
![home](/assets/images/guide/home.jpg){:width="215"}
19+
20+
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.
21+
22+
![fov start](/assets/images/guide/fov-start.jpg){:width="215"} ![fov initial result](/assets/images/guide/fov-initial-decoding-result.jpg){:width="215"}
23+
24+
3. After pressing "Retake", the app will reenter the live capturing interface, with the previous decoding result displayed in the bottom‑left corner.
25+
26+
![fov live](/assets/images/guide/fov-live.jpg){:width="215"}
27+
28+
Barcodes will be highlighted in different colors:
29+
30+
* Already recognized: green.
31+
* Newly recognized: light blue.
32+
33+
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.
34+
35+
![fov second decoding result](/assets/images/guide/fov-second-decoding-result.jpg){:width="215"}
36+
37+
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.
38+
39+
![fov result](/assets/images/guide/fov-result.jpg){:width="215"}
40+
41+
42+
There are many export options:
43+
44+
* Save to local folder
45+
* Save to OneDrive
46+
* Share to third-party apps
47+
48+
It saves the whole image and a CSV of barcode results.
49+
50+
> [!NOTE]
51+
> The export feature requires login.
52+
53+
## Icon Reference
54+
55+
| Icon | Description |
56+
| --------- | ----------- |
57+
| ![auto capture](/assets/images/guide/icon/auto_capture.svg) | Auto capture at fixed interval. |
58+
| ![wanted](/assets/images/guide/icon/wanted.svg) | Set wanted barcodes. |
59+
| ![flashlight](/assets/images/guide/icon/flashlight.svg){:height="23"}{:width="24"} | Toggle flashlight. |
60+
| ![beep](/assets/images/guide/icon/beep.svg) | Beep after successful scanning. |
61+
| ![vibrate](/assets/images/guide/icon/vibrate.svg) | Vibrate after successful scanning. |
62+
| ![settings](/assets/images/guide/icon/settings.svg) | Go to settings page. |
63+
| ![add](/assets/images/guide/icon/add.svg) | Import images and barcodes. |
64+
| ![refresh](/assets/images/guide/icon/refresh.svg) | Start a new scanning. |
65+
| ![capture](/assets/images/guide/icon/capture.svg) | Capture a photo for decoding. |
66+
| ![download](/assets/images/guide/icon/download.svg) | Save the scanning result. |
67+
| ![results](/assets/images/guide/icon/results.svg) | Go to the result page. |
68+
69+
70+
71+
## More Scanning Modes
72+
73+
Continue reading to learn other advanced scanning modes: [Three Scanning Modes](/app/guide/three-scanning-modes.md).
74+
75+
76+

0 commit comments

Comments
 (0)