Skip to content

Commit 00c9b90

Browse files
authored
Merge pull request #199 from icfung828/master
add back faq: what-are-the-resources-files
2 parents aaa20aa + e88eda4 commit 00c9b90

File tree

16 files changed

+144
-21
lines changed

16 files changed

+144
-21
lines changed

about/resources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: Dynamic Web TWAIN SDK Documentation Resources Page
1313

1414
* <a href="https://www.dynamsoft.com/Downloads/WebTWAIN_Download.aspx" target="_blank">Official installer</a>
1515

16-
> This official package is meant for developers to evaluate the SDK. When the package is installed, you get all the [resource files]({{site.about}}faqs.html#what-are-the-resources-files), documentation, and samples. A 30-day free trial is included when evaluating our SDK.
16+
> This official package is meant for developers to evaluate the SDK. When the package is installed, you get all the [resource files]({{site.faq}}what-are-the-resources-files.html), documentation, and samples. A 30-day free trial is included when evaluating our SDK.
1717
1818
* <a href="https://www.npmjs.com/package/dwt" target="_blank">NPM package</a>
1919

@@ -27,7 +27,7 @@ description: Dynamic Web TWAIN SDK Documentation Resources Page
2727

2828
* <a href="https://www.dynamsoft.com/Downloads/WebTWAIN-Sample-Download.aspx" target="_blank">Official samples</a>
2929

30-
> We have many prebuilt samples to demonstrate common user scenarios. All samples contain the [resource files]({{site.about}}faqs.html#what-are-the-resources-files) required in your application. If a sample is hosted on the Dynamsoft website (not Github), then the sample comes with a 30-day free trial license as well. Otherwise, you can [get a trial license](#how-do-i-get-a-trial-license).
30+
> We have many prebuilt samples to demonstrate common user scenarios. All samples contain the [resource files]({{site.faq}}what-are-the-resources-files.html) required in your application. If a sample is hosted on the Dynamsoft website (not Github), then the sample comes with a 30-day free trial license as well. Otherwise, you can [get a trial license](#how-do-i-get-a-trial-license).
3131
3232
* <a href="https://github.com/dynamsoft-dwt" target="_blank">Github repo</a>
3333

faq/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,8 @@ description: Dynamic Web TWAIN SDK Documentation FAQ
251251

252252
<a href="{{site.faq}}how-come-would-you-need-local.dynamsoft.com.html" target="_blank">In which cases would I use local.dynamsoft.com instead of 127.0.0.1?</a>
253253

254+
<a href="{{site.faq}}what-are-the-resources-files.html" target="_blank">What are the Resources files?</a>
255+
254256
<a href="{{site.faq}}resources-to-be-included-in-SDK.html" target="_blank">What resources of the SDK should be included in my web application?</a>
255257

256258
<a href="{{site.faq}}change-reference-path.html" target="_blank">How can I change the reference path to the Dynamsoft’s resources in my project?</a>
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
layout: default-layout
3+
noTitleIndex: true
4+
needAutoGenerateSidebar: true
5+
title: What are the Resources files?
6+
keywords: Dynamic Web TWAIN, Documentation, General
7+
breadcrumbText: What Are The Resources Files
8+
description: What are the Resources files?
9+
---
10+
11+
# General
12+
13+
## What are the Resources files?
14+
15+
Resources files help you include Dynamic Web TWAIN in your application. The following shows the purpose of these files.
16+
17+
> *Resources* is the default name of the folder that contain these files. It can be changed. For example, in the [Dynamic Web TWAIN package](https://github.com/dynamsoft-dwt/web-twain-package), it's called *dist*.
18+
19+
### Default files
20+
21+
* dynamsoft.webtwain.config.js
22+
23+
> This file is used to make basic configuration of the Dynamic Web TWAIN library. It's where you enter the product key for the product and to change the initial viewer size, etc.
24+
25+
* dynamsoft.webtwain.initiate.js
26+
27+
> This file is the core of the Dynamic Web TWAIN library.
28+
29+
* dynamsoft.webtwain.install.js
30+
31+
> This file is used to configure the dialogs which are shown when the Dynamic Web TWAIN library is not installed or needs to be upgraded. This file is already referenced inside the dynamsoft.webtwain.initiate.js
32+
33+
* Readme.txt
34+
* addon
35+
+ dynamsoft.upload.js
36+
37+
> This file contains the functionalities of the Dynamsoft Upload Module.
38+
39+
+ dynamsoft.webtwain.addon.camera.js
40+
41+
> This file contains the functionalities of the Camera addon.
42+
43+
+ dynamsoft.webtwain.addon.ocr.js
44+
45+
> This file contains the functionalities of the OCR Basic addon. It's not included by default, contact [Dynamsoft Support]({{site.about}}Getsupport.html) to get it.
46+
47+
+ dynamsoft.webtwain.addon.ocrpro.js
48+
49+
> This file contains the functionalities of the OCR Professional addon. It's not included by default, contact [Dynamsoft Support]({{site.about}}Getsupport.html) to get it.
50+
51+
+ dynamsoft.webtwain.addon.pdf.js
52+
53+
> This file contains the functionalities of the PDF Rasterizer addon.
54+
55+
+ dynamsoft.webtwain.addon.webcam.js
56+
57+
> This file contains the functionalities of the Webcam addon.
58+
59+
+ dynamsoft.webtwain.addon.barcodereader.js
60+
61+
> This file contains the functionalities of the Barcode addon.
62+
63+
+ dbrjs
64+
65+
> These files are meant for the barcode reader addon under [WASM mode]({{site.indepth}}initialize.html#wasm-mode).
66+
67+
- dbr.js
68+
- dbr-7.4.0.1.full.wasm
69+
- dbr-7.4.0.1.full.wasm.js
70+
- dbr-7.4.0.1.worker.js
71+
* dist
72+
73+
> Under this directory are the installers for the Dynamsoft Service which needs to be manually installed on each client machine that uses the Dynamic Web TWAIN library as a service.
74+
75+
- DynamsoftServiceSetup.deb
76+
77+
> For Linux (Debian)
78+
79+
- DynamsoftServiceSetup.rpm
80+
81+
> For Linux (Redhat)
82+
83+
- DynamsoftServiceSetup.msi
84+
85+
> For Windows
86+
87+
- DynamsoftServiceSetup.pkg
88+
89+
> For macOS
90+
91+
- LICENSE
92+
+ src
93+
94+
> These files contain the following functionalities for the [WASM-mode]({{site.indepth}}features/initialize.html#wasm-mode)
95+
> - image input & output
96+
> - decode & encode
97+
> - PDF read & write
98+
> - Viewer & UI
99+
100+
- dynamsoft.imageio.js
101+
- dynamsoft.imageio_wasm-<version number>.js
102+
- dynamsoft.imagecore-<version number>.wasm
103+
- dynamsoft.imageio-<version number>.wasm
104+
- dynamsoft.imageProc-<version number>.wasm
105+
- dynamsoft.pdfReader-<version number>.wasm
106+
- dynamsoft.pdfWriter-<version number>.wasm
107+
- dynamsoft.viewer.css
108+
- dynamsoft.viewer.js
109+
- dynamsoft.webtwain.css
110+
111+
### Other Resources files
112+
113+
The following two files are present in the [Dynamic Web TWAIN package](https://github.com/dynamsoft-dwt/web-twain-package).
114+
115+
* dynamsoft.webtwain.min.js
116+
117+
> This is an all-in-one JavaScript file that consists of the files dynamsoft.webtwain.initiate.js , dynamsoft.webtwain.config.js , dynamsoft.webtwain.install.js as well as all the add-on JavaScript files. If you include this file in the application, you no longer need to include these constituent files separately.
118+
119+
* dynamsoft.webtwain.min.mjs
120+
121+
> This file is like dynamsoft.webtwain.min.js but is built by the ECMAScript 6 (ES6) standard. It's used by applications (Angular, React, Vue, etc.) that import the `Dynamic Web TWAIN` package as a module.

indepth/deployment/server-v16.2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Once you have finished integrating `DWT` in your application, you can deploy it
1515
1616
## Make sure the static files can be served correctly
1717

18-
`DWT` comes with lots of static resources files, for the full list, check out [What are the Resources files]({{site.about}}FAQs.html#what-are-the-resources-files). The following table shows each file type and its MIME type which must be configured in your webserver in order for that type of file(s) to be correctly served to the client browsers.
18+
`DWT` comes with lots of static resources files, for the full list, check out [What are the Resources files]({{site.faq}}what-are-the-resources-files.html). The following table shows each file type and its MIME type which must be configured in your webserver in order for that type of file(s) to be correctly served to the client browsers.
1919

2020
| File Type | MIME Type | Required by |
2121
|:-:|:-:|:-:|

indepth/deployment/server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The deployment of Dynamic Web TWAIN is easy. Simply copy the Resources folder to
2626

2727
### Make sure the static files can be served correctly
2828

29-
`DWT` comes with lots of static resources files, for the full list, check out [What are the Resources files]({{site.about}}FAQs.html#what-are-the-resources-files). The following table shows each file type and its MIME type which must be configured in your webserver in order for that type of file(s) to be correctly served to the client browsers.
29+
`DWT` comes with lots of static resources files, for the full list, check out [What are the Resources files]({{site.faq}}what-are-the-resources-files.html). The following table shows each file type and its MIME type which must be configured in your webserver in order for that type of file(s) to be correctly served to the client browsers.
3030

3131
| File Type | MIME Type | Required by |
3232
|:-:|:-:|:-:|

indepth/development/Pro-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The following is how VDS works
3131

3232
## Customization Service
3333

34-
Dynamsoft provides many public samples and code snippets free of cost to all customers. The code in these materials can be customized at will. However, the [resources files]({{site.about}}faqs.html#what-are-the-resources-files) provided with each SDK **should not be changed** unless otherwise mentioned in this documentation. If you want to make unmentioned changes to any of these files in the documentation, you must first consult [Dynamsoft Support]({{site.about}}getsupport.html) to learn whether or not it can be done and if so, what that would entail from our end. If it involves a considerable amount of extra effort from the Dynamsoft team, the "Customization Service" (CS) may apply.
34+
Dynamsoft provides many public samples and code snippets free of cost to all customers. The code in these materials can be customized at will. However, the [resources files]({{site.faq}}what-are-the-resources-files.html) provided with each SDK **should not be changed** unless otherwise mentioned in this documentation. If you want to make unmentioned changes to any of these files in the documentation, you must first consult [Dynamsoft Support]({{site.about}}getsupport.html) to learn whether or not it can be done and if so, what that would entail from our end. If it involves a considerable amount of extra effort from the Dynamsoft team, the "Customization Service" (CS) may apply.
3535

3636
The difference between VDS and CS is that the latter involves changes to the `DWT` SDK itself and is considered much more complicated from a technical standpoint. However, in term of the customer's workflow to get a customization job done, the steps are the same as VDS.
3737

indepth/development/upgrade-v16.2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The following three steps are required to upgrade your application to use a newe
1919

2020
## Update the resources files
2121

22-
Read more about [resources files]({{site.about}}faqs.html#what-are-the-resources-files).
22+
Read more about [resources files]({{site.faq}}what-are-the-resources-files.html).
2323

2424
### Regular Web application
2525

indepth/features/OCR-v16.2.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Client side OCR only works in [browsers on Windows]({{site.getstarted}}platform.
3131

3232
#### Step one - Include OCRB
3333

34-
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocr.js` which is **NOT** included in the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRB-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRBasicx64-v16.zip).
34+
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocr.js` which is **NOT** included in the [resources files]({{site.faq}}what-are-the-resources-files.html). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRB-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRBasicx64-v16.zip).
3535

3636
> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the addon is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.
3737
@@ -72,7 +72,7 @@ function downloadOCRB(bDownloadDLL) {
7272
downloadOCRB(true);
7373
```
7474

75-
The code asks `DWT` to download `OCRB` from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRx64.zip'` and the language data from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRBasicLanguages/English.zip'` . Both zip files need to be placed on the server where you placed the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). As mentioned above, if you can't find these files, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRB-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRBasicx64-v16.zip).
75+
The code asks `DWT` to download `OCRB` from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRx64.zip'` and the language data from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRBasicLanguages/English.zip'` . Both zip files need to be placed on the server where you placed the [resources files]({{site.faq}}what-are-the-resources-files.html). As mentioned above, if you can't find these files, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRB-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRBasicx64-v16.zip).
7676

7777
Once the installation is done, you should be able to find the following files under `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_16\DynamicOCR` .
7878

@@ -131,7 +131,7 @@ function DoOCR() {
131131

132132
#### Step one - Include OCRPro
133133

134-
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocrpro.js` which is **NOT** included in the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRPro-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRProx64-v16.zip).
134+
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocrpro.js` which is **NOT** included in the [resources files]({{site.faq}}what-are-the-resources-files.html). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRPro-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRProx64-v16.zip).
135135

136136
> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the addon is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.
137137
@@ -159,7 +159,7 @@ function downloadOCRPro() {
159159
downloadOCRPro();
160160
```
161161

162-
The code asks `DWT` to download `OCRPro` from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRProx64.zip'` . This zip file needs to be placed on the server where you placed the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). As mentioned above, if you can't find these files, you can get them from [64bit-OCRPro-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRProx64-v16.zip).
162+
The code asks `DWT` to download `OCRPro` from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRProx64.zip'` . This zip file needs to be placed on the server where you placed the [resources files]({{site.faq}}what-are-the-resources-files.html). As mentioned above, if you can't find these files, you can get them from [64bit-OCRPro-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRProx64-v16.zip).
163163

164164
Once the installation is done, you should be able to find the following under `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_16`
165165
* `DynamicOCRProx64_1.2.0.0806.dll` : The version number may vary.

indepth/features/OCR.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Client side OCR only works in [browsers on Windows]({{site.getstarted}}platform.
3131

3232
#### Step one - Include OCRB
3333

34-
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocr.js` which is **NOT** included in the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
34+
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocr.js` which is **NOT** included in the [resources files]({{site.faq}}what-are-the-resources-files.html). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
3535

3636
> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the addon is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.
3737
@@ -72,7 +72,7 @@ function downloadOCRB(bDownloadDLL) {
7272
downloadOCRB(true);
7373
```
7474

75-
The code asks `DWT` to download `OCRB` from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRx64.zip'` and the language data from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRBasicLanguages/English.zip'` . Both zip files need to be placed on the server where you placed the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). As mentioned above, if you can't find these files, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
75+
The code asks `DWT` to download `OCRB` from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRx64.zip'` and the language data from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRBasicLanguages/English.zip'` . Both zip files need to be placed on the server where you placed the [resources files]({{site.faq}}what-are-the-resources-files.html). As mentioned above, if you can't find these files, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
7676

7777
Once the installation is done, you should be able to find the following files under `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_17\DynamicOCR` .
7878

@@ -131,7 +131,7 @@ function DoOCR() {
131131

132132
#### Step one - Include OCRPro
133133

134-
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocrpro.js` which is **NOT** included in the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
134+
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocrpro.js` which is **NOT** included in the [resources files]({{site.faq}}what-are-the-resources-files.html). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
135135

136136
> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the addon is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.
137137
@@ -159,7 +159,7 @@ function downloadOCRPro() {
159159
downloadOCRPro();
160160
```
161161

162-
The code asks `DWT` to download `OCRPro` from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRProx64.zip'` . This zip file needs to be placed on the server where you placed the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
162+
The code asks `DWT` to download `OCRPro` from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRProx64.zip'` . This zip file needs to be placed on the server where you placed the [resources files]({{site.faq}}what-are-the-resources-files.html). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
163163

164164
Once the installation is done, you should be able to find the following under `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_17`
165165
* `DynamicOCRProx64_1.2.0.0806.dll` : The version number may vary.

indepth/features/barcode-v16.2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ With the increasing use of barcode reading in document management systems, the B
2525

2626
### Step one - Include the add-on
2727

28-
To include this add-on is to reference the necessary JavaScript file which is included in the [resources files]({{site.about}}faqs.html#what-are-the-resources-files).
28+
To include this add-on is to reference the necessary JavaScript file which is included in the [resources files]({{site.faq}}what-are-the-resources-files.html).
2929

3030
> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the barcode reader is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.
3131

0 commit comments

Comments
 (0)